purecloud 0.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (667) hide show
  1. checksums.yaml +7 -0
  2. data/CONTRIBUTING.md +0 -0
  3. data/Gemfile +7 -0
  4. data/Gemfile.lock +39 -0
  5. data/LICENSE +22 -0
  6. data/PureCloud.gemspec +32 -0
  7. data/README.md +64 -0
  8. data/config-ruby.json +1 -0
  9. data/doc/template/default/layout/html/layout.erb +4 -0
  10. data/doc/template/default/method_details/html/source.erb +0 -0
  11. data/doc/template/default/module/html/attribute_summary.erb +8 -0
  12. data/doc/template/default/module/html/box_info.erb +0 -0
  13. data/doc/template/default/module/html/children.erb +0 -0
  14. data/extensions/auth.rb +40 -0
  15. data/external/swagger-codegen-cli.jar +0 -0
  16. data/lib/purecloud.rb +707 -0
  17. data/lib/purecloud/api/analytics_api.rb +1554 -0
  18. data/lib/purecloud/api/architect_api.rb +232 -0
  19. data/lib/purecloud/api/attributes_api.rb +377 -0
  20. data/lib/purecloud/api/authorization_api.rb +1135 -0
  21. data/lib/purecloud/api/compliance_api.rb +129 -0
  22. data/lib/purecloud/api/configuration_api.rb +5049 -0
  23. data/lib/purecloud/api/content_management_api.rb +2457 -0
  24. data/lib/purecloud/api/conversations_api.rb +1699 -0
  25. data/lib/purecloud/api/downloads_api.rb +140 -0
  26. data/lib/purecloud/api/fax_api.rb +378 -0
  27. data/lib/purecloud/api/geolocation_api.rb +263 -0
  28. data/lib/purecloud/api/greetings_api.rb +771 -0
  29. data/lib/purecloud/api/groups_api.rb +208 -0
  30. data/lib/purecloud/api/languages_api.rb +138 -0
  31. data/lib/purecloud/api/licensing_api.rb +428 -0
  32. data/lib/purecloud/api/locations_api.rb +148 -0
  33. data/lib/purecloud/api/notifications_api.rb +431 -0
  34. data/lib/purecloud/api/o_auth_api.rb +1269 -0
  35. data/lib/purecloud/api/orphaned_recordings_api.rb +205 -0
  36. data/lib/purecloud/api/outbound_api.rb +4262 -0
  37. data/lib/purecloud/api/presence_api.rb +662 -0
  38. data/lib/purecloud/api/quality_api.rb +1663 -0
  39. data/lib/purecloud/api/routing_api.rb +2133 -0
  40. data/lib/purecloud/api/scripts_api.rb +712 -0
  41. data/lib/purecloud/api/search_api.rb +73 -0
  42. data/lib/purecloud/api/stations_api.rb +205 -0
  43. data/lib/purecloud/api/telephony_providers_edge_api.rb +2407 -0
  44. data/lib/purecloud/api/tokens_api.rb +71 -0
  45. data/lib/purecloud/api/user_recordings_api.rb +394 -0
  46. data/lib/purecloud/api/users_api.rb +1361 -0
  47. data/lib/purecloud/api/utilities_api.rb +249 -0
  48. data/lib/purecloud/api/voicemail_api.rb +677 -0
  49. data/lib/purecloud/api_client.rb +304 -0
  50. data/lib/purecloud/api_error.rb +24 -0
  51. data/lib/purecloud/configuration.rb +170 -0
  52. data/lib/purecloud/models/account.rb +450 -0
  53. data/lib/purecloud/models/account_manager.rb +176 -0
  54. data/lib/purecloud/models/account_overview.rb +224 -0
  55. data/lib/purecloud/models/account_status.rb +230 -0
  56. data/lib/purecloud/models/action.rb +178 -0
  57. data/lib/purecloud/models/actions.rb +148 -0
  58. data/lib/purecloud/models/acw_settings.rb +165 -0
  59. data/lib/purecloud/models/address.rb +218 -0
  60. data/lib/purecloud/models/address_listing.rb +238 -0
  61. data/lib/purecloud/models/agent.rb +146 -0
  62. data/lib/purecloud/models/agent_activity.rb +210 -0
  63. data/lib/purecloud/models/agent_activity_entity_listing.rb +238 -0
  64. data/lib/purecloud/models/agent_evaluator_activity.rb +208 -0
  65. data/lib/purecloud/models/alert.rb +312 -0
  66. data/lib/purecloud/models/alert_entity_listing.rb +238 -0
  67. data/lib/purecloud/models/annotation.rb +218 -0
  68. data/lib/purecloud/models/app.rb +156 -0
  69. data/lib/purecloud/models/archive_retention.rb +165 -0
  70. data/lib/purecloud/models/associated_document.rb +168 -0
  71. data/lib/purecloud/models/attachment.rb +186 -0
  72. data/lib/purecloud/models/attribute.rb +230 -0
  73. data/lib/purecloud/models/attribute_entity_listing.rb +238 -0
  74. data/lib/purecloud/models/attribute_query_request.rb +170 -0
  75. data/lib/purecloud/models/attribute_value.rb +250 -0
  76. data/lib/purecloud/models/audit_change.rb +180 -0
  77. data/lib/purecloud/models/audit_entity_reference.rb +195 -0
  78. data/lib/purecloud/models/audit_message.rb +300 -0
  79. data/lib/purecloud/models/audit_search_result.rb +200 -0
  80. data/lib/purecloud/models/automate_queue.rb +214 -0
  81. data/lib/purecloud/models/automate_queue_member.rb +178 -0
  82. data/lib/purecloud/models/available_additional_service.rb +214 -0
  83. data/lib/purecloud/models/available_additional_service_listing.rb +238 -0
  84. data/lib/purecloud/models/available_topic.rb +147 -0
  85. data/lib/purecloud/models/backend_flow_available_actions.rb +148 -0
  86. data/lib/purecloud/models/backend_work_item_data_element.rb +176 -0
  87. data/lib/purecloud/models/basic_transform.rb +160 -0
  88. data/lib/purecloud/models/batch_command.rb +158 -0
  89. data/lib/purecloud/models/batch_item.rb +166 -0
  90. data/lib/purecloud/models/batch_item_body.rb +146 -0
  91. data/lib/purecloud/models/batch_reply.rb +148 -0
  92. data/lib/purecloud/models/batch_reply_item.rb +166 -0
  93. data/lib/purecloud/models/billing_period.rb +190 -0
  94. data/lib/purecloud/models/body.rb +136 -0
  95. data/lib/purecloud/models/body_1.rb +136 -0
  96. data/lib/purecloud/models/body_2.rb +136 -0
  97. data/lib/purecloud/models/bullseye.rb +148 -0
  98. data/lib/purecloud/models/byte_buffer.rb +220 -0
  99. data/lib/purecloud/models/calibration.rb +303 -0
  100. data/lib/purecloud/models/calibration_assignment.rb +178 -0
  101. data/lib/purecloud/models/calibration_entity_listing.rb +238 -0
  102. data/lib/purecloud/models/call.rb +323 -0
  103. data/lib/purecloud/models/call_forwarding.rb +211 -0
  104. data/lib/purecloud/models/call_record.rb +157 -0
  105. data/lib/purecloud/models/callable_contacts_diagnostic.rb +170 -0
  106. data/lib/purecloud/models/callable_time.rb +158 -0
  107. data/lib/purecloud/models/callable_time_set.rb +212 -0
  108. data/lib/purecloud/models/callable_time_set_entity_listing.rb +238 -0
  109. data/lib/purecloud/models/callback.rb +302 -0
  110. data/lib/purecloud/models/campaign.rb +200 -0
  111. data/lib/purecloud/models/campaign_diagnostics.rb +166 -0
  112. data/lib/purecloud/models/campaign_entity_listing.rb +238 -0
  113. data/lib/purecloud/models/campaign_schedule.rb +232 -0
  114. data/lib/purecloud/models/campaign_schedule_intervals.rb +158 -0
  115. data/lib/purecloud/models/campaign_sequence.rb +263 -0
  116. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +238 -0
  117. data/lib/purecloud/models/campaign_stats.rb +176 -0
  118. data/lib/purecloud/models/carrier.rb +220 -0
  119. data/lib/purecloud/models/carrier_address.rb +186 -0
  120. data/lib/purecloud/models/carrier_entity_listing.rb +238 -0
  121. data/lib/purecloud/models/certificate.rb +148 -0
  122. data/lib/purecloud/models/certificate_authority_entity_listing.rb +238 -0
  123. data/lib/purecloud/models/certificate_details.rb +218 -0
  124. data/lib/purecloud/models/change.rb +180 -0
  125. data/lib/purecloud/models/channel.rb +157 -0
  126. data/lib/purecloud/models/channel_entity_listing.rb +238 -0
  127. data/lib/purecloud/models/channel_topic.rb +158 -0
  128. data/lib/purecloud/models/charge.rb +206 -0
  129. data/lib/purecloud/models/chat.rb +146 -0
  130. data/lib/purecloud/models/chat_message.rb +226 -0
  131. data/lib/purecloud/models/chat_message_user.rb +188 -0
  132. data/lib/purecloud/models/chat_participant.rb +155 -0
  133. data/lib/purecloud/models/chat_search_item.rb +208 -0
  134. data/lib/purecloud/models/chat_search_listing.rb +238 -0
  135. data/lib/purecloud/models/chat_search_request.rb +244 -0
  136. data/lib/purecloud/models/client_spreadsheet_transform.rb +214 -0
  137. data/lib/purecloud/models/client_transform_model.rb +190 -0
  138. data/lib/purecloud/models/column_collapse.rb +158 -0
  139. data/lib/purecloud/models/command_status.rb +237 -0
  140. data/lib/purecloud/models/command_status_entity_listing.rb +238 -0
  141. data/lib/purecloud/models/common_audit_request.rb +214 -0
  142. data/lib/purecloud/models/condition.rb +228 -0
  143. data/lib/purecloud/models/connect_rate.rb +166 -0
  144. data/lib/purecloud/models/consult_transfer.rb +167 -0
  145. data/lib/purecloud/models/consult_transfer_response.rb +147 -0
  146. data/lib/purecloud/models/consult_transfer_update.rb +156 -0
  147. data/lib/purecloud/models/consumed_resources_entity_listing.rb +238 -0
  148. data/lib/purecloud/models/consuming_resources_entity_listing.rb +238 -0
  149. data/lib/purecloud/models/contact.rb +226 -0
  150. data/lib/purecloud/models/contact_callback_request.rb +186 -0
  151. data/lib/purecloud/models/contact_list.rb +266 -0
  152. data/lib/purecloud/models/contact_list_entity_listing.rb +238 -0
  153. data/lib/purecloud/models/contact_sales.rb +288 -0
  154. data/lib/purecloud/models/contact_sales_response.rb +178 -0
  155. data/lib/purecloud/models/content_facet_filter_item.rb +196 -0
  156. data/lib/purecloud/models/content_query_request.rb +202 -0
  157. data/lib/purecloud/models/content_sort_item.rb +158 -0
  158. data/lib/purecloud/models/contract.rb +198 -0
  159. data/lib/purecloud/models/contract_job.rb +198 -0
  160. data/lib/purecloud/models/conversation.rb +258 -0
  161. data/lib/purecloud/models/conversation_entity_listing.rb +238 -0
  162. data/lib/purecloud/models/conversation_historical_query_request_body.rb +185 -0
  163. data/lib/purecloud/models/conversation_historical_query_request_filter.rb +181 -0
  164. data/lib/purecloud/models/conversation_query_response.rb +366 -0
  165. data/lib/purecloud/models/conversation_response.rb +168 -0
  166. data/lib/purecloud/models/cover_sheet.rb +158 -0
  167. data/lib/purecloud/models/create_share_request.rb +206 -0
  168. data/lib/purecloud/models/create_share_request_member.rb +165 -0
  169. data/lib/purecloud/models/create_share_response.rb +270 -0
  170. data/lib/purecloud/models/create_template_from_script_request_data.rb +188 -0
  171. data/lib/purecloud/models/csv_schema.rb +224 -0
  172. data/lib/purecloud/models/customer_account.rb +238 -0
  173. data/lib/purecloud/models/data_item.rb +166 -0
  174. data/lib/purecloud/models/data_value_info.rb +148 -0
  175. data/lib/purecloud/models/default_greeting_list.rb +251 -0
  176. data/lib/purecloud/models/delete_retention.rb +146 -0
  177. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +238 -0
  178. data/lib/purecloud/models/delta_document.rb +216 -0
  179. data/lib/purecloud/models/delta_request.rb +146 -0
  180. data/lib/purecloud/models/delta_response.rb +170 -0
  181. data/lib/purecloud/models/dependency.rb +209 -0
  182. data/lib/purecloud/models/dependency_object.rb +233 -0
  183. data/lib/purecloud/models/dependency_object_entity_listing.rb +238 -0
  184. data/lib/purecloud/models/dependency_status.rb +241 -0
  185. data/lib/purecloud/models/dependency_type.rb +180 -0
  186. data/lib/purecloud/models/dependency_type_entity_listing.rb +238 -0
  187. data/lib/purecloud/models/destination.rb +197 -0
  188. data/lib/purecloud/models/detail.rb +176 -0
  189. data/lib/purecloud/models/diagnostic_email.rb +225 -0
  190. data/lib/purecloud/models/dialer_audit_request.rb +182 -0
  191. data/lib/purecloud/models/dialer_call.rb +156 -0
  192. data/lib/purecloud/models/dialer_disposition_call_command.rb +166 -0
  193. data/lib/purecloud/models/dialer_place_call_command.rb +156 -0
  194. data/lib/purecloud/models/dialer_preview.rb +188 -0
  195. data/lib/purecloud/models/did.rb +319 -0
  196. data/lib/purecloud/models/did_entity_listing.rb +238 -0
  197. data/lib/purecloud/models/did_pool.rb +321 -0
  198. data/lib/purecloud/models/did_pool_entity_listing.rb +238 -0
  199. data/lib/purecloud/models/digit_length.rb +156 -0
  200. data/lib/purecloud/models/dnc_list.rb +242 -0
  201. data/lib/purecloud/models/dnc_list_entity_listing.rb +238 -0
  202. data/lib/purecloud/models/dns.rb +166 -0
  203. data/lib/purecloud/models/document.rb +479 -0
  204. data/lib/purecloud/models/document_audit.rb +339 -0
  205. data/lib/purecloud/models/document_audit_entity_listing.rb +238 -0
  206. data/lib/purecloud/models/document_entity_listing.rb +238 -0
  207. data/lib/purecloud/models/document_thumbnail.rb +156 -0
  208. data/lib/purecloud/models/document_update.rb +228 -0
  209. data/lib/purecloud/models/document_upload.rb +192 -0
  210. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +238 -0
  211. data/lib/purecloud/models/domain_capabilities.rb +170 -0
  212. data/lib/purecloud/models/domain_certificate_authority.rb +327 -0
  213. data/lib/purecloud/models/domain_edge_software_update_dto.rb +242 -0
  214. data/lib/purecloud/models/domain_edge_software_version_dto.rb +223 -0
  215. data/lib/purecloud/models/domain_entity.rb +168 -0
  216. data/lib/purecloud/models/domain_entity_listing.rb +238 -0
  217. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +238 -0
  218. data/lib/purecloud/models/domain_entity_listing_query_result.rb +238 -0
  219. data/lib/purecloud/models/domain_invoice_entity_listing.rb +238 -0
  220. data/lib/purecloud/models/domain_license.rb +200 -0
  221. data/lib/purecloud/models/domain_license_entity_listing.rb +238 -0
  222. data/lib/purecloud/models/domain_logical_interface.rb +526 -0
  223. data/lib/purecloud/models/domain_network_address.rb +178 -0
  224. data/lib/purecloud/models/domain_network_command_response.rb +178 -0
  225. data/lib/purecloud/models/domain_network_route.rb +188 -0
  226. data/lib/purecloud/models/domain_org_role_difference.rb +192 -0
  227. data/lib/purecloud/models/domain_organization_product.rb +146 -0
  228. data/lib/purecloud/models/domain_organization_role.rb +268 -0
  229. data/lib/purecloud/models/domain_permission.rb +200 -0
  230. data/lib/purecloud/models/domain_permission_collection.rb +190 -0
  231. data/lib/purecloud/models/domain_permission_policy.rb +222 -0
  232. data/lib/purecloud/models/domain_physical_capabilities.rb +160 -0
  233. data/lib/purecloud/models/domain_physical_interface.rb +218 -0
  234. data/lib/purecloud/models/domain_resource_condition_node.rb +208 -0
  235. data/lib/purecloud/models/domain_resource_condition_value.rb +185 -0
  236. data/lib/purecloud/models/domain_schema_reference.rb +168 -0
  237. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +238 -0
  238. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +238 -0
  239. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +238 -0
  240. data/lib/purecloud/models/download_response.rb +156 -0
  241. data/lib/purecloud/models/duration_condition.rb +175 -0
  242. data/lib/purecloud/models/edge.rb +523 -0
  243. data/lib/purecloud/models/edge_auto_update_config.rb +178 -0
  244. data/lib/purecloud/models/edge_entity_listing.rb +238 -0
  245. data/lib/purecloud/models/edge_group.rb +306 -0
  246. data/lib/purecloud/models/edge_group_entity_listing.rb +238 -0
  247. data/lib/purecloud/models/edge_interface.rb +220 -0
  248. data/lib/purecloud/models/edge_line.rb +259 -0
  249. data/lib/purecloud/models/edge_line_entity_listing.rb +238 -0
  250. data/lib/purecloud/models/edge_version_information.rb +146 -0
  251. data/lib/purecloud/models/edge_version_report.rb +156 -0
  252. data/lib/purecloud/models/email.rb +278 -0
  253. data/lib/purecloud/models/email_address.rb +156 -0
  254. data/lib/purecloud/models/email_attachment.rb +186 -0
  255. data/lib/purecloud/models/email_message.rb +245 -0
  256. data/lib/purecloud/models/email_message_listing.rb +238 -0
  257. data/lib/purecloud/models/email_setup.rb +147 -0
  258. data/lib/purecloud/models/embedded_signature_view.rb +146 -0
  259. data/lib/purecloud/models/encryption_key.rb +198 -0
  260. data/lib/purecloud/models/encryption_key_entity_listing.rb +238 -0
  261. data/lib/purecloud/models/endpoint.rb +335 -0
  262. data/lib/purecloud/models/endpoint_entity_listing.rb +238 -0
  263. data/lib/purecloud/models/entity.rb +166 -0
  264. data/lib/purecloud/models/entry.rb +156 -0
  265. data/lib/purecloud/models/error_body.rb +242 -0
  266. data/lib/purecloud/models/error_details.rb +218 -0
  267. data/lib/purecloud/models/evaluation.rb +358 -0
  268. data/lib/purecloud/models/evaluation_assignment.rb +156 -0
  269. data/lib/purecloud/models/evaluation_entity_listing.rb +238 -0
  270. data/lib/purecloud/models/evaluation_form.rb +233 -0
  271. data/lib/purecloud/models/evaluation_form_and_scoring_set.rb +156 -0
  272. data/lib/purecloud/models/evaluation_form_entity_listing.rb +238 -0
  273. data/lib/purecloud/models/evaluation_query_request.rb +263 -0
  274. data/lib/purecloud/models/evaluation_scoring_set.rb +200 -0
  275. data/lib/purecloud/models/evaluator_activity.rb +238 -0
  276. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +238 -0
  277. data/lib/purecloud/models/expansion_criterium.rb +165 -0
  278. data/lib/purecloud/models/expression_response.rb +256 -0
  279. data/lib/purecloud/models/extension.rb +319 -0
  280. data/lib/purecloud/models/extension_entity_listing.rb +238 -0
  281. data/lib/purecloud/models/extension_pool.rb +291 -0
  282. data/lib/purecloud/models/extension_pool_entity_listing.rb +238 -0
  283. data/lib/purecloud/models/facet.rb +156 -0
  284. data/lib/purecloud/models/facet_entry.rb +227 -0
  285. data/lib/purecloud/models/facet_filter_item.rb +196 -0
  286. data/lib/purecloud/models/facet_group.rb +168 -0
  287. data/lib/purecloud/models/facet_info.rb +158 -0
  288. data/lib/purecloud/models/facet_item.rb +166 -0
  289. data/lib/purecloud/models/facet_key_attribute.rb +166 -0
  290. data/lib/purecloud/models/facet_request.rb +232 -0
  291. data/lib/purecloud/models/facet_result.rb +211 -0
  292. data/lib/purecloud/models/facet_result_item.rb +208 -0
  293. data/lib/purecloud/models/facet_statistics.rb +208 -0
  294. data/lib/purecloud/models/facet_term.rb +197 -0
  295. data/lib/purecloud/models/facets.rb +158 -0
  296. data/lib/purecloud/models/failed_object.rb +176 -0
  297. data/lib/purecloud/models/favorite_template_request_data.rb +146 -0
  298. data/lib/purecloud/models/fax_document.rb +324 -0
  299. data/lib/purecloud/models/fax_document_entity_listing.rb +238 -0
  300. data/lib/purecloud/models/fax_send_request.rb +220 -0
  301. data/lib/purecloud/models/fax_send_response.rb +197 -0
  302. data/lib/purecloud/models/fax_summary.rb +166 -0
  303. data/lib/purecloud/models/filter.rb +178 -0
  304. data/lib/purecloud/models/filter_item.rb +208 -0
  305. data/lib/purecloud/models/flow.rb +273 -0
  306. data/lib/purecloud/models/flow_activate_request.rb +150 -0
  307. data/lib/purecloud/models/flow_associate_workspaces_request.rb +150 -0
  308. data/lib/purecloud/models/flow_body.rb +160 -0
  309. data/lib/purecloud/models/flow_body_format.rb +166 -0
  310. data/lib/purecloud/models/flow_config_id.rb +180 -0
  311. data/lib/purecloud/models/flow_config_meta_data.rb +279 -0
  312. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +238 -0
  313. data/lib/purecloud/models/flow_details.rb +288 -0
  314. data/lib/purecloud/models/flow_details_search_result.rb +161 -0
  315. data/lib/purecloud/models/flow_entity_listing.rb +238 -0
  316. data/lib/purecloud/models/flow_exec_id.rb +169 -0
  317. data/lib/purecloud/models/flow_history_item.rb +238 -0
  318. data/lib/purecloud/models/flow_history_result_item.rb +172 -0
  319. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +238 -0
  320. data/lib/purecloud/models/flow_input_data.rb +150 -0
  321. data/lib/purecloud/models/flow_launch_request.rb +190 -0
  322. data/lib/purecloud/models/flow_lock_request.rb +150 -0
  323. data/lib/purecloud/models/flow_publish.rb +191 -0
  324. data/lib/purecloud/models/flow_report_result_item.rb +280 -0
  325. data/lib/purecloud/models/flow_state.rb +170 -0
  326. data/lib/purecloud/models/flow_terminate_request.rb +161 -0
  327. data/lib/purecloud/models/flow_upload_response.rb +159 -0
  328. data/lib/purecloud/models/flow_version.rb +257 -0
  329. data/lib/purecloud/models/flow_version_config_meta_data.rb +224 -0
  330. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +238 -0
  331. data/lib/purecloud/models/flow_version_entity_listing.rb +238 -0
  332. data/lib/purecloud/models/gateway.rb +166 -0
  333. data/lib/purecloud/models/geolocation.rb +242 -0
  334. data/lib/purecloud/models/geolocation_settings.rb +180 -0
  335. data/lib/purecloud/models/gistener.rb +282 -0
  336. data/lib/purecloud/models/greeting.rb +278 -0
  337. data/lib/purecloud/models/greeting_audio_file.rb +166 -0
  338. data/lib/purecloud/models/greeting_media_info.rb +167 -0
  339. data/lib/purecloud/models/greeting_owner.rb +168 -0
  340. data/lib/purecloud/models/group.rb +236 -0
  341. data/lib/purecloud/models/group_entity_listing.rb +238 -0
  342. data/lib/purecloud/models/group_images.rb +148 -0
  343. data/lib/purecloud/models/group_tag.rb +223 -0
  344. data/lib/purecloud/models/hardware_rate.rb +198 -0
  345. data/lib/purecloud/models/hardware_rate_listing.rb +238 -0
  346. data/lib/purecloud/models/hipaa_config.rb +180 -0
  347. data/lib/purecloud/models/import_status.rb +195 -0
  348. data/lib/purecloud/models/inbound_domain.rb +200 -0
  349. data/lib/purecloud/models/inbound_domain_entity_listing.rb +238 -0
  350. data/lib/purecloud/models/inbound_route.rb +247 -0
  351. data/lib/purecloud/models/inbound_route_entity_listing.rb +238 -0
  352. data/lib/purecloud/models/indexed_transform.rb +180 -0
  353. data/lib/purecloud/models/invoice.rb +230 -0
  354. data/lib/purecloud/models/ivr.rb +341 -0
  355. data/lib/purecloud/models/ivr_entity_listing.rb +238 -0
  356. data/lib/purecloud/models/key_rotation_schedule.rb +187 -0
  357. data/lib/purecloud/models/language.rb +168 -0
  358. data/lib/purecloud/models/language_entity_listing.rb +238 -0
  359. data/lib/purecloud/models/library.rb +199 -0
  360. data/lib/purecloud/models/library_entity_listing.rb +238 -0
  361. data/lib/purecloud/models/license.rb +157 -0
  362. data/lib/purecloud/models/licenses_by_permission.rb +169 -0
  363. data/lib/purecloud/models/line.rb +351 -0
  364. data/lib/purecloud/models/line_base.rb +190 -0
  365. data/lib/purecloud/models/line_base_entity_listing.rb +238 -0
  366. data/lib/purecloud/models/line_entity_listing.rb +238 -0
  367. data/lib/purecloud/models/line_properties.rb +136 -0
  368. data/lib/purecloud/models/line_status.rb +195 -0
  369. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +238 -0
  370. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +238 -0
  371. data/lib/purecloud/models/location.rb +274 -0
  372. data/lib/purecloud/models/location_address_fields.rb +206 -0
  373. data/lib/purecloud/models/location_emergency_number.rb +176 -0
  374. data/lib/purecloud/models/location_entity_listing.rb +238 -0
  375. data/lib/purecloud/models/lock_info.rb +187 -0
  376. data/lib/purecloud/models/logical_interface_entity_listing.rb +238 -0
  377. data/lib/purecloud/models/management_unit.rb +186 -0
  378. data/lib/purecloud/models/management_unit_timezone.rb +146 -0
  379. data/lib/purecloud/models/max_participants.rb +146 -0
  380. data/lib/purecloud/models/media_result.rb +168 -0
  381. data/lib/purecloud/models/media_setting.rb +156 -0
  382. data/lib/purecloud/models/media_summary.rb +156 -0
  383. data/lib/purecloud/models/metabase.rb +178 -0
  384. data/lib/purecloud/models/metered_evaluation_assignment.rb +200 -0
  385. data/lib/purecloud/models/metric_threshold.rb +165 -0
  386. data/lib/purecloud/models/noc_support.rb +156 -0
  387. data/lib/purecloud/models/number.rb +156 -0
  388. data/lib/purecloud/models/number_order_request.rb +201 -0
  389. data/lib/purecloud/models/number_plan.rb +351 -0
  390. data/lib/purecloud/models/o_auth_client.rb +240 -0
  391. data/lib/purecloud/models/o_auth_client_entity_listing.rb +238 -0
  392. data/lib/purecloud/models/o_auth_provider.rb +168 -0
  393. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +238 -0
  394. data/lib/purecloud/models/occurrence.rb +165 -0
  395. data/lib/purecloud/models/okta.rb +198 -0
  396. data/lib/purecloud/models/one_login.rb +198 -0
  397. data/lib/purecloud/models/order.rb +188 -0
  398. data/lib/purecloud/models/org_license_assignment.rb +178 -0
  399. data/lib/purecloud/models/org_media_utilization.rb +160 -0
  400. data/lib/purecloud/models/organization.rb +279 -0
  401. data/lib/purecloud/models/organization_address.rb +194 -0
  402. data/lib/purecloud/models/organization_create.rb +205 -0
  403. data/lib/purecloud/models/organization_presence.rb +253 -0
  404. data/lib/purecloud/models/organization_presence_entity_listing.rb +238 -0
  405. data/lib/purecloud/models/organization_product_entity_listing.rb +188 -0
  406. data/lib/purecloud/models/organization_role_entity_listing.rb +238 -0
  407. data/lib/purecloud/models/orphan_recording.rb +277 -0
  408. data/lib/purecloud/models/orphan_recording_listing.rb +238 -0
  409. data/lib/purecloud/models/out_of_office.rb +212 -0
  410. data/lib/purecloud/models/outbound_route.rb +347 -0
  411. data/lib/purecloud/models/outbound_route_entity_listing.rb +238 -0
  412. data/lib/purecloud/models/page.rb +224 -0
  413. data/lib/purecloud/models/parameter.rb +196 -0
  414. data/lib/purecloud/models/parsed_certificate.rb +150 -0
  415. data/lib/purecloud/models/participant.rb +490 -0
  416. data/lib/purecloud/models/participant_attributes.rb +148 -0
  417. data/lib/purecloud/models/participant_request.rb +235 -0
  418. data/lib/purecloud/models/penetration_rate.rb +176 -0
  419. data/lib/purecloud/models/penetration_rate_id.rb +156 -0
  420. data/lib/purecloud/models/permission_collection_entity_listing.rb +238 -0
  421. data/lib/purecloud/models/permissions.rb +169 -0
  422. data/lib/purecloud/models/phone.rb +375 -0
  423. data/lib/purecloud/models/phone_base.rb +212 -0
  424. data/lib/purecloud/models/phone_base_entity_listing.rb +238 -0
  425. data/lib/purecloud/models/phone_capabilities.rb +206 -0
  426. data/lib/purecloud/models/phone_column.rb +156 -0
  427. data/lib/purecloud/models/phone_entity_listing.rb +238 -0
  428. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +238 -0
  429. data/lib/purecloud/models/phone_number_column.rb +156 -0
  430. data/lib/purecloud/models/phone_number_status.rb +148 -0
  431. data/lib/purecloud/models/phone_status.rb +263 -0
  432. data/lib/purecloud/models/phones_reboot.rb +148 -0
  433. data/lib/purecloud/models/physical_interface_entity_listing.rb +238 -0
  434. data/lib/purecloud/models/pin_configuration.rb +156 -0
  435. data/lib/purecloud/models/policy.rb +252 -0
  436. data/lib/purecloud/models/policy_actions.rb +206 -0
  437. data/lib/purecloud/models/policy_conditions.rb +228 -0
  438. data/lib/purecloud/models/policy_entity_listing.rb +238 -0
  439. data/lib/purecloud/models/policy_error_message.rb +209 -0
  440. data/lib/purecloud/models/policy_errors.rb +148 -0
  441. data/lib/purecloud/models/preview.rb +230 -0
  442. data/lib/purecloud/models/primary_user_presence_source.rb +188 -0
  443. data/lib/purecloud/models/product.rb +199 -0
  444. data/lib/purecloud/models/progress_model.rb +169 -0
  445. data/lib/purecloud/models/prompt.rb +190 -0
  446. data/lib/purecloud/models/prompt_asset.rb +238 -0
  447. data/lib/purecloud/models/prompt_asset_entity_listing.rb +238 -0
  448. data/lib/purecloud/models/prompt_entity_listing.rb +238 -0
  449. data/lib/purecloud/models/provision_info.rb +169 -0
  450. data/lib/purecloud/models/publication.rb +224 -0
  451. data/lib/purecloud/models/publish_script_request_data.rb +156 -0
  452. data/lib/purecloud/models/published_result.rb +208 -0
  453. data/lib/purecloud/models/pure_cloud.rb +168 -0
  454. data/lib/purecloud/models/put_management_unit.rb +175 -0
  455. data/lib/purecloud/models/quality_audit.rb +250 -0
  456. data/lib/purecloud/models/quality_audit_page.rb +238 -0
  457. data/lib/purecloud/models/query_facet_info.rb +160 -0
  458. data/lib/purecloud/models/query_request.rb +202 -0
  459. data/lib/purecloud/models/query_result.rb +178 -0
  460. data/lib/purecloud/models/query_results.rb +156 -0
  461. data/lib/purecloud/models/question_group.rb +236 -0
  462. data/lib/purecloud/models/question_group_score.rb +250 -0
  463. data/lib/purecloud/models/question_score.rb +200 -0
  464. data/lib/purecloud/models/queue.rb +382 -0
  465. data/lib/purecloud/models/queue_entity_listing.rb +238 -0
  466. data/lib/purecloud/models/queue_member.rb +220 -0
  467. data/lib/purecloud/models/queue_member_entity_listing.rb +238 -0
  468. data/lib/purecloud/models/queue_utilization_diagnostic.rb +216 -0
  469. data/lib/purecloud/models/queues_entity_listing.rb +238 -0
  470. data/lib/purecloud/models/quote.rb +392 -0
  471. data/lib/purecloud/models/quote_charge.rb +281 -0
  472. data/lib/purecloud/models/quote_listing.rb +238 -0
  473. data/lib/purecloud/models/rate.rb +190 -0
  474. data/lib/purecloud/models/reaction.rb +175 -0
  475. data/lib/purecloud/models/recording.rb +407 -0
  476. data/lib/purecloud/models/replace_request.rb +166 -0
  477. data/lib/purecloud/models/replace_response.rb +205 -0
  478. data/lib/purecloud/models/report_meta_data.rb +234 -0
  479. data/lib/purecloud/models/report_meta_data_entity_listing.rb +238 -0
  480. data/lib/purecloud/models/report_request.rb +210 -0
  481. data/lib/purecloud/models/report_run_entry.rb +258 -0
  482. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +238 -0
  483. data/lib/purecloud/models/report_schedule.rb +315 -0
  484. data/lib/purecloud/models/report_schedule_entity_listing.rb +238 -0
  485. data/lib/purecloud/models/reservation.rb +187 -0
  486. data/lib/purecloud/models/resource_condition_node.rb +208 -0
  487. data/lib/purecloud/models/resource_condition_value.rb +165 -0
  488. data/lib/purecloud/models/resource_permission_policy.rb +250 -0
  489. data/lib/purecloud/models/response.rb +228 -0
  490. data/lib/purecloud/models/response_entity_list.rb +239 -0
  491. data/lib/purecloud/models/response_entity_listing.rb +238 -0
  492. data/lib/purecloud/models/response_query_request.rb +172 -0
  493. data/lib/purecloud/models/response_query_results.rb +148 -0
  494. data/lib/purecloud/models/response_set.rb +212 -0
  495. data/lib/purecloud/models/response_set_entity_listing.rb +238 -0
  496. data/lib/purecloud/models/response_text.rb +159 -0
  497. data/lib/purecloud/models/rest_error_detail.rb +156 -0
  498. data/lib/purecloud/models/retention_duration.rb +156 -0
  499. data/lib/purecloud/models/ring.rb +158 -0
  500. data/lib/purecloud/models/routing_status.rb +176 -0
  501. data/lib/purecloud/models/rule.rb +200 -0
  502. data/lib/purecloud/models/rule_entity_listing.rb +238 -0
  503. data/lib/purecloud/models/rule_set.rb +232 -0
  504. data/lib/purecloud/models/rule_set_entity_listing.rb +238 -0
  505. data/lib/purecloud/models/run_now_response.rb +168 -0
  506. data/lib/purecloud/models/salesforce.rb +198 -0
  507. data/lib/purecloud/models/schedule.rb +314 -0
  508. data/lib/purecloud/models/schedule_entity_listing.rb +238 -0
  509. data/lib/purecloud/models/schedule_group.rb +303 -0
  510. data/lib/purecloud/models/schedule_group_entity_listing.rb +238 -0
  511. data/lib/purecloud/models/schema_category.rb +168 -0
  512. data/lib/purecloud/models/schema_category_entity_listing.rb +238 -0
  513. data/lib/purecloud/models/schema_reference_entity_listing.rb +238 -0
  514. data/lib/purecloud/models/script.rb +272 -0
  515. data/lib/purecloud/models/script_entity_listing.rb +238 -0
  516. data/lib/purecloud/models/search_request.rb +222 -0
  517. data/lib/purecloud/models/security_profile.rb +180 -0
  518. data/lib/purecloud/models/security_profile_entity_listing.rb +238 -0
  519. data/lib/purecloud/models/segment.rb +188 -0
  520. data/lib/purecloud/models/sequence_schedule.rb +232 -0
  521. data/lib/purecloud/models/server_date.rb +147 -0
  522. data/lib/purecloud/models/service.rb +245 -0
  523. data/lib/purecloud/models/service_context.rb +146 -0
  524. data/lib/purecloud/models/service_entity_listing.rb +238 -0
  525. data/lib/purecloud/models/service_level.rb +156 -0
  526. data/lib/purecloud/models/service_type.rb +200 -0
  527. data/lib/purecloud/models/session.rb +219 -0
  528. data/lib/purecloud/models/session_entity_listing.rb +238 -0
  529. data/lib/purecloud/models/session_request.rb +146 -0
  530. data/lib/purecloud/models/share.rb +256 -0
  531. data/lib/purecloud/models/share_entity_listing.rb +238 -0
  532. data/lib/purecloud/models/shared_response.rb +186 -0
  533. data/lib/purecloud/models/sheet_schema.rb +213 -0
  534. data/lib/purecloud/models/sheet_transform.rb +166 -0
  535. data/lib/purecloud/models/signature_document_info.rb +166 -0
  536. data/lib/purecloud/models/site.rb +374 -0
  537. data/lib/purecloud/models/site_entity_listing.rb +238 -0
  538. data/lib/purecloud/models/skill.rb +269 -0
  539. data/lib/purecloud/models/skill_entity_listing.rb +238 -0
  540. data/lib/purecloud/models/skills_to_remove.rb +166 -0
  541. data/lib/purecloud/models/social_account.rb +273 -0
  542. data/lib/purecloud/models/social_expression.rb +259 -0
  543. data/lib/purecloud/models/socialize_entity_filter.rb +178 -0
  544. data/lib/purecloud/models/socialize_filter_request.rb +198 -0
  545. data/lib/purecloud/models/sort_by.rb +158 -0
  546. data/lib/purecloud/models/sort_field.rb +165 -0
  547. data/lib/purecloud/models/sort_item.rb +158 -0
  548. data/lib/purecloud/models/spreadsheet_transform.rb +236 -0
  549. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +238 -0
  550. data/lib/purecloud/models/station.rb +227 -0
  551. data/lib/purecloud/models/station_entity_listing.rb +238 -0
  552. data/lib/purecloud/models/sub_data_item.rb +192 -0
  553. data/lib/purecloud/models/support.rb +166 -0
  554. data/lib/purecloud/models/system_prompt.rb +190 -0
  555. data/lib/purecloud/models/system_prompt_asset.rb +259 -0
  556. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +238 -0
  557. data/lib/purecloud/models/system_prompt_entity_listing.rb +238 -0
  558. data/lib/purecloud/models/table_transform.rb +204 -0
  559. data/lib/purecloud/models/tag.rb +158 -0
  560. data/lib/purecloud/models/tag_model.rb +156 -0
  561. data/lib/purecloud/models/tag_query_request.rb +166 -0
  562. data/lib/purecloud/models/tag_value.rb +192 -0
  563. data/lib/purecloud/models/tag_value_entity_listing.rb +238 -0
  564. data/lib/purecloud/models/template.rb +253 -0
  565. data/lib/purecloud/models/template_entity_listing.rb +238 -0
  566. data/lib/purecloud/models/term_attribute.rb +175 -0
  567. data/lib/purecloud/models/text_table_transform.rb +232 -0
  568. data/lib/purecloud/models/text_table_transform_entity_listing.rb +238 -0
  569. data/lib/purecloud/models/third_party_account.rb +212 -0
  570. data/lib/purecloud/models/third_party_subscription.rb +199 -0
  571. data/lib/purecloud/models/tier.rb +156 -0
  572. data/lib/purecloud/models/time_allowed.rb +170 -0
  573. data/lib/purecloud/models/time_interval.rb +156 -0
  574. data/lib/purecloud/models/time_slot.rb +166 -0
  575. data/lib/purecloud/models/time_zone.rb +188 -0
  576. data/lib/purecloud/models/time_zone_entity_listing.rb +238 -0
  577. data/lib/purecloud/models/topic_entity_listing.rb +238 -0
  578. data/lib/purecloud/models/trace.rb +216 -0
  579. data/lib/purecloud/models/trace_list.rb +158 -0
  580. data/lib/purecloud/models/transform_endpoint.rb +271 -0
  581. data/lib/purecloud/models/transform_lens.rb +156 -0
  582. data/lib/purecloud/models/transform_model.rb +212 -0
  583. data/lib/purecloud/models/transform_progress.rb +260 -0
  584. data/lib/purecloud/models/trunk_base.rb +325 -0
  585. data/lib/purecloud/models/trunk_base_assignment.rb +158 -0
  586. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +238 -0
  587. data/lib/purecloud/models/twitter_expression.rb +412 -0
  588. data/lib/purecloud/models/twitter_expression_buffer.rb +149 -0
  589. data/lib/purecloud/models/unpivot_columns.rb +148 -0
  590. data/lib/purecloud/models/unread_metric.rb +146 -0
  591. data/lib/purecloud/models/upload_progress.rb +213 -0
  592. data/lib/purecloud/models/uri_reference.rb +166 -0
  593. data/lib/purecloud/models/url_response.rb +146 -0
  594. data/lib/purecloud/models/user.rb +396 -0
  595. data/lib/purecloud/models/user_action_category.rb +168 -0
  596. data/lib/purecloud/models/user_action_category_entity_listing.rb +238 -0
  597. data/lib/purecloud/models/user_action_metadata.rb +246 -0
  598. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +218 -0
  599. data/lib/purecloud/models/user_action_metadata_request.rb +196 -0
  600. data/lib/purecloud/models/user_authorization.rb +216 -0
  601. data/lib/purecloud/models/user_conversation_summary.rb +206 -0
  602. data/lib/purecloud/models/user_entity_listing.rb +238 -0
  603. data/lib/purecloud/models/user_image.rb +156 -0
  604. data/lib/purecloud/models/user_license_assignment.rb +188 -0
  605. data/lib/purecloud/models/user_param.rb +156 -0
  606. data/lib/purecloud/models/user_presence.rb +230 -0
  607. data/lib/purecloud/models/user_presence_entity_listing.rb +238 -0
  608. data/lib/purecloud/models/user_queue.rb +394 -0
  609. data/lib/purecloud/models/user_queue_entity_listing.rb +238 -0
  610. data/lib/purecloud/models/user_recording.rb +274 -0
  611. data/lib/purecloud/models/user_recording_entity_listing.rb +238 -0
  612. data/lib/purecloud/models/user_skill.rb +290 -0
  613. data/lib/purecloud/models/user_skill_entity_listing.rb +238 -0
  614. data/lib/purecloud/models/user_station_resource.rb +228 -0
  615. data/lib/purecloud/models/user_status.rb +210 -0
  616. data/lib/purecloud/models/users_entity_listing.rb +238 -0
  617. data/lib/purecloud/models/utilization.rb +181 -0
  618. data/lib/purecloud/models/validate_address_request.rb +146 -0
  619. data/lib/purecloud/models/validate_address_response.rb +158 -0
  620. data/lib/purecloud/models/value.rb +220 -0
  621. data/lib/purecloud/models/video.rb +240 -0
  622. data/lib/purecloud/models/view.rb +146 -0
  623. data/lib/purecloud/models/voice_rate.rb +254 -0
  624. data/lib/purecloud/models/voice_rate_extended.rb +355 -0
  625. data/lib/purecloud/models/voice_rate_international.rb +276 -0
  626. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +238 -0
  627. data/lib/purecloud/models/voice_rate_update.rb +282 -0
  628. data/lib/purecloud/models/voice_rates_csv.rb +180 -0
  629. data/lib/purecloud/models/voice_xml_operation.rb +285 -0
  630. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +238 -0
  631. data/lib/purecloud/models/voicemail_mailbox_info.rb +198 -0
  632. data/lib/purecloud/models/voicemail_media_info.rb +167 -0
  633. data/lib/purecloud/models/voicemail_message.rb +252 -0
  634. data/lib/purecloud/models/voicemail_message_entity_listing.rb +238 -0
  635. data/lib/purecloud/models/voicemail_organization_policy.rb +296 -0
  636. data/lib/purecloud/models/voicemail_user_policy.rb +250 -0
  637. data/lib/purecloud/models/vpn.rb +166 -0
  638. data/lib/purecloud/models/work_item.rb +170 -0
  639. data/lib/purecloud/models/work_item_actions.rb +148 -0
  640. data/lib/purecloud/models/work_item_cache.rb +193 -0
  641. data/lib/purecloud/models/work_item_command.rb +156 -0
  642. data/lib/purecloud/models/work_item_command_group.rb +168 -0
  643. data/lib/purecloud/models/work_item_definition.rb +183 -0
  644. data/lib/purecloud/models/work_item_details.rb +361 -0
  645. data/lib/purecloud/models/work_item_search_details.rb +147 -0
  646. data/lib/purecloud/models/work_item_search_details_search_result.rb +161 -0
  647. data/lib/purecloud/models/work_item_submit_request.rb +161 -0
  648. data/lib/purecloud/models/work_item_transfer_request.rb +168 -0
  649. data/lib/purecloud/models/workspace.rb +263 -0
  650. data/lib/purecloud/models/workspace_create.rb +156 -0
  651. data/lib/purecloud/models/workspace_entity_listing.rb +238 -0
  652. data/lib/purecloud/models/workspace_member.rb +237 -0
  653. data/lib/purecloud/models/workspace_member_entity_listing.rb +238 -0
  654. data/lib/purecloud/models/workspace_summary.rb +146 -0
  655. data/lib/purecloud/models/wrap_up_code_mapping.rb +224 -0
  656. data/lib/purecloud/models/wrapup.rb +211 -0
  657. data/lib/purecloud/models/wrapup_code.rb +198 -0
  658. data/lib/purecloud/models/wrapup_code_entity_listing.rb +238 -0
  659. data/lib/purecloud/models/xlsx_schema.rb +171 -0
  660. data/lib/purecloud/version.rb +3 -0
  661. data/newVersion.md +1 -0
  662. data/purecloud.gemspec +32 -0
  663. data/rakefile +101 -0
  664. data/spec/test.rb +37 -0
  665. data/swagger.json +1 -0
  666. data/version.json +1 -0
  667. metadata +891 -0
