purecloud 0.27.0 → 0.28.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (269) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -0
  3. data/config-ruby.json +1 -1
  4. data/extensions/auth.rb +7 -0
  5. data/lib/purecloud.rb +137 -85
  6. data/lib/purecloud/api/analytics_api.rb +1906 -0
  7. data/lib/purecloud/api/architect_api.rb +51 -51
  8. data/lib/purecloud/api/attributes_api.rb +6 -6
  9. data/lib/purecloud/api/authorization_api.rb +17 -79
  10. data/lib/purecloud/api/callbacks_api.rb +483 -0
  11. data/lib/purecloud/api/calls_api.rb +1088 -0
  12. data/lib/purecloud/api/chats_api.rb +483 -0
  13. data/lib/purecloud/api/compliance_api.rb +2 -2
  14. data/lib/purecloud/api/configuration_api.rb +83 -83
  15. data/lib/purecloud/api/content_management_api.rb +36 -36
  16. data/lib/purecloud/api/conversations_api.rb +3542 -465
  17. data/lib/purecloud/api/downloads_api.rb +2 -2
  18. data/lib/purecloud/api/emails_api.rb +1013 -0
  19. data/lib/purecloud/api/evaluations_api.rb +73 -0
  20. data/lib/purecloud/api/external_contacts_api.rb +26 -26
  21. data/lib/purecloud/api/fax_api.rb +6 -6
  22. data/lib/purecloud/api/faxes_api.rb +73 -0
  23. data/lib/purecloud/api/geolocation_api.rb +4 -4
  24. data/lib/purecloud/api/greetings_api.rb +12 -12
  25. data/lib/purecloud/api/groups_api.rb +3 -3
  26. data/lib/purecloud/api/integrations_api.rb +144 -0
  27. data/lib/purecloud/api/languages_api.rb +2 -2
  28. data/lib/purecloud/api/licensing_api.rb +7 -7
  29. data/lib/purecloud/api/locations_api.rb +2 -2
  30. data/lib/purecloud/api/notifications_api.rb +7 -7
  31. data/lib/purecloud/api/o_auth_api.rb +22 -22
  32. data/lib/purecloud/api/outbound_api.rb +69 -81
  33. data/lib/purecloud/api/presence_api.rb +10 -10
  34. data/lib/purecloud/api/quality_api.rb +41 -93
  35. data/lib/purecloud/api/recording_api.rb +20 -29
  36. data/lib/purecloud/api/response_management_api.rb +11 -11
  37. data/lib/purecloud/api/routing_api.rb +333 -189
  38. data/lib/purecloud/api/scripts_api.rb +11 -11
  39. data/lib/purecloud/api/search_api.rb +1 -1
  40. data/lib/purecloud/api/socials_api.rb +483 -0
  41. data/lib/purecloud/api/stations_api.rb +3 -3
  42. data/lib/purecloud/api/telephony_providers_edge_api.rb +38 -38
  43. data/lib/purecloud/api/tokens_api.rb +1 -1
  44. data/lib/purecloud/api/user_recordings_api.rb +6 -6
  45. data/lib/purecloud/api/users_api.rb +403 -95
  46. data/lib/purecloud/api/utilities_api.rb +4 -60
  47. data/lib/purecloud/api/videos_api.rb +483 -0
  48. data/lib/purecloud/api/voicemail_api.rb +11 -11
  49. data/lib/purecloud/models/address.rb +47 -25
  50. data/lib/purecloud/models/address_listing.rb +11 -11
  51. data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
  52. data/lib/purecloud/models/aggregate_data_container.rb +161 -0
  53. data/lib/purecloud/models/aggregate_metric_data.rb +175 -0
  54. data/lib/purecloud/models/{session_request.rb → aggregate_query_response.rb} +10 -8
  55. data/lib/purecloud/models/{domain_license_entity_listing.rb → aggregation_query.rb} +49 -79
  56. data/lib/purecloud/models/{tag.rb → aggregation_range.rb} +16 -16
  57. data/lib/purecloud/models/aggregation_result.rb +199 -0
  58. data/lib/purecloud/models/aggregation_result_entry.rb +179 -0
  59. data/lib/purecloud/models/alert_entity_listing.rb +11 -11
  60. data/lib/purecloud/models/analytics_conversation.rb +181 -0
  61. data/lib/purecloud/models/analytics_conversation_query_response.rb +160 -0
  62. data/lib/purecloud/models/{queue_member_entity_listing.rb → analytics_evaluation.rb} +62 -64
  63. data/lib/purecloud/models/analytics_participant.rb +158 -0
  64. data/lib/purecloud/models/analytics_property.rb +178 -0
  65. data/lib/purecloud/models/analytics_query_aggregation.rb +202 -0
  66. data/lib/purecloud/models/analytics_query_clause.rb +168 -0
  67. data/lib/purecloud/models/analytics_query_filter.rb +181 -0
  68. data/lib/purecloud/models/analytics_query_predicate.rb +269 -0
  69. data/lib/purecloud/models/analytics_segment.rb +607 -0
  70. data/lib/purecloud/models/{put_management_unit.rb → analytics_session.rb} +27 -25
  71. data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
  72. data/lib/purecloud/models/audit_entity_reference.rb +1 -1
  73. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +11 -11
  74. data/lib/purecloud/models/available_additional_service_listing.rb +11 -11
  75. data/lib/purecloud/models/available_topic_entity_listing.rb +11 -11
  76. data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
  77. data/lib/purecloud/models/call.rb +2 -22
  78. data/lib/purecloud/models/call_conversation.rb +213 -0
  79. data/lib/purecloud/models/call_participant.rb +527 -0
  80. data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
  81. data/lib/purecloud/models/callback_conversation.rb +194 -0
  82. data/lib/purecloud/models/callback_participant.rb +456 -0
  83. data/lib/purecloud/models/campaign.rb +17 -219
  84. data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
  85. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
  86. data/lib/purecloud/models/carrier_entity_listing.rb +11 -11
  87. data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
  88. data/lib/purecloud/models/channel_entity_listing.rb +11 -11
  89. data/lib/purecloud/models/channel_topic_entity_listing.rb +11 -11
  90. data/lib/purecloud/models/{domain_license.rb → chat_conversation.rb} +19 -25
  91. data/lib/purecloud/models/chat_participant.rb +270 -12
  92. data/lib/purecloud/models/chat_search_listing.rb +11 -11
  93. data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
  94. data/lib/purecloud/models/consumed_resources_entity_listing.rb +11 -11
  95. data/lib/purecloud/models/consuming_resources_entity_listing.rb +11 -11
  96. data/lib/purecloud/models/contact.rb +41 -73
  97. data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
  98. data/lib/purecloud/models/contact_listing.rb +11 -11
  99. data/lib/purecloud/models/contact_sales.rb +1 -21
  100. data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
  101. data/lib/purecloud/models/{evaluation_query_request.rb → conversation_query.rb} +77 -90
  102. data/lib/purecloud/models/conversation_query_response.rb +11 -11
  103. data/lib/purecloud/models/{session_entity_listing.rb → create_call_request.rb} +71 -68
  104. data/lib/purecloud/models/{conversation_response.rb → create_call_response.rb} +1 -1
  105. data/lib/purecloud/models/create_user.rb +219 -0
  106. data/lib/purecloud/models/data_item.rb +19 -23
  107. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +11 -11
  108. data/lib/purecloud/models/dependency_object_entity_listing.rb +11 -11
  109. data/lib/purecloud/models/dependency_type_entity_listing.rb +11 -11
  110. data/lib/purecloud/models/destination.rb +1 -21
  111. data/lib/purecloud/models/did_entity_listing.rb +11 -11
  112. data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
  113. data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
  114. data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
  115. data/lib/purecloud/models/document_entity_listing.rb +11 -11
  116. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +11 -11
  117. data/lib/purecloud/models/domain_entity_listing.rb +11 -11
  118. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
  119. data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
  120. data/lib/purecloud/models/domain_invoice_entity_listing.rb +11 -11
  121. data/lib/purecloud/models/domain_organization_role.rb +1 -23
  122. data/lib/purecloud/models/domain_permission.rb +1 -13
  123. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +11 -11
  124. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +11 -11
  125. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +11 -11
  126. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +11 -11
  127. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +11 -11
  128. data/lib/purecloud/models/edge_entity_listing.rb +11 -11
  129. data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
  130. data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
  131. data/lib/purecloud/models/email_conversation.rb +194 -0
  132. data/lib/purecloud/models/email_message_listing.rb +11 -11
  133. data/lib/purecloud/models/email_participant.rb +424 -0
  134. data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
  135. data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
  136. data/lib/purecloud/models/entity.rb +10 -20
  137. data/lib/purecloud/models/evaluation.rb +1 -0
  138. data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
  139. data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
  140. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
  141. data/lib/purecloud/models/extension_entity_listing.rb +11 -11
  142. data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
  143. data/lib/purecloud/models/external_organization_listing.rb +11 -11
  144. data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
  145. data/lib/purecloud/models/filter.rb +14 -11
  146. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/flow_entity_listing.rb +11 -11
  148. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +11 -11
  149. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +11 -11
  150. data/lib/purecloud/models/flow_version_entity_listing.rb +11 -11
  151. data/lib/purecloud/models/group_entity_listing.rb +11 -11
  152. data/lib/purecloud/models/hardware_rate_listing.rb +11 -11
  153. data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
  154. data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
  155. data/lib/purecloud/models/integration_type_entity_listing.rb +11 -11
  156. data/lib/purecloud/models/ivr_entity_listing.rb +11 -11
  157. data/lib/purecloud/models/language_entity_listing.rb +11 -11
  158. data/lib/purecloud/models/library_entity_listing.rb +11 -11
  159. data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
  160. data/lib/purecloud/models/line_entity_listing.rb +11 -11
  161. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +11 -11
  162. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +11 -11
  163. data/lib/purecloud/models/location_entity_listing.rb +11 -11
  164. data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
  165. data/lib/purecloud/models/management_unit.rb +26 -14
  166. data/lib/purecloud/models/media_result.rb +1 -11
  167. data/lib/purecloud/models/media_summary.rb +2 -2
  168. data/lib/purecloud/models/media_summary_detail.rb +156 -0
  169. data/lib/purecloud/models/note_listing.rb +11 -11
  170. data/lib/purecloud/models/numeric_range.rb +180 -0
  171. data/lib/purecloud/models/o_auth_client.rb +21 -14
  172. data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
  173. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
  174. data/lib/purecloud/models/observation_data_container.rb +161 -0
  175. data/lib/purecloud/models/observation_query.rb +160 -0
  176. data/lib/purecloud/models/observation_query_response.rb +148 -0
  177. data/lib/purecloud/models/okta.rb +11 -11
  178. data/lib/purecloud/models/one_login.rb +11 -11
  179. data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
  180. data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
  181. data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
  182. data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
  183. data/lib/purecloud/models/paging_spec.rb +158 -0
  184. data/lib/purecloud/models/participant.rb +1 -13
  185. data/lib/purecloud/models/payment_method_listing.rb +11 -11
  186. data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
  187. data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
  188. data/lib/purecloud/models/phone_entity_listing.rb +11 -11
  189. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
  190. data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
  191. data/lib/purecloud/models/policy_entity_listing.rb +11 -11
  192. data/lib/purecloud/models/presence_query_response.rb +161 -0
  193. data/lib/purecloud/models/prompt_asset_entity_listing.rb +11 -11
  194. data/lib/purecloud/models/prompt_entity_listing.rb +11 -11
  195. data/lib/purecloud/models/property_index_request.rb +182 -0
  196. data/lib/purecloud/models/quality_audit_page.rb +11 -11
  197. data/lib/purecloud/models/queue.rb +1 -23
  198. data/lib/purecloud/models/queue_entity_listing.rb +11 -11
  199. data/lib/purecloud/models/queues_entity_listing.rb +11 -11
  200. data/lib/purecloud/models/quote.rb +1 -37
  201. data/lib/purecloud/models/quote_listing.rb +11 -11
  202. data/lib/purecloud/models/recording.rb +13 -34
  203. data/lib/purecloud/models/relationship_listing.rb +11 -11
  204. data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
  205. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
  206. data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
  207. data/lib/purecloud/models/response.rb +14 -84
  208. data/lib/purecloud/models/response_entity_list.rb +11 -11
  209. data/lib/purecloud/models/response_entity_listing.rb +11 -11
  210. data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
  211. data/lib/purecloud/models/{user_status.rb → routing_skill.rb} +35 -25
  212. data/lib/purecloud/models/rule_entity_listing.rb +11 -11
  213. data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
  214. data/lib/purecloud/models/salesforce.rb +11 -11
  215. data/lib/purecloud/models/schedule_entity_listing.rb +11 -11
  216. data/lib/purecloud/models/schedule_group_entity_listing.rb +11 -11
  217. data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
  218. data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
  219. data/lib/purecloud/models/script_entity_listing.rb +11 -11
  220. data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
  221. data/lib/purecloud/models/service_entity_listing.rb +11 -11
  222. data/lib/purecloud/models/share_entity_listing.rb +11 -11
  223. data/lib/purecloud/models/site_entity_listing.rb +11 -11
  224. data/lib/purecloud/models/skill_entity_listing.rb +12 -12
  225. data/lib/purecloud/models/social_conversation.rb +194 -0
  226. data/lib/purecloud/models/social_participant.rb +446 -0
  227. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +11 -11
  228. data/lib/purecloud/models/station_entity_listing.rb +11 -11
  229. data/lib/purecloud/models/statistical_response.rb +158 -0
  230. data/lib/purecloud/models/statistical_summary.rb +226 -0
  231. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +11 -11
  232. data/lib/purecloud/models/system_prompt_entity_listing.rb +11 -11
  233. data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
  234. data/lib/purecloud/models/template_entity_listing.rb +11 -11
  235. data/lib/purecloud/models/text_table_transform_entity_listing.rb +11 -11
  236. data/lib/purecloud/models/time_zone.rb +1 -11
  237. data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
  238. data/lib/purecloud/models/transfer_request.rb +193 -0
  239. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
  240. data/lib/purecloud/models/user.rb +96 -129
  241. data/lib/purecloud/models/user_action_category_entity_listing.rb +11 -11
  242. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +11 -11
  243. data/lib/purecloud/models/user_authorization.rb +1 -13
  244. data/lib/purecloud/models/user_entity_listing.rb +11 -11
  245. data/lib/purecloud/models/user_presence_entity_listing.rb +11 -11
  246. data/lib/purecloud/models/user_queue.rb +1 -23
  247. data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
  248. data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
  249. data/lib/purecloud/models/{session.rb → user_routing_skill.rb} +26 -41
  250. data/lib/purecloud/models/user_skill_entity_listing.rb +12 -12
  251. data/lib/purecloud/models/user_station.rb +178 -0
  252. data/lib/purecloud/models/user_stations.rb +180 -0
  253. data/lib/purecloud/models/users_entity_listing.rb +11 -11
  254. data/lib/purecloud/models/utilization.rb +4 -36
  255. data/lib/purecloud/models/video_conversation.rb +194 -0
  256. data/lib/purecloud/models/video_participant.rb +463 -0
  257. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +11 -11
  258. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +11 -11
  259. data/lib/purecloud/models/voicemail_message_entity_listing.rb +11 -11
  260. data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
  261. data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
  262. data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
  263. data/lib/purecloud/version.rb +1 -1
  264. data/newVersion.md +1 -1
  265. data/swagger.json +1 -1
  266. data/version.json +1 -1
  267. metadata +60 -15
  268. data/lib/purecloud/models/skill.rb +0 -269
  269. data/lib/purecloud/models/user_skill.rb +0 -290
