purecloud 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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,1554 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class AnalyticsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Get a list of alerts.
12
+ #
13
+ # @param [Hash] opts the optional parameters
14
+ # @option opts [Integer] :page_number Page number
15
+ # @option opts [Integer] :page_size Page size
16
+ # @option opts [String] :sort_by title, startTime, endTime, description or unread
17
+ # @option opts [String] :sort_order ascending or descending
18
+ # @return [AlertEntityListing]
19
+ def get_alerting_alerts(opts = {})
20
+ data, status_code, headers = get_alerting_alerts_with_http_info(opts)
21
+ return data
22
+ end
23
+
24
+ # Get a list of alerts.
25
+ #
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [Integer] :page_number Page number
28
+ # @option opts [Integer] :page_size Page size
29
+ # @option opts [String] :sort_by title, startTime, endTime, description or unread
30
+ # @option opts [String] :sort_order ascending or descending
31
+ # @return [Array<(AlertEntityListing, Fixnum, Hash)>] AlertEntityListing data, response status code and response headers
32
+ def get_alerting_alerts_with_http_info(opts = {})
33
+ if @api_client.config.debugging
34
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts ..."
35
+ end
36
+
37
+ # resource path
38
+ path = "/api/v1/analytics/alerting/alerts".sub('{format}','json')
39
+
40
+ # query parameters
41
+ query_params = {}
42
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
43
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
44
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
45
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
46
+
47
+ # header parameters
48
+ header_params = {}
49
+
50
+ # HTTP header 'Accept' (if needed)
51
+ _header_accept = ['application/json']
52
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
53
+
54
+ # HTTP header 'Content-Type'
55
+ _header_content_type = ['application/json']
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
57
+
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = nil
63
+
64
+
65
+ auth_names = ['PureCloud Auth']
66
+ data, status_code, headers = @api_client.call_api(:GET, path,
67
+ :header_params => header_params,
68
+ :query_params => query_params,
69
+ :form_params => form_params,
70
+ :body => post_body,
71
+ :auth_names => auth_names,
72
+ :return_type => 'AlertEntityListing')
73
+ if @api_client.config.debugging
74
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
+ end
76
+ return data, status_code, headers
77
+ end
78
+
79
+ # A count of unread alerts.
80
+ #
81
+ # @param [Hash] opts the optional parameters
82
+ # @return [UnreadMetric]
83
+ def get_alerting_alerts_unread(opts = {})
84
+ data, status_code, headers = get_alerting_alerts_unread_with_http_info(opts)
85
+ return data
86
+ end
87
+
88
+ # A count of unread alerts.
89
+ #
90
+ # @param [Hash] opts the optional parameters
91
+ # @return [Array<(UnreadMetric, Fixnum, Hash)>] UnreadMetric data, response status code and response headers
92
+ def get_alerting_alerts_unread_with_http_info(opts = {})
93
+ if @api_client.config.debugging
94
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts_unread ..."
95
+ end
96
+
97
+ # resource path
98
+ path = "/api/v1/analytics/alerting/alerts/unread".sub('{format}','json')
99
+
100
+ # query parameters
101
+ query_params = {}
102
+
103
+ # header parameters
104
+ header_params = {}
105
+
106
+ # HTTP header 'Accept' (if needed)
107
+ _header_accept = ['application/json']
108
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
109
+
110
+ # HTTP header 'Content-Type'
111
+ _header_content_type = ['application/json']
112
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
113
+
114
+ # form parameters
115
+ form_params = {}
116
+
117
+ # http body (model)
118
+ post_body = nil
119
+
120
+
121
+ auth_names = ['PureCloud Auth']
122
+ data, status_code, headers = @api_client.call_api(:GET, path,
123
+ :header_params => header_params,
124
+ :query_params => query_params,
125
+ :form_params => form_params,
126
+ :body => post_body,
127
+ :auth_names => auth_names,
128
+ :return_type => 'UnreadMetric')
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alerts_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
131
+ end
132
+ return data, status_code, headers
133
+ end
134
+
135
+ # Get an alert.
136
+ #
137
+ # @param alert_id Alert ID
138
+ # @param [Hash] opts the optional parameters
139
+ # @return [Alert]
140
+ def get_alerting_alert(alert_id, opts = {})
141
+ data, status_code, headers = get_alerting_alert_with_http_info(alert_id, opts)
142
+ return data
143
+ end
144
+
145
+ # Get an alert.
146
+ #
147
+ # @param alert_id Alert ID
148
+ # @param [Hash] opts the optional parameters
149
+ # @return [Array<(Alert, Fixnum, Hash)>] Alert data, response status code and response headers
150
+ def get_alerting_alert_with_http_info(alert_id, opts = {})
151
+ if @api_client.config.debugging
152
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alert ..."
153
+ end
154
+
155
+ # verify the required parameter 'alert_id' is set
156
+ fail "Missing the required parameter 'alert_id' when calling get_alerting_alert" if alert_id.nil?
157
+
158
+ # resource path
159
+ path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)
160
+
161
+ # query parameters
162
+ query_params = {}
163
+
164
+ # header parameters
165
+ header_params = {}
166
+
167
+ # HTTP header 'Accept' (if needed)
168
+ _header_accept = ['application/json']
169
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
170
+
171
+ # HTTP header 'Content-Type'
172
+ _header_content_type = ['application/json']
173
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
174
+
175
+ # form parameters
176
+ form_params = {}
177
+
178
+ # http body (model)
179
+ post_body = nil
180
+
181
+
182
+ auth_names = ['PureCloud Auth']
183
+ data, status_code, headers = @api_client.call_api(:GET, path,
184
+ :header_params => header_params,
185
+ :query_params => query_params,
186
+ :form_params => form_params,
187
+ :body => post_body,
188
+ :auth_names => auth_names,
189
+ :return_type => 'Alert')
190
+ if @api_client.config.debugging
191
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
192
+ end
193
+ return data, status_code, headers
194
+ end
195
+
196
+ # Update an alerts unread status.
197
+ #
198
+ # @param alert_id Alert ID
199
+ # @param [Hash] opts the optional parameters
200
+ # @option opts [Alert] :body Alert
201
+ # @return [Alert]
202
+ def put_alerting_alert(alert_id, opts = {})
203
+ data, status_code, headers = put_alerting_alert_with_http_info(alert_id, opts)
204
+ return data
205
+ end
206
+
207
+ # Update an alerts unread status.
208
+ #
209
+ # @param alert_id Alert ID
210
+ # @param [Hash] opts the optional parameters
211
+ # @option opts [Alert] :body Alert
212
+ # @return [Array<(Alert, Fixnum, Hash)>] Alert data, response status code and response headers
213
+ def put_alerting_alert_with_http_info(alert_id, opts = {})
214
+ if @api_client.config.debugging
215
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#put_alerting_alert ..."
216
+ end
217
+
218
+ # verify the required parameter 'alert_id' is set
219
+ fail "Missing the required parameter 'alert_id' when calling put_alerting_alert" if alert_id.nil?
220
+
221
+ # resource path
222
+ path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)
223
+
224
+ # query parameters
225
+ query_params = {}
226
+
227
+ # header parameters
228
+ header_params = {}
229
+
230
+ # HTTP header 'Accept' (if needed)
231
+ _header_accept = ['application/json']
232
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
233
+
234
+ # HTTP header 'Content-Type'
235
+ _header_content_type = ['application/json']
236
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
237
+
238
+ # form parameters
239
+ form_params = {}
240
+
241
+ # http body (model)
242
+ post_body = @api_client.object_to_http_body(opts[:'body'])
243
+
244
+
245
+ auth_names = ['PureCloud Auth']
246
+ data, status_code, headers = @api_client.call_api(:PUT, path,
247
+ :header_params => header_params,
248
+ :query_params => query_params,
249
+ :form_params => form_params,
250
+ :body => post_body,
251
+ :auth_names => auth_names,
252
+ :return_type => 'Alert')
253
+ if @api_client.config.debugging
254
+ @api_client.config.logger.debug "API called: AnalyticsApi#put_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
255
+ end
256
+ return data, status_code, headers
257
+ end
258
+
259
+ # Delete an alert.
260
+ #
261
+ # @param alert_id Alert ID
262
+ # @param [Hash] opts the optional parameters
263
+ # @return [nil]
264
+ def delete_alerting_alert(alert_id, opts = {})
265
+ delete_alerting_alert_with_http_info(alert_id, opts)
266
+ return nil
267
+ end
268
+
269
+ # Delete an alert.
270
+ #
271
+ # @param alert_id Alert ID
272
+ # @param [Hash] opts the optional parameters
273
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
274
+ def delete_alerting_alert_with_http_info(alert_id, opts = {})
275
+ if @api_client.config.debugging
276
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_alert ..."
277
+ end
278
+
279
+ # verify the required parameter 'alert_id' is set
280
+ fail "Missing the required parameter 'alert_id' when calling delete_alerting_alert" if alert_id.nil?
281
+
282
+ # resource path
283
+ path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)
284
+
285
+ # query parameters
286
+ query_params = {}
287
+
288
+ # header parameters
289
+ header_params = {}
290
+
291
+ # HTTP header 'Accept' (if needed)
292
+ _header_accept = ['application/json']
293
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
294
+
295
+ # HTTP header 'Content-Type'
296
+ _header_content_type = ['application/json']
297
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
298
+
299
+ # form parameters
300
+ form_params = {}
301
+
302
+ # http body (model)
303
+ post_body = nil
304
+
305
+
306
+ auth_names = ['PureCloud Auth']
307
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
308
+ :header_params => header_params,
309
+ :query_params => query_params,
310
+ :form_params => form_params,
311
+ :body => post_body,
312
+ :auth_names => auth_names)
313
+ if @api_client.config.debugging
314
+ @api_client.config.logger.debug "API called: AnalyticsApi#delete_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
315
+ end
316
+ return data, status_code, headers
317
+ end
318
+
319
+ # Get a list of rules.
320
+ #
321
+ # @param [Hash] opts the optional parameters
322
+ # @option opts [Integer] :page_number Page number
323
+ # @option opts [Integer] :page_size Page size
324
+ # @option opts [String] :sort_by title, description, inAlarm or enabled
325
+ # @option opts [String] :sort_order ascending or descending
326
+ # @return [RuleEntityListing]
327
+ def get_alerting_rules(opts = {})
328
+ data, status_code, headers = get_alerting_rules_with_http_info(opts)
329
+ return data
330
+ end
331
+
332
+ # Get a list of rules.
333
+ #
334
+ # @param [Hash] opts the optional parameters
335
+ # @option opts [Integer] :page_number Page number
336
+ # @option opts [Integer] :page_size Page size
337
+ # @option opts [String] :sort_by title, description, inAlarm or enabled
338
+ # @option opts [String] :sort_order ascending or descending
339
+ # @return [Array<(RuleEntityListing, Fixnum, Hash)>] RuleEntityListing data, response status code and response headers
340
+ def get_alerting_rules_with_http_info(opts = {})
341
+ if @api_client.config.debugging
342
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rules ..."
343
+ end
344
+
345
+ # resource path
346
+ path = "/api/v1/analytics/alerting/rules".sub('{format}','json')
347
+
348
+ # query parameters
349
+ query_params = {}
350
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
351
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
352
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
353
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
354
+
355
+ # header parameters
356
+ header_params = {}
357
+
358
+ # HTTP header 'Accept' (if needed)
359
+ _header_accept = ['application/json']
360
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
361
+
362
+ # HTTP header 'Content-Type'
363
+ _header_content_type = ['application/json']
364
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
365
+
366
+ # form parameters
367
+ form_params = {}
368
+
369
+ # http body (model)
370
+ post_body = nil
371
+
372
+
373
+ auth_names = ['PureCloud Auth']
374
+ data, status_code, headers = @api_client.call_api(:GET, path,
375
+ :header_params => header_params,
376
+ :query_params => query_params,
377
+ :form_params => form_params,
378
+ :body => post_body,
379
+ :auth_names => auth_names,
380
+ :return_type => 'RuleEntityListing')
381
+ if @api_client.config.debugging
382
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
383
+ end
384
+ return data, status_code, headers
385
+ end
386
+
387
+ # Create an alerting rule.
388
+ #
389
+ # @param [Hash] opts the optional parameters
390
+ # @option opts [Rule] :body Rule
391
+ # @return [Rule]
392
+ def post_alerting_rules(opts = {})
393
+ data, status_code, headers = post_alerting_rules_with_http_info(opts)
394
+ return data
395
+ end
396
+
397
+ # Create an alerting rule.
398
+ #
399
+ # @param [Hash] opts the optional parameters
400
+ # @option opts [Rule] :body Rule
401
+ # @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
402
+ def post_alerting_rules_with_http_info(opts = {})
403
+ if @api_client.config.debugging
404
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_alerting_rules ..."
405
+ end
406
+
407
+ # resource path
408
+ path = "/api/v1/analytics/alerting/rules".sub('{format}','json')
409
+
410
+ # query parameters
411
+ query_params = {}
412
+
413
+ # header parameters
414
+ header_params = {}
415
+
416
+ # HTTP header 'Accept' (if needed)
417
+ _header_accept = ['application/json']
418
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
419
+
420
+ # HTTP header 'Content-Type'
421
+ _header_content_type = ['application/json']
422
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
423
+
424
+ # form parameters
425
+ form_params = {}
426
+
427
+ # http body (model)
428
+ post_body = @api_client.object_to_http_body(opts[:'body'])
429
+
430
+
431
+ auth_names = ['PureCloud Auth']
432
+ data, status_code, headers = @api_client.call_api(:POST, path,
433
+ :header_params => header_params,
434
+ :query_params => query_params,
435
+ :form_params => form_params,
436
+ :body => post_body,
437
+ :auth_names => auth_names,
438
+ :return_type => 'Rule')
439
+ if @api_client.config.debugging
440
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_alerting_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
441
+ end
442
+ return data, status_code, headers
443
+ end
444
+
445
+ # Get an alerting rule.
446
+ #
447
+ # @param rule_id Rule ID
448
+ # @param [Hash] opts the optional parameters
449
+ # @return [Rule]
450
+ def get_alerting_rule(rule_id, opts = {})
451
+ data, status_code, headers = get_alerting_rule_with_http_info(rule_id, opts)
452
+ return data
453
+ end
454
+
455
+ # Get an alerting rule.
456
+ #
457
+ # @param rule_id Rule ID
458
+ # @param [Hash] opts the optional parameters
459
+ # @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
460
+ def get_alerting_rule_with_http_info(rule_id, opts = {})
461
+ if @api_client.config.debugging
462
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rule ..."
463
+ end
464
+
465
+ # verify the required parameter 'rule_id' is set
466
+ fail "Missing the required parameter 'rule_id' when calling get_alerting_rule" if rule_id.nil?
467
+
468
+ # resource path
469
+ path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)
470
+
471
+ # query parameters
472
+ query_params = {}
473
+
474
+ # header parameters
475
+ header_params = {}
476
+
477
+ # HTTP header 'Accept' (if needed)
478
+ _header_accept = ['application/json']
479
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
480
+
481
+ # HTTP header 'Content-Type'
482
+ _header_content_type = ['application/json']
483
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
484
+
485
+ # form parameters
486
+ form_params = {}
487
+
488
+ # http body (model)
489
+ post_body = nil
490
+
491
+
492
+ auth_names = ['PureCloud Auth']
493
+ data, status_code, headers = @api_client.call_api(:GET, path,
494
+ :header_params => header_params,
495
+ :query_params => query_params,
496
+ :form_params => form_params,
497
+ :body => post_body,
498
+ :auth_names => auth_names,
499
+ :return_type => 'Rule')
500
+ if @api_client.config.debugging
501
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
502
+ end
503
+ return data, status_code, headers
504
+ end
505
+
506
+ # Update an alerting rule.
507
+ #
508
+ # @param rule_id Rule ID
509
+ # @param [Hash] opts the optional parameters
510
+ # @option opts [Rule] :body Rule
511
+ # @return [Rule]
512
+ def put_alerting_rule(rule_id, opts = {})
513
+ data, status_code, headers = put_alerting_rule_with_http_info(rule_id, opts)
514
+ return data
515
+ end
516
+
517
+ # Update an alerting rule.
518
+ #
519
+ # @param rule_id Rule ID
520
+ # @param [Hash] opts the optional parameters
521
+ # @option opts [Rule] :body Rule
522
+ # @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
523
+ def put_alerting_rule_with_http_info(rule_id, opts = {})
524
+ if @api_client.config.debugging
525
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#put_alerting_rule ..."
526
+ end
527
+
528
+ # verify the required parameter 'rule_id' is set
529
+ fail "Missing the required parameter 'rule_id' when calling put_alerting_rule" if rule_id.nil?
530
+
531
+ # resource path
532
+ path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)
533
+
534
+ # query parameters
535
+ query_params = {}
536
+
537
+ # header parameters
538
+ header_params = {}
539
+
540
+ # HTTP header 'Accept' (if needed)
541
+ _header_accept = ['application/json']
542
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
543
+
544
+ # HTTP header 'Content-Type'
545
+ _header_content_type = ['application/json']
546
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
547
+
548
+ # form parameters
549
+ form_params = {}
550
+
551
+ # http body (model)
552
+ post_body = @api_client.object_to_http_body(opts[:'body'])
553
+
554
+
555
+ auth_names = ['PureCloud Auth']
556
+ data, status_code, headers = @api_client.call_api(:PUT, path,
557
+ :header_params => header_params,
558
+ :query_params => query_params,
559
+ :form_params => form_params,
560
+ :body => post_body,
561
+ :auth_names => auth_names,
562
+ :return_type => 'Rule')
563
+ if @api_client.config.debugging
564
+ @api_client.config.logger.debug "API called: AnalyticsApi#put_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
565
+ end
566
+ return data, status_code, headers
567
+ end
568
+
569
+ # Delete an alerting rule.
570
+ #
571
+ # @param rule_id Rule ID
572
+ # @param [Hash] opts the optional parameters
573
+ # @return [nil]
574
+ def delete_alerting_rule(rule_id, opts = {})
575
+ delete_alerting_rule_with_http_info(rule_id, opts)
576
+ return nil
577
+ end
578
+
579
+ # Delete an alerting rule.
580
+ #
581
+ # @param rule_id Rule ID
582
+ # @param [Hash] opts the optional parameters
583
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
584
+ def delete_alerting_rule_with_http_info(rule_id, opts = {})
585
+ if @api_client.config.debugging
586
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_rule ..."
587
+ end
588
+
589
+ # verify the required parameter 'rule_id' is set
590
+ fail "Missing the required parameter 'rule_id' when calling delete_alerting_rule" if rule_id.nil?
591
+
592
+ # resource path
593
+ path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)
594
+
595
+ # query parameters
596
+ query_params = {}
597
+
598
+ # header parameters
599
+ header_params = {}
600
+
601
+ # HTTP header 'Accept' (if needed)
602
+ _header_accept = ['application/json']
603
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
604
+
605
+ # HTTP header 'Content-Type'
606
+ _header_content_type = ['application/json']
607
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
608
+
609
+ # form parameters
610
+ form_params = {}
611
+
612
+ # http body (model)
613
+ post_body = nil
614
+
615
+
616
+ auth_names = ['PureCloud Auth']
617
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
618
+ :header_params => header_params,
619
+ :query_params => query_params,
620
+ :form_params => form_params,
621
+ :body => post_body,
622
+ :auth_names => auth_names)
623
+ if @api_client.config.debugging
624
+ @api_client.config.logger.debug "API called: AnalyticsApi#delete_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
625
+ end
626
+ return data, status_code, headers
627
+ end
628
+
629
+ # Executes a metrics query against the analytics service
630
+ #
631
+ # @param [Hash] opts the optional parameters
632
+ # @option opts [Body] :body queryObject
633
+ # @return [nil]
634
+ def post_metrics_query(opts = {})
635
+ post_metrics_query_with_http_info(opts)
636
+ return nil
637
+ end
638
+
639
+ # Executes a metrics query against the analytics service
640
+ #
641
+ # @param [Hash] opts the optional parameters
642
+ # @option opts [Body] :body queryObject
643
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
644
+ def post_metrics_query_with_http_info(opts = {})
645
+ if @api_client.config.debugging
646
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_metrics_query ..."
647
+ end
648
+
649
+ # resource path
650
+ path = "/api/v1/analytics/metrics/query".sub('{format}','json')
651
+
652
+ # query parameters
653
+ query_params = {}
654
+
655
+ # header parameters
656
+ header_params = {}
657
+
658
+ # HTTP header 'Accept' (if needed)
659
+ _header_accept = ['application/json']
660
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
661
+
662
+ # HTTP header 'Content-Type'
663
+ _header_content_type = ['application/json']
664
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
665
+
666
+ # form parameters
667
+ form_params = {}
668
+
669
+ # http body (model)
670
+ post_body = @api_client.object_to_http_body(opts[:'body'])
671
+
672
+
673
+ auth_names = ['PureCloud Auth']
674
+ data, status_code, headers = @api_client.call_api(:POST, path,
675
+ :header_params => header_params,
676
+ :query_params => query_params,
677
+ :form_params => form_params,
678
+ :body => post_body,
679
+ :auth_names => auth_names)
680
+ if @api_client.config.debugging
681
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_metrics_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
682
+ end
683
+ return data, status_code, headers
684
+ end
685
+
686
+ # Get list of reporting metadata.
687
+ #
688
+ # @param [Hash] opts the optional parameters
689
+ # @option opts [Integer] :page_number Page number
690
+ # @option opts [Integer] :page_size Page size
691
+ # @option opts [String] :accept_language Accepted language
692
+ # @option opts [String] :locale Locale
693
+ # @return [ReportMetaDataEntityListing]
694
+ def get_reporting_metadata(opts = {})
695
+ data, status_code, headers = get_reporting_metadata_with_http_info(opts)
696
+ return data
697
+ end
698
+
699
+ # Get list of reporting metadata.
700
+ #
701
+ # @param [Hash] opts the optional parameters
702
+ # @option opts [Integer] :page_number Page number
703
+ # @option opts [Integer] :page_size Page size
704
+ # @option opts [String] :accept_language Accepted language
705
+ # @option opts [String] :locale Locale
706
+ # @return [Array<(ReportMetaDataEntityListing, Fixnum, Hash)>] ReportMetaDataEntityListing data, response status code and response headers
707
+ def get_reporting_metadata_with_http_info(opts = {})
708
+ if @api_client.config.debugging
709
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_metadata ..."
710
+ end
711
+
712
+ # resource path
713
+ path = "/api/v1/analytics/reporting/metadata".sub('{format}','json')
714
+
715
+ # query parameters
716
+ query_params = {}
717
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
718
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
719
+ query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
720
+
721
+ # header parameters
722
+ header_params = {}
723
+
724
+ # HTTP header 'Accept' (if needed)
725
+ _header_accept = ['application/json']
726
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
727
+
728
+ # HTTP header 'Content-Type'
729
+ _header_content_type = ['application/json']
730
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
731
+ header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']
732
+
733
+ # form parameters
734
+ form_params = {}
735
+
736
+ # http body (model)
737
+ post_body = nil
738
+
739
+
740
+ auth_names = ['PureCloud Auth']
741
+ data, status_code, headers = @api_client.call_api(:GET, path,
742
+ :header_params => header_params,
743
+ :query_params => query_params,
744
+ :form_params => form_params,
745
+ :body => post_body,
746
+ :auth_names => auth_names,
747
+ :return_type => 'ReportMetaDataEntityListing')
748
+ if @api_client.config.debugging
749
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
750
+ end
751
+ return data, status_code, headers
752
+ end
753
+
754
+ # Get a list of report formats
755
+ # Get a list of report formats.
756
+ # @param [Hash] opts the optional parameters
757
+ # @return [Array<String>]
758
+ def get_reporting_reportformats(opts = {})
759
+ data, status_code, headers = get_reporting_reportformats_with_http_info(opts)
760
+ return data
761
+ end
762
+
763
+ # Get a list of report formats
764
+ # Get a list of report formats.
765
+ # @param [Hash] opts the optional parameters
766
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
767
+ def get_reporting_reportformats_with_http_info(opts = {})
768
+ if @api_client.config.debugging
769
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_reportformats ..."
770
+ end
771
+
772
+ # resource path
773
+ path = "/api/v1/analytics/reporting/reportformats".sub('{format}','json')
774
+
775
+ # query parameters
776
+ query_params = {}
777
+
778
+ # header parameters
779
+ header_params = {}
780
+
781
+ # HTTP header 'Accept' (if needed)
782
+ _header_accept = ['application/json']
783
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
784
+
785
+ # HTTP header 'Content-Type'
786
+ _header_content_type = ['application/json']
787
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
788
+
789
+ # form parameters
790
+ form_params = {}
791
+
792
+ # http body (model)
793
+ post_body = nil
794
+
795
+
796
+ auth_names = ['PureCloud Auth']
797
+ data, status_code, headers = @api_client.call_api(:GET, path,
798
+ :header_params => header_params,
799
+ :query_params => query_params,
800
+ :form_params => form_params,
801
+ :body => post_body,
802
+ :auth_names => auth_names,
803
+ :return_type => 'Array<String>')
804
+ if @api_client.config.debugging
805
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_reportformats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
806
+ end
807
+ return data, status_code, headers
808
+ end
809
+
810
+ # Get a list of scheduled report jobs
811
+ # Get a list of scheduled report jobs.
812
+ # @param [Hash] opts the optional parameters
813
+ # @option opts [Integer] :page_number Page number
814
+ # @option opts [Integer] :page_size Page size
815
+ # @return [ReportScheduleEntityListing]
816
+ def get_reporting_schedules(opts = {})
817
+ data, status_code, headers = get_reporting_schedules_with_http_info(opts)
818
+ return data
819
+ end
820
+
821
+ # Get a list of scheduled report jobs
822
+ # Get a list of scheduled report jobs.
823
+ # @param [Hash] opts the optional parameters
824
+ # @option opts [Integer] :page_number Page number
825
+ # @option opts [Integer] :page_size Page size
826
+ # @return [Array<(ReportScheduleEntityListing, Fixnum, Hash)>] ReportScheduleEntityListing data, response status code and response headers
827
+ def get_reporting_schedules_with_http_info(opts = {})
828
+ if @api_client.config.debugging
829
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules ..."
830
+ end
831
+
832
+ # resource path
833
+ path = "/api/v1/analytics/reporting/schedules".sub('{format}','json')
834
+
835
+ # query parameters
836
+ query_params = {}
837
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
838
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
839
+
840
+ # header parameters
841
+ header_params = {}
842
+
843
+ # HTTP header 'Accept' (if needed)
844
+ _header_accept = ['application/json']
845
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
846
+
847
+ # HTTP header 'Content-Type'
848
+ _header_content_type = ['application/json']
849
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
850
+
851
+ # form parameters
852
+ form_params = {}
853
+
854
+ # http body (model)
855
+ post_body = nil
856
+
857
+
858
+ auth_names = ['PureCloud Auth']
859
+ data, status_code, headers = @api_client.call_api(:GET, path,
860
+ :header_params => header_params,
861
+ :query_params => query_params,
862
+ :form_params => form_params,
863
+ :body => post_body,
864
+ :auth_names => auth_names,
865
+ :return_type => 'ReportScheduleEntityListing')
866
+ if @api_client.config.debugging
867
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
868
+ end
869
+ return data, status_code, headers
870
+ end
871
+
872
+ # Create a scheduled report job
873
+ # Create a scheduled report job.
874
+ # @param [Hash] opts the optional parameters
875
+ # @option opts [ReportSchedule] :body ReportSchedule
876
+ # @return [ReportSchedule]
877
+ def post_reporting_schedules(opts = {})
878
+ data, status_code, headers = post_reporting_schedules_with_http_info(opts)
879
+ return data
880
+ end
881
+
882
+ # Create a scheduled report job
883
+ # Create a scheduled report job.
884
+ # @param [Hash] opts the optional parameters
885
+ # @option opts [ReportSchedule] :body ReportSchedule
886
+ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
887
+ def post_reporting_schedules_with_http_info(opts = {})
888
+ if @api_client.config.debugging
889
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_reporting_schedules ..."
890
+ end
891
+
892
+ # resource path
893
+ path = "/api/v1/analytics/reporting/schedules".sub('{format}','json')
894
+
895
+ # query parameters
896
+ query_params = {}
897
+
898
+ # header parameters
899
+ header_params = {}
900
+
901
+ # HTTP header 'Accept' (if needed)
902
+ _header_accept = ['application/json']
903
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
904
+
905
+ # HTTP header 'Content-Type'
906
+ _header_content_type = ['application/json']
907
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
908
+
909
+ # form parameters
910
+ form_params = {}
911
+
912
+ # http body (model)
913
+ post_body = @api_client.object_to_http_body(opts[:'body'])
914
+
915
+
916
+ auth_names = ['PureCloud Auth']
917
+ data, status_code, headers = @api_client.call_api(:POST, path,
918
+ :header_params => header_params,
919
+ :query_params => query_params,
920
+ :form_params => form_params,
921
+ :body => post_body,
922
+ :auth_names => auth_names,
923
+ :return_type => 'ReportSchedule')
924
+ if @api_client.config.debugging
925
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
926
+ end
927
+ return data, status_code, headers
928
+ end
929
+
930
+ # Get a scheduled report job.
931
+ #
932
+ # @param schedule_id Schedule ID
933
+ # @param [Hash] opts the optional parameters
934
+ # @return [ReportSchedule]
935
+ def get_reporting_schedule(schedule_id, opts = {})
936
+ data, status_code, headers = get_reporting_schedule_with_http_info(schedule_id, opts)
937
+ return data
938
+ end
939
+
940
+ # Get a scheduled report job.
941
+ #
942
+ # @param schedule_id Schedule ID
943
+ # @param [Hash] opts the optional parameters
944
+ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
945
+ def get_reporting_schedule_with_http_info(schedule_id, opts = {})
946
+ if @api_client.config.debugging
947
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule ..."
948
+ end
949
+
950
+ # verify the required parameter 'schedule_id' is set
951
+ fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule" if schedule_id.nil?
952
+
953
+ # resource path
954
+ path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
955
+
956
+ # query parameters
957
+ query_params = {}
958
+
959
+ # header parameters
960
+ header_params = {}
961
+
962
+ # HTTP header 'Accept' (if needed)
963
+ _header_accept = ['application/json']
964
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
965
+
966
+ # HTTP header 'Content-Type'
967
+ _header_content_type = ['application/json']
968
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
969
+
970
+ # form parameters
971
+ form_params = {}
972
+
973
+ # http body (model)
974
+ post_body = nil
975
+
976
+
977
+ auth_names = ['PureCloud Auth']
978
+ data, status_code, headers = @api_client.call_api(:GET, path,
979
+ :header_params => header_params,
980
+ :query_params => query_params,
981
+ :form_params => form_params,
982
+ :body => post_body,
983
+ :auth_names => auth_names,
984
+ :return_type => 'ReportSchedule')
985
+ if @api_client.config.debugging
986
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
987
+ end
988
+ return data, status_code, headers
989
+ end
990
+
991
+ # Update a scheduled report job.
992
+ #
993
+ # @param schedule_id Schedule ID
994
+ # @param [Hash] opts the optional parameters
995
+ # @option opts [ReportSchedule] :body ReportSchedule
996
+ # @return [ReportSchedule]
997
+ def put_reporting_schedule(schedule_id, opts = {})
998
+ data, status_code, headers = put_reporting_schedule_with_http_info(schedule_id, opts)
999
+ return data
1000
+ end
1001
+
1002
+ # Update a scheduled report job.
1003
+ #
1004
+ # @param schedule_id Schedule ID
1005
+ # @param [Hash] opts the optional parameters
1006
+ # @option opts [ReportSchedule] :body ReportSchedule
1007
+ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
1008
+ def put_reporting_schedule_with_http_info(schedule_id, opts = {})
1009
+ if @api_client.config.debugging
1010
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#put_reporting_schedule ..."
1011
+ end
1012
+
1013
+ # verify the required parameter 'schedule_id' is set
1014
+ fail "Missing the required parameter 'schedule_id' when calling put_reporting_schedule" if schedule_id.nil?
1015
+
1016
+ # resource path
1017
+ path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1018
+
1019
+ # query parameters
1020
+ query_params = {}
1021
+
1022
+ # header parameters
1023
+ header_params = {}
1024
+
1025
+ # HTTP header 'Accept' (if needed)
1026
+ _header_accept = ['application/json']
1027
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1028
+
1029
+ # HTTP header 'Content-Type'
1030
+ _header_content_type = ['application/json']
1031
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1032
+
1033
+ # form parameters
1034
+ form_params = {}
1035
+
1036
+ # http body (model)
1037
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1038
+
1039
+
1040
+ auth_names = ['PureCloud Auth']
1041
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1042
+ :header_params => header_params,
1043
+ :query_params => query_params,
1044
+ :form_params => form_params,
1045
+ :body => post_body,
1046
+ :auth_names => auth_names,
1047
+ :return_type => 'ReportSchedule')
1048
+ if @api_client.config.debugging
1049
+ @api_client.config.logger.debug "API called: AnalyticsApi#put_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1050
+ end
1051
+ return data, status_code, headers
1052
+ end
1053
+
1054
+ # Delete a scheduled report job.
1055
+ #
1056
+ # @param schedule_id Schedule ID
1057
+ # @param [Hash] opts the optional parameters
1058
+ # @return [String]
1059
+ def delete_reporting_schedule(schedule_id, opts = {})
1060
+ data, status_code, headers = delete_reporting_schedule_with_http_info(schedule_id, opts)
1061
+ return data
1062
+ end
1063
+
1064
+ # Delete a scheduled report job.
1065
+ #
1066
+ # @param schedule_id Schedule ID
1067
+ # @param [Hash] opts the optional parameters
1068
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1069
+ def delete_reporting_schedule_with_http_info(schedule_id, opts = {})
1070
+ if @api_client.config.debugging
1071
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_reporting_schedule ..."
1072
+ end
1073
+
1074
+ # verify the required parameter 'schedule_id' is set
1075
+ fail "Missing the required parameter 'schedule_id' when calling delete_reporting_schedule" if schedule_id.nil?
1076
+
1077
+ # resource path
1078
+ path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1079
+
1080
+ # query parameters
1081
+ query_params = {}
1082
+
1083
+ # header parameters
1084
+ header_params = {}
1085
+
1086
+ # HTTP header 'Accept' (if needed)
1087
+ _header_accept = ['application/json']
1088
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1089
+
1090
+ # HTTP header 'Content-Type'
1091
+ _header_content_type = ['application/json']
1092
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1093
+
1094
+ # form parameters
1095
+ form_params = {}
1096
+
1097
+ # http body (model)
1098
+ post_body = nil
1099
+
1100
+
1101
+ auth_names = ['PureCloud Auth']
1102
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1103
+ :header_params => header_params,
1104
+ :query_params => query_params,
1105
+ :form_params => form_params,
1106
+ :body => post_body,
1107
+ :auth_names => auth_names,
1108
+ :return_type => 'String')
1109
+ if @api_client.config.debugging
1110
+ @api_client.config.logger.debug "API called: AnalyticsApi#delete_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1111
+ end
1112
+ return data, status_code, headers
1113
+ end
1114
+
1115
+ # Get list of completed scheduled report jobs.
1116
+ #
1117
+ # @param schedule_id Schedule ID
1118
+ # @param [Hash] opts the optional parameters
1119
+ # @option opts [Integer] :page_number
1120
+ # @option opts [Integer] :page_size
1121
+ # @return [ReportRunEntryEntityDomainListing]
1122
+ def get_reporting_schedule_history(schedule_id, opts = {})
1123
+ data, status_code, headers = get_reporting_schedule_history_with_http_info(schedule_id, opts)
1124
+ return data
1125
+ end
1126
+
1127
+ # Get list of completed scheduled report jobs.
1128
+ #
1129
+ # @param schedule_id Schedule ID
1130
+ # @param [Hash] opts the optional parameters
1131
+ # @option opts [Integer] :page_number
1132
+ # @option opts [Integer] :page_size
1133
+ # @return [Array<(ReportRunEntryEntityDomainListing, Fixnum, Hash)>] ReportRunEntryEntityDomainListing data, response status code and response headers
1134
+ def get_reporting_schedule_history_with_http_info(schedule_id, opts = {})
1135
+ if @api_client.config.debugging
1136
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history ..."
1137
+ end
1138
+
1139
+ # verify the required parameter 'schedule_id' is set
1140
+ fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history" if schedule_id.nil?
1141
+
1142
+ # resource path
1143
+ path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1144
+
1145
+ # query parameters
1146
+ query_params = {}
1147
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1148
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1149
+
1150
+ # header parameters
1151
+ header_params = {}
1152
+
1153
+ # HTTP header 'Accept' (if needed)
1154
+ _header_accept = ['application/json']
1155
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1156
+
1157
+ # HTTP header 'Content-Type'
1158
+ _header_content_type = ['application/json']
1159
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1160
+
1161
+ # form parameters
1162
+ form_params = {}
1163
+
1164
+ # http body (model)
1165
+ post_body = nil
1166
+
1167
+
1168
+ auth_names = ['PureCloud Auth']
1169
+ data, status_code, headers = @api_client.call_api(:GET, path,
1170
+ :header_params => header_params,
1171
+ :query_params => query_params,
1172
+ :form_params => form_params,
1173
+ :body => post_body,
1174
+ :auth_names => auth_names,
1175
+ :return_type => 'ReportRunEntryEntityDomainListing')
1176
+ if @api_client.config.debugging
1177
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1178
+ end
1179
+ return data, status_code, headers
1180
+ end
1181
+
1182
+ # Get most recently completed scheduled report job.
1183
+ #
1184
+ # @param schedule_id Schedule ID
1185
+ # @param [Hash] opts the optional parameters
1186
+ # @return [ReportRunEntry]
1187
+ def get_reporting_schedule_history_latest(schedule_id, opts = {})
1188
+ data, status_code, headers = get_reporting_schedule_history_latest_with_http_info(schedule_id, opts)
1189
+ return data
1190
+ end
1191
+
1192
+ # Get most recently completed scheduled report job.
1193
+ #
1194
+ # @param schedule_id Schedule ID
1195
+ # @param [Hash] opts the optional parameters
1196
+ # @return [Array<(ReportRunEntry, Fixnum, Hash)>] ReportRunEntry data, response status code and response headers
1197
+ def get_reporting_schedule_history_latest_with_http_info(schedule_id, opts = {})
1198
+ if @api_client.config.debugging
1199
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history_latest ..."
1200
+ end
1201
+
1202
+ # verify the required parameter 'schedule_id' is set
1203
+ fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history_latest" if schedule_id.nil?
1204
+
1205
+ # resource path
1206
+ path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history/latest".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1207
+
1208
+ # query parameters
1209
+ query_params = {}
1210
+
1211
+ # header parameters
1212
+ header_params = {}
1213
+
1214
+ # HTTP header 'Accept' (if needed)
1215
+ _header_accept = ['application/json']
1216
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1217
+
1218
+ # HTTP header 'Content-Type'
1219
+ _header_content_type = ['application/json']
1220
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1221
+
1222
+ # form parameters
1223
+ form_params = {}
1224
+
1225
+ # http body (model)
1226
+ post_body = nil
1227
+
1228
+
1229
+ auth_names = ['PureCloud Auth']
1230
+ data, status_code, headers = @api_client.call_api(:GET, path,
1231
+ :header_params => header_params,
1232
+ :query_params => query_params,
1233
+ :form_params => form_params,
1234
+ :body => post_body,
1235
+ :auth_names => auth_names,
1236
+ :return_type => 'ReportRunEntry')
1237
+ if @api_client.config.debugging
1238
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history_latest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1239
+ end
1240
+ return data, status_code, headers
1241
+ end
1242
+
1243
+ # A completed scheduled report job
1244
+ # A completed scheduled report job.
1245
+ # @param run_id Run ID
1246
+ # @param schedule_id Schedule ID
1247
+ # @param [Hash] opts the optional parameters
1248
+ # @return [ReportRunEntry]
1249
+ def get_reporting_schedule_history_0(run_id, schedule_id, opts = {})
1250
+ data, status_code, headers = get_reporting_schedule_history_0_with_http_info(run_id, schedule_id, opts)
1251
+ return data
1252
+ end
1253
+
1254
+ # A completed scheduled report job
1255
+ # A completed scheduled report job.
1256
+ # @param run_id Run ID
1257
+ # @param schedule_id Schedule ID
1258
+ # @param [Hash] opts the optional parameters
1259
+ # @return [Array<(ReportRunEntry, Fixnum, Hash)>] ReportRunEntry data, response status code and response headers
1260
+ def get_reporting_schedule_history_0_with_http_info(run_id, schedule_id, opts = {})
1261
+ if @api_client.config.debugging
1262
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history_0 ..."
1263
+ end
1264
+
1265
+ # verify the required parameter 'run_id' is set
1266
+ fail "Missing the required parameter 'run_id' when calling get_reporting_schedule_history_0" if run_id.nil?
1267
+
1268
+ # verify the required parameter 'schedule_id' is set
1269
+ fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history_0" if schedule_id.nil?
1270
+
1271
+ # resource path
1272
+ path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history/{runId}".sub('{format}','json').sub('{' + 'runId' + '}', run_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1273
+
1274
+ # query parameters
1275
+ query_params = {}
1276
+
1277
+ # header parameters
1278
+ header_params = {}
1279
+
1280
+ # HTTP header 'Accept' (if needed)
1281
+ _header_accept = ['application/json']
1282
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1283
+
1284
+ # HTTP header 'Content-Type'
1285
+ _header_content_type = ['application/json']
1286
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1287
+
1288
+ # form parameters
1289
+ form_params = {}
1290
+
1291
+ # http body (model)
1292
+ post_body = nil
1293
+
1294
+
1295
+ auth_names = ['PureCloud Auth']
1296
+ data, status_code, headers = @api_client.call_api(:GET, path,
1297
+ :header_params => header_params,
1298
+ :query_params => query_params,
1299
+ :form_params => form_params,
1300
+ :body => post_body,
1301
+ :auth_names => auth_names,
1302
+ :return_type => 'ReportRunEntry')
1303
+ if @api_client.config.debugging
1304
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1305
+ end
1306
+ return data, status_code, headers
1307
+ end
1308
+
1309
+ # Place a scheduled report immediately into the reporting queue
1310
+ #
1311
+ # @param schedule_id Schedule ID
1312
+ # @param [Hash] opts the optional parameters
1313
+ # @return [RunNowResponse]
1314
+ def post_reporting_schedule_runreport(schedule_id, opts = {})
1315
+ data, status_code, headers = post_reporting_schedule_runreport_with_http_info(schedule_id, opts)
1316
+ return data
1317
+ end
1318
+
1319
+ # Place a scheduled report immediately into the reporting queue
1320
+ #
1321
+ # @param schedule_id Schedule ID
1322
+ # @param [Hash] opts the optional parameters
1323
+ # @return [Array<(RunNowResponse, Fixnum, Hash)>] RunNowResponse data, response status code and response headers
1324
+ def post_reporting_schedule_runreport_with_http_info(schedule_id, opts = {})
1325
+ if @api_client.config.debugging
1326
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_reporting_schedule_runreport ..."
1327
+ end
1328
+
1329
+ # verify the required parameter 'schedule_id' is set
1330
+ fail "Missing the required parameter 'schedule_id' when calling post_reporting_schedule_runreport" if schedule_id.nil?
1331
+
1332
+ # resource path
1333
+ path = "/api/v1/analytics/reporting/schedules/{scheduleId}/runreport".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1334
+
1335
+ # query parameters
1336
+ query_params = {}
1337
+
1338
+ # header parameters
1339
+ header_params = {}
1340
+
1341
+ # HTTP header 'Accept' (if needed)
1342
+ _header_accept = ['application/json']
1343
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1344
+
1345
+ # HTTP header 'Content-Type'
1346
+ _header_content_type = ['application/json']
1347
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1348
+
1349
+ # form parameters
1350
+ form_params = {}
1351
+
1352
+ # http body (model)
1353
+ post_body = nil
1354
+
1355
+
1356
+ auth_names = ['PureCloud Auth']
1357
+ data, status_code, headers = @api_client.call_api(:POST, path,
1358
+ :header_params => header_params,
1359
+ :query_params => query_params,
1360
+ :form_params => form_params,
1361
+ :body => post_body,
1362
+ :auth_names => auth_names,
1363
+ :return_type => 'RunNowResponse')
1364
+ if @api_client.config.debugging
1365
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_reporting_schedule_runreport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1366
+ end
1367
+ return data, status_code, headers
1368
+ end
1369
+
1370
+ # Get a list of report time periods.
1371
+ #
1372
+ # @param [Hash] opts the optional parameters
1373
+ # @return [Array<String>]
1374
+ def get_reporting_timeperiods(opts = {})
1375
+ data, status_code, headers = get_reporting_timeperiods_with_http_info(opts)
1376
+ return data
1377
+ end
1378
+
1379
+ # Get a list of report time periods.
1380
+ #
1381
+ # @param [Hash] opts the optional parameters
1382
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
1383
+ def get_reporting_timeperiods_with_http_info(opts = {})
1384
+ if @api_client.config.debugging
1385
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_timeperiods ..."
1386
+ end
1387
+
1388
+ # resource path
1389
+ path = "/api/v1/analytics/reporting/timeperiods".sub('{format}','json')
1390
+
1391
+ # query parameters
1392
+ query_params = {}
1393
+
1394
+ # header parameters
1395
+ header_params = {}
1396
+
1397
+ # HTTP header 'Accept' (if needed)
1398
+ _header_accept = ['application/json']
1399
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1400
+
1401
+ # HTTP header 'Content-Type'
1402
+ _header_content_type = ['application/json']
1403
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1404
+
1405
+ # form parameters
1406
+ form_params = {}
1407
+
1408
+ # http body (model)
1409
+ post_body = nil
1410
+
1411
+
1412
+ auth_names = ['PureCloud Auth']
1413
+ data, status_code, headers = @api_client.call_api(:GET, path,
1414
+ :header_params => header_params,
1415
+ :query_params => query_params,
1416
+ :form_params => form_params,
1417
+ :body => post_body,
1418
+ :auth_names => auth_names,
1419
+ :return_type => 'Array<String>')
1420
+ if @api_client.config.debugging
1421
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_timeperiods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1422
+ end
1423
+ return data, status_code, headers
1424
+ end
1425
+
1426
+ # Get a reporting metadata.
1427
+ #
1428
+ # @param report_id Report ID
1429
+ # @param [Hash] opts the optional parameters
1430
+ # @option opts [String] :accept_language Accepted language
1431
+ # @option opts [String] :locale Locale
1432
+ # @return [ReportMetaData]
1433
+ def get_reporting_metadata_0(report_id, opts = {})
1434
+ data, status_code, headers = get_reporting_metadata_0_with_http_info(report_id, opts)
1435
+ return data
1436
+ end
1437
+
1438
+ # Get a reporting metadata.
1439
+ #
1440
+ # @param report_id Report ID
1441
+ # @param [Hash] opts the optional parameters
1442
+ # @option opts [String] :accept_language Accepted language
1443
+ # @option opts [String] :locale Locale
1444
+ # @return [Array<(ReportMetaData, Fixnum, Hash)>] ReportMetaData data, response status code and response headers
1445
+ def get_reporting_metadata_0_with_http_info(report_id, opts = {})
1446
+ if @api_client.config.debugging
1447
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_metadata_0 ..."
1448
+ end
1449
+
1450
+ # verify the required parameter 'report_id' is set
1451
+ fail "Missing the required parameter 'report_id' when calling get_reporting_metadata_0" if report_id.nil?
1452
+
1453
+ # resource path
1454
+ path = "/api/v1/analytics/reporting/{reportId}/metadata".sub('{format}','json').sub('{' + 'reportId' + '}', report_id.to_s)
1455
+
1456
+ # query parameters
1457
+ query_params = {}
1458
+ query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
1459
+
1460
+ # header parameters
1461
+ header_params = {}
1462
+
1463
+ # HTTP header 'Accept' (if needed)
1464
+ _header_accept = ['application/json']
1465
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1466
+
1467
+ # HTTP header 'Content-Type'
1468
+ _header_content_type = ['application/json']
1469
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1470
+ header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']
1471
+
1472
+ # form parameters
1473
+ form_params = {}
1474
+
1475
+ # http body (model)
1476
+ post_body = nil
1477
+
1478
+
1479
+ auth_names = ['PureCloud Auth']
1480
+ data, status_code, headers = @api_client.call_api(:GET, path,
1481
+ :header_params => header_params,
1482
+ :query_params => query_params,
1483
+ :form_params => form_params,
1484
+ :body => post_body,
1485
+ :auth_names => auth_names,
1486
+ :return_type => 'ReportMetaData')
1487
+ if @api_client.config.debugging
1488
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_metadata_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1489
+ end
1490
+ return data, status_code, headers
1491
+ end
1492
+
1493
+ # Executes a segments query against the analytics service
1494
+ #
1495
+ # @param [Hash] opts the optional parameters
1496
+ # @option opts [Body1] :body queryObject
1497
+ # @return [nil]
1498
+ def post_segments_query(opts = {})
1499
+ post_segments_query_with_http_info(opts)
1500
+ return nil
1501
+ end
1502
+
1503
+ # Executes a segments query against the analytics service
1504
+ #
1505
+ # @param [Hash] opts the optional parameters
1506
+ # @option opts [Body1] :body queryObject
1507
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1508
+ def post_segments_query_with_http_info(opts = {})
1509
+ if @api_client.config.debugging
1510
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_segments_query ..."
1511
+ end
1512
+
1513
+ # resource path
1514
+ path = "/api/v1/analytics/segments/query".sub('{format}','json')
1515
+
1516
+ # query parameters
1517
+ query_params = {}
1518
+
1519
+ # header parameters
1520
+ header_params = {}
1521
+
1522
+ # HTTP header 'Accept' (if needed)
1523
+ _header_accept = ['application/json']
1524
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1525
+
1526
+ # HTTP header 'Content-Type'
1527
+ _header_content_type = ['application/json']
1528
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1529
+
1530
+ # form parameters
1531
+ form_params = {}
1532
+
1533
+ # http body (model)
1534
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1535
+
1536
+
1537
+ auth_names = ['PureCloud Auth']
1538
+ data, status_code, headers = @api_client.call_api(:POST, path,
1539
+ :header_params => header_params,
1540
+ :query_params => query_params,
1541
+ :form_params => form_params,
1542
+ :body => post_body,
1543
+ :auth_names => auth_names)
1544
+ if @api_client.config.debugging
1545
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_segments_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1546
+ end
1547
+ return data, status_code, headers
1548
+ end
1549
+ end
1550
+ end
1551
+
1552
+
1553
+
1554
+