purecloud 0.28.0 → 0.29.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (294) hide show
  1. checksums.yaml +4 -4
  2. data/config-ruby.json +1 -1
  3. data/lib/purecloud.rb +119 -110
  4. data/lib/purecloud/api/alerting_api.rb +609 -0
  5. data/lib/purecloud/api/analytics_api.rb +0 -618
  6. data/lib/purecloud/api/authorization_api.rb +32 -26
  7. data/lib/purecloud/api/callbacks_api.rb +5 -5
  8. data/lib/purecloud/api/calls_api.rb +5 -5
  9. data/lib/purecloud/api/chats_api.rb +5 -5
  10. data/lib/purecloud/api/configuration_api.rb +325 -4514
  11. data/lib/purecloud/api/conversations_api.rb +30 -157
  12. data/lib/purecloud/api/emails_api.rb +5 -5
  13. data/lib/purecloud/api/groups_api.rb +120 -0
  14. data/lib/purecloud/api/integrations_api.rb +6 -0
  15. data/lib/purecloud/api/integrations_workforce_management_api.rb +73 -0
  16. data/lib/purecloud/api/languages_api.rb +181 -0
  17. data/lib/purecloud/api/organization_api.rb +243 -0
  18. data/lib/purecloud/api/outbound_api.rb +13 -380
  19. data/lib/purecloud/api/presence_api.rb +20 -222
  20. data/lib/purecloud/api/quality_api.rb +30 -0
  21. data/lib/purecloud/api/recording_api.rb +12 -0
  22. data/lib/purecloud/api/routing_api.rb +211 -8
  23. data/lib/purecloud/api/scripts_api.rb +8 -2
  24. data/lib/purecloud/api/search_api.rb +315 -13
  25. data/lib/purecloud/api/socials_api.rb +5 -5
  26. data/lib/purecloud/api/telephony_providers_edge_api.rb +4594 -698
  27. data/lib/purecloud/api/users_api.rb +303 -44
  28. data/lib/purecloud/api/utilities_api.rb +0 -58
  29. data/lib/purecloud/api/videos_api.rb +5 -5
  30. data/lib/purecloud/models/address.rb +49 -51
  31. data/lib/purecloud/models/address_listing.rb +12 -12
  32. data/lib/purecloud/models/agent_activity_entity_listing.rb +11 -11
  33. data/lib/purecloud/models/{analytics_segment.rb → analytics_conversation_segment.rb} +8 -8
  34. data/lib/purecloud/models/analytics_query_predicate.rb +1 -1
  35. data/lib/purecloud/models/analytics_session.rb +1 -1
  36. data/lib/purecloud/models/attribute_entity_listing.rb +11 -11
  37. data/lib/purecloud/models/{primary_user_presence_source.rb → audit_entity.rb} +12 -24
  38. data/lib/purecloud/models/{facet.rb → audit_facet.rb} +1 -1
  39. data/lib/purecloud/models/audit_filter.rb +178 -0
  40. data/lib/purecloud/models/audit_message.rb +2 -2
  41. data/lib/purecloud/models/{facet_group.rb → audit_user.rb} +18 -20
  42. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +11 -11
  43. data/lib/purecloud/models/available_additional_service_listing.rb +11 -11
  44. data/lib/purecloud/models/available_topic_entity_listing.rb +11 -11
  45. data/lib/purecloud/models/{chat_search_item.rb → billing_address.rb} +37 -27
  46. data/lib/purecloud/models/calibration_entity_listing.rb +11 -11
  47. data/lib/purecloud/models/call.rb +16 -4
  48. data/lib/purecloud/models/call_conversation.rb +1 -1
  49. data/lib/purecloud/models/{chat_search_listing.rb → call_conversation_entity_listing.rb} +13 -13
  50. data/lib/purecloud/models/{call_participant.rb → call_media_participant.rb} +1 -1
  51. data/lib/purecloud/models/callable_time.rb +1 -1
  52. data/lib/purecloud/models/callable_time_set_entity_listing.rb +11 -11
  53. data/lib/purecloud/models/callback_conversation.rb +1 -1
  54. data/lib/purecloud/models/callback_conversation_entity_listing.rb +238 -0
  55. data/lib/purecloud/models/{callback_participant.rb → callback_media_participant.rb} +1 -1
  56. data/lib/purecloud/models/campaign.rb +219 -17
  57. data/lib/purecloud/models/campaign_entity_listing.rb +11 -11
  58. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +11 -11
  59. data/lib/purecloud/models/{facet_item.rb → campaign_time_slot.rb} +20 -20
  60. data/lib/purecloud/models/carrier_entity_listing.rb +11 -11
  61. data/lib/purecloud/models/certificate_authority_entity_listing.rb +11 -11
  62. data/lib/purecloud/models/change.rb +1 -1
  63. data/lib/purecloud/models/channel_entity_listing.rb +11 -11
  64. data/lib/purecloud/models/channel_topic_entity_listing.rb +11 -11
  65. data/lib/purecloud/models/chat_conversation.rb +1 -1
  66. data/lib/purecloud/models/{rule_entity_listing.rb → chat_conversation_entity_listing.rb} +13 -13
  67. data/lib/purecloud/models/{chat_participant.rb → chat_media_participant.rb} +1 -1
  68. data/lib/purecloud/models/command_status_entity_listing.rb +11 -11
  69. data/lib/purecloud/models/common_audit_request.rb +2 -2
  70. data/lib/purecloud/models/{template.rb → composer_template.rb} +2 -2
  71. data/lib/purecloud/models/consumed_resources_entity_listing.rb +11 -11
  72. data/lib/purecloud/models/consuming_resources_entity_listing.rb +11 -11
  73. data/lib/purecloud/models/{client_transform_model.rb → contact_address.rb} +42 -36
  74. data/lib/purecloud/models/contact_list.rb +111 -1
  75. data/lib/purecloud/models/contact_list_entity_listing.rb +11 -11
  76. data/lib/purecloud/models/contact_listing.rb +11 -11
  77. data/lib/purecloud/models/{dialer_disposition_call_command.rb → contact_phone_number_column.rb} +20 -20
  78. data/lib/purecloud/models/{facet_filter_item.rb → content_filter_item.rb} +1 -1
  79. data/lib/purecloud/models/{transform_progress.rb → conversation_chat.rb} +91 -82
  80. data/lib/purecloud/models/conversation_entity_listing.rb +11 -11
  81. data/lib/purecloud/models/create_share_request.rb +2 -2
  82. data/lib/purecloud/models/create_share_request_member.rb +1 -1
  83. data/lib/purecloud/models/customer_account.rb +1 -1
  84. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +11 -11
  85. data/lib/purecloud/models/dependency_object_entity_listing.rb +11 -11
  86. data/lib/purecloud/models/dependency_type_entity_listing.rb +11 -11
  87. data/lib/purecloud/models/{action.rb → dialer_action.rb} +1 -1
  88. data/lib/purecloud/models/dialer_audit_request.rb +2 -2
  89. data/lib/purecloud/models/{transform_model.rb → dialer_contact.rb} +42 -28
  90. data/lib/purecloud/models/{rule.rb → dialer_rule.rb} +2 -2
  91. data/lib/purecloud/models/did.rb +1 -1
  92. data/lib/purecloud/models/did_entity_listing.rb +11 -11
  93. data/lib/purecloud/models/did_pool.rb +1 -1
  94. data/lib/purecloud/models/did_pool_entity_listing.rb +11 -11
  95. data/lib/purecloud/models/{metric_threshold.rb → disconnect_reason.rb} +29 -19
  96. data/lib/purecloud/models/dnc_list_entity_listing.rb +11 -11
  97. data/lib/purecloud/models/document_audit_entity_listing.rb +11 -11
  98. data/lib/purecloud/models/document_entity_listing.rb +11 -11
  99. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +11 -11
  100. data/lib/purecloud/models/domain_certificate_authority.rb +1 -1
  101. data/lib/purecloud/models/domain_entity_listing.rb +11 -11
  102. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +11 -11
  103. data/lib/purecloud/models/domain_entity_listing_query_result.rb +11 -11
  104. data/lib/purecloud/models/domain_invoice_entity_listing.rb +11 -11
  105. data/lib/purecloud/models/domain_logical_interface.rb +28 -2
  106. data/lib/purecloud/models/{dialer_place_call_command.rb → domain_role.rb} +16 -14
  107. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +11 -11
  108. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +11 -11
  109. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +11 -11
  110. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +11 -11
  111. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +11 -11
  112. data/lib/purecloud/models/edge.rb +1 -1
  113. data/lib/purecloud/models/edge_entity_listing.rb +11 -11
  114. data/lib/purecloud/models/edge_group.rb +1 -1
  115. data/lib/purecloud/models/edge_group_entity_listing.rb +11 -11
  116. data/lib/purecloud/models/edge_line.rb +1 -1
  117. data/lib/purecloud/models/edge_line_entity_listing.rb +11 -11
  118. data/lib/purecloud/models/email_conversation.rb +1 -1
  119. data/lib/purecloud/models/{user_presence_entity_listing.rb → email_conversation_entity_listing.rb} +13 -13
  120. data/lib/purecloud/models/{email_participant.rb → email_media_participant.rb} +1 -1
  121. data/lib/purecloud/models/email_message.rb +56 -26
  122. data/lib/purecloud/models/email_message_listing.rb +11 -11
  123. data/lib/purecloud/models/encryption_key_entity_listing.rb +11 -11
  124. data/lib/purecloud/models/endpoint.rb +2 -2
  125. data/lib/purecloud/models/endpoint_entity_listing.rb +11 -11
  126. data/lib/purecloud/models/entity.rb +20 -10
  127. data/lib/purecloud/models/evaluation_entity_listing.rb +11 -11
  128. data/lib/purecloud/models/evaluation_form_entity_listing.rb +11 -11
  129. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +11 -11
  130. data/lib/purecloud/models/extension.rb +1 -1
  131. data/lib/purecloud/models/extension_entity_listing.rb +11 -11
  132. data/lib/purecloud/models/extension_pool.rb +1 -1
  133. data/lib/purecloud/models/extension_pool_entity_listing.rb +11 -11
  134. data/lib/purecloud/models/external_contact.rb +1 -1
  135. data/lib/purecloud/models/external_organization.rb +1 -1
  136. data/lib/purecloud/models/external_organization_listing.rb +11 -11
  137. data/lib/purecloud/models/fax_document_entity_listing.rb +11 -11
  138. data/lib/purecloud/models/flow_body.rb +1 -1
  139. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +11 -11
  140. data/lib/purecloud/models/flow_entity_listing.rb +11 -11
  141. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +11 -11
  142. data/lib/purecloud/models/flow_search_request.rb +222 -0
  143. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +11 -11
  144. data/lib/purecloud/models/flow_version_entity_listing.rb +11 -11
  145. data/lib/purecloud/models/group.rb +42 -36
  146. data/lib/purecloud/models/group_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/groups_search_response.rb +230 -0
  148. data/lib/purecloud/models/hardware_rate_listing.rb +11 -11
  149. data/lib/purecloud/models/health_check_info.rb +1 -31
  150. data/lib/purecloud/models/inbound_domain_entity_listing.rb +11 -11
  151. data/lib/purecloud/models/inbound_route_entity_listing.rb +11 -11
  152. data/lib/purecloud/models/integration_type_entity_listing.rb +11 -11
  153. data/lib/purecloud/models/interaction_stats_alert.rb +373 -0
  154. data/lib/purecloud/models/interaction_stats_alert_container.rb +238 -0
  155. data/lib/purecloud/models/{alert.rb → interaction_stats_rule.rb} +111 -80
  156. data/lib/purecloud/models/interaction_stats_rule_container.rb +238 -0
  157. data/lib/purecloud/models/ivr.rb +1 -1
  158. data/lib/purecloud/models/ivr_entity_listing.rb +11 -11
  159. data/lib/purecloud/models/json_node.rb +395 -0
  160. data/lib/purecloud/models/json_node_search_response.rb +228 -0
  161. data/lib/purecloud/models/language_entity_listing.rb +11 -11
  162. data/lib/purecloud/models/library_entity_listing.rb +11 -11
  163. data/lib/purecloud/models/line.rb +2 -2
  164. data/lib/purecloud/models/line_base.rb +1 -1
  165. data/lib/purecloud/models/line_base_entity_listing.rb +11 -11
  166. data/lib/purecloud/models/line_entity_listing.rb +11 -11
  167. data/lib/purecloud/models/{body_1.rb → line_properties.rb} +1 -1
  168. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +11 -11
  169. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +11 -11
  170. data/lib/purecloud/models/location_entity_listing.rb +11 -11
  171. data/lib/purecloud/models/logical_interface_entity_listing.rb +11 -11
  172. data/lib/purecloud/models/media_participant_request.rb +232 -0
  173. data/lib/purecloud/models/{inline_response_200.rb → member_entity.rb} +13 -3
  174. data/lib/purecloud/models/note_listing.rb +11 -11
  175. data/lib/purecloud/models/number_plan.rb +1 -1
  176. data/lib/purecloud/models/o_auth_client.rb +1 -1
  177. data/lib/purecloud/models/o_auth_client_entity_listing.rb +11 -11
  178. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +11 -11
  179. data/lib/purecloud/models/organization.rb +2 -22
  180. data/lib/purecloud/models/organization_presence_entity_listing.rb +11 -11
  181. data/lib/purecloud/models/organization_role_entity_listing.rb +11 -11
  182. data/lib/purecloud/models/orphan_recording_listing.rb +11 -11
  183. data/lib/purecloud/models/outbound_route.rb +1 -1
  184. data/lib/purecloud/models/outbound_route_entity_listing.rb +11 -11
  185. data/lib/purecloud/models/page.rb +2 -2
  186. data/lib/purecloud/models/participant.rb +1 -1
  187. data/lib/purecloud/models/participant_request.rb +7 -0
  188. data/lib/purecloud/models/payment_method_listing.rb +11 -11
  189. data/lib/purecloud/models/permission_collection_entity_listing.rb +11 -11
  190. data/lib/purecloud/models/phone.rb +2 -2
  191. data/lib/purecloud/models/phone_base.rb +1 -1
  192. data/lib/purecloud/models/phone_base_entity_listing.rb +11 -11
  193. data/lib/purecloud/models/phone_entity_listing.rb +11 -11
  194. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +11 -11
  195. data/lib/purecloud/models/physical_interface_entity_listing.rb +11 -11
  196. data/lib/purecloud/models/policy_entity_listing.rb +11 -11
  197. data/lib/purecloud/models/prompt_asset.rb +25 -1
  198. data/lib/purecloud/models/prompt_asset_entity_listing.rb +11 -11
  199. data/lib/purecloud/models/prompt_entity_listing.rb +11 -11
  200. data/lib/purecloud/models/quality_audit_page.rb +11 -11
  201. data/lib/purecloud/models/query_request.rb +1 -1
  202. data/lib/purecloud/models/queue.rb +1 -1
  203. data/lib/purecloud/models/queue_entity_listing.rb +11 -11
  204. data/lib/purecloud/models/queues_entity_listing.rb +11 -11
  205. data/lib/purecloud/models/quote_charge.rb +1 -1
  206. data/lib/purecloud/models/quote_listing.rb +11 -11
  207. data/lib/purecloud/models/recording.rb +13 -2
  208. data/lib/purecloud/models/{preview.rb → recording_email_message.rb} +72 -57
  209. data/lib/purecloud/models/relationship_listing.rb +11 -11
  210. data/lib/purecloud/models/report_meta_data_entity_listing.rb +11 -11
  211. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +11 -11
  212. data/lib/purecloud/models/report_schedule.rb +1 -1
  213. data/lib/purecloud/models/report_schedule_entity_listing.rb +11 -11
  214. data/lib/purecloud/models/resource_permission_policy.rb +1 -11
  215. data/lib/purecloud/models/response.rb +84 -14
  216. data/lib/purecloud/models/response_entity_list.rb +11 -11
  217. data/lib/purecloud/models/response_entity_listing.rb +11 -11
  218. data/lib/purecloud/models/{filter.rb → response_filter.rb} +1 -1
  219. data/lib/purecloud/models/response_query_request.rb +1 -1
  220. data/lib/purecloud/models/response_set_entity_listing.rb +11 -11
  221. data/lib/purecloud/models/rule_set.rb +1 -1
  222. data/lib/purecloud/models/rule_set_entity_listing.rb +11 -11
  223. data/lib/purecloud/models/schedule.rb +1 -1
  224. data/lib/purecloud/models/schedule_entity_listing.rb +11 -11
  225. data/lib/purecloud/models/schedule_group.rb +1 -1
  226. data/lib/purecloud/models/schedule_group_entity_listing.rb +11 -11
  227. data/lib/purecloud/models/schema_category_entity_listing.rb +11 -11
  228. data/lib/purecloud/models/schema_reference_entity_listing.rb +11 -11
  229. data/lib/purecloud/models/script_entity_listing.rb +11 -11
  230. data/lib/purecloud/models/{occurrence.rb → search_aggregation.rb} +19 -9
  231. data/lib/purecloud/models/{conversation_historical_query_request_filter.rb → search_criteria.rb} +83 -24
  232. data/lib/purecloud/models/search_request.rb +73 -50
  233. data/lib/purecloud/models/security_profile_entity_listing.rb +11 -11
  234. data/lib/purecloud/models/service_entity_listing.rb +11 -11
  235. data/lib/purecloud/models/share_entity_listing.rb +11 -11
  236. data/lib/purecloud/models/{group_images.rb → shared_entity.rb} +8 -10
  237. data/lib/purecloud/models/site.rb +1 -1
  238. data/lib/purecloud/models/site_entity_listing.rb +11 -11
  239. data/lib/purecloud/models/skill_entity_listing.rb +11 -11
  240. data/lib/purecloud/models/social_conversation.rb +1 -1
  241. data/lib/purecloud/models/social_conversation_entity_listing.rb +238 -0
  242. data/lib/purecloud/models/{social_participant.rb → social_media_participant.rb} +1 -1
  243. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +11 -11
  244. data/lib/purecloud/models/station.rb +11 -1
  245. data/lib/purecloud/models/station_entity_listing.rb +11 -11
  246. data/lib/purecloud/models/{facets.rb → subscriber_response.rb} +16 -16
  247. data/lib/purecloud/models/system_prompt_asset.rb +25 -1
  248. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +11 -11
  249. data/lib/purecloud/models/system_prompt_entity_listing.rb +11 -11
  250. data/lib/purecloud/models/tag_value_entity_listing.rb +11 -11
  251. data/lib/purecloud/models/template_entity_listing.rb +12 -12
  252. data/lib/purecloud/models/text_table_transform_entity_listing.rb +11 -11
  253. data/lib/purecloud/models/time_slot.rb +3 -0
  254. data/lib/purecloud/models/time_zone_entity_listing.rb +11 -11
  255. data/lib/purecloud/models/trunk_base.rb +2 -2
  256. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +11 -11
  257. data/lib/purecloud/models/unread_metric.rb +1 -0
  258. data/lib/purecloud/models/unread_status.rb +149 -0
  259. data/lib/purecloud/models/user.rb +7 -7
  260. data/lib/purecloud/models/user_action_category_entity_listing.rb +11 -11
  261. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +11 -11
  262. data/lib/purecloud/models/user_authorization.rb +7 -37
  263. data/lib/purecloud/models/user_entity_listing.rb +11 -11
  264. data/lib/purecloud/models/user_me.rb +375 -0
  265. data/lib/purecloud/models/user_presence.rb +14 -32
  266. data/lib/purecloud/models/user_queue.rb +1 -1
  267. data/lib/purecloud/models/user_queue_entity_listing.rb +11 -11
  268. data/lib/purecloud/models/user_recording_entity_listing.rb +11 -11
  269. data/lib/purecloud/models/user_skill_entity_listing.rb +11 -11
  270. data/lib/purecloud/models/users_entity_listing.rb +11 -11
  271. data/lib/purecloud/models/users_search_response.rb +230 -0
  272. data/lib/purecloud/models/validate_address_response.rb +1 -1
  273. data/lib/purecloud/models/video_conversation.rb +1 -1
  274. data/lib/purecloud/models/{alert_entity_listing.rb → video_conversation_entity_listing.rb} +13 -13
  275. data/lib/purecloud/models/{video_participant.rb → video_media_participant.rb} +1 -1
  276. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +11 -11
  277. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +11 -11
  278. data/lib/purecloud/models/voicemail_message_entity_listing.rb +11 -11
  279. data/lib/purecloud/models/workspace_entity_listing.rb +11 -11
  280. data/lib/purecloud/models/workspace_member_entity_listing.rb +11 -11
  281. data/lib/purecloud/models/wrapup_code_entity_listing.rb +11 -11
  282. data/lib/purecloud/version.rb +1 -1
  283. data/newVersion.md +1 -1
  284. data/swagger.json +1 -1
  285. data/version.json +1 -1
  286. metadata +54 -45
  287. data/lib/purecloud/api/architect_api.rb +0 -3285
  288. data/lib/purecloud/models/chat_search_request.rb +0 -244
  289. data/lib/purecloud/models/conversation_historical_query_request_body.rb +0 -185
  290. data/lib/purecloud/models/conversation_query_response.rb +0 -366
  291. data/lib/purecloud/models/dialer_call.rb +0 -156
  292. data/lib/purecloud/models/penetration_rate.rb +0 -176
  293. data/lib/purecloud/models/penetration_rate_id.rb +0 -156
  294. data/lib/purecloud/models/progress_model.rb +0 -169
@@ -8,624 +8,6 @@ module PureCloud
8
8
  @api_client = api_client
9
9
  end
10
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
11
  # Query for conversation aggregates
630
12
  #
631
13
  # @param [Hash] opts the optional parameters