@@ -0,0 +1,1906 @@
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/v2/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/v2/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_alerts_alert_id(alert_id, opts = {})
141
+ data, status_code, headers = get_alerting_alerts_alert_id_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_alerts_alert_id_with_http_info(alert_id, opts = {})
151
+ if @api_client.config.debugging
152
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts_alert_id ..."
153
+ end
154
+
155
+ # verify the required parameter 'alert_id' is set
156
+ fail "Missing the required parameter 'alert_id' when calling get_alerting_alerts_alert_id" if alert_id.nil?
157
+
158
+ # resource path
159
+ path = "/api/v2/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_alerts_alert_id\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_alerts_alert_id(alert_id, opts = {})
203
+ data, status_code, headers = put_alerting_alerts_alert_id_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_alerts_alert_id_with_http_info(alert_id, opts = {})
214
+ if @api_client.config.debugging
215
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#put_alerting_alerts_alert_id ..."
216
+ end
217
+
218
+ # verify the required parameter 'alert_id' is set
219
+ fail "Missing the required parameter 'alert_id' when calling put_alerting_alerts_alert_id" if alert_id.nil?
220
+
221
+ # resource path
222
+ path = "/api/v2/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_alerts_alert_id\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_alerts_alert_id(alert_id, opts = {})
265
+ delete_alerting_alerts_alert_id_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_alerts_alert_id_with_http_info(alert_id, opts = {})
275
+ if @api_client.config.debugging
276
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_alerts_alert_id ..."
277
+ end
278
+
279
+ # verify the required parameter 'alert_id' is set
280
+ fail "Missing the required parameter 'alert_id' when calling delete_alerting_alerts_alert_id" if alert_id.nil?
281
+
282
+ # resource path
283
+ path = "/api/v2/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_alerts_alert_id\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/v2/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/v2/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_rules_rule_id(rule_id, opts = {})
451
+ data, status_code, headers = get_alerting_rules_rule_id_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_rules_rule_id_with_http_info(rule_id, opts = {})
461
+ if @api_client.config.debugging
462
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rules_rule_id ..."
463
+ end
464
+
465
+ # verify the required parameter 'rule_id' is set
466
+ fail "Missing the required parameter 'rule_id' when calling get_alerting_rules_rule_id" if rule_id.nil?
467
+
468
+ # resource path
469
+ path = "/api/v2/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_rules_rule_id\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_rules_rule_id(rule_id, opts = {})
513
+ data, status_code, headers = put_alerting_rules_rule_id_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_rules_rule_id_with_http_info(rule_id, opts = {})
524
+ if @api_client.config.debugging
525
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#put_alerting_rules_rule_id ..."
526
+ end
527
+
528
+ # verify the required parameter 'rule_id' is set
529
+ fail "Missing the required parameter 'rule_id' when calling put_alerting_rules_rule_id" if rule_id.nil?
530
+
531
+ # resource path
532
+ path = "/api/v2/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_rules_rule_id\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_rules_rule_id(rule_id, opts = {})
575
+ delete_alerting_rules_rule_id_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_rules_rule_id_with_http_info(rule_id, opts = {})
585
+ if @api_client.config.debugging
586
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_rules_rule_id ..."
587
+ end
588
+
589
+ # verify the required parameter 'rule_id' is set
590
+ fail "Missing the required parameter 'rule_id' when calling delete_alerting_rules_rule_id" if rule_id.nil?
591
+
592
+ # resource path
593
+ path = "/api/v2/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_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
625
+ end
626
+ return data, status_code, headers
627
+ end
628
+
629
+ # Query for conversation aggregates
630
+ #
631
+ # @param [Hash] opts the optional parameters
632
+ # @option opts [AggregationQuery] :body query
633
+ # @return [AggregateQueryResponse]
634
+ def post_conversations_aggregates_query(opts = {})
635
+ data, status_code, headers = post_conversations_aggregates_query_with_http_info(opts)
636
+ return data
637
+ end
638
+
639
+ # Query for conversation aggregates
640
+ #
641
+ # @param [Hash] opts the optional parameters
642
+ # @option opts [AggregationQuery] :body query
643
+ # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
644
+ def post_conversations_aggregates_query_with_http_info(opts = {})
645
+ if @api_client.config.debugging
646
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_conversations_aggregates_query ..."
647
+ end
648
+
649
+ # resource path
650
+ path = "/api/v2/analytics/conversations/aggregates/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
+ :return_type => 'AggregateQueryResponse')
681
+ if @api_client.config.debugging
682
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_conversations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
683
+ end
684
+ return data, status_code, headers
685
+ end
686
+
687
+ # Query for conversation details
688
+ #
689
+ # @param [Hash] opts the optional parameters
690
+ # @option opts [ConversationQuery] :body query
691
+ # @return [AnalyticsConversationQueryResponse]
692
+ def post_conversations_details_query(opts = {})
693
+ data, status_code, headers = post_conversations_details_query_with_http_info(opts)
694
+ return data
695
+ end
696
+
697
+ # Query for conversation details
698
+ #
699
+ # @param [Hash] opts the optional parameters
700
+ # @option opts [ConversationQuery] :body query
701
+ # @return [Array<(AnalyticsConversationQueryResponse, Fixnum, Hash)>] AnalyticsConversationQueryResponse data, response status code and response headers
702
+ def post_conversations_details_query_with_http_info(opts = {})
703
+ if @api_client.config.debugging
704
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_conversations_details_query ..."
705
+ end
706
+
707
+ # resource path
708
+ path = "/api/v2/analytics/conversations/details/query".sub('{format}','json')
709
+
710
+ # query parameters
711
+ query_params = {}
712
+
713
+ # header parameters
714
+ header_params = {}
715
+
716
+ # HTTP header 'Accept' (if needed)
717
+ _header_accept = ['application/json']
718
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
719
+
720
+ # HTTP header 'Content-Type'
721
+ _header_content_type = ['application/json']
722
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
723
+
724
+ # form parameters
725
+ form_params = {}
726
+
727
+ # http body (model)
728
+ post_body = @api_client.object_to_http_body(opts[:'body'])
729
+
730
+
731
+ auth_names = ['PureCloud Auth']
732
+ data, status_code, headers = @api_client.call_api(:POST, path,
733
+ :header_params => header_params,
734
+ :query_params => query_params,
735
+ :form_params => form_params,
736
+ :body => post_body,
737
+ :auth_names => auth_names,
738
+ :return_type => 'AnalyticsConversationQueryResponse')
739
+ if @api_client.config.debugging
740
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_conversations_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
741
+ end
742
+ return data, status_code, headers
743
+ end
744
+
745
+ # Get a conversation by id
746
+ #
747
+ # @param conversation_id conversationId
748
+ # @param [Hash] opts the optional parameters
749
+ # @return [AnalyticsConversation]
750
+ def get_conversations_conversation_id_details(conversation_id, opts = {})
751
+ data, status_code, headers = get_conversations_conversation_id_details_with_http_info(conversation_id, opts)
752
+ return data
753
+ end
754
+
755
+ # Get a conversation by id
756
+ #
757
+ # @param conversation_id conversationId
758
+ # @param [Hash] opts the optional parameters
759
+ # @return [Array<(AnalyticsConversation, Fixnum, Hash)>] AnalyticsConversation data, response status code and response headers
760
+ def get_conversations_conversation_id_details_with_http_info(conversation_id, opts = {})
761
+ if @api_client.config.debugging
762
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_conversations_conversation_id_details ..."
763
+ end
764
+
765
+ # verify the required parameter 'conversation_id' is set
766
+ fail "Missing the required parameter 'conversation_id' when calling get_conversations_conversation_id_details" if conversation_id.nil?
767
+
768
+ # resource path
769
+ path = "/api/v2/analytics/conversations/{conversationId}/details".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
770
+
771
+ # query parameters
772
+ query_params = {}
773
+
774
+ # header parameters
775
+ header_params = {}
776
+
777
+ # HTTP header 'Accept' (if needed)
778
+ _header_accept = ['application/json']
779
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
780
+
781
+ # HTTP header 'Content-Type'
782
+ _header_content_type = ['application/json']
783
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
784
+
785
+ # form parameters
786
+ form_params = {}
787
+
788
+ # http body (model)
789
+ post_body = nil
790
+
791
+
792
+ auth_names = ['PureCloud Auth']
793
+ data, status_code, headers = @api_client.call_api(:GET, path,
794
+ :header_params => header_params,
795
+ :query_params => query_params,
796
+ :form_params => form_params,
797
+ :body => post_body,
798
+ :auth_names => auth_names,
799
+ :return_type => 'AnalyticsConversation')
800
+ if @api_client.config.debugging
801
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_conversations_conversation_id_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
802
+ end
803
+ return data, status_code, headers
804
+ end
805
+
806
+ # Index conversation properties
807
+ #
808
+ # @param conversation_id conversationId
809
+ # @param [Hash] opts the optional parameters
810
+ # @option opts [PropertyIndexRequest] :body request
811
+ # @return [PropertyIndexRequest]
812
+ def post_conversations_conversation_id_details_properties(conversation_id, opts = {})
813
+ data, status_code, headers = post_conversations_conversation_id_details_properties_with_http_info(conversation_id, opts)
814
+ return data
815
+ end
816
+
817
+ # Index conversation properties
818
+ #
819
+ # @param conversation_id conversationId
820
+ # @param [Hash] opts the optional parameters
821
+ # @option opts [PropertyIndexRequest] :body request
822
+ # @return [Array<(PropertyIndexRequest, Fixnum, Hash)>] PropertyIndexRequest data, response status code and response headers
823
+ def post_conversations_conversation_id_details_properties_with_http_info(conversation_id, opts = {})
824
+ if @api_client.config.debugging
825
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_conversations_conversation_id_details_properties ..."
826
+ end
827
+
828
+ # verify the required parameter 'conversation_id' is set
829
+ fail "Missing the required parameter 'conversation_id' when calling post_conversations_conversation_id_details_properties" if conversation_id.nil?
830
+
831
+ # resource path
832
+ path = "/api/v2/analytics/conversations/{conversationId}/details/properties".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
833
+
834
+ # query parameters
835
+ query_params = {}
836
+
837
+ # header parameters
838
+ header_params = {}
839
+
840
+ # HTTP header 'Accept' (if needed)
841
+ _header_accept = ['application/json']
842
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
843
+
844
+ # HTTP header 'Content-Type'
845
+ _header_content_type = ['application/json']
846
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
847
+
848
+ # form parameters
849
+ form_params = {}
850
+
851
+ # http body (model)
852
+ post_body = @api_client.object_to_http_body(opts[:'body'])
853
+
854
+
855
+ auth_names = ['PureCloud Auth']
856
+ data, status_code, headers = @api_client.call_api(:POST, path,
857
+ :header_params => header_params,
858
+ :query_params => query_params,
859
+ :form_params => form_params,
860
+ :body => post_body,
861
+ :auth_names => auth_names,
862
+ :return_type => 'PropertyIndexRequest')
863
+ if @api_client.config.debugging
864
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_conversations_conversation_id_details_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
865
+ end
866
+ return data, status_code, headers
867
+ end
868
+
869
+ # Query for evaluation aggregates
870
+ #
871
+ # @param [Hash] opts the optional parameters
872
+ # @option opts [AggregationQuery] :body query
873
+ # @return [AggregateQueryResponse]
874
+ def post_evaluations_aggregates_query(opts = {})
875
+ data, status_code, headers = post_evaluations_aggregates_query_with_http_info(opts)
876
+ return data
877
+ end
878
+
879
+ # Query for evaluation aggregates
880
+ #
881
+ # @param [Hash] opts the optional parameters
882
+ # @option opts [AggregationQuery] :body query
883
+ # @return [Array<(AggregateQueryResponse, Fixnum, Hash)>] AggregateQueryResponse data, response status code and response headers
884
+ def post_evaluations_aggregates_query_with_http_info(opts = {})
885
+ if @api_client.config.debugging
886
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_evaluations_aggregates_query ..."
887
+ end
888
+
889
+ # resource path
890
+ path = "/api/v2/analytics/evaluations/aggregates/query".sub('{format}','json')
891
+
892
+ # query parameters
893
+ query_params = {}
894
+
895
+ # header parameters
896
+ header_params = {}
897
+
898
+ # HTTP header 'Accept' (if needed)
899
+ _header_accept = ['application/json']
900
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
901
+
902
+ # HTTP header 'Content-Type'
903
+ _header_content_type = ['application/json']
904
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
905
+
906
+ # form parameters
907
+ form_params = {}
908
+
909
+ # http body (model)
910
+ post_body = @api_client.object_to_http_body(opts[:'body'])
911
+
912
+
913
+ auth_names = ['PureCloud Auth']
914
+ data, status_code, headers = @api_client.call_api(:POST, path,
915
+ :header_params => header_params,
916
+ :query_params => query_params,
917
+ :form_params => form_params,
918
+ :body => post_body,
919
+ :auth_names => auth_names,
920
+ :return_type => 'AggregateQueryResponse')
921
+ if @api_client.config.debugging
922
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_evaluations_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
923
+ end
924
+ return data, status_code, headers
925
+ end
926
+
927
+ # Query for queue observations
928
+ #
929
+ # @param [Hash] opts the optional parameters
930
+ # @option opts [ObservationQuery] :body query
931
+ # @return [ObservationQueryResponse]
932
+ def post_queues_observations_query(opts = {})
933
+ data, status_code, headers = post_queues_observations_query_with_http_info(opts)
934
+ return data
935
+ end
936
+
937
+ # Query for queue observations
938
+ #
939
+ # @param [Hash] opts the optional parameters
940
+ # @option opts [ObservationQuery] :body query
941
+ # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers
942
+ def post_queues_observations_query_with_http_info(opts = {})
943
+ if @api_client.config.debugging
944
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_queues_observations_query ..."
945
+ end
946
+
947
+ # resource path
948
+ path = "/api/v2/analytics/queues/observations/query".sub('{format}','json')
949
+
950
+ # query parameters
951
+ query_params = {}
952
+
953
+ # header parameters
954
+ header_params = {}
955
+
956
+ # HTTP header 'Accept' (if needed)
957
+ _header_accept = ['application/json']
958
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
959
+
960
+ # HTTP header 'Content-Type'
961
+ _header_content_type = ['application/json']
962
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
963
+
964
+ # form parameters
965
+ form_params = {}
966
+
967
+ # http body (model)
968
+ post_body = @api_client.object_to_http_body(opts[:'body'])
969
+
970
+
971
+ auth_names = ['PureCloud Auth']
972
+ data, status_code, headers = @api_client.call_api(:POST, path,
973
+ :header_params => header_params,
974
+ :query_params => query_params,
975
+ :form_params => form_params,
976
+ :body => post_body,
977
+ :auth_names => auth_names,
978
+ :return_type => 'ObservationQueryResponse')
979
+ if @api_client.config.debugging
980
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
981
+ end
982
+ return data, status_code, headers
983
+ end
984
+
985
+ # Get list of reporting metadata.
986
+ #
987
+ # @param [Hash] opts the optional parameters
988
+ # @option opts [Integer] :page_number Page number
989
+ # @option opts [Integer] :page_size Page size
990
+ # @option opts [String] :locale Locale
991
+ # @return [ReportMetaDataEntityListing]
992
+ def get_reporting_metadata(opts = {})
993
+ data, status_code, headers = get_reporting_metadata_with_http_info(opts)
994
+ return data
995
+ end
996
+
997
+ # Get list of reporting metadata.
998
+ #
999
+ # @param [Hash] opts the optional parameters
1000
+ # @option opts [Integer] :page_number Page number
1001
+ # @option opts [Integer] :page_size Page size
1002
+ # @option opts [String] :locale Locale
1003
+ # @return [Array<(ReportMetaDataEntityListing, Fixnum, Hash)>] ReportMetaDataEntityListing data, response status code and response headers
1004
+ def get_reporting_metadata_with_http_info(opts = {})
1005
+ if @api_client.config.debugging
1006
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_metadata ..."
1007
+ end
1008
+
1009
+ # resource path
1010
+ path = "/api/v2/analytics/reporting/metadata".sub('{format}','json')
1011
+
1012
+ # query parameters
1013
+ query_params = {}
1014
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1015
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1016
+ query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
1017
+
1018
+ # header parameters
1019
+ header_params = {}
1020
+
1021
+ # HTTP header 'Accept' (if needed)
1022
+ _header_accept = ['application/json']
1023
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1024
+
1025
+ # HTTP header 'Content-Type'
1026
+ _header_content_type = ['application/json']
1027
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1028
+
1029
+ # form parameters
1030
+ form_params = {}
1031
+
1032
+ # http body (model)
1033
+ post_body = nil
1034
+
1035
+
1036
+ auth_names = ['PureCloud Auth']
1037
+ data, status_code, headers = @api_client.call_api(:GET, path,
1038
+ :header_params => header_params,
1039
+ :query_params => query_params,
1040
+ :form_params => form_params,
1041
+ :body => post_body,
1042
+ :auth_names => auth_names,
1043
+ :return_type => 'ReportMetaDataEntityListing')
1044
+ if @api_client.config.debugging
1045
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1046
+ end
1047
+ return data, status_code, headers
1048
+ end
1049
+
1050
+ # Get a list of report formats
1051
+ # Get a list of report formats.
1052
+ # @param [Hash] opts the optional parameters
1053
+ # @return [Array<String>]
1054
+ def get_reporting_reportformats(opts = {})
1055
+ data, status_code, headers = get_reporting_reportformats_with_http_info(opts)
1056
+ return data
1057
+ end
1058
+
1059
+ # Get a list of report formats
1060
+ # Get a list of report formats.
1061
+ # @param [Hash] opts the optional parameters
1062
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
1063
+ def get_reporting_reportformats_with_http_info(opts = {})
1064
+ if @api_client.config.debugging
1065
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_reportformats ..."
1066
+ end
1067
+
1068
+ # resource path
1069
+ path = "/api/v2/analytics/reporting/reportformats".sub('{format}','json')
1070
+
1071
+ # query parameters
1072
+ query_params = {}
1073
+
1074
+ # header parameters
1075
+ header_params = {}
1076
+
1077
+ # HTTP header 'Accept' (if needed)
1078
+ _header_accept = ['application/json']
1079
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1080
+
1081
+ # HTTP header 'Content-Type'
1082
+ _header_content_type = ['application/json']
1083
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1084
+
1085
+ # form parameters
1086
+ form_params = {}
1087
+
1088
+ # http body (model)
1089
+ post_body = nil
1090
+
1091
+
1092
+ auth_names = ['PureCloud Auth']
1093
+ data, status_code, headers = @api_client.call_api(:GET, path,
1094
+ :header_params => header_params,
1095
+ :query_params => query_params,
1096
+ :form_params => form_params,
1097
+ :body => post_body,
1098
+ :auth_names => auth_names,
1099
+ :return_type => 'Array<String>')
1100
+ if @api_client.config.debugging
1101
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_reportformats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1102
+ end
1103
+ return data, status_code, headers
1104
+ end
1105
+
1106
+ # Get a list of scheduled report jobs
1107
+ # Get a list of scheduled report jobs.
1108
+ # @param [Hash] opts the optional parameters
1109
+ # @option opts [Integer] :page_number Page number
1110
+ # @option opts [Integer] :page_size Page size
1111
+ # @return [ReportScheduleEntityListing]
1112
+ def get_reporting_schedules(opts = {})
1113
+ data, status_code, headers = get_reporting_schedules_with_http_info(opts)
1114
+ return data
1115
+ end
1116
+
1117
+ # Get a list of scheduled report jobs
1118
+ # Get a list of scheduled report jobs.
1119
+ # @param [Hash] opts the optional parameters
1120
+ # @option opts [Integer] :page_number Page number
1121
+ # @option opts [Integer] :page_size Page size
1122
+ # @return [Array<(ReportScheduleEntityListing, Fixnum, Hash)>] ReportScheduleEntityListing data, response status code and response headers
1123
+ def get_reporting_schedules_with_http_info(opts = {})
1124
+ if @api_client.config.debugging
1125
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules ..."
1126
+ end
1127
+
1128
+ # resource path
1129
+ path = "/api/v2/analytics/reporting/schedules".sub('{format}','json')
1130
+
1131
+ # query parameters
1132
+ query_params = {}
1133
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1134
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1135
+
1136
+ # header parameters
1137
+ header_params = {}
1138
+
1139
+ # HTTP header 'Accept' (if needed)
1140
+ _header_accept = ['application/json']
1141
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1142
+
1143
+ # HTTP header 'Content-Type'
1144
+ _header_content_type = ['application/json']
1145
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1146
+
1147
+ # form parameters
1148
+ form_params = {}
1149
+
1150
+ # http body (model)
1151
+ post_body = nil
1152
+
1153
+
1154
+ auth_names = ['PureCloud Auth']
1155
+ data, status_code, headers = @api_client.call_api(:GET, path,
1156
+ :header_params => header_params,
1157
+ :query_params => query_params,
1158
+ :form_params => form_params,
1159
+ :body => post_body,
1160
+ :auth_names => auth_names,
1161
+ :return_type => 'ReportScheduleEntityListing')
1162
+ if @api_client.config.debugging
1163
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1164
+ end
1165
+ return data, status_code, headers
1166
+ end
1167
+
1168
+ # Create a scheduled report job
1169
+ # Create a scheduled report job.
1170
+ # @param [Hash] opts the optional parameters
1171
+ # @option opts [ReportSchedule] :body ReportSchedule
1172
+ # @return [ReportSchedule]
1173
+ def post_reporting_schedules(opts = {})
1174
+ data, status_code, headers = post_reporting_schedules_with_http_info(opts)
1175
+ return data
1176
+ end
1177
+
1178
+ # Create a scheduled report job
1179
+ # Create a scheduled report job.
1180
+ # @param [Hash] opts the optional parameters
1181
+ # @option opts [ReportSchedule] :body ReportSchedule
1182
+ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
1183
+ def post_reporting_schedules_with_http_info(opts = {})
1184
+ if @api_client.config.debugging
1185
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_reporting_schedules ..."
1186
+ end
1187
+
1188
+ # resource path
1189
+ path = "/api/v2/analytics/reporting/schedules".sub('{format}','json')
1190
+
1191
+ # query parameters
1192
+ query_params = {}
1193
+
1194
+ # header parameters
1195
+ header_params = {}
1196
+
1197
+ # HTTP header 'Accept' (if needed)
1198
+ _header_accept = ['application/json']
1199
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1200
+
1201
+ # HTTP header 'Content-Type'
1202
+ _header_content_type = ['application/json']
1203
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1204
+
1205
+ # form parameters
1206
+ form_params = {}
1207
+
1208
+ # http body (model)
1209
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1210
+
1211
+
1212
+ auth_names = ['PureCloud Auth']
1213
+ data, status_code, headers = @api_client.call_api(:POST, path,
1214
+ :header_params => header_params,
1215
+ :query_params => query_params,
1216
+ :form_params => form_params,
1217
+ :body => post_body,
1218
+ :auth_names => auth_names,
1219
+ :return_type => 'ReportSchedule')
1220
+ if @api_client.config.debugging
1221
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1222
+ end
1223
+ return data, status_code, headers
1224
+ end
1225
+
1226
+ # Get a scheduled report job.
1227
+ #
1228
+ # @param schedule_id Schedule ID
1229
+ # @param [Hash] opts the optional parameters
1230
+ # @return [ReportSchedule]
1231
+ def get_reporting_schedules_schedule_id(schedule_id, opts = {})
1232
+ data, status_code, headers = get_reporting_schedules_schedule_id_with_http_info(schedule_id, opts)
1233
+ return data
1234
+ end
1235
+
1236
+ # Get a scheduled report job.
1237
+ #
1238
+ # @param schedule_id Schedule ID
1239
+ # @param [Hash] opts the optional parameters
1240
+ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
1241
+ def get_reporting_schedules_schedule_id_with_http_info(schedule_id, opts = {})
1242
+ if @api_client.config.debugging
1243
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules_schedule_id ..."
1244
+ end
1245
+
1246
+ # verify the required parameter 'schedule_id' is set
1247
+ fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedules_schedule_id" if schedule_id.nil?
1248
+
1249
+ # resource path
1250
+ path = "/api/v2/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1251
+
1252
+ # query parameters
1253
+ query_params = {}
1254
+
1255
+ # header parameters
1256
+ header_params = {}
1257
+
1258
+ # HTTP header 'Accept' (if needed)
1259
+ _header_accept = ['application/json']
1260
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1261
+
1262
+ # HTTP header 'Content-Type'
1263
+ _header_content_type = ['application/json']
1264
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1265
+
1266
+ # form parameters
1267
+ form_params = {}
1268
+
1269
+ # http body (model)
1270
+ post_body = nil
1271
+
1272
+
1273
+ auth_names = ['PureCloud Auth']
1274
+ data, status_code, headers = @api_client.call_api(:GET, path,
1275
+ :header_params => header_params,
1276
+ :query_params => query_params,
1277
+ :form_params => form_params,
1278
+ :body => post_body,
1279
+ :auth_names => auth_names,
1280
+ :return_type => 'ReportSchedule')
1281
+ if @api_client.config.debugging
1282
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1283
+ end
1284
+ return data, status_code, headers
1285
+ end
1286
+
1287
+ # Update a scheduled report job.
1288
+ #
1289
+ # @param schedule_id Schedule ID
1290
+ # @param [Hash] opts the optional parameters
1291
+ # @option opts [ReportSchedule] :body ReportSchedule
1292
+ # @return [ReportSchedule]
1293
+ def put_reporting_schedules_schedule_id(schedule_id, opts = {})
1294
+ data, status_code, headers = put_reporting_schedules_schedule_id_with_http_info(schedule_id, opts)
1295
+ return data
1296
+ end
1297
+
1298
+ # Update a scheduled report job.
1299
+ #
1300
+ # @param schedule_id Schedule ID
1301
+ # @param [Hash] opts the optional parameters
1302
+ # @option opts [ReportSchedule] :body ReportSchedule
1303
+ # @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
1304
+ def put_reporting_schedules_schedule_id_with_http_info(schedule_id, opts = {})
1305
+ if @api_client.config.debugging
1306
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#put_reporting_schedules_schedule_id ..."
1307
+ end
1308
+
1309
+ # verify the required parameter 'schedule_id' is set
1310
+ fail "Missing the required parameter 'schedule_id' when calling put_reporting_schedules_schedule_id" if schedule_id.nil?
1311
+
1312
+ # resource path
1313
+ path = "/api/v2/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1314
+
1315
+ # query parameters
1316
+ query_params = {}
1317
+
1318
+ # header parameters
1319
+ header_params = {}
1320
+
1321
+ # HTTP header 'Accept' (if needed)
1322
+ _header_accept = ['application/json']
1323
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1324
+
1325
+ # HTTP header 'Content-Type'
1326
+ _header_content_type = ['application/json']
1327
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1328
+
1329
+ # form parameters
1330
+ form_params = {}
1331
+
1332
+ # http body (model)
1333
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1334
+
1335
+
1336
+ auth_names = ['PureCloud Auth']
1337
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1338
+ :header_params => header_params,
1339
+ :query_params => query_params,
1340
+ :form_params => form_params,
1341
+ :body => post_body,
1342
+ :auth_names => auth_names,
1343
+ :return_type => 'ReportSchedule')
1344
+ if @api_client.config.debugging
1345
+ @api_client.config.logger.debug "API called: AnalyticsApi#put_reporting_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1346
+ end
1347
+ return data, status_code, headers
1348
+ end
1349
+
1350
+ # Delete a scheduled report job.
1351
+ #
1352
+ # @param schedule_id Schedule ID
1353
+ # @param [Hash] opts the optional parameters
1354
+ # @return [String]
1355
+ def delete_reporting_schedules_schedule_id(schedule_id, opts = {})
1356
+ data, status_code, headers = delete_reporting_schedules_schedule_id_with_http_info(schedule_id, opts)
1357
+ return data
1358
+ end
1359
+
1360
+ # Delete a scheduled report job.
1361
+ #
1362
+ # @param schedule_id Schedule ID
1363
+ # @param [Hash] opts the optional parameters
1364
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1365
+ def delete_reporting_schedules_schedule_id_with_http_info(schedule_id, opts = {})
1366
+ if @api_client.config.debugging
1367
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_reporting_schedules_schedule_id ..."
1368
+ end
1369
+
1370
+ # verify the required parameter 'schedule_id' is set
1371
+ fail "Missing the required parameter 'schedule_id' when calling delete_reporting_schedules_schedule_id" if schedule_id.nil?
1372
+
1373
+ # resource path
1374
+ path = "/api/v2/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1375
+
1376
+ # query parameters
1377
+ query_params = {}
1378
+
1379
+ # header parameters
1380
+ header_params = {}
1381
+
1382
+ # HTTP header 'Accept' (if needed)
1383
+ _header_accept = ['application/json']
1384
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1385
+
1386
+ # HTTP header 'Content-Type'
1387
+ _header_content_type = ['application/json']
1388
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1389
+
1390
+ # form parameters
1391
+ form_params = {}
1392
+
1393
+ # http body (model)
1394
+ post_body = nil
1395
+
1396
+
1397
+ auth_names = ['PureCloud Auth']
1398
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1399
+ :header_params => header_params,
1400
+ :query_params => query_params,
1401
+ :form_params => form_params,
1402
+ :body => post_body,
1403
+ :auth_names => auth_names,
1404
+ :return_type => 'String')
1405
+ if @api_client.config.debugging
1406
+ @api_client.config.logger.debug "API called: AnalyticsApi#delete_reporting_schedules_schedule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1407
+ end
1408
+ return data, status_code, headers
1409
+ end
1410
+
1411
+ # Get list of completed scheduled report jobs.
1412
+ #
1413
+ # @param schedule_id Schedule ID
1414
+ # @param [Hash] opts the optional parameters
1415
+ # @option opts [Integer] :page_number
1416
+ # @option opts [Integer] :page_size
1417
+ # @return [ReportRunEntryEntityDomainListing]
1418
+ def get_reporting_schedules_schedule_id_history(schedule_id, opts = {})
1419
+ data, status_code, headers = get_reporting_schedules_schedule_id_history_with_http_info(schedule_id, opts)
1420
+ return data
1421
+ end
1422
+
1423
+ # Get list of completed scheduled report jobs.
1424
+ #
1425
+ # @param schedule_id Schedule ID
1426
+ # @param [Hash] opts the optional parameters
1427
+ # @option opts [Integer] :page_number
1428
+ # @option opts [Integer] :page_size
1429
+ # @return [Array<(ReportRunEntryEntityDomainListing, Fixnum, Hash)>] ReportRunEntryEntityDomainListing data, response status code and response headers
1430
+ def get_reporting_schedules_schedule_id_history_with_http_info(schedule_id, opts = {})
1431
+ if @api_client.config.debugging
1432
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules_schedule_id_history ..."
1433
+ end
1434
+
1435
+ # verify the required parameter 'schedule_id' is set
1436
+ fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedules_schedule_id_history" if schedule_id.nil?
1437
+
1438
+ # resource path
1439
+ path = "/api/v2/analytics/reporting/schedules/{scheduleId}/history".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1440
+
1441
+ # query parameters
1442
+ query_params = {}
1443
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1444
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1445
+
1446
+ # header parameters
1447
+ header_params = {}
1448
+
1449
+ # HTTP header 'Accept' (if needed)
1450
+ _header_accept = ['application/json']
1451
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1452
+
1453
+ # HTTP header 'Content-Type'
1454
+ _header_content_type = ['application/json']
1455
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1456
+
1457
+ # form parameters
1458
+ form_params = {}
1459
+
1460
+ # http body (model)
1461
+ post_body = nil
1462
+
1463
+
1464
+ auth_names = ['PureCloud Auth']
1465
+ data, status_code, headers = @api_client.call_api(:GET, path,
1466
+ :header_params => header_params,
1467
+ :query_params => query_params,
1468
+ :form_params => form_params,
1469
+ :body => post_body,
1470
+ :auth_names => auth_names,
1471
+ :return_type => 'ReportRunEntryEntityDomainListing')
1472
+ if @api_client.config.debugging
1473
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedules_schedule_id_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1474
+ end
1475
+ return data, status_code, headers
1476
+ end
1477
+
1478
+ # Get most recently completed scheduled report job.
1479
+ #
1480
+ # @param schedule_id Schedule ID
1481
+ # @param [Hash] opts the optional parameters
1482
+ # @return [ReportRunEntry]
1483
+ def get_reporting_schedules_schedule_id_history_latest(schedule_id, opts = {})
1484
+ data, status_code, headers = get_reporting_schedules_schedule_id_history_latest_with_http_info(schedule_id, opts)
1485
+ return data
1486
+ end
1487
+
1488
+ # Get most recently completed scheduled report job.
1489
+ #
1490
+ # @param schedule_id Schedule ID
1491
+ # @param [Hash] opts the optional parameters
1492
+ # @return [Array<(ReportRunEntry, Fixnum, Hash)>] ReportRunEntry data, response status code and response headers
1493
+ def get_reporting_schedules_schedule_id_history_latest_with_http_info(schedule_id, opts = {})
1494
+ if @api_client.config.debugging
1495
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules_schedule_id_history_latest ..."
1496
+ end
1497
+
1498
+ # verify the required parameter 'schedule_id' is set
1499
+ fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedules_schedule_id_history_latest" if schedule_id.nil?
1500
+
1501
+ # resource path
1502
+ path = "/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1503
+
1504
+ # query parameters
1505
+ query_params = {}
1506
+
1507
+ # header parameters
1508
+ header_params = {}
1509
+
1510
+ # HTTP header 'Accept' (if needed)
1511
+ _header_accept = ['application/json']
1512
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1513
+
1514
+ # HTTP header 'Content-Type'
1515
+ _header_content_type = ['application/json']
1516
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1517
+
1518
+ # form parameters
1519
+ form_params = {}
1520
+
1521
+ # http body (model)
1522
+ post_body = nil
1523
+
1524
+
1525
+ auth_names = ['PureCloud Auth']
1526
+ data, status_code, headers = @api_client.call_api(:GET, path,
1527
+ :header_params => header_params,
1528
+ :query_params => query_params,
1529
+ :form_params => form_params,
1530
+ :body => post_body,
1531
+ :auth_names => auth_names,
1532
+ :return_type => 'ReportRunEntry')
1533
+ if @api_client.config.debugging
1534
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedules_schedule_id_history_latest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1535
+ end
1536
+ return data, status_code, headers
1537
+ end
1538
+
1539
+ # A completed scheduled report job
1540
+ # A completed scheduled report job.
1541
+ # @param run_id Run ID
1542
+ # @param schedule_id Schedule ID
1543
+ # @param [Hash] opts the optional parameters
1544
+ # @return [ReportRunEntry]
1545
+ def get_reporting_schedules_schedule_id_history_run_id(run_id, schedule_id, opts = {})
1546
+ data, status_code, headers = get_reporting_schedules_schedule_id_history_run_id_with_http_info(run_id, schedule_id, opts)
1547
+ return data
1548
+ end
1549
+
1550
+ # A completed scheduled report job
1551
+ # A completed scheduled report job.
1552
+ # @param run_id Run ID
1553
+ # @param schedule_id Schedule ID
1554
+ # @param [Hash] opts the optional parameters
1555
+ # @return [Array<(ReportRunEntry, Fixnum, Hash)>] ReportRunEntry data, response status code and response headers
1556
+ def get_reporting_schedules_schedule_id_history_run_id_with_http_info(run_id, schedule_id, opts = {})
1557
+ if @api_client.config.debugging
1558
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules_schedule_id_history_run_id ..."
1559
+ end
1560
+
1561
+ # verify the required parameter 'run_id' is set
1562
+ fail "Missing the required parameter 'run_id' when calling get_reporting_schedules_schedule_id_history_run_id" if run_id.nil?
1563
+
1564
+ # verify the required parameter 'schedule_id' is set
1565
+ fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedules_schedule_id_history_run_id" if schedule_id.nil?
1566
+
1567
+ # resource path
1568
+ path = "/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}".sub('{format}','json').sub('{' + 'runId' + '}', run_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1569
+
1570
+ # query parameters
1571
+ query_params = {}
1572
+
1573
+ # header parameters
1574
+ header_params = {}
1575
+
1576
+ # HTTP header 'Accept' (if needed)
1577
+ _header_accept = ['application/json']
1578
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1579
+
1580
+ # HTTP header 'Content-Type'
1581
+ _header_content_type = ['application/json']
1582
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1583
+
1584
+ # form parameters
1585
+ form_params = {}
1586
+
1587
+ # http body (model)
1588
+ post_body = nil
1589
+
1590
+
1591
+ auth_names = ['PureCloud Auth']
1592
+ data, status_code, headers = @api_client.call_api(:GET, path,
1593
+ :header_params => header_params,
1594
+ :query_params => query_params,
1595
+ :form_params => form_params,
1596
+ :body => post_body,
1597
+ :auth_names => auth_names,
1598
+ :return_type => 'ReportRunEntry')
1599
+ if @api_client.config.debugging
1600
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedules_schedule_id_history_run_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1601
+ end
1602
+ return data, status_code, headers
1603
+ end
1604
+
1605
+ # Place a scheduled report immediately into the reporting queue
1606
+ #
1607
+ # @param schedule_id Schedule ID
1608
+ # @param [Hash] opts the optional parameters
1609
+ # @return [RunNowResponse]
1610
+ def post_reporting_schedules_schedule_id_runreport(schedule_id, opts = {})
1611
+ data, status_code, headers = post_reporting_schedules_schedule_id_runreport_with_http_info(schedule_id, opts)
1612
+ return data
1613
+ end
1614
+
1615
+ # Place a scheduled report immediately into the reporting queue
1616
+ #
1617
+ # @param schedule_id Schedule ID
1618
+ # @param [Hash] opts the optional parameters
1619
+ # @return [Array<(RunNowResponse, Fixnum, Hash)>] RunNowResponse data, response status code and response headers
1620
+ def post_reporting_schedules_schedule_id_runreport_with_http_info(schedule_id, opts = {})
1621
+ if @api_client.config.debugging
1622
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_reporting_schedules_schedule_id_runreport ..."
1623
+ end
1624
+
1625
+ # verify the required parameter 'schedule_id' is set
1626
+ fail "Missing the required parameter 'schedule_id' when calling post_reporting_schedules_schedule_id_runreport" if schedule_id.nil?
1627
+
1628
+ # resource path
1629
+ path = "/api/v2/analytics/reporting/schedules/{scheduleId}/runreport".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
1630
+
1631
+ # query parameters
1632
+ query_params = {}
1633
+
1634
+ # header parameters
1635
+ header_params = {}
1636
+
1637
+ # HTTP header 'Accept' (if needed)
1638
+ _header_accept = ['application/json']
1639
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1640
+
1641
+ # HTTP header 'Content-Type'
1642
+ _header_content_type = ['application/json']
1643
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1644
+
1645
+ # form parameters
1646
+ form_params = {}
1647
+
1648
+ # http body (model)
1649
+ post_body = nil
1650
+
1651
+
1652
+ auth_names = ['PureCloud Auth']
1653
+ data, status_code, headers = @api_client.call_api(:POST, path,
1654
+ :header_params => header_params,
1655
+ :query_params => query_params,
1656
+ :form_params => form_params,
1657
+ :body => post_body,
1658
+ :auth_names => auth_names,
1659
+ :return_type => 'RunNowResponse')
1660
+ if @api_client.config.debugging
1661
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_reporting_schedules_schedule_id_runreport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1662
+ end
1663
+ return data, status_code, headers
1664
+ end
1665
+
1666
+ # Get a list of report time periods.
1667
+ #
1668
+ # @param [Hash] opts the optional parameters
1669
+ # @return [Array<String>]
1670
+ def get_reporting_timeperiods(opts = {})
1671
+ data, status_code, headers = get_reporting_timeperiods_with_http_info(opts)
1672
+ return data
1673
+ end
1674
+
1675
+ # Get a list of report time periods.
1676
+ #
1677
+ # @param [Hash] opts the optional parameters
1678
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
1679
+ def get_reporting_timeperiods_with_http_info(opts = {})
1680
+ if @api_client.config.debugging
1681
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_timeperiods ..."
1682
+ end
1683
+
1684
+ # resource path
1685
+ path = "/api/v2/analytics/reporting/timeperiods".sub('{format}','json')
1686
+
1687
+ # query parameters
1688
+ query_params = {}
1689
+
1690
+ # header parameters
1691
+ header_params = {}
1692
+
1693
+ # HTTP header 'Accept' (if needed)
1694
+ _header_accept = ['application/json']
1695
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1696
+
1697
+ # HTTP header 'Content-Type'
1698
+ _header_content_type = ['application/json']
1699
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1700
+
1701
+ # form parameters
1702
+ form_params = {}
1703
+
1704
+ # http body (model)
1705
+ post_body = nil
1706
+
1707
+
1708
+ auth_names = ['PureCloud Auth']
1709
+ data, status_code, headers = @api_client.call_api(:GET, path,
1710
+ :header_params => header_params,
1711
+ :query_params => query_params,
1712
+ :form_params => form_params,
1713
+ :body => post_body,
1714
+ :auth_names => auth_names,
1715
+ :return_type => 'Array<String>')
1716
+ if @api_client.config.debugging
1717
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_timeperiods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1718
+ end
1719
+ return data, status_code, headers
1720
+ end
1721
+
1722
+ # Get a reporting metadata.
1723
+ #
1724
+ # @param report_id Report ID
1725
+ # @param [Hash] opts the optional parameters
1726
+ # @option opts [String] :locale Locale
1727
+ # @return [ReportMetaData]
1728
+ def get_reporting_report_id_metadata(report_id, opts = {})
1729
+ data, status_code, headers = get_reporting_report_id_metadata_with_http_info(report_id, opts)
1730
+ return data
1731
+ end
1732
+
1733
+ # Get a reporting metadata.
1734
+ #
1735
+ # @param report_id Report ID
1736
+ # @param [Hash] opts the optional parameters
1737
+ # @option opts [String] :locale Locale
1738
+ # @return [Array<(ReportMetaData, Fixnum, Hash)>] ReportMetaData data, response status code and response headers
1739
+ def get_reporting_report_id_metadata_with_http_info(report_id, opts = {})
1740
+ if @api_client.config.debugging
1741
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_report_id_metadata ..."
1742
+ end
1743
+
1744
+ # verify the required parameter 'report_id' is set
1745
+ fail "Missing the required parameter 'report_id' when calling get_reporting_report_id_metadata" if report_id.nil?
1746
+
1747
+ # resource path
1748
+ path = "/api/v2/analytics/reporting/{reportId}/metadata".sub('{format}','json').sub('{' + 'reportId' + '}', report_id.to_s)
1749
+
1750
+ # query parameters
1751
+ query_params = {}
1752
+ query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
1753
+
1754
+ # header parameters
1755
+ header_params = {}
1756
+
1757
+ # HTTP header 'Accept' (if needed)
1758
+ _header_accept = ['application/json']
1759
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1760
+
1761
+ # HTTP header 'Content-Type'
1762
+ _header_content_type = ['application/json']
1763
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1764
+
1765
+ # form parameters
1766
+ form_params = {}
1767
+
1768
+ # http body (model)
1769
+ post_body = nil
1770
+
1771
+
1772
+ auth_names = ['PureCloud Auth']
1773
+ data, status_code, headers = @api_client.call_api(:GET, path,
1774
+ :header_params => header_params,
1775
+ :query_params => query_params,
1776
+ :form_params => form_params,
1777
+ :body => post_body,
1778
+ :auth_names => auth_names,
1779
+ :return_type => 'ReportMetaData')
1780
+ if @api_client.config.debugging
1781
+ @api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_report_id_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1782
+ end
1783
+ return data, status_code, headers
1784
+ end
1785
+
1786
+ # Query for user aggregates
1787
+ #
1788
+ # @param [Hash] opts the optional parameters
1789
+ # @option opts [AggregationQuery] :body query
1790
+ # @return [PresenceQueryResponse]
1791
+ def post_users_aggregates_query(opts = {})
1792
+ data, status_code, headers = post_users_aggregates_query_with_http_info(opts)
1793
+ return data
1794
+ end
1795
+
1796
+ # Query for user aggregates
1797
+ #
1798
+ # @param [Hash] opts the optional parameters
1799
+ # @option opts [AggregationQuery] :body query
1800
+ # @return [Array<(PresenceQueryResponse, Fixnum, Hash)>] PresenceQueryResponse data, response status code and response headers
1801
+ def post_users_aggregates_query_with_http_info(opts = {})
1802
+ if @api_client.config.debugging
1803
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_users_aggregates_query ..."
1804
+ end
1805
+
1806
+ # resource path
1807
+ path = "/api/v2/analytics/users/aggregates/query".sub('{format}','json')
1808
+
1809
+ # query parameters
1810
+ query_params = {}
1811
+
1812
+ # header parameters
1813
+ header_params = {}
1814
+
1815
+ # HTTP header 'Accept' (if needed)
1816
+ _header_accept = ['application/json']
1817
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1818
+
1819
+ # HTTP header 'Content-Type'
1820
+ _header_content_type = ['application/json']
1821
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1822
+
1823
+ # form parameters
1824
+ form_params = {}
1825
+
1826
+ # http body (model)
1827
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1828
+
1829
+
1830
+ auth_names = ['PureCloud Auth']
1831
+ data, status_code, headers = @api_client.call_api(:POST, path,
1832
+ :header_params => header_params,
1833
+ :query_params => query_params,
1834
+ :form_params => form_params,
1835
+ :body => post_body,
1836
+ :auth_names => auth_names,
1837
+ :return_type => 'PresenceQueryResponse')
1838
+ if @api_client.config.debugging
1839
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1840
+ end
1841
+ return data, status_code, headers
1842
+ end
1843
+
1844
+ # Query for user observations
1845
+ #
1846
+ # @param [Hash] opts the optional parameters
1847
+ # @option opts [ObservationQuery] :body query
1848
+ # @return [ObservationQueryResponse]
1849
+ def post_users_observations_query(opts = {})
1850
+ data, status_code, headers = post_users_observations_query_with_http_info(opts)
1851
+ return data
1852
+ end
1853
+
1854
+ # Query for user observations
1855
+ #
1856
+ # @param [Hash] opts the optional parameters
1857
+ # @option opts [ObservationQuery] :body query
1858
+ # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers
1859
+ def post_users_observations_query_with_http_info(opts = {})
1860
+ if @api_client.config.debugging
1861
+ @api_client.config.logger.debug "Calling API: AnalyticsApi#post_users_observations_query ..."
1862
+ end
1863
+
1864
+ # resource path
1865
+ path = "/api/v2/analytics/users/observations/query".sub('{format}','json')
1866
+
1867
+ # query parameters
1868
+ query_params = {}
1869
+
1870
+ # header parameters
1871
+ header_params = {}
1872
+
1873
+ # HTTP header 'Accept' (if needed)
1874
+ _header_accept = ['application/json']
1875
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1876
+
1877
+ # HTTP header 'Content-Type'
1878
+ _header_content_type = ['application/json']
1879
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1880
+
1881
+ # form parameters
1882
+ form_params = {}
1883
+
1884
+ # http body (model)
1885
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1886
+
1887
+
1888
+ auth_names = ['PureCloud Auth']
1889
+ data, status_code, headers = @api_client.call_api(:POST, path,
1890
+ :header_params => header_params,
1891
+ :query_params => query_params,
1892
+ :form_params => form_params,
1893
+ :body => post_body,
1894
+ :auth_names => auth_names,
1895
+ :return_type => 'ObservationQueryResponse')
1896
+ if @api_client.config.debugging
1897
+ @api_client.config.logger.debug "API called: AnalyticsApi#post_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1898
+ end
1899
+ return data, status_code, headers
1900
+ end
1901
+ end
1902
+ end
1903
+
1904
+
1905
+
1906
+