@@ -0,0 +1,1663 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class QualityApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Get all of a Conversation's Recordings.
12
+ #
13
+ # @param conversation_id Conversation ID
14
+ # @param [Hash] opts the optional parameters
15
+ # @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready.
16
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
17
+ # @return [Array<Recording>]
18
+ def get_conversation_recordings(conversation_id, opts = {})
19
+ data, status_code, headers = get_conversation_recordings_with_http_info(conversation_id, opts)
20
+ return data
21
+ end
22
+
23
+ # Get all of a Conversation&#39;s Recordings.
24
+ #
25
+ # @param conversation_id Conversation ID
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready.
28
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
29
+ # @return [Array<(Array<Recording>, Fixnum, Hash)>] Array<Recording> data, response status code and response headers
30
+ def get_conversation_recordings_with_http_info(conversation_id, opts = {})
31
+ if @api_client.config.debugging
32
+ @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_recordings ..."
33
+ end
34
+
35
+ # verify the required parameter 'conversation_id' is set
36
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_recordings" if conversation_id.nil?
37
+
38
+ if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
39
+ fail 'invalid value for "format_id", must be one of WEBM, WAV'
40
+ end
41
+
42
+ # resource path
43
+ path = "/api/v1/conversations/{conversationId}/recordings".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
44
+
45
+ # query parameters
46
+ query_params = {}
47
+ query_params[:'maxWaitMs'] = opts[:'max_wait_ms'] if opts[:'max_wait_ms']
48
+ query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
49
+
50
+ # header parameters
51
+ header_params = {}
52
+
53
+ # HTTP header 'Accept' (if needed)
54
+ _header_accept = ['application/json']
55
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
56
+
57
+ # HTTP header 'Content-Type'
58
+ _header_content_type = ['application/json']
59
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
60
+
61
+ # form parameters
62
+ form_params = {}
63
+
64
+ # http body (model)
65
+ post_body = nil
66
+
67
+
68
+ auth_names = ['PureCloud Auth']
69
+ data, status_code, headers = @api_client.call_api(:GET, path,
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => 'Array<Recording>')
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: QualityApi#get_conversation_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
81
+
82
+ # Gets a specific recording.
83
+ #
84
+ # @param conversation_id Conversation ID
85
+ # @param recording_id Recording ID
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for completion.
88
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
89
+ # @option opts [BOOLEAN] :download requesting a download format of the recording
90
+ # @option opts [String] :file_name the name of the downloaded fileName
91
+ # @return [nil]
92
+ def get_conversation_recording(conversation_id, recording_id, opts = {})
93
+ get_conversation_recording_with_http_info(conversation_id, recording_id, opts)
94
+ return nil
95
+ end
96
+
97
+ # Gets a specific recording.
98
+ #
99
+ # @param conversation_id Conversation ID
100
+ # @param recording_id Recording ID
101
+ # @param [Hash] opts the optional parameters
102
+ # @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for completion.
103
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
104
+ # @option opts [BOOLEAN] :download requesting a download format of the recording
105
+ # @option opts [String] :file_name the name of the downloaded fileName
106
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
107
+ def get_conversation_recording_with_http_info(conversation_id, recording_id, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_recording ..."
110
+ end
111
+
112
+ # verify the required parameter 'conversation_id' is set
113
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_recording" if conversation_id.nil?
114
+
115
+ # verify the required parameter 'recording_id' is set
116
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_recording" if recording_id.nil?
117
+
118
+ if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
119
+ fail 'invalid value for "format_id", must be one of WEBM, WAV'
120
+ end
121
+
122
+ # resource path
123
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
124
+
125
+ # query parameters
126
+ query_params = {}
127
+ query_params[:'maxWaitMs'] = opts[:'max_wait_ms'] if opts[:'max_wait_ms']
128
+ query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
129
+ query_params[:'download'] = opts[:'download'] if opts[:'download']
130
+ query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
131
+
132
+ # header parameters
133
+ header_params = {}
134
+
135
+ # HTTP header 'Accept' (if needed)
136
+ _header_accept = ['application/json']
137
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
138
+
139
+ # HTTP header 'Content-Type'
140
+ _header_content_type = ['application/json']
141
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
142
+
143
+ # form parameters
144
+ form_params = {}
145
+
146
+ # http body (model)
147
+ post_body = nil
148
+
149
+
150
+ auth_names = ['PureCloud Auth']
151
+ data, status_code, headers = @api_client.call_api(:GET, path,
152
+ :header_params => header_params,
153
+ :query_params => query_params,
154
+ :form_params => form_params,
155
+ :body => post_body,
156
+ :auth_names => auth_names)
157
+ if @api_client.config.debugging
158
+ @api_client.config.logger.debug "API called: QualityApi#get_conversation_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
159
+ end
160
+ return data, status_code, headers
161
+ end
162
+
163
+ # Updates the retention records on a recording.
164
+ # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter &#39;restoreDays&#39; is deprecated and will be removed in the next major version release. If &#39;restoreDays&#39; is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate&#39;s time stamp in the PUT body to 10 days in the future.
165
+ # @param conversation_id Conversation ID
166
+ # @param recording_id Recording ID
167
+ # @param body recording
168
+ # @param [Hash] opts the optional parameters
169
+ # @option opts [Integer] :restore_days The number of days the recording will be available before it is re-archived. Deprecated.
170
+ # @return [nil]
171
+ def put_conversation_recording(conversation_id, recording_id, body, opts = {})
172
+ put_conversation_recording_with_http_info(conversation_id, recording_id, body, opts)
173
+ return nil
174
+ end
175
+
176
+ # Updates the retention records on a recording.
177
+ # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter &#39;restoreDays&#39; is deprecated and will be removed in the next major version release. If &#39;restoreDays&#39; is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate&#39;s time stamp in the PUT body to 10 days in the future.
178
+ # @param conversation_id Conversation ID
179
+ # @param recording_id Recording ID
180
+ # @param body recording
181
+ # @param [Hash] opts the optional parameters
182
+ # @option opts [Integer] :restore_days The number of days the recording will be available before it is re-archived. Deprecated.
183
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
184
+ def put_conversation_recording_with_http_info(conversation_id, recording_id, body, opts = {})
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug "Calling API: QualityApi#put_conversation_recording ..."
187
+ end
188
+
189
+ # verify the required parameter 'conversation_id' is set
190
+ fail "Missing the required parameter 'conversation_id' when calling put_conversation_recording" if conversation_id.nil?
191
+
192
+ # verify the required parameter 'recording_id' is set
193
+ fail "Missing the required parameter 'recording_id' when calling put_conversation_recording" if recording_id.nil?
194
+
195
+ # verify the required parameter 'body' is set
196
+ fail "Missing the required parameter 'body' when calling put_conversation_recording" if body.nil?
197
+
198
+ # resource path
199
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
200
+
201
+ # query parameters
202
+ query_params = {}
203
+ query_params[:'restoreDays'] = opts[:'restore_days'] if opts[:'restore_days']
204
+
205
+ # header parameters
206
+ header_params = {}
207
+
208
+ # HTTP header 'Accept' (if needed)
209
+ _header_accept = ['application/json']
210
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
211
+
212
+ # HTTP header 'Content-Type'
213
+ _header_content_type = ['application/json']
214
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
215
+
216
+ # form parameters
217
+ form_params = {}
218
+
219
+ # http body (model)
220
+ post_body = @api_client.object_to_http_body(body)
221
+
222
+
223
+ auth_names = ['PureCloud Auth']
224
+ data, status_code, headers = @api_client.call_api(:PUT, path,
225
+ :header_params => header_params,
226
+ :query_params => query_params,
227
+ :form_params => form_params,
228
+ :body => post_body,
229
+ :auth_names => auth_names)
230
+ if @api_client.config.debugging
231
+ @api_client.config.logger.debug "API called: QualityApi#put_conversation_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
232
+ end
233
+ return data, status_code, headers
234
+ end
235
+
236
+ # Get annotations for recording
237
+ #
238
+ # @param conversation_id Conversation ID
239
+ # @param recording_id Recording ID
240
+ # @param [Hash] opts the optional parameters
241
+ # @return [Array<Annotation>]
242
+ def get_conversation_recording_annotations(conversation_id, recording_id, opts = {})
243
+ data, status_code, headers = get_conversation_recording_annotations_with_http_info(conversation_id, recording_id, opts)
244
+ return data
245
+ end
246
+
247
+ # Get annotations for recording
248
+ #
249
+ # @param conversation_id Conversation ID
250
+ # @param recording_id Recording ID
251
+ # @param [Hash] opts the optional parameters
252
+ # @return [Array<(Array<Annotation>, Fixnum, Hash)>] Array<Annotation> data, response status code and response headers
253
+ def get_conversation_recording_annotations_with_http_info(conversation_id, recording_id, opts = {})
254
+ if @api_client.config.debugging
255
+ @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_recording_annotations ..."
256
+ end
257
+
258
+ # verify the required parameter 'conversation_id' is set
259
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_recording_annotations" if conversation_id.nil?
260
+
261
+ # verify the required parameter 'recording_id' is set
262
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_recording_annotations" if recording_id.nil?
263
+
264
+ # resource path
265
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
266
+
267
+ # query parameters
268
+ query_params = {}
269
+
270
+ # header parameters
271
+ header_params = {}
272
+
273
+ # HTTP header 'Accept' (if needed)
274
+ _header_accept = ['application/json']
275
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
276
+
277
+ # HTTP header 'Content-Type'
278
+ _header_content_type = ['application/json']
279
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
280
+
281
+ # form parameters
282
+ form_params = {}
283
+
284
+ # http body (model)
285
+ post_body = nil
286
+
287
+
288
+ auth_names = ['PureCloud Auth']
289
+ data, status_code, headers = @api_client.call_api(:GET, path,
290
+ :header_params => header_params,
291
+ :query_params => query_params,
292
+ :form_params => form_params,
293
+ :body => post_body,
294
+ :auth_names => auth_names,
295
+ :return_type => 'Array<Annotation>')
296
+ if @api_client.config.debugging
297
+ @api_client.config.logger.debug "API called: QualityApi#get_conversation_recording_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
298
+ end
299
+ return data, status_code, headers
300
+ end
301
+
302
+ # Create annotation
303
+ #
304
+ # @param conversation_id Conversation ID
305
+ # @param recording_id Recording ID
306
+ # @param [Hash] opts the optional parameters
307
+ # @option opts [Annotation] :body annotation
308
+ # @return [Annotation]
309
+ def post_conversation_recording_annotations(conversation_id, recording_id, opts = {})
310
+ data, status_code, headers = post_conversation_recording_annotations_with_http_info(conversation_id, recording_id, opts)
311
+ return data
312
+ end
313
+
314
+ # Create annotation
315
+ #
316
+ # @param conversation_id Conversation ID
317
+ # @param recording_id Recording ID
318
+ # @param [Hash] opts the optional parameters
319
+ # @option opts [Annotation] :body annotation
320
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
321
+ def post_conversation_recording_annotations_with_http_info(conversation_id, recording_id, opts = {})
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug "Calling API: QualityApi#post_conversation_recording_annotations ..."
324
+ end
325
+
326
+ # verify the required parameter 'conversation_id' is set
327
+ fail "Missing the required parameter 'conversation_id' when calling post_conversation_recording_annotations" if conversation_id.nil?
328
+
329
+ # verify the required parameter 'recording_id' is set
330
+ fail "Missing the required parameter 'recording_id' when calling post_conversation_recording_annotations" if recording_id.nil?
331
+
332
+ # resource path
333
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
334
+
335
+ # query parameters
336
+ query_params = {}
337
+
338
+ # header parameters
339
+ header_params = {}
340
+
341
+ # HTTP header 'Accept' (if needed)
342
+ _header_accept = ['application/json']
343
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
344
+
345
+ # HTTP header 'Content-Type'
346
+ _header_content_type = ['application/json']
347
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
348
+
349
+ # form parameters
350
+ form_params = {}
351
+
352
+ # http body (model)
353
+ post_body = @api_client.object_to_http_body(opts[:'body'])
354
+
355
+
356
+ auth_names = ['PureCloud Auth']
357
+ data, status_code, headers = @api_client.call_api(:POST, path,
358
+ :header_params => header_params,
359
+ :query_params => query_params,
360
+ :form_params => form_params,
361
+ :body => post_body,
362
+ :auth_names => auth_names,
363
+ :return_type => 'Annotation')
364
+ if @api_client.config.debugging
365
+ @api_client.config.logger.debug "API called: QualityApi#post_conversation_recording_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
366
+ end
367
+ return data, status_code, headers
368
+ end
369
+
370
+ # Get annotation
371
+ #
372
+ # @param conversation_id Conversation ID
373
+ # @param recording_id Recording ID
374
+ # @param annotation_id Annotation ID
375
+ # @param [Hash] opts the optional parameters
376
+ # @return [Annotation]
377
+ def get_conversation_recording_annotation(conversation_id, recording_id, annotation_id, opts = {})
378
+ data, status_code, headers = get_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, opts)
379
+ return data
380
+ end
381
+
382
+ # Get annotation
383
+ #
384
+ # @param conversation_id Conversation ID
385
+ # @param recording_id Recording ID
386
+ # @param annotation_id Annotation ID
387
+ # @param [Hash] opts the optional parameters
388
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
389
+ def get_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
390
+ if @api_client.config.debugging
391
+ @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_recording_annotation ..."
392
+ end
393
+
394
+ # verify the required parameter 'conversation_id' is set
395
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_recording_annotation" if conversation_id.nil?
396
+
397
+ # verify the required parameter 'recording_id' is set
398
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_recording_annotation" if recording_id.nil?
399
+
400
+ # verify the required parameter 'annotation_id' is set
401
+ fail "Missing the required parameter 'annotation_id' when calling get_conversation_recording_annotation" if annotation_id.nil?
402
+
403
+ # resource path
404
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
405
+
406
+ # query parameters
407
+ query_params = {}
408
+
409
+ # header parameters
410
+ header_params = {}
411
+
412
+ # HTTP header 'Accept' (if needed)
413
+ _header_accept = ['application/json']
414
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
415
+
416
+ # HTTP header 'Content-Type'
417
+ _header_content_type = ['application/json']
418
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
419
+
420
+ # form parameters
421
+ form_params = {}
422
+
423
+ # http body (model)
424
+ post_body = nil
425
+
426
+
427
+ auth_names = ['PureCloud Auth']
428
+ data, status_code, headers = @api_client.call_api(:GET, path,
429
+ :header_params => header_params,
430
+ :query_params => query_params,
431
+ :form_params => form_params,
432
+ :body => post_body,
433
+ :auth_names => auth_names,
434
+ :return_type => 'Annotation')
435
+ if @api_client.config.debugging
436
+ @api_client.config.logger.debug "API called: QualityApi#get_conversation_recording_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
437
+ end
438
+ return data, status_code, headers
439
+ end
440
+
441
+ # Update annotation
442
+ #
443
+ # @param conversation_id Conversation ID
444
+ # @param recording_id Recording ID
445
+ # @param annotation_id Annotation ID
446
+ # @param [Hash] opts the optional parameters
447
+ # @option opts [Annotation] :body annotation
448
+ # @return [Annotation]
449
+ def put_conversation_recording_annotation(conversation_id, recording_id, annotation_id, opts = {})
450
+ data, status_code, headers = put_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, opts)
451
+ return data
452
+ end
453
+
454
+ # Update annotation
455
+ #
456
+ # @param conversation_id Conversation ID
457
+ # @param recording_id Recording ID
458
+ # @param annotation_id Annotation ID
459
+ # @param [Hash] opts the optional parameters
460
+ # @option opts [Annotation] :body annotation
461
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
462
+ def put_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
463
+ if @api_client.config.debugging
464
+ @api_client.config.logger.debug "Calling API: QualityApi#put_conversation_recording_annotation ..."
465
+ end
466
+
467
+ # verify the required parameter 'conversation_id' is set
468
+ fail "Missing the required parameter 'conversation_id' when calling put_conversation_recording_annotation" if conversation_id.nil?
469
+
470
+ # verify the required parameter 'recording_id' is set
471
+ fail "Missing the required parameter 'recording_id' when calling put_conversation_recording_annotation" if recording_id.nil?
472
+
473
+ # verify the required parameter 'annotation_id' is set
474
+ fail "Missing the required parameter 'annotation_id' when calling put_conversation_recording_annotation" if annotation_id.nil?
475
+
476
+ # resource path
477
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
478
+
479
+ # query parameters
480
+ query_params = {}
481
+
482
+ # header parameters
483
+ header_params = {}
484
+
485
+ # HTTP header 'Accept' (if needed)
486
+ _header_accept = ['application/json']
487
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
488
+
489
+ # HTTP header 'Content-Type'
490
+ _header_content_type = ['application/json']
491
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
492
+
493
+ # form parameters
494
+ form_params = {}
495
+
496
+ # http body (model)
497
+ post_body = @api_client.object_to_http_body(opts[:'body'])
498
+
499
+
500
+ auth_names = ['PureCloud Auth']
501
+ data, status_code, headers = @api_client.call_api(:PUT, path,
502
+ :header_params => header_params,
503
+ :query_params => query_params,
504
+ :form_params => form_params,
505
+ :body => post_body,
506
+ :auth_names => auth_names,
507
+ :return_type => 'Annotation')
508
+ if @api_client.config.debugging
509
+ @api_client.config.logger.debug "API called: QualityApi#put_conversation_recording_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
510
+ end
511
+ return data, status_code, headers
512
+ end
513
+
514
+ # Delete annotation
515
+ #
516
+ # @param conversation_id Conversation ID
517
+ # @param recording_id Recording ID
518
+ # @param annotation_id Annotation ID
519
+ # @param [Hash] opts the optional parameters
520
+ # @return [nil]
521
+ def delete_conversation_recording_annotation(conversation_id, recording_id, annotation_id, opts = {})
522
+ delete_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, opts)
523
+ return nil
524
+ end
525
+
526
+ # Delete annotation
527
+ #
528
+ # @param conversation_id Conversation ID
529
+ # @param recording_id Recording ID
530
+ # @param annotation_id Annotation ID
531
+ # @param [Hash] opts the optional parameters
532
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
533
+ def delete_conversation_recording_annotation_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
534
+ if @api_client.config.debugging
535
+ @api_client.config.logger.debug "Calling API: QualityApi#delete_conversation_recording_annotation ..."
536
+ end
537
+
538
+ # verify the required parameter 'conversation_id' is set
539
+ fail "Missing the required parameter 'conversation_id' when calling delete_conversation_recording_annotation" if conversation_id.nil?
540
+
541
+ # verify the required parameter 'recording_id' is set
542
+ fail "Missing the required parameter 'recording_id' when calling delete_conversation_recording_annotation" if recording_id.nil?
543
+
544
+ # verify the required parameter 'annotation_id' is set
545
+ fail "Missing the required parameter 'annotation_id' when calling delete_conversation_recording_annotation" if annotation_id.nil?
546
+
547
+ # resource path
548
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
549
+
550
+ # query parameters
551
+ query_params = {}
552
+
553
+ # header parameters
554
+ header_params = {}
555
+
556
+ # HTTP header 'Accept' (if needed)
557
+ _header_accept = ['application/json']
558
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
559
+
560
+ # HTTP header 'Content-Type'
561
+ _header_content_type = ['application/json']
562
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
563
+
564
+ # form parameters
565
+ form_params = {}
566
+
567
+ # http body (model)
568
+ post_body = nil
569
+
570
+
571
+ auth_names = ['PureCloud Auth']
572
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
573
+ :header_params => header_params,
574
+ :query_params => query_params,
575
+ :form_params => form_params,
576
+ :body => post_body,
577
+ :auth_names => auth_names)
578
+ if @api_client.config.debugging
579
+ @api_client.config.logger.debug "API called: QualityApi#delete_conversation_recording_annotation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
580
+ end
581
+ return data, status_code, headers
582
+ end
583
+
584
+ # Gets a list of Agent Activities
585
+ # Including the number of evaluations and average evaluation score
586
+ # @param [Hash] opts the optional parameters
587
+ # @option opts [Integer] :page_size The total page size requested
588
+ # @option opts [Integer] :page_number The page number requested
589
+ # @option opts [String] :sort_by variable name requested to sort by
590
+ # @option opts [Array<String>] :expand variable name requested by expand list
591
+ # @option opts [DateTime] :start_time Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
592
+ # @option opts [DateTime] :end_time End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
593
+ # @option opts [Array<String>] :agent_user_id user id of agent requested
594
+ # @option opts [String] :evaluator_user_id user id of the evaluator
595
+ # @option opts [String] :name name
596
+ # @option opts [String] :group group id
597
+ # @return [AgentActivityEntityListing]
598
+ def get_agents_activity(opts = {})
599
+ data, status_code, headers = get_agents_activity_with_http_info(opts)
600
+ return data
601
+ end
602
+
603
+ # Gets a list of Agent Activities
604
+ # Including the number of evaluations and average evaluation score
605
+ # @param [Hash] opts the optional parameters
606
+ # @option opts [Integer] :page_size The total page size requested
607
+ # @option opts [Integer] :page_number The page number requested
608
+ # @option opts [String] :sort_by variable name requested to sort by
609
+ # @option opts [Array<String>] :expand variable name requested by expand list
610
+ # @option opts [DateTime] :start_time Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
611
+ # @option opts [DateTime] :end_time End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
612
+ # @option opts [Array<String>] :agent_user_id user id of agent requested
613
+ # @option opts [String] :evaluator_user_id user id of the evaluator
614
+ # @option opts [String] :name name
615
+ # @option opts [String] :group group id
616
+ # @return [Array<(AgentActivityEntityListing, Fixnum, Hash)>] AgentActivityEntityListing data, response status code and response headers
617
+ def get_agents_activity_with_http_info(opts = {})
618
+ if @api_client.config.debugging
619
+ @api_client.config.logger.debug "Calling API: QualityApi#get_agents_activity ..."
620
+ end
621
+
622
+ # resource path
623
+ path = "/api/v1/quality/agents/activity".sub('{format}','json')
624
+
625
+ # query parameters
626
+ query_params = {}
627
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
628
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
629
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
630
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
631
+ query_params[:'startTime'] = opts[:'start_time'] if opts[:'start_time']
632
+ query_params[:'endTime'] = opts[:'end_time'] if opts[:'end_time']
633
+ query_params[:'agentUserId'] = @api_client.build_collection_param(opts[:'agent_user_id'], :multi) if opts[:'agent_user_id']
634
+ query_params[:'evaluatorUserId'] = opts[:'evaluator_user_id'] if opts[:'evaluator_user_id']
635
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
636
+ query_params[:'group'] = opts[:'group'] if opts[:'group']
637
+
638
+ # header parameters
639
+ header_params = {}
640
+
641
+ # HTTP header 'Accept' (if needed)
642
+ _header_accept = ['application/json']
643
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
644
+
645
+ # HTTP header 'Content-Type'
646
+ _header_content_type = ['application/json']
647
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
648
+
649
+ # form parameters
650
+ form_params = {}
651
+
652
+ # http body (model)
653
+ post_body = nil
654
+
655
+
656
+ auth_names = ['PureCloud Auth']
657
+ data, status_code, headers = @api_client.call_api(:GET, path,
658
+ :header_params => header_params,
659
+ :query_params => query_params,
660
+ :form_params => form_params,
661
+ :body => post_body,
662
+ :auth_names => auth_names,
663
+ :return_type => 'AgentActivityEntityListing')
664
+ if @api_client.config.debugging
665
+ @api_client.config.logger.debug "API called: QualityApi#get_agents_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
666
+ end
667
+ return data, status_code, headers
668
+ end
669
+
670
+ # Get the list of calibrations
671
+ #
672
+ # @param [Hash] opts the optional parameters
673
+ # @option opts [Integer] :page_size The total page size requested
674
+ # @option opts [Integer] :page_number The page number requested
675
+ # @option opts [String] :sort_by variable name requested to sort by
676
+ # @option opts [Array<String>] :expand variable name requested by expand list
677
+ # @option opts [String] :conversation_id conversation id
678
+ # @option opts [DateTime] :start_time Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
679
+ # @option opts [DateTime] :end_time end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
680
+ # @option opts [String] :calibrator_id user id of calibrator
681
+ # @return [CalibrationEntityListing]
682
+ def get_calibrations(opts = {})
683
+ data, status_code, headers = get_calibrations_with_http_info(opts)
684
+ return data
685
+ end
686
+
687
+ # Get the list of calibrations
688
+ #
689
+ # @param [Hash] opts the optional parameters
690
+ # @option opts [Integer] :page_size The total page size requested
691
+ # @option opts [Integer] :page_number The page number requested
692
+ # @option opts [String] :sort_by variable name requested to sort by
693
+ # @option opts [Array<String>] :expand variable name requested by expand list
694
+ # @option opts [String] :conversation_id conversation id
695
+ # @option opts [DateTime] :start_time Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
696
+ # @option opts [DateTime] :end_time end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
697
+ # @option opts [String] :calibrator_id user id of calibrator
698
+ # @return [Array<(CalibrationEntityListing, Fixnum, Hash)>] CalibrationEntityListing data, response status code and response headers
699
+ def get_calibrations_with_http_info(opts = {})
700
+ if @api_client.config.debugging
701
+ @api_client.config.logger.debug "Calling API: QualityApi#get_calibrations ..."
702
+ end
703
+
704
+ # resource path
705
+ path = "/api/v1/quality/calibrations".sub('{format}','json')
706
+
707
+ # query parameters
708
+ query_params = {}
709
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
710
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
711
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
712
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
713
+ query_params[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id']
714
+ query_params[:'startTime'] = opts[:'start_time'] if opts[:'start_time']
715
+ query_params[:'endTime'] = opts[:'end_time'] if opts[:'end_time']
716
+ query_params[:'calibratorId'] = opts[:'calibrator_id'] if opts[:'calibrator_id']
717
+
718
+ # header parameters
719
+ header_params = {}
720
+
721
+ # HTTP header 'Accept' (if needed)
722
+ _header_accept = ['application/json']
723
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
724
+
725
+ # HTTP header 'Content-Type'
726
+ _header_content_type = ['application/json']
727
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
728
+
729
+ # form parameters
730
+ form_params = {}
731
+
732
+ # http body (model)
733
+ post_body = nil
734
+
735
+
736
+ auth_names = ['PureCloud Auth']
737
+ data, status_code, headers = @api_client.call_api(:GET, path,
738
+ :header_params => header_params,
739
+ :query_params => query_params,
740
+ :form_params => form_params,
741
+ :body => post_body,
742
+ :auth_names => auth_names,
743
+ :return_type => 'CalibrationEntityListing')
744
+ if @api_client.config.debugging
745
+ @api_client.config.logger.debug "API called: QualityApi#get_calibrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
746
+ end
747
+ return data, status_code, headers
748
+ end
749
+
750
+ # Create a calibration
751
+ #
752
+ # @param [Hash] opts the optional parameters
753
+ # @option opts [Calibration] :body calibration
754
+ # @option opts [String] :expand calibratorId
755
+ # @return [Calibration]
756
+ def post_calibrations(opts = {})
757
+ data, status_code, headers = post_calibrations_with_http_info(opts)
758
+ return data
759
+ end
760
+
761
+ # Create a calibration
762
+ #
763
+ # @param [Hash] opts the optional parameters
764
+ # @option opts [Calibration] :body calibration
765
+ # @option opts [String] :expand calibratorId
766
+ # @return [Array<(Calibration, Fixnum, Hash)>] Calibration data, response status code and response headers
767
+ def post_calibrations_with_http_info(opts = {})
768
+ if @api_client.config.debugging
769
+ @api_client.config.logger.debug "Calling API: QualityApi#post_calibrations ..."
770
+ end
771
+
772
+ # resource path
773
+ path = "/api/v1/quality/calibrations".sub('{format}','json')
774
+
775
+ # query parameters
776
+ query_params = {}
777
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
778
+
779
+ # header parameters
780
+ header_params = {}
781
+
782
+ # HTTP header 'Accept' (if needed)
783
+ _header_accept = ['application/json']
784
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
785
+
786
+ # HTTP header 'Content-Type'
787
+ _header_content_type = ['application/json']
788
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
789
+
790
+ # form parameters
791
+ form_params = {}
792
+
793
+ # http body (model)
794
+ post_body = @api_client.object_to_http_body(opts[:'body'])
795
+
796
+
797
+ auth_names = ['PureCloud Auth']
798
+ data, status_code, headers = @api_client.call_api(:POST, path,
799
+ :header_params => header_params,
800
+ :query_params => query_params,
801
+ :form_params => form_params,
802
+ :body => post_body,
803
+ :auth_names => auth_names,
804
+ :return_type => 'Calibration')
805
+ if @api_client.config.debugging
806
+ @api_client.config.logger.debug "API called: QualityApi#post_calibrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
807
+ end
808
+ return data, status_code, headers
809
+ end
810
+
811
+ # Get a calibration by id.
812
+ #
813
+ # @param calibration_id Calibration ID
814
+ # @param [Hash] opts the optional parameters
815
+ # @option opts [String] :calibrator_id calibratorId
816
+ # @return [Calibration]
817
+ def get_calibration(calibration_id, opts = {})
818
+ data, status_code, headers = get_calibration_with_http_info(calibration_id, opts)
819
+ return data
820
+ end
821
+
822
+ # Get a calibration by id.
823
+ #
824
+ # @param calibration_id Calibration ID
825
+ # @param [Hash] opts the optional parameters
826
+ # @option opts [String] :calibrator_id calibratorId
827
+ # @return [Array<(Calibration, Fixnum, Hash)>] Calibration data, response status code and response headers
828
+ def get_calibration_with_http_info(calibration_id, opts = {})
829
+ if @api_client.config.debugging
830
+ @api_client.config.logger.debug "Calling API: QualityApi#get_calibration ..."
831
+ end
832
+
833
+ # verify the required parameter 'calibration_id' is set
834
+ fail "Missing the required parameter 'calibration_id' when calling get_calibration" if calibration_id.nil?
835
+
836
+ # resource path
837
+ path = "/api/v1/quality/calibrations/{calibrationId}".sub('{format}','json').sub('{' + 'calibrationId' + '}', calibration_id.to_s)
838
+
839
+ # query parameters
840
+ query_params = {}
841
+ query_params[:'calibratorId'] = opts[:'calibrator_id'] if opts[:'calibrator_id']
842
+
843
+ # header parameters
844
+ header_params = {}
845
+
846
+ # HTTP header 'Accept' (if needed)
847
+ _header_accept = ['application/json']
848
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
849
+
850
+ # HTTP header 'Content-Type'
851
+ _header_content_type = ['application/json']
852
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
853
+
854
+ # form parameters
855
+ form_params = {}
856
+
857
+ # http body (model)
858
+ post_body = nil
859
+
860
+
861
+ auth_names = ['PureCloud Auth']
862
+ data, status_code, headers = @api_client.call_api(:GET, path,
863
+ :header_params => header_params,
864
+ :query_params => query_params,
865
+ :form_params => form_params,
866
+ :body => post_body,
867
+ :auth_names => auth_names,
868
+ :return_type => 'Calibration')
869
+ if @api_client.config.debugging
870
+ @api_client.config.logger.debug "API called: QualityApi#get_calibration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
871
+ end
872
+ return data, status_code, headers
873
+ end
874
+
875
+ # Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
876
+ #
877
+ # @param calibration_id Calibration ID
878
+ # @param [Hash] opts the optional parameters
879
+ # @option opts [Calibration] :body Calibration
880
+ # @return [Calibration]
881
+ def put_calibration(calibration_id, opts = {})
882
+ data, status_code, headers = put_calibration_with_http_info(calibration_id, opts)
883
+ return data
884
+ end
885
+
886
+ # Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
887
+ #
888
+ # @param calibration_id Calibration ID
889
+ # @param [Hash] opts the optional parameters
890
+ # @option opts [Calibration] :body Calibration
891
+ # @return [Array<(Calibration, Fixnum, Hash)>] Calibration data, response status code and response headers
892
+ def put_calibration_with_http_info(calibration_id, opts = {})
893
+ if @api_client.config.debugging
894
+ @api_client.config.logger.debug "Calling API: QualityApi#put_calibration ..."
895
+ end
896
+
897
+ # verify the required parameter 'calibration_id' is set
898
+ fail "Missing the required parameter 'calibration_id' when calling put_calibration" if calibration_id.nil?
899
+
900
+ # resource path
901
+ path = "/api/v1/quality/calibrations/{calibrationId}".sub('{format}','json').sub('{' + 'calibrationId' + '}', calibration_id.to_s)
902
+
903
+ # query parameters
904
+ query_params = {}
905
+
906
+ # header parameters
907
+ header_params = {}
908
+
909
+ # HTTP header 'Accept' (if needed)
910
+ _header_accept = ['application/json']
911
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
912
+
913
+ # HTTP header 'Content-Type'
914
+ _header_content_type = ['application/json']
915
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
916
+
917
+ # form parameters
918
+ form_params = {}
919
+
920
+ # http body (model)
921
+ post_body = @api_client.object_to_http_body(opts[:'body'])
922
+
923
+
924
+ auth_names = ['PureCloud Auth']
925
+ data, status_code, headers = @api_client.call_api(:PUT, path,
926
+ :header_params => header_params,
927
+ :query_params => query_params,
928
+ :form_params => form_params,
929
+ :body => post_body,
930
+ :auth_names => auth_names,
931
+ :return_type => 'Calibration')
932
+ if @api_client.config.debugging
933
+ @api_client.config.logger.debug "API called: QualityApi#put_calibration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
934
+ end
935
+ return data, status_code, headers
936
+ end
937
+
938
+ # Delete a calibration by id.
939
+ #
940
+ # @param calibration_id Calibration ID
941
+ # @param [Hash] opts the optional parameters
942
+ # @option opts [String] :calibrator_id calibratorId
943
+ # @return [Calibration]
944
+ def delete_calibration(calibration_id, opts = {})
945
+ data, status_code, headers = delete_calibration_with_http_info(calibration_id, opts)
946
+ return data
947
+ end
948
+
949
+ # Delete a calibration by id.
950
+ #
951
+ # @param calibration_id Calibration ID
952
+ # @param [Hash] opts the optional parameters
953
+ # @option opts [String] :calibrator_id calibratorId
954
+ # @return [Array<(Calibration, Fixnum, Hash)>] Calibration data, response status code and response headers
955
+ def delete_calibration_with_http_info(calibration_id, opts = {})
956
+ if @api_client.config.debugging
957
+ @api_client.config.logger.debug "Calling API: QualityApi#delete_calibration ..."
958
+ end
959
+
960
+ # verify the required parameter 'calibration_id' is set
961
+ fail "Missing the required parameter 'calibration_id' when calling delete_calibration" if calibration_id.nil?
962
+
963
+ # resource path
964
+ path = "/api/v1/quality/calibrations/{calibrationId}".sub('{format}','json').sub('{' + 'calibrationId' + '}', calibration_id.to_s)
965
+
966
+ # query parameters
967
+ query_params = {}
968
+ query_params[:'calibratorId'] = opts[:'calibrator_id'] if opts[:'calibrator_id']
969
+
970
+ # header parameters
971
+ header_params = {}
972
+
973
+ # HTTP header 'Accept' (if needed)
974
+ _header_accept = ['application/json']
975
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
976
+
977
+ # HTTP header 'Content-Type'
978
+ _header_content_type = ['application/json']
979
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
980
+
981
+ # form parameters
982
+ form_params = {}
983
+
984
+ # http body (model)
985
+ post_body = nil
986
+
987
+
988
+ auth_names = ['PureCloud Auth']
989
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
990
+ :header_params => header_params,
991
+ :query_params => query_params,
992
+ :form_params => form_params,
993
+ :body => post_body,
994
+ :auth_names => auth_names,
995
+ :return_type => 'Calibration')
996
+ if @api_client.config.debugging
997
+ @api_client.config.logger.debug "API called: QualityApi#delete_calibration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
998
+ end
999
+ return data, status_code, headers
1000
+ end
1001
+
1002
+ # Get audits for conversation or recording
1003
+ #
1004
+ # @param conversation_id Conversation ID
1005
+ # @param [Hash] opts the optional parameters
1006
+ # @option opts [Integer] :page_size The total page size requested
1007
+ # @option opts [Integer] :page_number The page number requested
1008
+ # @option opts [String] :sort_by variable name requested to sort by
1009
+ # @option opts [Array<String>] :expand variable name requested by expand list
1010
+ # @option opts [String] :recording_id id of the recording
1011
+ # @option opts [String] :entity_type entity type options: Recording, Calibration, Evaluation, Annotation
1012
+ # @return [QualityAuditPage]
1013
+ def get_conversation_audits(conversation_id, opts = {})
1014
+ data, status_code, headers = get_conversation_audits_with_http_info(conversation_id, opts)
1015
+ return data
1016
+ end
1017
+
1018
+ # Get audits for conversation or recording
1019
+ #
1020
+ # @param conversation_id Conversation ID
1021
+ # @param [Hash] opts the optional parameters
1022
+ # @option opts [Integer] :page_size The total page size requested
1023
+ # @option opts [Integer] :page_number The page number requested
1024
+ # @option opts [String] :sort_by variable name requested to sort by
1025
+ # @option opts [Array<String>] :expand variable name requested by expand list
1026
+ # @option opts [String] :recording_id id of the recording
1027
+ # @option opts [String] :entity_type entity type options: Recording, Calibration, Evaluation, Annotation
1028
+ # @return [Array<(QualityAuditPage, Fixnum, Hash)>] QualityAuditPage data, response status code and response headers
1029
+ def get_conversation_audits_with_http_info(conversation_id, opts = {})
1030
+ if @api_client.config.debugging
1031
+ @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_audits ..."
1032
+ end
1033
+
1034
+ # verify the required parameter 'conversation_id' is set
1035
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_audits" if conversation_id.nil?
1036
+
1037
+ # resource path
1038
+ path = "/api/v1/quality/conversations/{conversationId}/audits".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
1039
+
1040
+ # query parameters
1041
+ query_params = {}
1042
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1043
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1044
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1045
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1046
+ query_params[:'recordingId'] = opts[:'recording_id'] if opts[:'recording_id']
1047
+ query_params[:'entityType'] = opts[:'entity_type'] if opts[:'entity_type']
1048
+
1049
+ # header parameters
1050
+ header_params = {}
1051
+
1052
+ # HTTP header 'Accept' (if needed)
1053
+ _header_accept = ['application/json']
1054
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1055
+
1056
+ # HTTP header 'Content-Type'
1057
+ _header_content_type = ['application/json']
1058
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1059
+
1060
+ # form parameters
1061
+ form_params = {}
1062
+
1063
+ # http body (model)
1064
+ post_body = nil
1065
+
1066
+
1067
+ auth_names = ['PureCloud Auth']
1068
+ data, status_code, headers = @api_client.call_api(:GET, path,
1069
+ :header_params => header_params,
1070
+ :query_params => query_params,
1071
+ :form_params => form_params,
1072
+ :body => post_body,
1073
+ :auth_names => auth_names,
1074
+ :return_type => 'QualityAuditPage')
1075
+ if @api_client.config.debugging
1076
+ @api_client.config.logger.debug "API called: QualityApi#get_conversation_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1077
+ end
1078
+ return data, status_code, headers
1079
+ end
1080
+
1081
+ # Create an evaluation
1082
+ #
1083
+ # @param conversation_id
1084
+ # @param [Hash] opts the optional parameters
1085
+ # @option opts [Evaluation] :body evaluation
1086
+ # @option opts [String] :expand evaluatorId
1087
+ # @return [Evaluation]
1088
+ def post_conversation_evaluations(conversation_id, opts = {})
1089
+ data, status_code, headers = post_conversation_evaluations_with_http_info(conversation_id, opts)
1090
+ return data
1091
+ end
1092
+
1093
+ # Create an evaluation
1094
+ #
1095
+ # @param conversation_id
1096
+ # @param [Hash] opts the optional parameters
1097
+ # @option opts [Evaluation] :body evaluation
1098
+ # @option opts [String] :expand evaluatorId
1099
+ # @return [Array<(Evaluation, Fixnum, Hash)>] Evaluation data, response status code and response headers
1100
+ def post_conversation_evaluations_with_http_info(conversation_id, opts = {})
1101
+ if @api_client.config.debugging
1102
+ @api_client.config.logger.debug "Calling API: QualityApi#post_conversation_evaluations ..."
1103
+ end
1104
+
1105
+ # verify the required parameter 'conversation_id' is set
1106
+ fail "Missing the required parameter 'conversation_id' when calling post_conversation_evaluations" if conversation_id.nil?
1107
+
1108
+ # resource path
1109
+ path = "/api/v1/quality/conversations/{conversationId}/evaluations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
1110
+
1111
+ # query parameters
1112
+ query_params = {}
1113
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1114
+
1115
+ # header parameters
1116
+ header_params = {}
1117
+
1118
+ # HTTP header 'Accept' (if needed)
1119
+ _header_accept = ['application/json']
1120
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1121
+
1122
+ # HTTP header 'Content-Type'
1123
+ _header_content_type = ['application/json']
1124
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1125
+
1126
+ # form parameters
1127
+ form_params = {}
1128
+
1129
+ # http body (model)
1130
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1131
+
1132
+
1133
+ auth_names = ['PureCloud Auth']
1134
+ data, status_code, headers = @api_client.call_api(:POST, path,
1135
+ :header_params => header_params,
1136
+ :query_params => query_params,
1137
+ :form_params => form_params,
1138
+ :body => post_body,
1139
+ :auth_names => auth_names,
1140
+ :return_type => 'Evaluation')
1141
+ if @api_client.config.debugging
1142
+ @api_client.config.logger.debug "API called: QualityApi#post_conversation_evaluations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1143
+ end
1144
+ return data, status_code, headers
1145
+ end
1146
+
1147
+ # Get an evaluation
1148
+ #
1149
+ # @param conversation_id
1150
+ # @param evaluation_id
1151
+ # @param [Hash] opts the optional parameters
1152
+ # @option opts [String] :expand agent, evaluator, evaluationForm
1153
+ # @return [Evaluation]
1154
+ def get_conversation_evaluation(conversation_id, evaluation_id, opts = {})
1155
+ data, status_code, headers = get_conversation_evaluation_with_http_info(conversation_id, evaluation_id, opts)
1156
+ return data
1157
+ end
1158
+
1159
+ # Get an evaluation
1160
+ #
1161
+ # @param conversation_id
1162
+ # @param evaluation_id
1163
+ # @param [Hash] opts the optional parameters
1164
+ # @option opts [String] :expand agent, evaluator, evaluationForm
1165
+ # @return [Array<(Evaluation, Fixnum, Hash)>] Evaluation data, response status code and response headers
1166
+ def get_conversation_evaluation_with_http_info(conversation_id, evaluation_id, opts = {})
1167
+ if @api_client.config.debugging
1168
+ @api_client.config.logger.debug "Calling API: QualityApi#get_conversation_evaluation ..."
1169
+ end
1170
+
1171
+ # verify the required parameter 'conversation_id' is set
1172
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_evaluation" if conversation_id.nil?
1173
+
1174
+ # verify the required parameter 'evaluation_id' is set
1175
+ fail "Missing the required parameter 'evaluation_id' when calling get_conversation_evaluation" if evaluation_id.nil?
1176
+
1177
+ # resource path
1178
+ path = "/api/v1/quality/conversations/{conversationId}/evaluations/{evaluationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'evaluationId' + '}', evaluation_id.to_s)
1179
+
1180
+ # query parameters
1181
+ query_params = {}
1182
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1183
+
1184
+ # header parameters
1185
+ header_params = {}
1186
+
1187
+ # HTTP header 'Accept' (if needed)
1188
+ _header_accept = ['application/json']
1189
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1190
+
1191
+ # HTTP header 'Content-Type'
1192
+ _header_content_type = ['application/json']
1193
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1194
+
1195
+ # form parameters
1196
+ form_params = {}
1197
+
1198
+ # http body (model)
1199
+ post_body = nil
1200
+
1201
+
1202
+ auth_names = ['PureCloud Auth']
1203
+ data, status_code, headers = @api_client.call_api(:GET, path,
1204
+ :header_params => header_params,
1205
+ :query_params => query_params,
1206
+ :form_params => form_params,
1207
+ :body => post_body,
1208
+ :auth_names => auth_names,
1209
+ :return_type => 'Evaluation')
1210
+ if @api_client.config.debugging
1211
+ @api_client.config.logger.debug "API called: QualityApi#get_conversation_evaluation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1212
+ end
1213
+ return data, status_code, headers
1214
+ end
1215
+
1216
+ # Update an evaluation
1217
+ #
1218
+ # @param conversation_id
1219
+ # @param evaluation_id
1220
+ # @param [Hash] opts the optional parameters
1221
+ # @option opts [Evaluation] :body evaluation
1222
+ # @option opts [String] :expand evaluatorId
1223
+ # @return [Evaluation]
1224
+ def put_conversation_evaluation(conversation_id, evaluation_id, opts = {})
1225
+ data, status_code, headers = put_conversation_evaluation_with_http_info(conversation_id, evaluation_id, opts)
1226
+ return data
1227
+ end
1228
+
1229
+ # Update an evaluation
1230
+ #
1231
+ # @param conversation_id
1232
+ # @param evaluation_id
1233
+ # @param [Hash] opts the optional parameters
1234
+ # @option opts [Evaluation] :body evaluation
1235
+ # @option opts [String] :expand evaluatorId
1236
+ # @return [Array<(Evaluation, Fixnum, Hash)>] Evaluation data, response status code and response headers
1237
+ def put_conversation_evaluation_with_http_info(conversation_id, evaluation_id, opts = {})
1238
+ if @api_client.config.debugging
1239
+ @api_client.config.logger.debug "Calling API: QualityApi#put_conversation_evaluation ..."
1240
+ end
1241
+
1242
+ # verify the required parameter 'conversation_id' is set
1243
+ fail "Missing the required parameter 'conversation_id' when calling put_conversation_evaluation" if conversation_id.nil?
1244
+
1245
+ # verify the required parameter 'evaluation_id' is set
1246
+ fail "Missing the required parameter 'evaluation_id' when calling put_conversation_evaluation" if evaluation_id.nil?
1247
+
1248
+ # resource path
1249
+ path = "/api/v1/quality/conversations/{conversationId}/evaluations/{evaluationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'evaluationId' + '}', evaluation_id.to_s)
1250
+
1251
+ # query parameters
1252
+ query_params = {}
1253
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1254
+
1255
+ # header parameters
1256
+ header_params = {}
1257
+
1258
+ # HTTP header 'Accept' (if needed)
1259
+ _header_accept = ['application/json']
1260
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1261
+
1262
+ # HTTP header 'Content-Type'
1263
+ _header_content_type = ['application/json']
1264
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1265
+
1266
+ # form parameters
1267
+ form_params = {}
1268
+
1269
+ # http body (model)
1270
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1271
+
1272
+
1273
+ auth_names = ['PureCloud Auth']
1274
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1275
+ :header_params => header_params,
1276
+ :query_params => query_params,
1277
+ :form_params => form_params,
1278
+ :body => post_body,
1279
+ :auth_names => auth_names,
1280
+ :return_type => 'Evaluation')
1281
+ if @api_client.config.debugging
1282
+ @api_client.config.logger.debug "API called: QualityApi#put_conversation_evaluation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1283
+ end
1284
+ return data, status_code, headers
1285
+ end
1286
+
1287
+ # Delete an evaluation
1288
+ #
1289
+ # @param conversation_id
1290
+ # @param evaluation_id
1291
+ # @param [Hash] opts the optional parameters
1292
+ # @option opts [String] :expand evaluatorId
1293
+ # @return [Evaluation]
1294
+ def delete_conversation_evaluation(conversation_id, evaluation_id, opts = {})
1295
+ data, status_code, headers = delete_conversation_evaluation_with_http_info(conversation_id, evaluation_id, opts)
1296
+ return data
1297
+ end
1298
+
1299
+ # Delete an evaluation
1300
+ #
1301
+ # @param conversation_id
1302
+ # @param evaluation_id
1303
+ # @param [Hash] opts the optional parameters
1304
+ # @option opts [String] :expand evaluatorId
1305
+ # @return [Array<(Evaluation, Fixnum, Hash)>] Evaluation data, response status code and response headers
1306
+ def delete_conversation_evaluation_with_http_info(conversation_id, evaluation_id, opts = {})
1307
+ if @api_client.config.debugging
1308
+ @api_client.config.logger.debug "Calling API: QualityApi#delete_conversation_evaluation ..."
1309
+ end
1310
+
1311
+ # verify the required parameter 'conversation_id' is set
1312
+ fail "Missing the required parameter 'conversation_id' when calling delete_conversation_evaluation" if conversation_id.nil?
1313
+
1314
+ # verify the required parameter 'evaluation_id' is set
1315
+ fail "Missing the required parameter 'evaluation_id' when calling delete_conversation_evaluation" if evaluation_id.nil?
1316
+
1317
+ # resource path
1318
+ path = "/api/v1/quality/conversations/{conversationId}/evaluations/{evaluationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'evaluationId' + '}', evaluation_id.to_s)
1319
+
1320
+ # query parameters
1321
+ query_params = {}
1322
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1323
+
1324
+ # header parameters
1325
+ header_params = {}
1326
+
1327
+ # HTTP header 'Accept' (if needed)
1328
+ _header_accept = ['application/json']
1329
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1330
+
1331
+ # HTTP header 'Content-Type'
1332
+ _header_content_type = ['application/json']
1333
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1334
+
1335
+ # form parameters
1336
+ form_params = {}
1337
+
1338
+ # http body (model)
1339
+ post_body = nil
1340
+
1341
+
1342
+ auth_names = ['PureCloud Auth']
1343
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1344
+ :header_params => header_params,
1345
+ :query_params => query_params,
1346
+ :form_params => form_params,
1347
+ :body => post_body,
1348
+ :auth_names => auth_names,
1349
+ :return_type => 'Evaluation')
1350
+ if @api_client.config.debugging
1351
+ @api_client.config.logger.debug "API called: QualityApi#delete_conversation_evaluation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1352
+ end
1353
+ return data, status_code, headers
1354
+ end
1355
+
1356
+ # Queries Evaluations and returns a paged list
1357
+ # Query params must include one of conversationId, evaluatorUserId, or agentUserId
1358
+ # @param [Hash] opts the optional parameters
1359
+ # @option opts [Integer] :page_size The total page size requested
1360
+ # @option opts [Integer] :page_number The page number requested
1361
+ # @option opts [String] :sort_by variable name requested to sort by
1362
+ # @option opts [Array<String>] :expand variable name requested by expand list
1363
+ # @option opts [String] :conversation_id conversationId specified
1364
+ # @option opts [String] :agent_user_id user id of the agent
1365
+ # @option opts [String] :evaluator_user_id evaluator user id
1366
+ # @option opts [String] :queue_id queue id
1367
+ # @option opts [String] :start_time start time of the evaluation query
1368
+ # @option opts [String] :end_time end time of the evaluation query
1369
+ # @option opts [Array<String>] :evaluation_state evaluation state options: Pending, InProgress, Finished
1370
+ # @option opts [BOOLEAN] :is_released the evaluation has been released
1371
+ # @option opts [BOOLEAN] :agent_has_read agent has the evaluation
1372
+ # @option opts [BOOLEAN] :expand_answer_total_scores get the total scores for evaluations
1373
+ # @option opts [Integer] :maximum maximum
1374
+ # @return [EvaluationEntityListing]
1375
+ def get_evaluations_query(opts = {})
1376
+ data, status_code, headers = get_evaluations_query_with_http_info(opts)
1377
+ return data
1378
+ end
1379
+
1380
+ # Queries Evaluations and returns a paged list
1381
+ # Query params must include one of conversationId, evaluatorUserId, or agentUserId
1382
+ # @param [Hash] opts the optional parameters
1383
+ # @option opts [Integer] :page_size The total page size requested
1384
+ # @option opts [Integer] :page_number The page number requested
1385
+ # @option opts [String] :sort_by variable name requested to sort by
1386
+ # @option opts [Array<String>] :expand variable name requested by expand list
1387
+ # @option opts [String] :conversation_id conversationId specified
1388
+ # @option opts [String] :agent_user_id user id of the agent
1389
+ # @option opts [String] :evaluator_user_id evaluator user id
1390
+ # @option opts [String] :queue_id queue id
1391
+ # @option opts [String] :start_time start time of the evaluation query
1392
+ # @option opts [String] :end_time end time of the evaluation query
1393
+ # @option opts [Array<String>] :evaluation_state evaluation state options: Pending, InProgress, Finished
1394
+ # @option opts [BOOLEAN] :is_released the evaluation has been released
1395
+ # @option opts [BOOLEAN] :agent_has_read agent has the evaluation
1396
+ # @option opts [BOOLEAN] :expand_answer_total_scores get the total scores for evaluations
1397
+ # @option opts [Integer] :maximum maximum
1398
+ # @return [Array<(EvaluationEntityListing, Fixnum, Hash)>] EvaluationEntityListing data, response status code and response headers
1399
+ def get_evaluations_query_with_http_info(opts = {})
1400
+ if @api_client.config.debugging
1401
+ @api_client.config.logger.debug "Calling API: QualityApi#get_evaluations_query ..."
1402
+ end
1403
+
1404
+ # resource path
1405
+ path = "/api/v1/quality/evaluations/query".sub('{format}','json')
1406
+
1407
+ # query parameters
1408
+ query_params = {}
1409
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1410
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1411
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1412
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1413
+ query_params[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id']
1414
+ query_params[:'agentUserId'] = opts[:'agent_user_id'] if opts[:'agent_user_id']
1415
+ query_params[:'evaluatorUserId'] = opts[:'evaluator_user_id'] if opts[:'evaluator_user_id']
1416
+ query_params[:'queueId'] = opts[:'queue_id'] if opts[:'queue_id']
1417
+ query_params[:'startTime'] = opts[:'start_time'] if opts[:'start_time']
1418
+ query_params[:'endTime'] = opts[:'end_time'] if opts[:'end_time']
1419
+ query_params[:'evaluationState'] = @api_client.build_collection_param(opts[:'evaluation_state'], :multi) if opts[:'evaluation_state']
1420
+ query_params[:'isReleased'] = opts[:'is_released'] if opts[:'is_released']
1421
+ query_params[:'agentHasRead'] = opts[:'agent_has_read'] if opts[:'agent_has_read']
1422
+ query_params[:'expandAnswerTotalScores'] = opts[:'expand_answer_total_scores'] if opts[:'expand_answer_total_scores']
1423
+ query_params[:'maximum'] = opts[:'maximum'] if opts[:'maximum']
1424
+
1425
+ # header parameters
1426
+ header_params = {}
1427
+
1428
+ # HTTP header 'Accept' (if needed)
1429
+ _header_accept = ['application/json']
1430
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1431
+
1432
+ # HTTP header 'Content-Type'
1433
+ _header_content_type = ['application/json']
1434
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1435
+
1436
+ # form parameters
1437
+ form_params = {}
1438
+
1439
+ # http body (model)
1440
+ post_body = nil
1441
+
1442
+
1443
+ auth_names = ['PureCloud Auth']
1444
+ data, status_code, headers = @api_client.call_api(:GET, path,
1445
+ :header_params => header_params,
1446
+ :query_params => query_params,
1447
+ :form_params => form_params,
1448
+ :body => post_body,
1449
+ :auth_names => auth_names,
1450
+ :return_type => 'EvaluationEntityListing')
1451
+ if @api_client.config.debugging
1452
+ @api_client.config.logger.debug "API called: QualityApi#get_evaluations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1453
+ end
1454
+ return data, status_code, headers
1455
+ end
1456
+
1457
+ # Query evaluations
1458
+ #
1459
+ # @param [Hash] opts the optional parameters
1460
+ # @option opts [EvaluationQueryRequest] :body query
1461
+ # @option opts [String] :expand evaluator,agent
1462
+ # @return [EvaluationEntityListing]
1463
+ def post_evaluations_query(opts = {})
1464
+ data, status_code, headers = post_evaluations_query_with_http_info(opts)
1465
+ return data
1466
+ end
1467
+
1468
+ # Query evaluations
1469
+ #
1470
+ # @param [Hash] opts the optional parameters
1471
+ # @option opts [EvaluationQueryRequest] :body query
1472
+ # @option opts [String] :expand evaluator,agent
1473
+ # @return [Array<(EvaluationEntityListing, Fixnum, Hash)>] EvaluationEntityListing data, response status code and response headers
1474
+ def post_evaluations_query_with_http_info(opts = {})
1475
+ if @api_client.config.debugging
1476
+ @api_client.config.logger.debug "Calling API: QualityApi#post_evaluations_query ..."
1477
+ end
1478
+
1479
+ # resource path
1480
+ path = "/api/v1/quality/evaluations/query".sub('{format}','json')
1481
+
1482
+ # query parameters
1483
+ query_params = {}
1484
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1485
+
1486
+ # header parameters
1487
+ header_params = {}
1488
+
1489
+ # HTTP header 'Accept' (if needed)
1490
+ _header_accept = ['application/json']
1491
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1492
+
1493
+ # HTTP header 'Content-Type'
1494
+ _header_content_type = ['application/json']
1495
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1496
+
1497
+ # form parameters
1498
+ form_params = {}
1499
+
1500
+ # http body (model)
1501
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1502
+
1503
+
1504
+ auth_names = ['PureCloud Auth']
1505
+ data, status_code, headers = @api_client.call_api(:POST, path,
1506
+ :header_params => header_params,
1507
+ :query_params => query_params,
1508
+ :form_params => form_params,
1509
+ :body => post_body,
1510
+ :auth_names => auth_names,
1511
+ :return_type => 'EvaluationEntityListing')
1512
+ if @api_client.config.debugging
1513
+ @api_client.config.logger.debug "API called: QualityApi#post_evaluations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1514
+ end
1515
+ return data, status_code, headers
1516
+ end
1517
+
1518
+ # Score evaluation
1519
+ #
1520
+ # @param [Hash] opts the optional parameters
1521
+ # @option opts [EvaluationFormAndScoringSet] :body evaluationAndScoringSet
1522
+ # @return [EvaluationScoringSet]
1523
+ def post_evaluations_scoring(opts = {})
1524
+ data, status_code, headers = post_evaluations_scoring_with_http_info(opts)
1525
+ return data
1526
+ end
1527
+
1528
+ # Score evaluation
1529
+ #
1530
+ # @param [Hash] opts the optional parameters
1531
+ # @option opts [EvaluationFormAndScoringSet] :body evaluationAndScoringSet
1532
+ # @return [Array<(EvaluationScoringSet, Fixnum, Hash)>] EvaluationScoringSet data, response status code and response headers
1533
+ def post_evaluations_scoring_with_http_info(opts = {})
1534
+ if @api_client.config.debugging
1535
+ @api_client.config.logger.debug "Calling API: QualityApi#post_evaluations_scoring ..."
1536
+ end
1537
+
1538
+ # resource path
1539
+ path = "/api/v1/quality/evaluations/scoring".sub('{format}','json')
1540
+
1541
+ # query parameters
1542
+ query_params = {}
1543
+
1544
+ # header parameters
1545
+ header_params = {}
1546
+
1547
+ # HTTP header 'Accept' (if needed)
1548
+ _header_accept = ['application/json']
1549
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1550
+
1551
+ # HTTP header 'Content-Type'
1552
+ _header_content_type = ['application/json']
1553
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1554
+
1555
+ # form parameters
1556
+ form_params = {}
1557
+
1558
+ # http body (model)
1559
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1560
+
1561
+
1562
+ auth_names = ['PureCloud Auth']
1563
+ data, status_code, headers = @api_client.call_api(:POST, path,
1564
+ :header_params => header_params,
1565
+ :query_params => query_params,
1566
+ :form_params => form_params,
1567
+ :body => post_body,
1568
+ :auth_names => auth_names,
1569
+ :return_type => 'EvaluationScoringSet')
1570
+ if @api_client.config.debugging
1571
+ @api_client.config.logger.debug "API called: QualityApi#post_evaluations_scoring\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1572
+ end
1573
+ return data, status_code, headers
1574
+ end
1575
+
1576
+ # Get an evaluator activity
1577
+ #
1578
+ # @param [Hash] opts the optional parameters
1579
+ # @option opts [Integer] :page_size The total page size requested
1580
+ # @option opts [Integer] :page_number The page number requested
1581
+ # @option opts [String] :sort_by variable name requested to sort by
1582
+ # @option opts [Array<String>] :expand variable name requested by expand list
1583
+ # @option opts [DateTime] :start_time The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
1584
+ # @option opts [DateTime] :end_time The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
1585
+ # @option opts [String] :name Evaluator name
1586
+ # @option opts [Array<String>] :permission permission strings
1587
+ # @option opts [String] :group group id
1588
+ # @return [EvaluatorActivityEntityListing]
1589
+ def get_evaluators_activity(opts = {})
1590
+ data, status_code, headers = get_evaluators_activity_with_http_info(opts)
1591
+ return data
1592
+ end
1593
+
1594
+ # Get an evaluator activity
1595
+ #
1596
+ # @param [Hash] opts the optional parameters
1597
+ # @option opts [Integer] :page_size The total page size requested
1598
+ # @option opts [Integer] :page_number The page number requested
1599
+ # @option opts [String] :sort_by variable name requested to sort by
1600
+ # @option opts [Array<String>] :expand variable name requested by expand list
1601
+ # @option opts [DateTime] :start_time The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
1602
+ # @option opts [DateTime] :end_time The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
1603
+ # @option opts [String] :name Evaluator name
1604
+ # @option opts [Array<String>] :permission permission strings
1605
+ # @option opts [String] :group group id
1606
+ # @return [Array<(EvaluatorActivityEntityListing, Fixnum, Hash)>] EvaluatorActivityEntityListing data, response status code and response headers
1607
+ def get_evaluators_activity_with_http_info(opts = {})
1608
+ if @api_client.config.debugging
1609
+ @api_client.config.logger.debug "Calling API: QualityApi#get_evaluators_activity ..."
1610
+ end
1611
+
1612
+ # resource path
1613
+ path = "/api/v1/quality/evaluators/activity".sub('{format}','json')
1614
+
1615
+ # query parameters
1616
+ query_params = {}
1617
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1618
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1619
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1620
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1621
+ query_params[:'startTime'] = opts[:'start_time'] if opts[:'start_time']
1622
+ query_params[:'endTime'] = opts[:'end_time'] if opts[:'end_time']
1623
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
1624
+ query_params[:'permission'] = @api_client.build_collection_param(opts[:'permission'], :multi) if opts[:'permission']
1625
+ query_params[:'group'] = opts[:'group'] if opts[:'group']
1626
+
1627
+ # header parameters
1628
+ header_params = {}
1629
+
1630
+ # HTTP header 'Accept' (if needed)
1631
+ _header_accept = ['application/json']
1632
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1633
+
1634
+ # HTTP header 'Content-Type'
1635
+ _header_content_type = ['application/json']
1636
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1637
+
1638
+ # form parameters
1639
+ form_params = {}
1640
+
1641
+ # http body (model)
1642
+ post_body = nil
1643
+
1644
+
1645
+ auth_names = ['PureCloud Auth']
1646
+ data, status_code, headers = @api_client.call_api(:GET, path,
1647
+ :header_params => header_params,
1648
+ :query_params => query_params,
1649
+ :form_params => form_params,
1650
+ :body => post_body,
1651
+ :auth_names => auth_names,
1652
+ :return_type => 'EvaluatorActivityEntityListing')
1653
+ if @api_client.config.debugging
1654
+ @api_client.config.logger.debug "API called: QualityApi#get_evaluators_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1655
+ end
1656
+ return data, status_code, headers
1657
+ end
1658
+ end
1659
+ end
1660
+
1661
+
1662
+
1663
+