purecloudclient_v2a 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1104) hide show
  1. checksums.yaml +7 -0
  2. data/bin/console +14 -0
  3. data/bin/setup +8 -0
  4. data/lib/purecloudclient_v2a.rb +1186 -0
  5. data/lib/purecloudclient_v2a/api/alerting_api.rb +783 -0
  6. data/lib/purecloudclient_v2a/api/analytics_api.rb +1518 -0
  7. data/lib/purecloudclient_v2a/api/architect_api.rb +5354 -0
  8. data/lib/purecloudclient_v2a/api/attributes_api.rb +434 -0
  9. data/lib/purecloudclient_v2a/api/authorization_api.rb +1287 -0
  10. data/lib/purecloudclient_v2a/api/billing_api.rb +104 -0
  11. data/lib/purecloudclient_v2a/api/content_management_api.rb +3133 -0
  12. data/lib/purecloudclient_v2a/api/conversations_api.rb +6365 -0
  13. data/lib/purecloudclient_v2a/api/external_contacts_api.rb +2415 -0
  14. data/lib/purecloudclient_v2a/api/fax_api.rb +424 -0
  15. data/lib/purecloudclient_v2a/api/geolocation_api.rb +307 -0
  16. data/lib/purecloudclient_v2a/api/greetings_api.rb +1163 -0
  17. data/lib/purecloudclient_v2a/api/groups_api.rb +921 -0
  18. data/lib/purecloudclient_v2a/api/identity_provider_api.rb +1657 -0
  19. data/lib/purecloudclient_v2a/api/integrations_api.rb +1749 -0
  20. data/lib/purecloudclient_v2a/api/languages_api.rb +697 -0
  21. data/lib/purecloudclient_v2a/api/license_api.rb +523 -0
  22. data/lib/purecloudclient_v2a/api/locations_api.rb +318 -0
  23. data/lib/purecloudclient_v2a/api/mobile_devices_api.rb +380 -0
  24. data/lib/purecloudclient_v2a/api/notifications_api.rb +480 -0
  25. data/lib/purecloudclient_v2a/api/o_auth_api.rb +416 -0
  26. data/lib/purecloudclient_v2a/api/organization_api.rb +296 -0
  27. data/lib/purecloudclient_v2a/api/organization_authorization_api.rb +1751 -0
  28. data/lib/purecloudclient_v2a/api/outbound_api.rb +6699 -0
  29. data/lib/purecloudclient_v2a/api/presence_api.rb +611 -0
  30. data/lib/purecloudclient_v2a/api/quality_api.rb +2866 -0
  31. data/lib/purecloudclient_v2a/api/recording_api.rb +2700 -0
  32. data/lib/purecloudclient_v2a/api/response_management_api.rb +839 -0
  33. data/lib/purecloudclient_v2a/api/routing_api.rb +3320 -0
  34. data/lib/purecloudclient_v2a/api/scripts_api.rb +938 -0
  35. data/lib/purecloudclient_v2a/api/search_api.rb +1034 -0
  36. data/lib/purecloudclient_v2a/api/signed_data_api.rb +90 -0
  37. data/lib/purecloudclient_v2a/api/stations_api.rb +283 -0
  38. data/lib/purecloudclient_v2a/api/suggest_api.rb +343 -0
  39. data/lib/purecloudclient_v2a/api/telephony_providers_edge_api.rb +9640 -0
  40. data/lib/purecloudclient_v2a/api/tokens_api.rb +136 -0
  41. data/lib/purecloudclient_v2a/api/user_recordings_api.rb +464 -0
  42. data/lib/purecloudclient_v2a/api/users_api.rb +3422 -0
  43. data/lib/purecloudclient_v2a/api/utilities_api.rb +220 -0
  44. data/lib/purecloudclient_v2a/api/voicemail_api.rb +1657 -0
  45. data/lib/purecloudclient_v2a/api/workforce_management_api.rb +1100 -0
  46. data/lib/purecloudclient_v2a/api_client.rb +339 -0
  47. data/lib/purecloudclient_v2a/api_error.rb +40 -0
  48. data/lib/purecloudclient_v2a/configuration.rb +170 -0
  49. data/lib/purecloudclient_v2a/models/action.rb +409 -0
  50. data/lib/purecloudclient_v2a/models/action_config.rb +229 -0
  51. data/lib/purecloudclient_v2a/models/action_contract.rb +229 -0
  52. data/lib/purecloudclient_v2a/models/action_contract_input.rb +239 -0
  53. data/lib/purecloudclient_v2a/models/action_entity_listing.rb +428 -0
  54. data/lib/purecloudclient_v2a/models/action_input.rb +255 -0
  55. data/lib/purecloudclient_v2a/models/action_output.rb +333 -0
  56. data/lib/purecloudclient_v2a/models/actions.rb +203 -0
  57. data/lib/purecloudclient_v2a/models/active_alert_count.rb +202 -0
  58. data/lib/purecloudclient_v2a/models/activity_code.rb +399 -0
  59. data/lib/purecloudclient_v2a/models/activity_code_container.rb +205 -0
  60. data/lib/purecloudclient_v2a/models/acw_settings.rb +242 -0
  61. data/lib/purecloudclient_v2a/models/address.rb +306 -0
  62. data/lib/purecloudclient_v2a/models/addressable_entity_user.rb +228 -0
  63. data/lib/purecloudclient_v2a/models/addressable_license_definition.rb +228 -0
  64. data/lib/purecloudclient_v2a/models/adfs.rb +378 -0
  65. data/lib/purecloudclient_v2a/models/adherence_settings.rb +335 -0
  66. data/lib/purecloudclient_v2a/models/adjacents.rb +257 -0
  67. data/lib/purecloudclient_v2a/models/agent.rb +202 -0
  68. data/lib/purecloudclient_v2a/models/agent_activity.rb +355 -0
  69. data/lib/purecloudclient_v2a/models/agent_activity_entity_listing.rb +428 -0
  70. data/lib/purecloudclient_v2a/models/agent_activity_notification.rb +328 -0
  71. data/lib/purecloudclient_v2a/models/agent_activity_notification_organization_presence.rb +226 -0
  72. data/lib/purecloudclient_v2a/models/agent_activity_notification_out_of_office.rb +226 -0
  73. data/lib/purecloudclient_v2a/models/agent_activity_notification_presence.rb +251 -0
  74. data/lib/purecloudclient_v2a/models/agent_activity_notification_presence_presence_definition.rb +226 -0
  75. data/lib/purecloudclient_v2a/models/agent_activity_notification_routing_status.rb +240 -0
  76. data/lib/purecloudclient_v2a/models/agent_evaluator_activity.rb +353 -0
  77. data/lib/purecloudclient_v2a/models/agent_management_unit_reference.rb +229 -0
  78. data/lib/purecloudclient_v2a/models/aggregate_data_container.rb +231 -0
  79. data/lib/purecloudclient_v2a/models/aggregate_metric_data.rb +265 -0
  80. data/lib/purecloudclient_v2a/models/aggregate_query_response.rb +203 -0
  81. data/lib/purecloudclient_v2a/models/aggregate_view_data.rb +226 -0
  82. data/lib/purecloudclient_v2a/models/aggregation_query.rb +390 -0
  83. data/lib/purecloudclient_v2a/models/aggregation_range.rb +228 -0
  84. data/lib/purecloudclient_v2a/models/aggregation_result.rb +319 -0
  85. data/lib/purecloudclient_v2a/models/aggregation_result_entry.rb +279 -0
  86. data/lib/purecloudclient_v2a/models/analytics_conversation.rb +310 -0
  87. data/lib/purecloudclient_v2a/models/analytics_conversation_query_response.rb +230 -0
  88. data/lib/purecloudclient_v2a/models/analytics_conversation_segment.rb +825 -0
  89. data/lib/purecloudclient_v2a/models/analytics_evaluation.rb +436 -0
  90. data/lib/purecloudclient_v2a/models/analytics_participant.rb +374 -0
  91. data/lib/purecloudclient_v2a/models/analytics_property.rb +283 -0
  92. data/lib/purecloudclient_v2a/models/analytics_query_aggregation.rb +322 -0
  93. data/lib/purecloudclient_v2a/models/analytics_query_clause.rb +254 -0
  94. data/lib/purecloudclient_v2a/models/analytics_query_filter.rb +277 -0
  95. data/lib/purecloudclient_v2a/models/analytics_query_predicate.rb +454 -0
  96. data/lib/purecloudclient_v2a/models/analytics_routing_status_record.rb +294 -0
  97. data/lib/purecloudclient_v2a/models/analytics_session.rb +1165 -0
  98. data/lib/purecloudclient_v2a/models/analytics_user_detail.rb +258 -0
  99. data/lib/purecloudclient_v2a/models/analytics_user_details_query_response.rb +230 -0
  100. data/lib/purecloudclient_v2a/models/analytics_user_presence_record.rb +320 -0
  101. data/lib/purecloudclient_v2a/models/analytics_view.rb +309 -0
  102. data/lib/purecloudclient_v2a/models/annotation.rb +756 -0
  103. data/lib/purecloudclient_v2a/models/answer_option.rb +251 -0
  104. data/lib/purecloudclient_v2a/models/archive_retention.rb +240 -0
  105. data/lib/purecloudclient_v2a/models/asg_info_response.rb +334 -0
  106. data/lib/purecloudclient_v2a/models/attachment.rb +301 -0
  107. data/lib/purecloudclient_v2a/models/attempt_limits.rb +477 -0
  108. data/lib/purecloudclient_v2a/models/attempt_limits_entity_listing.rb +428 -0
  109. data/lib/purecloudclient_v2a/models/attempt_limits_notification.rb +492 -0
  110. data/lib/purecloudclient_v2a/models/attempt_limits_notification_recall_entries.rb +251 -0
  111. data/lib/purecloudclient_v2a/models/attempt_limits_notification_recall_entry.rb +251 -0
  112. data/lib/purecloudclient_v2a/models/attribute.rb +411 -0
  113. data/lib/purecloudclient_v2a/models/attribute_entity_listing.rb +428 -0
  114. data/lib/purecloudclient_v2a/models/attribute_filter_item.rb +267 -0
  115. data/lib/purecloudclient_v2a/models/attribute_query_request.rb +255 -0
  116. data/lib/purecloudclient_v2a/models/audit_change.rb +280 -0
  117. data/lib/purecloudclient_v2a/models/audit_entity.rb +285 -0
  118. data/lib/purecloudclient_v2a/models/audit_entity_reference.rb +315 -0
  119. data/lib/purecloudclient_v2a/models/audit_facet.rb +238 -0
  120. data/lib/purecloudclient_v2a/models/audit_filter.rb +302 -0
  121. data/lib/purecloudclient_v2a/models/audit_message.rb +617 -0
  122. data/lib/purecloudclient_v2a/models/audit_query_response.rb +176 -0
  123. data/lib/purecloudclient_v2a/models/audit_search_result.rb +334 -0
  124. data/lib/purecloudclient_v2a/models/audit_user.rb +259 -0
  125. data/lib/purecloudclient_v2a/models/available_language_list.rb +203 -0
  126. data/lib/purecloudclient_v2a/models/available_topic.rb +281 -0
  127. data/lib/purecloudclient_v2a/models/available_topic_entity_listing.rb +203 -0
  128. data/lib/purecloudclient_v2a/models/available_translations.rb +230 -0
  129. data/lib/purecloudclient_v2a/models/billing_usage.rb +271 -0
  130. data/lib/purecloudclient_v2a/models/billing_usage_report.rb +348 -0
  131. data/lib/purecloudclient_v2a/models/billing_usage_resource.rb +238 -0
  132. data/lib/purecloudclient_v2a/models/bullseye.rb +203 -0
  133. data/lib/purecloudclient_v2a/models/calibration.rb +583 -0
  134. data/lib/purecloudclient_v2a/models/calibration_assignment.rb +278 -0
  135. data/lib/purecloudclient_v2a/models/calibration_create.rb +589 -0
  136. data/lib/purecloudclient_v2a/models/calibration_entity_listing.rb +428 -0
  137. data/lib/purecloudclient_v2a/models/call.rb +807 -0
  138. data/lib/purecloudclient_v2a/models/call_basic.rb +807 -0
  139. data/lib/purecloudclient_v2a/models/call_command.rb +233 -0
  140. data/lib/purecloudclient_v2a/models/call_conversation.rb +348 -0
  141. data/lib/purecloudclient_v2a/models/call_conversation_entity_listing.rb +428 -0
  142. data/lib/purecloudclient_v2a/models/call_conversation_notification.rb +319 -0
  143. data/lib/purecloudclient_v2a/models/call_conversation_notification_call_media_participant.rb +1184 -0
  144. data/lib/purecloudclient_v2a/models/call_conversation_notification_detail.rb +276 -0
  145. data/lib/purecloudclient_v2a/models/call_conversation_notification_error_body.rb +432 -0
  146. data/lib/purecloudclient_v2a/models/call_conversation_notification_error_info.rb +432 -0
  147. data/lib/purecloudclient_v2a/models/call_conversation_notification_fax_status.rb +376 -0
  148. data/lib/purecloudclient_v2a/models/call_conversation_notification_participants.rb +1184 -0
  149. data/lib/purecloudclient_v2a/models/call_conversation_notification_uri_reference.rb +226 -0
  150. data/lib/purecloudclient_v2a/models/call_conversation_notification_wrapup.rb +328 -0
  151. data/lib/purecloudclient_v2a/models/call_forwarding.rb +424 -0
  152. data/lib/purecloudclient_v2a/models/call_history_conversation.rb +425 -0
  153. data/lib/purecloudclient_v2a/models/call_history_conversation_entity_listing.rb +428 -0
  154. data/lib/purecloudclient_v2a/models/call_history_participant.rb +648 -0
  155. data/lib/purecloudclient_v2a/models/call_media_participant.rb +1222 -0
  156. data/lib/purecloudclient_v2a/models/call_media_policy.rb +228 -0
  157. data/lib/purecloudclient_v2a/models/call_media_policy_conditions.rb +361 -0
  158. data/lib/purecloudclient_v2a/models/call_record.rb +228 -0
  159. data/lib/purecloudclient_v2a/models/call_route.rb +230 -0
  160. data/lib/purecloudclient_v2a/models/call_target.rb +242 -0
  161. data/lib/purecloudclient_v2a/models/callable_contacts_diagnostic.rb +284 -0
  162. data/lib/purecloudclient_v2a/models/callable_time.rb +240 -0
  163. data/lib/purecloudclient_v2a/models/callable_time_set.rb +370 -0
  164. data/lib/purecloudclient_v2a/models/callable_time_set_entity_listing.rb +428 -0
  165. data/lib/purecloudclient_v2a/models/callable_time_set_notification.rb +353 -0
  166. data/lib/purecloudclient_v2a/models/callable_time_set_notification_callable_time.rb +253 -0
  167. data/lib/purecloudclient_v2a/models/callable_time_set_notification_callable_times.rb +253 -0
  168. data/lib/purecloudclient_v2a/models/callable_time_set_notification_time_slot.rb +276 -0
  169. data/lib/purecloudclient_v2a/models/callable_time_set_notification_time_slots.rb +276 -0
  170. data/lib/purecloudclient_v2a/models/callback.rb +742 -0
  171. data/lib/purecloudclient_v2a/models/callback_basic.rb +742 -0
  172. data/lib/purecloudclient_v2a/models/callback_conversation.rb +309 -0
  173. data/lib/purecloudclient_v2a/models/callback_conversation_entity_listing.rb +428 -0
  174. data/lib/purecloudclient_v2a/models/callback_conversation_notification.rb +280 -0
  175. data/lib/purecloudclient_v2a/models/callback_conversation_notification_callback_media_participant.rb +1097 -0
  176. data/lib/purecloudclient_v2a/models/callback_conversation_notification_detail.rb +276 -0
  177. data/lib/purecloudclient_v2a/models/callback_conversation_notification_dialer_preview.rb +328 -0
  178. data/lib/purecloudclient_v2a/models/callback_conversation_notification_error_body.rb +432 -0
  179. data/lib/purecloudclient_v2a/models/callback_conversation_notification_error_info.rb +432 -0
  180. data/lib/purecloudclient_v2a/models/callback_conversation_notification_error_info_details.rb +276 -0
  181. data/lib/purecloudclient_v2a/models/callback_conversation_notification_participants.rb +1097 -0
  182. data/lib/purecloudclient_v2a/models/callback_conversation_notification_phone_number_column.rb +251 -0
  183. data/lib/purecloudclient_v2a/models/callback_conversation_notification_uri_reference.rb +226 -0
  184. data/lib/purecloudclient_v2a/models/callback_conversation_notification_voicemail.rb +240 -0
  185. data/lib/purecloudclient_v2a/models/callback_conversation_notification_wrapup.rb +328 -0
  186. data/lib/purecloudclient_v2a/models/callback_identifier.rb +252 -0
  187. data/lib/purecloudclient_v2a/models/callback_media_participant.rb +1106 -0
  188. data/lib/purecloudclient_v2a/models/campaign.rb +1052 -0
  189. data/lib/purecloudclient_v2a/models/campaign_diagnostics.rb +282 -0
  190. data/lib/purecloudclient_v2a/models/campaign_entity_listing.rb +428 -0
  191. data/lib/purecloudclient_v2a/models/campaign_interaction.rb +727 -0
  192. data/lib/purecloudclient_v2a/models/campaign_interactions.rb +336 -0
  193. data/lib/purecloudclient_v2a/models/campaign_notification.rb +1016 -0
  194. data/lib/purecloudclient_v2a/models/campaign_notification_contact_sort.rb +290 -0
  195. data/lib/purecloudclient_v2a/models/campaign_notification_errors.rb +251 -0
  196. data/lib/purecloudclient_v2a/models/campaign_notification_phone_column.rb +251 -0
  197. data/lib/purecloudclient_v2a/models/campaign_notification_phone_columns.rb +251 -0
  198. data/lib/purecloudclient_v2a/models/campaign_notification_rest_error_detail.rb +251 -0
  199. data/lib/purecloudclient_v2a/models/campaign_notification_uri_reference.rb +226 -0
  200. data/lib/purecloudclient_v2a/models/campaign_progress.rb +316 -0
  201. data/lib/purecloudclient_v2a/models/campaign_progress_notification.rb +301 -0
  202. data/lib/purecloudclient_v2a/models/campaign_progress_notification_uri_reference.rb +226 -0
  203. data/lib/purecloudclient_v2a/models/campaign_rule.rb +485 -0
  204. data/lib/purecloudclient_v2a/models/campaign_rule_action.rb +303 -0
  205. data/lib/purecloudclient_v2a/models/campaign_rule_action_entities.rb +258 -0
  206. data/lib/purecloudclient_v2a/models/campaign_rule_condition.rb +277 -0
  207. data/lib/purecloudclient_v2a/models/campaign_rule_entities.rb +232 -0
  208. data/lib/purecloudclient_v2a/models/campaign_rule_entity_listing.rb +428 -0
  209. data/lib/purecloudclient_v2a/models/campaign_rule_notification.rb +455 -0
  210. data/lib/purecloudclient_v2a/models/campaign_rule_notification_campaign_rule_action.rb +317 -0
  211. data/lib/purecloudclient_v2a/models/campaign_rule_notification_campaign_rule_action_entities.rb +280 -0
  212. data/lib/purecloudclient_v2a/models/campaign_rule_notification_campaign_rule_actions.rb +317 -0
  213. data/lib/purecloudclient_v2a/models/campaign_rule_notification_campaign_rule_condition.rb +292 -0
  214. data/lib/purecloudclient_v2a/models/campaign_rule_notification_campaign_rule_conditions.rb +292 -0
  215. data/lib/purecloudclient_v2a/models/campaign_rule_notification_campaign_rule_entities.rb +230 -0
  216. data/lib/purecloudclient_v2a/models/campaign_rule_notification_uri_reference.rb +226 -0
  217. data/lib/purecloudclient_v2a/models/campaign_rule_parameters.rb +322 -0
  218. data/lib/purecloudclient_v2a/models/campaign_schedule.rb +426 -0
  219. data/lib/purecloudclient_v2a/models/campaign_schedule_notification.rb +403 -0
  220. data/lib/purecloudclient_v2a/models/campaign_schedule_notification_intervals.rb +251 -0
  221. data/lib/purecloudclient_v2a/models/campaign_schedule_notification_schedule_interval.rb +251 -0
  222. data/lib/purecloudclient_v2a/models/campaign_schedule_notification_uri_reference.rb +226 -0
  223. data/lib/purecloudclient_v2a/models/campaign_sequence.rb +492 -0
  224. data/lib/purecloudclient_v2a/models/campaign_sequence_entity_listing.rb +428 -0
  225. data/lib/purecloudclient_v2a/models/campaign_sequence_notification.rb +467 -0
  226. data/lib/purecloudclient_v2a/models/campaign_sequence_notification_uri_reference.rb +226 -0
  227. data/lib/purecloudclient_v2a/models/campaign_stats.rb +332 -0
  228. data/lib/purecloudclient_v2a/models/campaign_time_slot.rb +269 -0
  229. data/lib/purecloudclient_v2a/models/category.rb +203 -0
  230. data/lib/purecloudclient_v2a/models/category_entity_listing.rb +303 -0
  231. data/lib/purecloudclient_v2a/models/certificate.rb +208 -0
  232. data/lib/purecloudclient_v2a/models/certificate_authority_entity_listing.rb +428 -0
  233. data/lib/purecloudclient_v2a/models/certificate_details.rb +357 -0
  234. data/lib/purecloudclient_v2a/models/change.rb +283 -0
  235. data/lib/purecloudclient_v2a/models/channel.rb +227 -0
  236. data/lib/purecloudclient_v2a/models/channel_entity_listing.rb +203 -0
  237. data/lib/purecloudclient_v2a/models/channel_topic.rb +228 -0
  238. data/lib/purecloudclient_v2a/models/channel_topic_entity_listing.rb +203 -0
  239. data/lib/purecloudclient_v2a/models/chat.rb +201 -0
  240. data/lib/purecloudclient_v2a/models/chat_conversation.rb +309 -0
  241. data/lib/purecloudclient_v2a/models/chat_conversation_entity_listing.rb +428 -0
  242. data/lib/purecloudclient_v2a/models/chat_conversation_notification.rb +280 -0
  243. data/lib/purecloudclient_v2a/models/chat_conversation_notification_chat_media_participant.rb +920 -0
  244. data/lib/purecloudclient_v2a/models/chat_conversation_notification_detail.rb +276 -0
  245. data/lib/purecloudclient_v2a/models/chat_conversation_notification_error_body.rb +432 -0
  246. data/lib/purecloudclient_v2a/models/chat_conversation_notification_error_info.rb +432 -0
  247. data/lib/purecloudclient_v2a/models/chat_conversation_notification_participants.rb +920 -0
  248. data/lib/purecloudclient_v2a/models/chat_conversation_notification_uri_reference.rb +226 -0
  249. data/lib/purecloudclient_v2a/models/chat_conversation_notification_wrapup.rb +328 -0
  250. data/lib/purecloudclient_v2a/models/chat_media_participant.rb +922 -0
  251. data/lib/purecloudclient_v2a/models/chat_media_policy.rb +228 -0
  252. data/lib/purecloudclient_v2a/models/chat_media_policy_conditions.rb +334 -0
  253. data/lib/purecloudclient_v2a/models/chat_message.rb +401 -0
  254. data/lib/purecloudclient_v2a/models/chat_message_user.rb +303 -0
  255. data/lib/purecloudclient_v2a/models/cobrowse_conversation.rb +309 -0
  256. data/lib/purecloudclient_v2a/models/cobrowse_conversation_entity_listing.rb +428 -0
  257. data/lib/purecloudclient_v2a/models/cobrowse_conversation_notification.rb +280 -0
  258. data/lib/purecloudclient_v2a/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +1022 -0
  259. data/lib/purecloudclient_v2a/models/cobrowse_conversation_notification_detail.rb +276 -0
  260. data/lib/purecloudclient_v2a/models/cobrowse_conversation_notification_error_body.rb +432 -0
  261. data/lib/purecloudclient_v2a/models/cobrowse_conversation_notification_error_info.rb +432 -0
  262. data/lib/purecloudclient_v2a/models/cobrowse_conversation_notification_participants.rb +1022 -0
  263. data/lib/purecloudclient_v2a/models/cobrowse_conversation_notification_uri_reference.rb +226 -0
  264. data/lib/purecloudclient_v2a/models/cobrowse_conversation_notification_wrapup.rb +328 -0
  265. data/lib/purecloudclient_v2a/models/cobrowse_media_participant.rb +1028 -0
  266. data/lib/purecloudclient_v2a/models/cobrowsesession.rb +572 -0
  267. data/lib/purecloudclient_v2a/models/command_status.rb +407 -0
  268. data/lib/purecloudclient_v2a/models/command_status_entity_listing.rb +428 -0
  269. data/lib/purecloudclient_v2a/models/condition.rb +468 -0
  270. data/lib/purecloudclient_v2a/models/connect_rate.rb +254 -0
  271. data/lib/purecloudclient_v2a/models/consult_transfer.rb +247 -0
  272. data/lib/purecloudclient_v2a/models/consult_transfer_response.rb +207 -0
  273. data/lib/purecloudclient_v2a/models/consult_transfer_update.rb +221 -0
  274. data/lib/purecloudclient_v2a/models/consumed_resources_entity_listing.rb +428 -0
  275. data/lib/purecloudclient_v2a/models/consuming_resources_entity_listing.rb +428 -0
  276. data/lib/purecloudclient_v2a/models/contact.rb +332 -0
  277. data/lib/purecloudclient_v2a/models/contact_address.rb +326 -0
  278. data/lib/purecloudclient_v2a/models/contact_callback_request.rb +331 -0
  279. data/lib/purecloudclient_v2a/models/contact_list.rb +529 -0
  280. data/lib/purecloudclient_v2a/models/contact_list_entity_listing.rb +428 -0
  281. data/lib/purecloudclient_v2a/models/contact_list_filter.rb +436 -0
  282. data/lib/purecloudclient_v2a/models/contact_list_filter_clause.rb +244 -0
  283. data/lib/purecloudclient_v2a/models/contact_list_filter_entity_listing.rb +428 -0
  284. data/lib/purecloudclient_v2a/models/contact_list_filter_notification.rb +444 -0
  285. data/lib/purecloudclient_v2a/models/contact_list_filter_notification_clauses.rb +267 -0
  286. data/lib/purecloudclient_v2a/models/contact_list_filter_notification_filter_clause.rb +267 -0
  287. data/lib/purecloudclient_v2a/models/contact_list_filter_notification_filter_predicate.rb +379 -0
  288. data/lib/purecloudclient_v2a/models/contact_list_filter_notification_predicates.rb +379 -0
  289. data/lib/purecloudclient_v2a/models/contact_list_filter_notification_range.rb +328 -0
  290. data/lib/purecloudclient_v2a/models/contact_list_filter_notification_uri_reference.rb +226 -0
  291. data/lib/purecloudclient_v2a/models/contact_list_filter_predicate.rb +360 -0
  292. data/lib/purecloudclient_v2a/models/contact_list_filter_range.rb +308 -0
  293. data/lib/purecloudclient_v2a/models/contact_list_notification.rb +507 -0
  294. data/lib/purecloudclient_v2a/models/contact_list_notification_contact_phone_number_column.rb +276 -0
  295. data/lib/purecloudclient_v2a/models/contact_list_notification_import_status.rb +340 -0
  296. data/lib/purecloudclient_v2a/models/contact_list_notification_phone_columns.rb +276 -0
  297. data/lib/purecloudclient_v2a/models/contact_list_notification_uri_reference.rb +226 -0
  298. data/lib/purecloudclient_v2a/models/contact_listing.rb +428 -0
  299. data/lib/purecloudclient_v2a/models/contact_phone_number_column.rb +264 -0
  300. data/lib/purecloudclient_v2a/models/contact_sort.rb +267 -0
  301. data/lib/purecloudclient_v2a/models/content_attribute_filter_item.rb +267 -0
  302. data/lib/purecloudclient_v2a/models/content_facet_filter_item.rb +306 -0
  303. data/lib/purecloudclient_v2a/models/content_filter_item.rb +306 -0
  304. data/lib/purecloudclient_v2a/models/content_query_request.rb +384 -0
  305. data/lib/purecloudclient_v2a/models/content_sort_item.rb +226 -0
  306. data/lib/purecloudclient_v2a/models/conversation.rb +503 -0
  307. data/lib/purecloudclient_v2a/models/conversation_association.rb +309 -0
  308. data/lib/purecloudclient_v2a/models/conversation_basic.rb +337 -0
  309. data/lib/purecloudclient_v2a/models/conversation_chat.rb +584 -0
  310. data/lib/purecloudclient_v2a/models/conversation_entity_listing.rb +428 -0
  311. data/lib/purecloudclient_v2a/models/conversation_notification.rb +303 -0
  312. data/lib/purecloudclient_v2a/models/conversation_notification_address.rb +326 -0
  313. data/lib/purecloudclient_v2a/models/conversation_notification_call.rb +809 -0
  314. data/lib/purecloudclient_v2a/models/conversation_notification_callback.rb +720 -0
  315. data/lib/purecloudclient_v2a/models/conversation_notification_callbacks.rb +720 -0
  316. data/lib/purecloudclient_v2a/models/conversation_notification_calls.rb +809 -0
  317. data/lib/purecloudclient_v2a/models/conversation_notification_chat.rb +504 -0
  318. data/lib/purecloudclient_v2a/models/conversation_notification_chats.rb +504 -0
  319. data/lib/purecloudclient_v2a/models/conversation_notification_cobrowse.rb +606 -0
  320. data/lib/purecloudclient_v2a/models/conversation_notification_cobrowsesessions.rb +606 -0
  321. data/lib/purecloudclient_v2a/models/conversation_notification_dialer_preview.rb +328 -0
  322. data/lib/purecloudclient_v2a/models/conversation_notification_disconnect_reason.rb +265 -0
  323. data/lib/purecloudclient_v2a/models/conversation_notification_disconnect_reasons.rb +265 -0
  324. data/lib/purecloudclient_v2a/models/conversation_notification_email.rb +643 -0
  325. data/lib/purecloudclient_v2a/models/conversation_notification_emails.rb +643 -0
  326. data/lib/purecloudclient_v2a/models/conversation_notification_error_details.rb +378 -0
  327. data/lib/purecloudclient_v2a/models/conversation_notification_error_info.rb +378 -0
  328. data/lib/purecloudclient_v2a/models/conversation_notification_fax_status.rb +376 -0
  329. data/lib/purecloudclient_v2a/models/conversation_notification_message.rb +670 -0
  330. data/lib/purecloudclient_v2a/models/conversation_notification_message_details.rb +290 -0
  331. data/lib/purecloudclient_v2a/models/conversation_notification_messages.rb +290 -0
  332. data/lib/purecloudclient_v2a/models/conversation_notification_messages_1.rb +670 -0
  333. data/lib/purecloudclient_v2a/models/conversation_notification_participant.rb +960 -0
  334. data/lib/purecloudclient_v2a/models/conversation_notification_participants.rb +960 -0
  335. data/lib/purecloudclient_v2a/models/conversation_notification_phone_number_column.rb +251 -0
  336. data/lib/purecloudclient_v2a/models/conversation_notification_screenshare.rb +504 -0
  337. data/lib/purecloudclient_v2a/models/conversation_notification_screenshares.rb +504 -0
  338. data/lib/purecloudclient_v2a/models/conversation_notification_self.rb +326 -0
  339. data/lib/purecloudclient_v2a/models/conversation_notification_social_expression.rb +604 -0
  340. data/lib/purecloudclient_v2a/models/conversation_notification_social_expressions.rb +604 -0
  341. data/lib/purecloudclient_v2a/models/conversation_notification_video.rb +554 -0
  342. data/lib/purecloudclient_v2a/models/conversation_notification_videos.rb +554 -0
  343. data/lib/purecloudclient_v2a/models/conversation_notification_voicemail.rb +240 -0
  344. data/lib/purecloudclient_v2a/models/conversation_notification_wrapup.rb +328 -0
  345. data/lib/purecloudclient_v2a/models/conversation_query.rb +420 -0
  346. data/lib/purecloudclient_v2a/models/copy_voicemail_message.rb +260 -0
  347. data/lib/purecloudclient_v2a/models/cover_sheet.rb +228 -0
  348. data/lib/purecloudclient_v2a/models/create_asg_request.rb +455 -0
  349. data/lib/purecloudclient_v2a/models/create_call_request.rb +416 -0
  350. data/lib/purecloudclient_v2a/models/create_call_response.rb +253 -0
  351. data/lib/purecloudclient_v2a/models/create_callback_command.rb +393 -0
  352. data/lib/purecloudclient_v2a/models/create_callback_on_conversation_command.rb +393 -0
  353. data/lib/purecloudclient_v2a/models/create_callback_response.rb +240 -0
  354. data/lib/purecloudclient_v2a/models/create_email_request.rb +589 -0
  355. data/lib/purecloudclient_v2a/models/create_queue_request.rb +870 -0
  356. data/lib/purecloudclient_v2a/models/create_secure_session.rb +290 -0
  357. data/lib/purecloudclient_v2a/models/create_share_request.rb +344 -0
  358. data/lib/purecloudclient_v2a/models/create_share_request_member.rb +240 -0
  359. data/lib/purecloudclient_v2a/models/create_share_response.rb +485 -0
  360. data/lib/purecloudclient_v2a/models/create_user.rb +347 -0
  361. data/lib/purecloudclient_v2a/models/create_web_chat_request.rb +372 -0
  362. data/lib/purecloudclient_v2a/models/current_user_schedule_request_body.rb +239 -0
  363. data/lib/purecloudclient_v2a/models/customer_interaction_center.rb +353 -0
  364. data/lib/purecloudclient_v2a/models/default_greeting_list.rb +446 -0
  365. data/lib/purecloudclient_v2a/models/delete_retention.rb +201 -0
  366. data/lib/purecloudclient_v2a/models/dependency.rb +392 -0
  367. data/lib/purecloudclient_v2a/models/dependency_object.rb +446 -0
  368. data/lib/purecloudclient_v2a/models/dependency_object_entity_listing.rb +428 -0
  369. data/lib/purecloudclient_v2a/models/dependency_status.rb +421 -0
  370. data/lib/purecloudclient_v2a/models/dependency_tracking_build_notification_notification.rb +251 -0
  371. data/lib/purecloudclient_v2a/models/dependency_tracking_build_notification_notification_home_organization.rb +251 -0
  372. data/lib/purecloudclient_v2a/models/dependency_tracking_build_notification_notification_user.rb +251 -0
  373. data/lib/purecloudclient_v2a/models/dependency_tracking_build_notification_notification_user_home_org.rb +251 -0
  374. data/lib/purecloudclient_v2a/models/dependency_type.rb +278 -0
  375. data/lib/purecloudclient_v2a/models/dependency_type_entity_listing.rb +428 -0
  376. data/lib/purecloudclient_v2a/models/destination.rb +282 -0
  377. data/lib/purecloudclient_v2a/models/detail.rb +276 -0
  378. data/lib/purecloudclient_v2a/models/dialer_action.rb +334 -0
  379. data/lib/purecloudclient_v2a/models/dialer_audit_request.rb +286 -0
  380. data/lib/purecloudclient_v2a/models/dialer_contact.rb +399 -0
  381. data/lib/purecloudclient_v2a/models/dialer_event_entity_listing.rb +428 -0
  382. data/lib/purecloudclient_v2a/models/dialer_preview.rb +307 -0
  383. data/lib/purecloudclient_v2a/models/dialer_rule.rb +365 -0
  384. data/lib/purecloudclient_v2a/models/did.rb +622 -0
  385. data/lib/purecloudclient_v2a/models/did_entity_listing.rb +428 -0
  386. data/lib/purecloudclient_v2a/models/did_pool.rb +634 -0
  387. data/lib/purecloudclient_v2a/models/did_pool_entity_listing.rb +428 -0
  388. data/lib/purecloudclient_v2a/models/digit_length.rb +226 -0
  389. data/lib/purecloudclient_v2a/models/digits.rb +207 -0
  390. data/lib/purecloudclient_v2a/models/directory_user_devices_listing.rb +428 -0
  391. data/lib/purecloudclient_v2a/models/disconnect_reason.rb +268 -0
  392. data/lib/purecloudclient_v2a/models/dnc_list.rb +514 -0
  393. data/lib/purecloudclient_v2a/models/dnc_list_create.rb +509 -0
  394. data/lib/purecloudclient_v2a/models/dnc_list_entity_listing.rb +428 -0
  395. data/lib/purecloudclient_v2a/models/dnc_list_notification.rb +492 -0
  396. data/lib/purecloudclient_v2a/models/dnc_list_notification_import_status.rb +340 -0
  397. data/lib/purecloudclient_v2a/models/document.rb +1009 -0
  398. data/lib/purecloudclient_v2a/models/document_attribute.rb +228 -0
  399. data/lib/purecloudclient_v2a/models/document_audit.rb +637 -0
  400. data/lib/purecloudclient_v2a/models/document_audit_entity_listing.rb +428 -0
  401. data/lib/purecloudclient_v2a/models/document_data_v2_notification.rb +526 -0
  402. data/lib/purecloudclient_v2a/models/document_data_v2_notification_created_by.rb +226 -0
  403. data/lib/purecloudclient_v2a/models/document_data_v2_notification_lock_data.rb +251 -0
  404. data/lib/purecloudclient_v2a/models/document_data_v2_notification_lock_info.rb +251 -0
  405. data/lib/purecloudclient_v2a/models/document_data_v2_notification_user_data.rb +226 -0
  406. data/lib/purecloudclient_v2a/models/document_data_v2_notification_workspace.rb +201 -0
  407. data/lib/purecloudclient_v2a/models/document_data_v2_notification_workspace_data.rb +201 -0
  408. data/lib/purecloudclient_v2a/models/document_entity_listing.rb +428 -0
  409. data/lib/purecloudclient_v2a/models/document_thumbnail.rb +276 -0
  410. data/lib/purecloudclient_v2a/models/document_update.rb +419 -0
  411. data/lib/purecloudclient_v2a/models/document_upload.rb +292 -0
  412. data/lib/purecloudclient_v2a/models/documentation_result.rb +721 -0
  413. data/lib/purecloudclient_v2a/models/documentation_search_criteria.rb +423 -0
  414. data/lib/purecloudclient_v2a/models/documentation_search_request.rb +349 -0
  415. data/lib/purecloudclient_v2a/models/documentation_search_response.rb +444 -0
  416. data/lib/purecloudclient_v2a/models/domain_capabilities.rb +332 -0
  417. data/lib/purecloudclient_v2a/models/domain_certificate_authority.rb +645 -0
  418. data/lib/purecloudclient_v2a/models/domain_edge_software_update_dto.rb +449 -0
  419. data/lib/purecloudclient_v2a/models/domain_edge_software_version_dto.rb +379 -0
  420. data/lib/purecloudclient_v2a/models/domain_edge_software_version_dto_entity_listing.rb +428 -0
  421. data/lib/purecloudclient_v2a/models/domain_entity.rb +253 -0
  422. data/lib/purecloudclient_v2a/models/domain_entity_listing.rb +428 -0
  423. data/lib/purecloudclient_v2a/models/domain_entity_listing_evaluation_form.rb +428 -0
  424. data/lib/purecloudclient_v2a/models/domain_entity_listing_query_result.rb +428 -0
  425. data/lib/purecloudclient_v2a/models/domain_logical_interface.rb +1098 -0
  426. data/lib/purecloudclient_v2a/models/domain_network_address.rb +308 -0
  427. data/lib/purecloudclient_v2a/models/domain_network_command_response.rb +276 -0
  428. data/lib/purecloudclient_v2a/models/domain_network_route.rb +320 -0
  429. data/lib/purecloudclient_v2a/models/domain_org_role_difference.rb +307 -0
  430. data/lib/purecloudclient_v2a/models/domain_organization_product.rb +201 -0
  431. data/lib/purecloudclient_v2a/models/domain_organization_role.rb +458 -0
  432. data/lib/purecloudclient_v2a/models/domain_organization_role_create.rb +464 -0
  433. data/lib/purecloudclient_v2a/models/domain_organization_role_update.rb +464 -0
  434. data/lib/purecloudclient_v2a/models/domain_permission.rb +301 -0
  435. data/lib/purecloudclient_v2a/models/domain_permission_collection.rb +305 -0
  436. data/lib/purecloudclient_v2a/models/domain_permission_policy.rb +380 -0
  437. data/lib/purecloudclient_v2a/models/domain_physical_capabilities.rb +226 -0
  438. data/lib/purecloudclient_v2a/models/domain_physical_interface.rb +632 -0
  439. data/lib/purecloudclient_v2a/models/domain_resource_condition_node.rb +333 -0
  440. data/lib/purecloudclient_v2a/models/domain_resource_condition_value.rb +290 -0
  441. data/lib/purecloudclient_v2a/models/domain_role.rb +228 -0
  442. data/lib/purecloudclient_v2a/models/domain_schema_reference.rb +507 -0
  443. data/lib/purecloudclient_v2a/models/download_response.rb +253 -0
  444. data/lib/purecloudclient_v2a/models/draft_validation_result.rb +231 -0
  445. data/lib/purecloudclient_v2a/models/duration_condition.rb +265 -0
  446. data/lib/purecloudclient_v2a/models/edge.rb +1297 -0
  447. data/lib/purecloudclient_v2a/models/edge_auto_update_config.rb +278 -0
  448. data/lib/purecloudclient_v2a/models/edge_entity_listing.rb +428 -0
  449. data/lib/purecloudclient_v2a/models/edge_group.rb +597 -0
  450. data/lib/purecloudclient_v2a/models/edge_group_entity_listing.rb +428 -0
  451. data/lib/purecloudclient_v2a/models/edge_interface.rb +380 -0
  452. data/lib/purecloudclient_v2a/models/edge_line.rb +723 -0
  453. data/lib/purecloudclient_v2a/models/edge_line_entity_listing.rb +428 -0
  454. data/lib/purecloudclient_v2a/models/edge_logs_job.rb +535 -0
  455. data/lib/purecloudclient_v2a/models/edge_logs_job_file.rb +677 -0
  456. data/lib/purecloudclient_v2a/models/edge_logs_job_request.rb +254 -0
  457. data/lib/purecloudclient_v2a/models/edge_logs_job_response.rb +507 -0
  458. data/lib/purecloudclient_v2a/models/edge_logs_job_upload_request.rb +209 -0
  459. data/lib/purecloudclient_v2a/models/edge_metrics.rb +387 -0
  460. data/lib/purecloudclient_v2a/models/edge_metrics_disk.rb +254 -0
  461. data/lib/purecloudclient_v2a/models/edge_metrics_memory.rb +254 -0
  462. data/lib/purecloudclient_v2a/models/edge_metrics_network.rb +306 -0
  463. data/lib/purecloudclient_v2a/models/edge_metrics_processor.rb +306 -0
  464. data/lib/purecloudclient_v2a/models/edge_metrics_subsystem.rb +254 -0
  465. data/lib/purecloudclient_v2a/models/edge_reboot_parameters.rb +202 -0
  466. data/lib/purecloudclient_v2a/models/edge_service_state_request.rb +233 -0
  467. data/lib/purecloudclient_v2a/models/edge_trunk_base.rb +610 -0
  468. data/lib/purecloudclient_v2a/models/edge_version_information.rb +201 -0
  469. data/lib/purecloudclient_v2a/models/edge_version_report.rb +226 -0
  470. data/lib/purecloudclient_v2a/models/email.rb +687 -0
  471. data/lib/purecloudclient_v2a/models/email_address.rb +226 -0
  472. data/lib/purecloudclient_v2a/models/email_attachment.rb +301 -0
  473. data/lib/purecloudclient_v2a/models/email_conversation.rb +309 -0
  474. data/lib/purecloudclient_v2a/models/email_conversation_entity_listing.rb +428 -0
  475. data/lib/purecloudclient_v2a/models/email_conversation_notification.rb +280 -0
  476. data/lib/purecloudclient_v2a/models/email_conversation_notification_detail.rb +276 -0
  477. data/lib/purecloudclient_v2a/models/email_conversation_notification_email_media_participant.rb +995 -0
  478. data/lib/purecloudclient_v2a/models/email_conversation_notification_error_body.rb +432 -0
  479. data/lib/purecloudclient_v2a/models/email_conversation_notification_error_info.rb +432 -0
  480. data/lib/purecloudclient_v2a/models/email_conversation_notification_participants.rb +995 -0
  481. data/lib/purecloudclient_v2a/models/email_conversation_notification_uri_reference.rb +226 -0
  482. data/lib/purecloudclient_v2a/models/email_conversation_notification_wrapup.rb +328 -0
  483. data/lib/purecloudclient_v2a/models/email_media_participant.rb +974 -0
  484. data/lib/purecloudclient_v2a/models/email_media_policy.rb +228 -0
  485. data/lib/purecloudclient_v2a/models/email_media_policy_conditions.rb +309 -0
  486. data/lib/purecloudclient_v2a/models/email_message.rb +510 -0
  487. data/lib/purecloudclient_v2a/models/email_message_listing.rb +428 -0
  488. data/lib/purecloudclient_v2a/models/email_setup.rb +202 -0
  489. data/lib/purecloudclient_v2a/models/empty.rb +176 -0
  490. data/lib/purecloudclient_v2a/models/encryption_key.rb +357 -0
  491. data/lib/purecloudclient_v2a/models/encryption_key_entity_listing.rb +428 -0
  492. data/lib/purecloudclient_v2a/models/endpoint.rb +667 -0
  493. data/lib/purecloudclient_v2a/models/endpoint_entity_listing.rb +428 -0
  494. data/lib/purecloudclient_v2a/models/entity.rb +202 -0
  495. data/lib/purecloudclient_v2a/models/entry.rb +228 -0
  496. data/lib/purecloudclient_v2a/models/error_body.rb +432 -0
  497. data/lib/purecloudclient_v2a/models/error_details.rb +378 -0
  498. data/lib/purecloudclient_v2a/models/estimated_wait_time_predictions.rb +209 -0
  499. data/lib/purecloudclient_v2a/models/evaluation.rb +714 -0
  500. data/lib/purecloudclient_v2a/models/evaluation_assignment.rb +226 -0
  501. data/lib/purecloudclient_v2a/models/evaluation_entity_listing.rb +428 -0
  502. data/lib/purecloudclient_v2a/models/evaluation_form.rb +424 -0
  503. data/lib/purecloudclient_v2a/models/evaluation_form_and_scoring_set.rb +226 -0
  504. data/lib/purecloudclient_v2a/models/evaluation_form_entity_listing.rb +428 -0
  505. data/lib/purecloudclient_v2a/models/evaluation_scoring_set.rb +328 -0
  506. data/lib/purecloudclient_v2a/models/evaluator_activity.rb +428 -0
  507. data/lib/purecloudclient_v2a/models/evaluator_activity_entity_listing.rb +428 -0
  508. data/lib/purecloudclient_v2a/models/event_log.rb +457 -0
  509. data/lib/purecloudclient_v2a/models/event_message.rb +344 -0
  510. data/lib/purecloudclient_v2a/models/expansion_criterium.rb +240 -0
  511. data/lib/purecloudclient_v2a/models/export_uri.rb +227 -0
  512. data/lib/purecloudclient_v2a/models/export_uri_notification.rb +251 -0
  513. data/lib/purecloudclient_v2a/models/extension.rb +622 -0
  514. data/lib/purecloudclient_v2a/models/extension_entity_listing.rb +428 -0
  515. data/lib/purecloudclient_v2a/models/extension_pool.rb +559 -0
  516. data/lib/purecloudclient_v2a/models/extension_pool_entity_listing.rb +428 -0
  517. data/lib/purecloudclient_v2a/models/external_contact.rb +720 -0
  518. data/lib/purecloudclient_v2a/models/external_data_source.rb +243 -0
  519. data/lib/purecloudclient_v2a/models/external_organization.rb +670 -0
  520. data/lib/purecloudclient_v2a/models/external_organization_listing.rb +428 -0
  521. data/lib/purecloudclient_v2a/models/facet.rb +238 -0
  522. data/lib/purecloudclient_v2a/models/facet_entry.rb +392 -0
  523. data/lib/purecloudclient_v2a/models/facet_info.rb +230 -0
  524. data/lib/purecloudclient_v2a/models/facet_key_attribute.rb +251 -0
  525. data/lib/purecloudclient_v2a/models/facet_statistics.rb +353 -0
  526. data/lib/purecloudclient_v2a/models/facet_term.rb +327 -0
  527. data/lib/purecloudclient_v2a/models/failed_object.rb +276 -0
  528. data/lib/purecloudclient_v2a/models/fax_data_v2_notification.rb +601 -0
  529. data/lib/purecloudclient_v2a/models/fax_data_v2_notification_lock_data.rb +251 -0
  530. data/lib/purecloudclient_v2a/models/fax_data_v2_notification_lock_info.rb +251 -0
  531. data/lib/purecloudclient_v2a/models/fax_data_v2_notification_user_data.rb +226 -0
  532. data/lib/purecloudclient_v2a/models/fax_data_v2_notification_workspace_data.rb +201 -0
  533. data/lib/purecloudclient_v2a/models/fax_document.rb +632 -0
  534. data/lib/purecloudclient_v2a/models/fax_document_entity_listing.rb +428 -0
  535. data/lib/purecloudclient_v2a/models/fax_send_request.rb +430 -0
  536. data/lib/purecloudclient_v2a/models/fax_send_response.rb +317 -0
  537. data/lib/purecloudclient_v2a/models/fax_status.rb +384 -0
  538. data/lib/purecloudclient_v2a/models/fax_summary.rb +251 -0
  539. data/lib/purecloudclient_v2a/models/feature_state.rb +201 -0
  540. data/lib/purecloudclient_v2a/models/field_config.rb +394 -0
  541. data/lib/purecloudclient_v2a/models/field_configs.rb +276 -0
  542. data/lib/purecloudclient_v2a/models/field_list.rb +405 -0
  543. data/lib/purecloudclient_v2a/models/filter.rb +302 -0
  544. data/lib/purecloudclient_v2a/models/filter_preview_response.rb +253 -0
  545. data/lib/purecloudclient_v2a/models/flow.rb +600 -0
  546. data/lib/purecloudclient_v2a/models/flow_entity_listing.rb +428 -0
  547. data/lib/purecloudclient_v2a/models/flow_notification_notification.rb +376 -0
  548. data/lib/purecloudclient_v2a/models/flow_notification_notification_architect_operation.rb +431 -0
  549. data/lib/purecloudclient_v2a/models/flow_notification_notification_error_detail.rb +276 -0
  550. data/lib/purecloudclient_v2a/models/flow_notification_notification_error_message_params.rb +203 -0
  551. data/lib/purecloudclient_v2a/models/flow_notification_notification_flow_version.rb +201 -0
  552. data/lib/purecloudclient_v2a/models/flow_notification_notification_home_organization.rb +251 -0
  553. data/lib/purecloudclient_v2a/models/flow_notification_notification_user.rb +251 -0
  554. data/lib/purecloudclient_v2a/models/flow_version.rb +492 -0
  555. data/lib/purecloudclient_v2a/models/flow_version_entity_listing.rb +428 -0
  556. data/lib/purecloudclient_v2a/models/g_suite.rb +378 -0
  557. data/lib/purecloudclient_v2a/models/geolocation.rb +457 -0
  558. data/lib/purecloudclient_v2a/models/geolocation_notification.rb +301 -0
  559. data/lib/purecloudclient_v2a/models/geolocation_settings.rb +303 -0
  560. data/lib/purecloudclient_v2a/models/greeting.rb +526 -0
  561. data/lib/purecloudclient_v2a/models/greeting_audio_file.rb +251 -0
  562. data/lib/purecloudclient_v2a/models/greeting_listing.rb +428 -0
  563. data/lib/purecloudclient_v2a/models/greeting_media_info.rb +252 -0
  564. data/lib/purecloudclient_v2a/models/greeting_notification.rb +351 -0
  565. data/lib/purecloudclient_v2a/models/greeting_notification_greeting_audio_file.rb +226 -0
  566. data/lib/purecloudclient_v2a/models/greeting_notification_greeting_owner.rb +201 -0
  567. data/lib/purecloudclient_v2a/models/greeting_owner.rb +253 -0
  568. data/lib/purecloudclient_v2a/models/group.rb +577 -0
  569. data/lib/purecloudclient_v2a/models/group_contact.rb +323 -0
  570. data/lib/purecloudclient_v2a/models/group_entity_listing.rb +428 -0
  571. data/lib/purecloudclient_v2a/models/group_members_update.rb +240 -0
  572. data/lib/purecloudclient_v2a/models/group_profile.rb +350 -0
  573. data/lib/purecloudclient_v2a/models/group_search_criteria.rb +423 -0
  574. data/lib/purecloudclient_v2a/models/group_search_request.rb +349 -0
  575. data/lib/purecloudclient_v2a/models/group_update.rb +470 -0
  576. data/lib/purecloudclient_v2a/models/groups_search_response.rb +444 -0
  577. data/lib/purecloudclient_v2a/models/heart_beat_alert_notification.rb +444 -0
  578. data/lib/purecloudclient_v2a/models/heart_beat_alert_notification_notification_user.rb +226 -0
  579. data/lib/purecloudclient_v2a/models/heart_beat_alert_notification_notification_users.rb +226 -0
  580. data/lib/purecloudclient_v2a/models/heart_beat_rule_notification.rb +419 -0
  581. data/lib/purecloudclient_v2a/models/heart_beat_rule_notification_notification_user.rb +226 -0
  582. data/lib/purecloudclient_v2a/models/history_listing.rb +562 -0
  583. data/lib/purecloudclient_v2a/models/identity_now.rb +378 -0
  584. data/lib/purecloudclient_v2a/models/import_script_status_response.rb +251 -0
  585. data/lib/purecloudclient_v2a/models/import_status.rb +340 -0
  586. data/lib/purecloudclient_v2a/models/import_status_notification.rb +340 -0
  587. data/lib/purecloudclient_v2a/models/inbound_domain.rb +324 -0
  588. data/lib/purecloudclient_v2a/models/inbound_domain_entity_listing.rb +428 -0
  589. data/lib/purecloudclient_v2a/models/inbound_message_request.rb +497 -0
  590. data/lib/purecloudclient_v2a/models/inbound_route.rb +504 -0
  591. data/lib/purecloudclient_v2a/models/inbound_route_entity_listing.rb +428 -0
  592. data/lib/purecloudclient_v2a/models/initiate_screen_recording.rb +251 -0
  593. data/lib/purecloudclient_v2a/models/instance_info.rb +320 -0
  594. data/lib/purecloudclient_v2a/models/interaction_stat_alert_notification.rb +650 -0
  595. data/lib/purecloudclient_v2a/models/interaction_stat_alert_notification_notification_user.rb +226 -0
  596. data/lib/purecloudclient_v2a/models/interaction_stat_rule_notification.rb +600 -0
  597. data/lib/purecloudclient_v2a/models/interaction_stat_rule_notification_notification_user.rb +226 -0
  598. data/lib/purecloudclient_v2a/models/interaction_stats_alert.rb +756 -0
  599. data/lib/purecloudclient_v2a/models/interaction_stats_alert_container.rb +428 -0
  600. data/lib/purecloudclient_v2a/models/interaction_stats_rule.rb +669 -0
  601. data/lib/purecloudclient_v2a/models/interaction_stats_rule_container.rb +428 -0
  602. data/lib/purecloudclient_v2a/models/intraday_data_group.rb +384 -0
  603. data/lib/purecloudclient_v2a/models/intraday_data_update_notification.rb +357 -0
  604. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_forecast_data_per_interval.rb +251 -0
  605. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_historical_agent_data_per_interval.rb +226 -0
  606. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_historical_queue_data_per_interval.rb +376 -0
  607. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_data_group.rb +377 -0
  608. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_data_groupings.rb +377 -0
  609. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_forecast_data.rb +251 -0
  610. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_historical_agent_data.rb +226 -0
  611. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_historical_queue_data.rb +376 -0
  612. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_metric.rb +240 -0
  613. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_performance_prediction_agent_data.rb +201 -0
  614. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_performance_prediction_queue_data.rb +251 -0
  615. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_intraday_schedule_data.rb +226 -0
  616. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_metrics.rb +240 -0
  617. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_performance_prediction_agent_data_per_interval.rb +201 -0
  618. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_performance_prediction_queue_data_per_interval.rb +251 -0
  619. data/lib/purecloudclient_v2a/models/intraday_data_update_notification_schedule_data_per_interval.rb +226 -0
  620. data/lib/purecloudclient_v2a/models/intraday_forecast_data.rb +254 -0
  621. data/lib/purecloudclient_v2a/models/intraday_historical_agent_data.rb +228 -0
  622. data/lib/purecloudclient_v2a/models/intraday_historical_queue_data.rb +384 -0
  623. data/lib/purecloudclient_v2a/models/intraday_metric.rb +242 -0
  624. data/lib/purecloudclient_v2a/models/intraday_performance_prediction_agent_data.rb +202 -0
  625. data/lib/purecloudclient_v2a/models/intraday_performance_prediction_queue_data.rb +254 -0
  626. data/lib/purecloudclient_v2a/models/intraday_query_data_command.rb +325 -0
  627. data/lib/purecloudclient_v2a/models/intraday_queue.rb +256 -0
  628. data/lib/purecloudclient_v2a/models/intraday_response.rb +404 -0
  629. data/lib/purecloudclient_v2a/models/intraday_schedule_data.rb +228 -0
  630. data/lib/purecloudclient_v2a/models/ivr.rb +614 -0
  631. data/lib/purecloudclient_v2a/models/ivr_entity_listing.rb +428 -0
  632. data/lib/purecloudclient_v2a/models/json_node.rb +715 -0
  633. data/lib/purecloudclient_v2a/models/json_node_search_response.rb +467 -0
  634. data/lib/purecloudclient_v2a/models/json_schema_document.rb +356 -0
  635. data/lib/purecloudclient_v2a/models/key_rotation_schedule.rb +298 -0
  636. data/lib/purecloudclient_v2a/models/keyword.rb +538 -0
  637. data/lib/purecloudclient_v2a/models/keyword_set.rb +429 -0
  638. data/lib/purecloudclient_v2a/models/keyword_set_entity_listing.rb +428 -0
  639. data/lib/purecloudclient_v2a/models/language.rb +349 -0
  640. data/lib/purecloudclient_v2a/models/language_entity_listing.rb +428 -0
  641. data/lib/purecloudclient_v2a/models/library.rb +335 -0
  642. data/lib/purecloudclient_v2a/models/library_entity_listing.rb +428 -0
  643. data/lib/purecloudclient_v2a/models/license_assignment_request.rb +273 -0
  644. data/lib/purecloudclient_v2a/models/license_batch_assignment_request.rb +209 -0
  645. data/lib/purecloudclient_v2a/models/license_definition.rb +332 -0
  646. data/lib/purecloudclient_v2a/models/license_org_toggle.rb +226 -0
  647. data/lib/purecloudclient_v2a/models/license_organization.rb +280 -0
  648. data/lib/purecloudclient_v2a/models/license_update_status.rb +251 -0
  649. data/lib/purecloudclient_v2a/models/license_user.rb +255 -0
  650. data/lib/purecloudclient_v2a/models/line.rb +736 -0
  651. data/lib/purecloudclient_v2a/models/line_base.rb +559 -0
  652. data/lib/purecloudclient_v2a/models/line_base_entity_listing.rb +428 -0
  653. data/lib/purecloudclient_v2a/models/line_entity_listing.rb +428 -0
  654. data/lib/purecloudclient_v2a/models/line_status.rb +308 -0
  655. data/lib/purecloudclient_v2a/models/local_encryption_configuration.rb +346 -0
  656. data/lib/purecloudclient_v2a/models/local_encryption_configuration_listing.rb +253 -0
  657. data/lib/purecloudclient_v2a/models/local_encryption_key_request.rb +269 -0
  658. data/lib/purecloudclient_v2a/models/location.rb +303 -0
  659. data/lib/purecloudclient_v2a/models/location_address.rb +351 -0
  660. data/lib/purecloudclient_v2a/models/location_definition.rb +420 -0
  661. data/lib/purecloudclient_v2a/models/location_emergency_number.rb +266 -0
  662. data/lib/purecloudclient_v2a/models/location_entity_listing.rb +428 -0
  663. data/lib/purecloudclient_v2a/models/location_search_criteria.rb +423 -0
  664. data/lib/purecloudclient_v2a/models/location_search_request.rb +349 -0
  665. data/lib/purecloudclient_v2a/models/locations_search_response.rb +444 -0
  666. data/lib/purecloudclient_v2a/models/lock_info.rb +292 -0
  667. data/lib/purecloudclient_v2a/models/logical_interface_entity_listing.rb +428 -0
  668. data/lib/purecloudclient_v2a/models/management_unit.rb +429 -0
  669. data/lib/purecloudclient_v2a/models/management_unit_listing.rb +428 -0
  670. data/lib/purecloudclient_v2a/models/management_unit_reference.rb +229 -0
  671. data/lib/purecloudclient_v2a/models/management_unit_settings.rb +364 -0
  672. data/lib/purecloudclient_v2a/models/max_participants.rb +202 -0
  673. data/lib/purecloudclient_v2a/models/media_participant_request.rb +372 -0
  674. data/lib/purecloudclient_v2a/models/media_policies.rb +280 -0
  675. data/lib/purecloudclient_v2a/models/media_result.rb +228 -0
  676. data/lib/purecloudclient_v2a/models/media_setting.rb +226 -0
  677. data/lib/purecloudclient_v2a/models/media_summary.rb +226 -0
  678. data/lib/purecloudclient_v2a/models/media_summary_detail.rb +226 -0
  679. data/lib/purecloudclient_v2a/models/media_transcription.rb +265 -0
  680. data/lib/purecloudclient_v2a/models/member_entity.rb +201 -0
  681. data/lib/purecloudclient_v2a/models/message.rb +755 -0
  682. data/lib/purecloudclient_v2a/models/message_conversation_notification.rb +280 -0
  683. data/lib/purecloudclient_v2a/models/message_conversation_notification_detail.rb +276 -0
  684. data/lib/purecloudclient_v2a/models/message_conversation_notification_error_body.rb +432 -0
  685. data/lib/purecloudclient_v2a/models/message_conversation_notification_error_info.rb +432 -0
  686. data/lib/purecloudclient_v2a/models/message_conversation_notification_message_details.rb +290 -0
  687. data/lib/purecloudclient_v2a/models/message_conversation_notification_message_media_participant.rb +1011 -0
  688. data/lib/purecloudclient_v2a/models/message_conversation_notification_messages.rb +290 -0
  689. data/lib/purecloudclient_v2a/models/message_conversation_notification_participants.rb +1011 -0
  690. data/lib/purecloudclient_v2a/models/message_conversation_notification_uri_reference.rb +226 -0
  691. data/lib/purecloudclient_v2a/models/message_conversation_notification_wrapup.rb +328 -0
  692. data/lib/purecloudclient_v2a/models/message_details.rb +320 -0
  693. data/lib/purecloudclient_v2a/models/message_media_policy.rb +228 -0
  694. data/lib/purecloudclient_v2a/models/message_media_policy_conditions.rb +309 -0
  695. data/lib/purecloudclient_v2a/models/meta_data.rb +253 -0
  696. data/lib/purecloudclient_v2a/models/metabase.rb +506 -0
  697. data/lib/purecloudclient_v2a/models/metered_evaluation_assignment.rb +328 -0
  698. data/lib/purecloudclient_v2a/models/named_entity.rb +228 -0
  699. data/lib/purecloudclient_v2a/models/note.rb +389 -0
  700. data/lib/purecloudclient_v2a/models/note_listing.rb +428 -0
  701. data/lib/purecloudclient_v2a/models/number.rb +226 -0
  702. data/lib/purecloudclient_v2a/models/number_plan.rb +684 -0
  703. data/lib/purecloudclient_v2a/models/numeric_range.rb +280 -0
  704. data/lib/purecloudclient_v2a/models/o_auth_client.rb +541 -0
  705. data/lib/purecloudclient_v2a/models/o_auth_client_entity_listing.rb +428 -0
  706. data/lib/purecloudclient_v2a/models/o_auth_client_listing.rb +496 -0
  707. data/lib/purecloudclient_v2a/models/o_auth_provider.rb +278 -0
  708. data/lib/purecloudclient_v2a/models/o_auth_provider_entity_listing.rb +428 -0
  709. data/lib/purecloudclient_v2a/models/observation_data_container.rb +231 -0
  710. data/lib/purecloudclient_v2a/models/observation_query.rb +235 -0
  711. data/lib/purecloudclient_v2a/models/observation_query_response.rb +203 -0
  712. data/lib/purecloudclient_v2a/models/okta.rb +353 -0
  713. data/lib/purecloudclient_v2a/models/one_login.rb +353 -0
  714. data/lib/purecloudclient_v2a/models/operation.rb +435 -0
  715. data/lib/purecloudclient_v2a/models/org_media_utilization.rb +256 -0
  716. data/lib/purecloudclient_v2a/models/org_o_auth_client.rb +408 -0
  717. data/lib/purecloudclient_v2a/models/org_user.rb +822 -0
  718. data/lib/purecloudclient_v2a/models/organization.rb +556 -0
  719. data/lib/purecloudclient_v2a/models/organization_features.rb +501 -0
  720. data/lib/purecloudclient_v2a/models/organization_presence.rb +463 -0
  721. data/lib/purecloudclient_v2a/models/organization_presence_entity_listing.rb +428 -0
  722. data/lib/purecloudclient_v2a/models/organization_product_entity_listing.rb +303 -0
  723. data/lib/purecloudclient_v2a/models/organization_role_entity_listing.rb +428 -0
  724. data/lib/purecloudclient_v2a/models/orphan_recording.rb +537 -0
  725. data/lib/purecloudclient_v2a/models/orphan_recording_listing.rb +428 -0
  726. data/lib/purecloudclient_v2a/models/orphan_update_request.rb +254 -0
  727. data/lib/purecloudclient_v2a/models/out_of_office.rb +380 -0
  728. data/lib/purecloudclient_v2a/models/out_of_office_notification.rb +276 -0
  729. data/lib/purecloudclient_v2a/models/out_of_office_notification_user.rb +201 -0
  730. data/lib/purecloudclient_v2a/models/outbound_route.rb +684 -0
  731. data/lib/purecloudclient_v2a/models/outbound_route_base.rb +632 -0
  732. data/lib/purecloudclient_v2a/models/outbound_route_base_entity_listing.rb +428 -0
  733. data/lib/purecloudclient_v2a/models/outbound_route_entity_listing.rb +428 -0
  734. data/lib/purecloudclient_v2a/models/outbound_settings.rb +383 -0
  735. data/lib/purecloudclient_v2a/models/outbound_settings_notification.rb +415 -0
  736. data/lib/purecloudclient_v2a/models/page.rb +384 -0
  737. data/lib/purecloudclient_v2a/models/paging_spec.rb +238 -0
  738. data/lib/purecloudclient_v2a/models/parameter.rb +304 -0
  739. data/lib/purecloudclient_v2a/models/parsed_certificate.rb +205 -0
  740. data/lib/purecloudclient_v2a/models/participant.rb +1204 -0
  741. data/lib/purecloudclient_v2a/models/participant_attributes.rb +204 -0
  742. data/lib/purecloudclient_v2a/models/participant_basic.rb +1204 -0
  743. data/lib/purecloudclient_v2a/models/permission_collection_entity_listing.rb +428 -0
  744. data/lib/purecloudclient_v2a/models/permissions.rb +260 -0
  745. data/lib/purecloudclient_v2a/models/phone.rb +858 -0
  746. data/lib/purecloudclient_v2a/models/phone_base.rb +623 -0
  747. data/lib/purecloudclient_v2a/models/phone_base_entity_listing.rb +428 -0
  748. data/lib/purecloudclient_v2a/models/phone_capabilities.rb +351 -0
  749. data/lib/purecloudclient_v2a/models/phone_column.rb +238 -0
  750. data/lib/purecloudclient_v2a/models/phone_entity_listing.rb +428 -0
  751. data/lib/purecloudclient_v2a/models/phone_meta_base_entity_listing.rb +428 -0
  752. data/lib/purecloudclient_v2a/models/phone_number.rb +326 -0
  753. data/lib/purecloudclient_v2a/models/phone_number_column.rb +226 -0
  754. data/lib/purecloudclient_v2a/models/phone_number_status.rb +202 -0
  755. data/lib/purecloudclient_v2a/models/phone_status.rb +479 -0
  756. data/lib/purecloudclient_v2a/models/phones_reboot.rb +230 -0
  757. data/lib/purecloudclient_v2a/models/physical_interface_entity_listing.rb +428 -0
  758. data/lib/purecloudclient_v2a/models/pin_configuration.rb +226 -0
  759. data/lib/purecloudclient_v2a/models/ping_identity.rb +378 -0
  760. data/lib/purecloudclient_v2a/models/policy.rb +483 -0
  761. data/lib/purecloudclient_v2a/models/policy_actions.rb +412 -0
  762. data/lib/purecloudclient_v2a/models/policy_conditions.rb +388 -0
  763. data/lib/purecloudclient_v2a/models/policy_create.rb +489 -0
  764. data/lib/purecloudclient_v2a/models/policy_entity_listing.rb +428 -0
  765. data/lib/purecloudclient_v2a/models/policy_error_message.rb +354 -0
  766. data/lib/purecloudclient_v2a/models/policy_errors.rb +203 -0
  767. data/lib/purecloudclient_v2a/models/post_action_input.rb +358 -0
  768. data/lib/purecloudclient_v2a/models/post_input_contract.rb +208 -0
  769. data/lib/purecloudclient_v2a/models/post_output_contract.rb +208 -0
  770. data/lib/purecloudclient_v2a/models/prediction_results.rb +292 -0
  771. data/lib/purecloudclient_v2a/models/presence_definition.rb +253 -0
  772. data/lib/purecloudclient_v2a/models/presence_query_response.rb +231 -0
  773. data/lib/purecloudclient_v2a/models/prompt.rb +336 -0
  774. data/lib/purecloudclient_v2a/models/prompt_asset.rb +480 -0
  775. data/lib/purecloudclient_v2a/models/prompt_asset_create.rb +486 -0
  776. data/lib/purecloudclient_v2a/models/prompt_asset_entity_listing.rb +428 -0
  777. data/lib/purecloudclient_v2a/models/prompt_entity_listing.rb +428 -0
  778. data/lib/purecloudclient_v2a/models/prompt_notification_notification.rb +276 -0
  779. data/lib/purecloudclient_v2a/models/prompt_notification_notification_architect_operation.rb +431 -0
  780. data/lib/purecloudclient_v2a/models/prompt_notification_notification_current_operation.rb +431 -0
  781. data/lib/purecloudclient_v2a/models/prompt_notification_notification_current_operation_error_details.rb +276 -0
  782. data/lib/purecloudclient_v2a/models/prompt_notification_notification_current_operation_error_message_params.rb +203 -0
  783. data/lib/purecloudclient_v2a/models/prompt_notification_notification_error_detail.rb +276 -0
  784. data/lib/purecloudclient_v2a/models/prompt_notification_notification_error_message_params.rb +203 -0
  785. data/lib/purecloudclient_v2a/models/prompt_notification_notification_home_organization.rb +251 -0
  786. data/lib/purecloudclient_v2a/models/prompt_notification_notification_user.rb +251 -0
  787. data/lib/purecloudclient_v2a/models/prompt_resource_notification_notification.rb +326 -0
  788. data/lib/purecloudclient_v2a/models/property_index_request.rb +271 -0
  789. data/lib/purecloudclient_v2a/models/provision_info.rb +254 -0
  790. data/lib/purecloudclient_v2a/models/publish_draft_input.rb +208 -0
  791. data/lib/purecloudclient_v2a/models/pure_cloud.rb +278 -0
  792. data/lib/purecloudclient_v2a/models/qualifier_mapping_observation_query_response.rb +231 -0
  793. data/lib/purecloudclient_v2a/models/quality_audit.rb +455 -0
  794. data/lib/purecloudclient_v2a/models/quality_audit_page.rb +428 -0
  795. data/lib/purecloudclient_v2a/models/query_facet_info.rb +230 -0
  796. data/lib/purecloudclient_v2a/models/query_request.rb +384 -0
  797. data/lib/purecloudclient_v2a/models/query_result.rb +278 -0
  798. data/lib/purecloudclient_v2a/models/query_results.rb +226 -0
  799. data/lib/purecloudclient_v2a/models/question.rb +478 -0
  800. data/lib/purecloudclient_v2a/models/question_group.rb +428 -0
  801. data/lib/purecloudclient_v2a/models/question_group_score.rb +453 -0
  802. data/lib/purecloudclient_v2a/models/question_score.rb +326 -0
  803. data/lib/purecloudclient_v2a/models/queue.rb +844 -0
  804. data/lib/purecloudclient_v2a/models/queue_email_address.rb +226 -0
  805. data/lib/purecloudclient_v2a/models/queue_entity_listing.rb +428 -0
  806. data/lib/purecloudclient_v2a/models/queue_member.rb +378 -0
  807. data/lib/purecloudclient_v2a/models/queue_member_entity_listing.rb +428 -0
  808. data/lib/purecloudclient_v2a/models/queue_member_notification.rb +276 -0
  809. data/lib/purecloudclient_v2a/models/queue_utilization_diagnostic.rb +410 -0
  810. data/lib/purecloudclient_v2a/models/reaction.rb +273 -0
  811. data/lib/purecloudclient_v2a/models/recall_entry.rb +226 -0
  812. data/lib/purecloudclient_v2a/models/recording.rb +805 -0
  813. data/lib/purecloudclient_v2a/models/recording_data_v2_notification.rb +601 -0
  814. data/lib/purecloudclient_v2a/models/recording_data_v2_notification_conversation_data.rb +201 -0
  815. data/lib/purecloudclient_v2a/models/recording_data_v2_notification_lock_data.rb +251 -0
  816. data/lib/purecloudclient_v2a/models/recording_data_v2_notification_lock_info.rb +251 -0
  817. data/lib/purecloudclient_v2a/models/recording_data_v2_notification_user_data.rb +226 -0
  818. data/lib/purecloudclient_v2a/models/recording_data_v2_notification_workspace_data.rb +201 -0
  819. data/lib/purecloudclient_v2a/models/recording_email_message.rb +435 -0
  820. data/lib/purecloudclient_v2a/models/recording_settings.rb +201 -0
  821. data/lib/purecloudclient_v2a/models/relationship.rb +374 -0
  822. data/lib/purecloudclient_v2a/models/relationship_listing.rb +428 -0
  823. data/lib/purecloudclient_v2a/models/replace_request.rb +251 -0
  824. data/lib/purecloudclient_v2a/models/replace_response.rb +340 -0
  825. data/lib/purecloudclient_v2a/models/report_meta_data.rb +409 -0
  826. data/lib/purecloudclient_v2a/models/report_meta_data_entity_listing.rb +428 -0
  827. data/lib/purecloudclient_v2a/models/report_run_entry.rb +468 -0
  828. data/lib/purecloudclient_v2a/models/report_run_entry_entity_domain_listing.rb +428 -0
  829. data/lib/purecloudclient_v2a/models/report_schedule.rb +621 -0
  830. data/lib/purecloudclient_v2a/models/report_schedule_entity_listing.rb +428 -0
  831. data/lib/purecloudclient_v2a/models/request_config.rb +309 -0
  832. data/lib/purecloudclient_v2a/models/resource_condition_node.rb +333 -0
  833. data/lib/purecloudclient_v2a/models/resource_condition_value.rb +240 -0
  834. data/lib/purecloudclient_v2a/models/resource_permission_policy.rb +455 -0
  835. data/lib/purecloudclient_v2a/models/response.rb +492 -0
  836. data/lib/purecloudclient_v2a/models/response_config.rb +257 -0
  837. data/lib/purecloudclient_v2a/models/response_entity_list.rb +429 -0
  838. data/lib/purecloudclient_v2a/models/response_entity_listing.rb +428 -0
  839. data/lib/purecloudclient_v2a/models/response_filter.rb +286 -0
  840. data/lib/purecloudclient_v2a/models/response_query_request.rb +257 -0
  841. data/lib/purecloudclient_v2a/models/response_query_results.rb +208 -0
  842. data/lib/purecloudclient_v2a/models/response_set.rb +370 -0
  843. data/lib/purecloudclient_v2a/models/response_set_entity_listing.rb +428 -0
  844. data/lib/purecloudclient_v2a/models/response_set_notification.rb +353 -0
  845. data/lib/purecloudclient_v2a/models/response_set_notification_reaction.rb +290 -0
  846. data/lib/purecloudclient_v2a/models/response_set_notification_responses.rb +290 -0
  847. data/lib/purecloudclient_v2a/models/response_substitution.rb +260 -0
  848. data/lib/purecloudclient_v2a/models/response_text.rb +248 -0
  849. data/lib/purecloudclient_v2a/models/rest_error_detail.rb +233 -0
  850. data/lib/purecloudclient_v2a/models/retention_duration.rb +226 -0
  851. data/lib/purecloudclient_v2a/models/reverse_whitepages_lookup_result.rb +230 -0
  852. data/lib/purecloudclient_v2a/models/ring.rb +228 -0
  853. data/lib/purecloudclient_v2a/models/routing_data.rb +315 -0
  854. data/lib/purecloudclient_v2a/models/routing_skill.rb +351 -0
  855. data/lib/purecloudclient_v2a/models/routing_status.rb +268 -0
  856. data/lib/purecloudclient_v2a/models/rule_set.rb +422 -0
  857. data/lib/purecloudclient_v2a/models/rule_set_diagnostic.rb +230 -0
  858. data/lib/purecloudclient_v2a/models/rule_set_entity_listing.rb +428 -0
  859. data/lib/purecloudclient_v2a/models/rule_set_notification.rb +403 -0
  860. data/lib/purecloudclient_v2a/models/rule_set_notification_action.rb +303 -0
  861. data/lib/purecloudclient_v2a/models/rule_set_notification_actions.rb +303 -0
  862. data/lib/purecloudclient_v2a/models/rule_set_notification_condition.rb +470 -0
  863. data/lib/purecloudclient_v2a/models/rule_set_notification_conditions.rb +470 -0
  864. data/lib/purecloudclient_v2a/models/rule_set_notification_rule.rb +369 -0
  865. data/lib/purecloudclient_v2a/models/rule_set_notification_rules.rb +369 -0
  866. data/lib/purecloudclient_v2a/models/rule_set_notification_uri_reference.rb +226 -0
  867. data/lib/purecloudclient_v2a/models/run_now_response.rb +253 -0
  868. data/lib/purecloudclient_v2a/models/salesforce.rb +353 -0
  869. data/lib/purecloudclient_v2a/models/schedule.rb +591 -0
  870. data/lib/purecloudclient_v2a/models/schedule_entity_listing.rb +428 -0
  871. data/lib/purecloudclient_v2a/models/schedule_group.rb +590 -0
  872. data/lib/purecloudclient_v2a/models/schedule_group_entity_listing.rb +428 -0
  873. data/lib/purecloudclient_v2a/models/schedule_interval.rb +238 -0
  874. data/lib/purecloudclient_v2a/models/scheduling_settings.rb +229 -0
  875. data/lib/purecloudclient_v2a/models/schema_category.rb +507 -0
  876. data/lib/purecloudclient_v2a/models/schema_category_entity_listing.rb +428 -0
  877. data/lib/purecloudclient_v2a/models/schema_reference_entity_listing.rb +428 -0
  878. data/lib/purecloudclient_v2a/models/screen_recording_session.rb +355 -0
  879. data/lib/purecloudclient_v2a/models/screen_recording_session_listing.rb +428 -0
  880. data/lib/purecloudclient_v2a/models/screen_recording_session_request.rb +268 -0
  881. data/lib/purecloudclient_v2a/models/screen_share_conversation_notification.rb +280 -0
  882. data/lib/purecloudclient_v2a/models/screen_share_conversation_notification_detail.rb +276 -0
  883. data/lib/purecloudclient_v2a/models/screen_share_conversation_notification_error_body.rb +432 -0
  884. data/lib/purecloudclient_v2a/models/screen_share_conversation_notification_error_info.rb +432 -0
  885. data/lib/purecloudclient_v2a/models/screen_share_conversation_notification_participants.rb +970 -0
  886. data/lib/purecloudclient_v2a/models/screen_share_conversation_notification_screen_share_media_participant.rb +970 -0
  887. data/lib/purecloudclient_v2a/models/screen_share_conversation_notification_uri_reference.rb +226 -0
  888. data/lib/purecloudclient_v2a/models/screen_share_conversation_notification_wrapup.rb +328 -0
  889. data/lib/purecloudclient_v2a/models/screenshare.rb +492 -0
  890. data/lib/purecloudclient_v2a/models/script.rb +534 -0
  891. data/lib/purecloudclient_v2a/models/script_entity_listing.rb +428 -0
  892. data/lib/purecloudclient_v2a/models/search_aggregation.rb +348 -0
  893. data/lib/purecloudclient_v2a/models/search_criteria.rb +417 -0
  894. data/lib/purecloudclient_v2a/models/search_request.rb +467 -0
  895. data/lib/purecloudclient_v2a/models/search_sort.rb +242 -0
  896. data/lib/purecloudclient_v2a/models/section.rb +278 -0
  897. data/lib/purecloudclient_v2a/models/secure_session.rb +382 -0
  898. data/lib/purecloudclient_v2a/models/secure_session_entity_listing.rb +203 -0
  899. data/lib/purecloudclient_v2a/models/security_profile.rb +280 -0
  900. data/lib/purecloudclient_v2a/models/security_profile_entity_listing.rb +428 -0
  901. data/lib/purecloudclient_v2a/models/segment.rb +316 -0
  902. data/lib/purecloudclient_v2a/models/sequence_schedule.rb +426 -0
  903. data/lib/purecloudclient_v2a/models/sequence_schedule_notification.rb +403 -0
  904. data/lib/purecloudclient_v2a/models/sequence_schedule_notification_schedule_interval.rb +251 -0
  905. data/lib/purecloudclient_v2a/models/sequence_schedule_notification_uri_reference.rb +226 -0
  906. data/lib/purecloudclient_v2a/models/server_date.rb +202 -0
  907. data/lib/purecloudclient_v2a/models/service_context.rb +202 -0
  908. data/lib/purecloudclient_v2a/models/service_level.rb +226 -0
  909. data/lib/purecloudclient_v2a/models/set_uui_data_request.rb +202 -0
  910. data/lib/purecloudclient_v2a/models/share.rb +481 -0
  911. data/lib/purecloudclient_v2a/models/share_entity_listing.rb +428 -0
  912. data/lib/purecloudclient_v2a/models/shared_entity.rb +201 -0
  913. data/lib/purecloudclient_v2a/models/shared_response.rb +301 -0
  914. data/lib/purecloudclient_v2a/models/short_term_forecasting_settings.rb +203 -0
  915. data/lib/purecloudclient_v2a/models/signed_data.rb +201 -0
  916. data/lib/purecloudclient_v2a/models/site.rb +751 -0
  917. data/lib/purecloudclient_v2a/models/site_entity_listing.rb +428 -0
  918. data/lib/purecloudclient_v2a/models/skill_entity_listing.rb +428 -0
  919. data/lib/purecloudclient_v2a/models/skills_to_remove.rb +251 -0
  920. data/lib/purecloudclient_v2a/models/social_conversation_notification.rb +280 -0
  921. data/lib/purecloudclient_v2a/models/social_conversation_notification_detail.rb +276 -0
  922. data/lib/purecloudclient_v2a/models/social_conversation_notification_error_body.rb +432 -0
  923. data/lib/purecloudclient_v2a/models/social_conversation_notification_error_info.rb +432 -0
  924. data/lib/purecloudclient_v2a/models/social_conversation_notification_participants.rb +995 -0
  925. data/lib/purecloudclient_v2a/models/social_conversation_notification_social_media_participant.rb +995 -0
  926. data/lib/purecloudclient_v2a/models/social_conversation_notification_uri_reference.rb +226 -0
  927. data/lib/purecloudclient_v2a/models/social_conversation_notification_wrapup.rb +328 -0
  928. data/lib/purecloudclient_v2a/models/social_expression.rb +622 -0
  929. data/lib/purecloudclient_v2a/models/sort_item.rb +226 -0
  930. data/lib/purecloudclient_v2a/models/station.rb +521 -0
  931. data/lib/purecloudclient_v2a/models/station_entity_listing.rb +428 -0
  932. data/lib/purecloudclient_v2a/models/statistical_response.rb +255 -0
  933. data/lib/purecloudclient_v2a/models/statistical_summary.rb +401 -0
  934. data/lib/purecloudclient_v2a/models/stats_notification_notification.rb +230 -0
  935. data/lib/purecloudclient_v2a/models/stats_notification_notification_data.rb +228 -0
  936. data/lib/purecloudclient_v2a/models/stats_notification_notification_datum.rb +228 -0
  937. data/lib/purecloudclient_v2a/models/stats_notification_notification_metric.rb +253 -0
  938. data/lib/purecloudclient_v2a/models/stats_notification_notification_metrics.rb +253 -0
  939. data/lib/purecloudclient_v2a/models/street_address.rb +394 -0
  940. data/lib/purecloudclient_v2a/models/subscriber_response.rb +235 -0
  941. data/lib/purecloudclient_v2a/models/suggest_search_criteria.rb +378 -0
  942. data/lib/purecloudclient_v2a/models/suggest_search_request.rb +270 -0
  943. data/lib/purecloudclient_v2a/models/system_presence.rb +253 -0
  944. data/lib/purecloudclient_v2a/models/system_prompt.rb +305 -0
  945. data/lib/purecloudclient_v2a/models/system_prompt_asset.rb +525 -0
  946. data/lib/purecloudclient_v2a/models/system_prompt_asset_entity_listing.rb +428 -0
  947. data/lib/purecloudclient_v2a/models/system_prompt_entity_listing.rb +428 -0
  948. data/lib/purecloudclient_v2a/models/system_prompt_resource_notification_notification.rb +326 -0
  949. data/lib/purecloudclient_v2a/models/tag_query_request.rb +251 -0
  950. data/lib/purecloudclient_v2a/models/tag_value.rb +311 -0
  951. data/lib/purecloudclient_v2a/models/tag_value_entity_listing.rb +428 -0
  952. data/lib/purecloudclient_v2a/models/term_attribute.rb +265 -0
  953. data/lib/purecloudclient_v2a/models/test_execution_operation_result.rb +306 -0
  954. data/lib/purecloudclient_v2a/models/test_execution_result.rb +282 -0
  955. data/lib/purecloudclient_v2a/models/ticker.rb +238 -0
  956. data/lib/purecloudclient_v2a/models/time_allowed.rb +253 -0
  957. data/lib/purecloudclient_v2a/models/time_interval.rb +226 -0
  958. data/lib/purecloudclient_v2a/models/time_off_request.rb +691 -0
  959. data/lib/purecloudclient_v2a/models/time_off_request_list.rb +280 -0
  960. data/lib/purecloudclient_v2a/models/time_off_request_patch.rb +201 -0
  961. data/lib/purecloudclient_v2a/models/time_off_request_settings.rb +255 -0
  962. data/lib/purecloudclient_v2a/models/time_off_request_update_notification.rb +594 -0
  963. data/lib/purecloudclient_v2a/models/time_off_request_update_notification_user.rb +201 -0
  964. data/lib/purecloudclient_v2a/models/time_slot.rb +254 -0
  965. data/lib/purecloudclient_v2a/models/time_zone.rb +278 -0
  966. data/lib/purecloudclient_v2a/models/time_zone_entity_listing.rb +428 -0
  967. data/lib/purecloudclient_v2a/models/token_info.rb +253 -0
  968. data/lib/purecloudclient_v2a/models/transfer_request.rb +306 -0
  969. data/lib/purecloudclient_v2a/models/trunk.rb +703 -0
  970. data/lib/purecloudclient_v2a/models/trunk_base.rb +636 -0
  971. data/lib/purecloudclient_v2a/models/trunk_base_assignment.rb +228 -0
  972. data/lib/purecloudclient_v2a/models/trunk_base_entity_listing.rb +428 -0
  973. data/lib/purecloudclient_v2a/models/trunk_connected_status.rb +227 -0
  974. data/lib/purecloudclient_v2a/models/trunk_entity_listing.rb +428 -0
  975. data/lib/purecloudclient_v2a/models/trunk_error_info.rb +251 -0
  976. data/lib/purecloudclient_v2a/models/trunk_error_info_details.rb +251 -0
  977. data/lib/purecloudclient_v2a/models/trunk_metabase_entity_listing.rb +428 -0
  978. data/lib/purecloudclient_v2a/models/trunk_metrics.rb +302 -0
  979. data/lib/purecloudclient_v2a/models/trunk_metrics_calls.rb +226 -0
  980. data/lib/purecloudclient_v2a/models/trunk_metrics_network_type_ip.rb +228 -0
  981. data/lib/purecloudclient_v2a/models/trunk_metrics_options.rb +278 -0
  982. data/lib/purecloudclient_v2a/models/trunk_metrics_qo_s.rb +207 -0
  983. data/lib/purecloudclient_v2a/models/trunk_metrics_registers.rb +279 -0
  984. data/lib/purecloudclient_v2a/models/trunk_recording_enabled_count.rb +228 -0
  985. data/lib/purecloudclient_v2a/models/trust_create.rb +271 -0
  986. data/lib/purecloudclient_v2a/models/trust_entity_listing.rb +428 -0
  987. data/lib/purecloudclient_v2a/models/trust_request.rb +344 -0
  988. data/lib/purecloudclient_v2a/models/trust_request_create.rb +209 -0
  989. data/lib/purecloudclient_v2a/models/trust_user.rb +822 -0
  990. data/lib/purecloudclient_v2a/models/trust_user_create.rb +240 -0
  991. data/lib/purecloudclient_v2a/models/trust_user_details.rb +228 -0
  992. data/lib/purecloudclient_v2a/models/trust_user_entity_listing.rb +428 -0
  993. data/lib/purecloudclient_v2a/models/trustee.rb +337 -0
  994. data/lib/purecloudclient_v2a/models/trustee_audit_query_request.rb +376 -0
  995. data/lib/purecloudclient_v2a/models/trustor.rb +337 -0
  996. data/lib/purecloudclient_v2a/models/trustor_audit_query_request.rb +374 -0
  997. data/lib/purecloudclient_v2a/models/trustor_entity_listing.rb +428 -0
  998. data/lib/purecloudclient_v2a/models/twitter_id.rb +307 -0
  999. data/lib/purecloudclient_v2a/models/unread_metric.rb +202 -0
  1000. data/lib/purecloudclient_v2a/models/unread_status.rb +202 -0
  1001. data/lib/purecloudclient_v2a/models/update_action_input.rb +285 -0
  1002. data/lib/purecloudclient_v2a/models/update_draft_input.rb +338 -0
  1003. data/lib/purecloudclient_v2a/models/update_user.rb +641 -0
  1004. data/lib/purecloudclient_v2a/models/uri_reference.rb +251 -0
  1005. data/lib/purecloudclient_v2a/models/usage.rb +203 -0
  1006. data/lib/purecloudclient_v2a/models/usage_item.rb +265 -0
  1007. data/lib/purecloudclient_v2a/models/user.rb +823 -0
  1008. data/lib/purecloudclient_v2a/models/user_agent_info.rb +254 -0
  1009. data/lib/purecloudclient_v2a/models/user_authorization.rb +259 -0
  1010. data/lib/purecloudclient_v2a/models/user_conversation_summary.rb +376 -0
  1011. data/lib/purecloudclient_v2a/models/user_conversation_summary_notification.rb +376 -0
  1012. data/lib/purecloudclient_v2a/models/user_conversation_summary_notification_call.rb +226 -0
  1013. data/lib/purecloudclient_v2a/models/user_conversation_summary_notification_call_contact_center.rb +226 -0
  1014. data/lib/purecloudclient_v2a/models/user_conversation_summary_notification_media_summary.rb +226 -0
  1015. data/lib/purecloudclient_v2a/models/user_conversation_summary_notification_media_summary_detail.rb +226 -0
  1016. data/lib/purecloudclient_v2a/models/user_details_query.rb +408 -0
  1017. data/lib/purecloudclient_v2a/models/user_device.rb +478 -0
  1018. data/lib/purecloudclient_v2a/models/user_entity_listing.rb +428 -0
  1019. data/lib/purecloudclient_v2a/models/user_expands.rb +358 -0
  1020. data/lib/purecloudclient_v2a/models/user_image.rb +227 -0
  1021. data/lib/purecloudclient_v2a/models/user_list_schedule_request_body.rb +272 -0
  1022. data/lib/purecloudclient_v2a/models/user_me.rb +1203 -0
  1023. data/lib/purecloudclient_v2a/models/user_param.rb +226 -0
  1024. data/lib/purecloudclient_v2a/models/user_presence.rb +381 -0
  1025. data/lib/purecloudclient_v2a/models/user_presence_notification.rb +301 -0
  1026. data/lib/purecloudclient_v2a/models/user_presence_notification_organization_presence.rb +226 -0
  1027. data/lib/purecloudclient_v2a/models/user_profile.rb +376 -0
  1028. data/lib/purecloudclient_v2a/models/user_profile_entity_listing.rb +428 -0
  1029. data/lib/purecloudclient_v2a/models/user_queue.rb +869 -0
  1030. data/lib/purecloudclient_v2a/models/user_queue_entity_listing.rb +428 -0
  1031. data/lib/purecloudclient_v2a/models/user_recording.rb +507 -0
  1032. data/lib/purecloudclient_v2a/models/user_recording_entity_listing.rb +428 -0
  1033. data/lib/purecloudclient_v2a/models/user_reference.rb +228 -0
  1034. data/lib/purecloudclient_v2a/models/user_routing_skill.rb +346 -0
  1035. data/lib/purecloudclient_v2a/models/user_routing_skill_post.rb +291 -0
  1036. data/lib/purecloudclient_v2a/models/user_routing_status_notification.rb +226 -0
  1037. data/lib/purecloudclient_v2a/models/user_routing_status_notification_error_info.rb +328 -0
  1038. data/lib/purecloudclient_v2a/models/user_routing_status_notification_error_info_user_params.rb +251 -0
  1039. data/lib/purecloudclient_v2a/models/user_routing_status_notification_routing_status.rb +240 -0
  1040. data/lib/purecloudclient_v2a/models/user_routing_status_notification_user_param.rb +251 -0
  1041. data/lib/purecloudclient_v2a/models/user_schedule.rb +233 -0
  1042. data/lib/purecloudclient_v2a/models/user_schedule_activity.rb +333 -0
  1043. data/lib/purecloudclient_v2a/models/user_schedule_adherence.rb +623 -0
  1044. data/lib/purecloudclient_v2a/models/user_schedule_adherence_update_notification.rb +440 -0
  1045. data/lib/purecloudclient_v2a/models/user_schedule_adherence_update_notification_user.rb +201 -0
  1046. data/lib/purecloudclient_v2a/models/user_schedule_container.rb +231 -0
  1047. data/lib/purecloudclient_v2a/models/user_schedule_full_day_time_off_marker.rb +307 -0
  1048. data/lib/purecloudclient_v2a/models/user_schedule_shift.rb +257 -0
  1049. data/lib/purecloudclient_v2a/models/user_search_criteria.rb +423 -0
  1050. data/lib/purecloudclient_v2a/models/user_search_request.rb +377 -0
  1051. data/lib/purecloudclient_v2a/models/user_skill_entity_listing.rb +428 -0
  1052. data/lib/purecloudclient_v2a/models/user_station.rb +356 -0
  1053. data/lib/purecloudclient_v2a/models/user_stations.rb +280 -0
  1054. data/lib/purecloudclient_v2a/models/user_stations_notification.rb +201 -0
  1055. data/lib/purecloudclient_v2a/models/user_stations_notification_associated_station.rb +251 -0
  1056. data/lib/purecloudclient_v2a/models/user_stations_notification_user.rb +201 -0
  1057. data/lib/purecloudclient_v2a/models/user_stations_notification_user_station.rb +251 -0
  1058. data/lib/purecloudclient_v2a/models/users_search_response.rb +444 -0
  1059. data/lib/purecloudclient_v2a/models/utilization.rb +204 -0
  1060. data/lib/purecloudclient_v2a/models/validate_address_request.rb +202 -0
  1061. data/lib/purecloudclient_v2a/models/validate_address_response.rb +233 -0
  1062. data/lib/purecloudclient_v2a/models/video.rb +516 -0
  1063. data/lib/purecloudclient_v2a/models/video_conversation_notification.rb +280 -0
  1064. data/lib/purecloudclient_v2a/models/video_conversation_notification_detail.rb +276 -0
  1065. data/lib/purecloudclient_v2a/models/video_conversation_notification_error_body.rb +432 -0
  1066. data/lib/purecloudclient_v2a/models/video_conversation_notification_error_info.rb +432 -0
  1067. data/lib/purecloudclient_v2a/models/video_conversation_notification_participants.rb +1020 -0
  1068. data/lib/purecloudclient_v2a/models/video_conversation_notification_uri_reference.rb +226 -0
  1069. data/lib/purecloudclient_v2a/models/video_conversation_notification_video_media_participant.rb +1020 -0
  1070. data/lib/purecloudclient_v2a/models/video_conversation_notification_wrapup.rb +328 -0
  1071. data/lib/purecloudclient_v2a/models/visibility_condition.rb +243 -0
  1072. data/lib/purecloudclient_v2a/models/vm_pairing_info.rb +277 -0
  1073. data/lib/purecloudclient_v2a/models/voicemail.rb +242 -0
  1074. data/lib/purecloudclient_v2a/models/voicemail_copy_record.rb +254 -0
  1075. data/lib/purecloudclient_v2a/models/voicemail_group_policy.rb +397 -0
  1076. data/lib/purecloudclient_v2a/models/voicemail_mailbox_info.rb +332 -0
  1077. data/lib/purecloudclient_v2a/models/voicemail_media_info.rb +279 -0
  1078. data/lib/purecloudclient_v2a/models/voicemail_message.rb +698 -0
  1079. data/lib/purecloudclient_v2a/models/voicemail_message_entity_listing.rb +428 -0
  1080. data/lib/purecloudclient_v2a/models/voicemail_message_notification.rb +476 -0
  1081. data/lib/purecloudclient_v2a/models/voicemail_organization_policy.rb +358 -0
  1082. data/lib/purecloudclient_v2a/models/voicemail_retention_policy.rb +243 -0
  1083. data/lib/purecloudclient_v2a/models/voicemail_search_criteria.rb +423 -0
  1084. data/lib/purecloudclient_v2a/models/voicemail_search_request.rb +377 -0
  1085. data/lib/purecloudclient_v2a/models/voicemail_user_policy.rb +280 -0
  1086. data/lib/purecloudclient_v2a/models/voicemails_search_response.rb +444 -0
  1087. data/lib/purecloudclient_v2a/models/wfm_historical_adherence_calculations_complete_notice_notification.rb +265 -0
  1088. data/lib/purecloudclient_v2a/models/wfm_historical_adherence_query.rb +323 -0
  1089. data/lib/purecloudclient_v2a/models/wfm_historical_adherence_response.rb +269 -0
  1090. data/lib/purecloudclient_v2a/models/wfm_intraday_queue_listing.rb +243 -0
  1091. data/lib/purecloudclient_v2a/models/wfm_user_entity_listing.rb +203 -0
  1092. data/lib/purecloudclient_v2a/models/workspace.rb +502 -0
  1093. data/lib/purecloudclient_v2a/models/workspace_create.rb +257 -0
  1094. data/lib/purecloudclient_v2a/models/workspace_entity_listing.rb +428 -0
  1095. data/lib/purecloudclient_v2a/models/workspace_member.rb +423 -0
  1096. data/lib/purecloudclient_v2a/models/workspace_member_entity_listing.rb +428 -0
  1097. data/lib/purecloudclient_v2a/models/workspace_summary.rb +226 -0
  1098. data/lib/purecloudclient_v2a/models/wrap_up_code_mapping.rb +387 -0
  1099. data/lib/purecloudclient_v2a/models/wrap_up_code_mapping_notification.rb +355 -0
  1100. data/lib/purecloudclient_v2a/models/wrapup.rb +360 -0
  1101. data/lib/purecloudclient_v2a/models/wrapup_code.rb +361 -0
  1102. data/lib/purecloudclient_v2a/models/wrapup_code_entity_listing.rb +428 -0
  1103. data/lib/purecloudclient_v2a/version.rb +3 -0
  1104. metadata +1188 -0
@@ -0,0 +1,3422 @@
1
+ =begin
2
+ PureCloud Platform API
3
+
4
+ With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: DeveloperEvangelists@genesys.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: ININ
11
+ http://www.inin.com
12
+
13
+ Terms of Service: https://developer.mypurecloud.com/tos
14
+
15
+ =end
16
+
17
+ require "uri"
18
+
19
+ module PureCloud
20
+ class UsersApi
21
+ attr_accessor :api_client
22
+
23
+ def initialize(api_client = ApiClient.default)
24
+ @api_client = api_client
25
+ end
26
+
27
+ # Delete user
28
+ #
29
+ # @param user_id User ID
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [Empty]
32
+ def delete_user(user_id, opts = {})
33
+ data, _status_code, _headers = delete_user_with_http_info(user_id, opts)
34
+ return data
35
+ end
36
+
37
+ # Delete user
38
+ #
39
+ # @param user_id User ID
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
42
+ def delete_user_with_http_info(user_id, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user ..."
45
+ end
46
+
47
+
48
+ # verify the required parameter 'user_id' is set
49
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user" if user_id.nil?
50
+
51
+
52
+
53
+
54
+
55
+ # resource path
56
+ local_var_path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = ['application/json']
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = nil
77
+
78
+ auth_names = ['PureCloud Auth']
79
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
80
+ :header_params => header_params,
81
+ :query_params => query_params,
82
+ :form_params => form_params,
83
+ :body => post_body,
84
+ :auth_names => auth_names,
85
+ :return_type => 'Empty')
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "API called: UsersApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+
92
+ # Removes all the roles from the user.
93
+ #
94
+ # @param user_id User ID
95
+ # @param [Hash] opts the optional parameters
96
+ # @return [nil]
97
+ def delete_user_roles(user_id, opts = {})
98
+ delete_user_roles_with_http_info(user_id, opts)
99
+ return nil
100
+ end
101
+
102
+ # Removes all the roles from the user.
103
+ #
104
+ # @param user_id User ID
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
107
+ def delete_user_roles_with_http_info(user_id, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user_roles ..."
110
+ end
111
+
112
+
113
+ # verify the required parameter 'user_id' is set
114
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_roles" if user_id.nil?
115
+
116
+
117
+
118
+
119
+
120
+ # resource path
121
+ local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
122
+
123
+ # query parameters
124
+ query_params = {}
125
+
126
+ # header parameters
127
+ header_params = {}
128
+
129
+ # HTTP header 'Accept' (if needed)
130
+ local_header_accept = ['application/json']
131
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
132
+
133
+ # HTTP header 'Content-Type'
134
+ local_header_content_type = ['application/json']
135
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
136
+
137
+ # form parameters
138
+ form_params = {}
139
+
140
+ # http body (model)
141
+ post_body = nil
142
+
143
+ auth_names = ['PureCloud Auth']
144
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
145
+ :header_params => header_params,
146
+ :query_params => query_params,
147
+ :form_params => form_params,
148
+ :body => post_body,
149
+ :auth_names => auth_names)
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Remove routing skill from user
157
+ #
158
+ # @param user_id User ID
159
+ # @param skill_id skillId
160
+ # @param [Hash] opts the optional parameters
161
+ # @return [nil]
162
+ def delete_user_routingskill(user_id, skill_id, opts = {})
163
+ delete_user_routingskill_with_http_info(user_id, skill_id, opts)
164
+ return nil
165
+ end
166
+
167
+ # Remove routing skill from user
168
+ #
169
+ # @param user_id User ID
170
+ # @param skill_id skillId
171
+ # @param [Hash] opts the optional parameters
172
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
173
+ def delete_user_routingskill_with_http_info(user_id, skill_id, opts = {})
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user_routingskill ..."
176
+ end
177
+
178
+
179
+ # verify the required parameter 'user_id' is set
180
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_routingskill" if user_id.nil?
181
+
182
+
183
+
184
+
185
+
186
+
187
+ # verify the required parameter 'skill_id' is set
188
+ fail ArgumentError, "Missing the required parameter 'skill_id' when calling UsersApi.delete_user_routingskill" if skill_id.nil?
189
+
190
+
191
+
192
+
193
+
194
+ # resource path
195
+ local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s)
196
+
197
+ # query parameters
198
+ query_params = {}
199
+
200
+ # header parameters
201
+ header_params = {}
202
+
203
+ # HTTP header 'Accept' (if needed)
204
+ local_header_accept = ['application/json']
205
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
206
+
207
+ # HTTP header 'Content-Type'
208
+ local_header_content_type = ['application/json']
209
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
210
+
211
+ # form parameters
212
+ form_params = {}
213
+
214
+ # http body (model)
215
+ post_body = nil
216
+
217
+ auth_names = ['PureCloud Auth']
218
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
219
+ :header_params => header_params,
220
+ :query_params => query_params,
221
+ :form_params => form_params,
222
+ :body => post_body,
223
+ :auth_names => auth_names)
224
+ if @api_client.config.debugging
225
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_routingskill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
226
+ end
227
+ return data, status_code, headers
228
+ end
229
+
230
+ # Clear associated station
231
+ #
232
+ # @param user_id User ID
233
+ # @param [Hash] opts the optional parameters
234
+ # @return [nil]
235
+ def delete_user_station_associatedstation(user_id, opts = {})
236
+ delete_user_station_associatedstation_with_http_info(user_id, opts)
237
+ return nil
238
+ end
239
+
240
+ # Clear associated station
241
+ #
242
+ # @param user_id User ID
243
+ # @param [Hash] opts the optional parameters
244
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
245
+ def delete_user_station_associatedstation_with_http_info(user_id, opts = {})
246
+ if @api_client.config.debugging
247
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user_station_associatedstation ..."
248
+ end
249
+
250
+
251
+ # verify the required parameter 'user_id' is set
252
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_station_associatedstation" if user_id.nil?
253
+
254
+
255
+
256
+
257
+
258
+ # resource path
259
+ local_var_path = "/api/v2/users/{userId}/station/associatedstation".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
260
+
261
+ # query parameters
262
+ query_params = {}
263
+
264
+ # header parameters
265
+ header_params = {}
266
+
267
+ # HTTP header 'Accept' (if needed)
268
+ local_header_accept = ['application/json']
269
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
270
+
271
+ # HTTP header 'Content-Type'
272
+ local_header_content_type = ['application/json']
273
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
274
+
275
+ # form parameters
276
+ form_params = {}
277
+
278
+ # http body (model)
279
+ post_body = nil
280
+
281
+ auth_names = ['PureCloud Auth']
282
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
283
+ :header_params => header_params,
284
+ :query_params => query_params,
285
+ :form_params => form_params,
286
+ :body => post_body,
287
+ :auth_names => auth_names)
288
+ if @api_client.config.debugging
289
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_station_associatedstation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
290
+ end
291
+ return data, status_code, headers
292
+ end
293
+
294
+ # Clear default station
295
+ #
296
+ # @param user_id User ID
297
+ # @param [Hash] opts the optional parameters
298
+ # @return [nil]
299
+ def delete_user_station_defaultstation(user_id, opts = {})
300
+ delete_user_station_defaultstation_with_http_info(user_id, opts)
301
+ return nil
302
+ end
303
+
304
+ # Clear default station
305
+ #
306
+ # @param user_id User ID
307
+ # @param [Hash] opts the optional parameters
308
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
309
+ def delete_user_station_defaultstation_with_http_info(user_id, opts = {})
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug "Calling API: UsersApi.delete_user_station_defaultstation ..."
312
+ end
313
+
314
+
315
+ # verify the required parameter 'user_id' is set
316
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user_station_defaultstation" if user_id.nil?
317
+
318
+
319
+
320
+
321
+
322
+ # resource path
323
+ local_var_path = "/api/v2/users/{userId}/station/defaultstation".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
324
+
325
+ # query parameters
326
+ query_params = {}
327
+
328
+ # header parameters
329
+ header_params = {}
330
+
331
+ # HTTP header 'Accept' (if needed)
332
+ local_header_accept = ['application/json']
333
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
334
+
335
+ # HTTP header 'Content-Type'
336
+ local_header_content_type = ['application/json']
337
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
338
+
339
+ # form parameters
340
+ form_params = {}
341
+
342
+ # http body (model)
343
+ post_body = nil
344
+
345
+ auth_names = ['PureCloud Auth']
346
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
347
+ :header_params => header_params,
348
+ :query_params => query_params,
349
+ :form_params => form_params,
350
+ :body => post_body,
351
+ :auth_names => auth_names)
352
+ if @api_client.config.debugging
353
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_station_defaultstation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
354
+ end
355
+ return data, status_code, headers
356
+ end
357
+
358
+ # Fetch field config for an entity type
359
+ #
360
+ # @param type Field type
361
+ # @param [Hash] opts the optional parameters
362
+ # @return [FieldConfig]
363
+ def get_fieldconfig(type, opts = {})
364
+ data, _status_code, _headers = get_fieldconfig_with_http_info(type, opts)
365
+ return data
366
+ end
367
+
368
+ # Fetch field config for an entity type
369
+ #
370
+ # @param type Field type
371
+ # @param [Hash] opts the optional parameters
372
+ # @return [Array<(FieldConfig, Fixnum, Hash)>] FieldConfig data, response status code and response headers
373
+ def get_fieldconfig_with_http_info(type, opts = {})
374
+ if @api_client.config.debugging
375
+ @api_client.config.logger.debug "Calling API: UsersApi.get_fieldconfig ..."
376
+ end
377
+
378
+
379
+ # verify the required parameter 'type' is set
380
+ fail ArgumentError, "Missing the required parameter 'type' when calling UsersApi.get_fieldconfig" if type.nil?
381
+
382
+ # verify enum value
383
+ unless ['person', 'group', 'org', 'externalContact'].include?(type)
384
+ fail ArgumentError, "invalid value for 'type', must be one of person, group, org, externalContact"
385
+ end
386
+
387
+
388
+
389
+
390
+
391
+ # resource path
392
+ local_var_path = "/api/v2/fieldconfig".sub('{format}','json')
393
+
394
+ # query parameters
395
+ query_params = {}
396
+ query_params[:'type'] = type
397
+
398
+ # header parameters
399
+ header_params = {}
400
+
401
+ # HTTP header 'Accept' (if needed)
402
+ local_header_accept = ['application/json']
403
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
404
+
405
+ # HTTP header 'Content-Type'
406
+ local_header_content_type = ['application/json']
407
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
408
+
409
+ # form parameters
410
+ form_params = {}
411
+
412
+ # http body (model)
413
+ post_body = nil
414
+
415
+ auth_names = ['PureCloud Auth']
416
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
417
+ :header_params => header_params,
418
+ :query_params => query_params,
419
+ :form_params => form_params,
420
+ :body => post_body,
421
+ :auth_names => auth_names,
422
+ :return_type => 'FieldConfig')
423
+ if @api_client.config.debugging
424
+ @api_client.config.logger.debug "API called: UsersApi#get_fieldconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
425
+ end
426
+ return data, status_code, headers
427
+ end
428
+
429
+ # Get a user profile listing
430
+ #
431
+ # @param [Hash] opts the optional parameters
432
+ # @option opts [Integer] :page_size Page size (default to 25)
433
+ # @option opts [Integer] :page_number Page number (default to 1)
434
+ # @option opts [Array<String>] :id id
435
+ # @option opts [Array<String>] :jid jid
436
+ # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
437
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
438
+ # @option opts [String] :state Only list users of this state (default to active)
439
+ # @return [UserProfileEntityListing]
440
+ def get_profiles_users(opts = {})
441
+ data, _status_code, _headers = get_profiles_users_with_http_info(opts)
442
+ return data
443
+ end
444
+
445
+ # Get a user profile listing
446
+ #
447
+ # @param [Hash] opts the optional parameters
448
+ # @option opts [Integer] :page_size Page size
449
+ # @option opts [Integer] :page_number Page number
450
+ # @option opts [Array<String>] :id id
451
+ # @option opts [Array<String>] :jid jid
452
+ # @option opts [String] :sort_order Ascending or descending sort order
453
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
454
+ # @option opts [String] :state Only list users of this state
455
+ # @return [Array<(UserProfileEntityListing, Fixnum, Hash)>] UserProfileEntityListing data, response status code and response headers
456
+ def get_profiles_users_with_http_info(opts = {})
457
+ if @api_client.config.debugging
458
+ @api_client.config.logger.debug "Calling API: UsersApi.get_profiles_users ..."
459
+ end
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
489
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
490
+ end
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+ if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
505
+ fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
506
+ end
507
+
508
+
509
+
510
+
511
+ # resource path
512
+ local_var_path = "/api/v2/profiles/users".sub('{format}','json')
513
+
514
+ # query parameters
515
+ query_params = {}
516
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
517
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
518
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
519
+ query_params[:'jid'] = @api_client.build_collection_param(opts[:'jid'], :multi) if opts[:'jid']
520
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
521
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
522
+ query_params[:'state'] = opts[:'state'] if opts[:'state']
523
+
524
+ # header parameters
525
+ header_params = {}
526
+
527
+ # HTTP header 'Accept' (if needed)
528
+ local_header_accept = ['application/json']
529
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
530
+
531
+ # HTTP header 'Content-Type'
532
+ local_header_content_type = ['application/json']
533
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
534
+
535
+ # form parameters
536
+ form_params = {}
537
+
538
+ # http body (model)
539
+ post_body = nil
540
+
541
+ auth_names = ['PureCloud Auth']
542
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
543
+ :header_params => header_params,
544
+ :query_params => query_params,
545
+ :form_params => form_params,
546
+ :body => post_body,
547
+ :auth_names => auth_names,
548
+ :return_type => 'UserProfileEntityListing')
549
+ if @api_client.config.debugging
550
+ @api_client.config.logger.debug "API called: UsersApi#get_profiles_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
551
+ end
552
+ return data, status_code, headers
553
+ end
554
+
555
+ # Get user.
556
+ #
557
+ # @param user_id User ID
558
+ # @param [Hash] opts the optional parameters
559
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
560
+ # @option opts [String] :state Search for a user with this state (default to active)
561
+ # @return [User]
562
+ def get_user(user_id, opts = {})
563
+ data, _status_code, _headers = get_user_with_http_info(user_id, opts)
564
+ return data
565
+ end
566
+
567
+ # Get user.
568
+ #
569
+ # @param user_id User ID
570
+ # @param [Hash] opts the optional parameters
571
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
572
+ # @option opts [String] :state Search for a user with this state
573
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
574
+ def get_user_with_http_info(user_id, opts = {})
575
+ if @api_client.config.debugging
576
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user ..."
577
+ end
578
+
579
+
580
+ # verify the required parameter 'user_id' is set
581
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user" if user_id.nil?
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+ if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
597
+ fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
598
+ end
599
+
600
+
601
+
602
+
603
+ # resource path
604
+ local_var_path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
605
+
606
+ # query parameters
607
+ query_params = {}
608
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
609
+ query_params[:'state'] = opts[:'state'] if opts[:'state']
610
+
611
+ # header parameters
612
+ header_params = {}
613
+
614
+ # HTTP header 'Accept' (if needed)
615
+ local_header_accept = ['application/json']
616
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
617
+
618
+ # HTTP header 'Content-Type'
619
+ local_header_content_type = ['application/json']
620
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
621
+
622
+ # form parameters
623
+ form_params = {}
624
+
625
+ # http body (model)
626
+ post_body = nil
627
+
628
+ auth_names = ['PureCloud Auth']
629
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
630
+ :header_params => header_params,
631
+ :query_params => query_params,
632
+ :form_params => form_params,
633
+ :body => post_body,
634
+ :auth_names => auth_names,
635
+ :return_type => 'User')
636
+ if @api_client.config.debugging
637
+ @api_client.config.logger.debug "API called: UsersApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
638
+ end
639
+ return data, status_code, headers
640
+ end
641
+
642
+ # Get adjacents
643
+ #
644
+ # @param user_id User ID
645
+ # @param [Hash] opts the optional parameters
646
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
647
+ # @return [Adjacents]
648
+ def get_user_adjacents(user_id, opts = {})
649
+ data, _status_code, _headers = get_user_adjacents_with_http_info(user_id, opts)
650
+ return data
651
+ end
652
+
653
+ # Get adjacents
654
+ #
655
+ # @param user_id User ID
656
+ # @param [Hash] opts the optional parameters
657
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
658
+ # @return [Array<(Adjacents, Fixnum, Hash)>] Adjacents data, response status code and response headers
659
+ def get_user_adjacents_with_http_info(user_id, opts = {})
660
+ if @api_client.config.debugging
661
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_adjacents ..."
662
+ end
663
+
664
+
665
+ # verify the required parameter 'user_id' is set
666
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_adjacents" if user_id.nil?
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+ # resource path
679
+ local_var_path = "/api/v2/users/{userId}/adjacents".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
680
+
681
+ # query parameters
682
+ query_params = {}
683
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
684
+
685
+ # header parameters
686
+ header_params = {}
687
+
688
+ # HTTP header 'Accept' (if needed)
689
+ local_header_accept = ['application/json']
690
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
691
+
692
+ # HTTP header 'Content-Type'
693
+ local_header_content_type = ['application/json']
694
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
695
+
696
+ # form parameters
697
+ form_params = {}
698
+
699
+ # http body (model)
700
+ post_body = nil
701
+
702
+ auth_names = ['PureCloud Auth']
703
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
704
+ :header_params => header_params,
705
+ :query_params => query_params,
706
+ :form_params => form_params,
707
+ :body => post_body,
708
+ :auth_names => auth_names,
709
+ :return_type => 'Adjacents')
710
+ if @api_client.config.debugging
711
+ @api_client.config.logger.debug "API called: UsersApi#get_user_adjacents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
712
+ end
713
+ return data, status_code, headers
714
+ end
715
+
716
+ # Get a user's CallForwarding
717
+ #
718
+ # @param user_id User ID
719
+ # @param [Hash] opts the optional parameters
720
+ # @return [CallForwarding]
721
+ def get_user_callforwarding(user_id, opts = {})
722
+ data, _status_code, _headers = get_user_callforwarding_with_http_info(user_id, opts)
723
+ return data
724
+ end
725
+
726
+ # Get a user&#39;s CallForwarding
727
+ #
728
+ # @param user_id User ID
729
+ # @param [Hash] opts the optional parameters
730
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
731
+ def get_user_callforwarding_with_http_info(user_id, opts = {})
732
+ if @api_client.config.debugging
733
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_callforwarding ..."
734
+ end
735
+
736
+
737
+ # verify the required parameter 'user_id' is set
738
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_callforwarding" if user_id.nil?
739
+
740
+
741
+
742
+
743
+
744
+ # resource path
745
+ local_var_path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
746
+
747
+ # query parameters
748
+ query_params = {}
749
+
750
+ # header parameters
751
+ header_params = {}
752
+
753
+ # HTTP header 'Accept' (if needed)
754
+ local_header_accept = ['application/json']
755
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
756
+
757
+ # HTTP header 'Content-Type'
758
+ local_header_content_type = ['application/json']
759
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
760
+
761
+ # form parameters
762
+ form_params = {}
763
+
764
+ # http body (model)
765
+ post_body = nil
766
+
767
+ auth_names = ['PureCloud Auth']
768
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
769
+ :header_params => header_params,
770
+ :query_params => query_params,
771
+ :form_params => form_params,
772
+ :body => post_body,
773
+ :auth_names => auth_names,
774
+ :return_type => 'CallForwarding')
775
+ if @api_client.config.debugging
776
+ @api_client.config.logger.debug "API called: UsersApi#get_user_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
777
+ end
778
+ return data, status_code, headers
779
+ end
780
+
781
+ # Get direct reports
782
+ #
783
+ # @param user_id User ID
784
+ # @param [Hash] opts the optional parameters
785
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
786
+ # @return [Array<User>]
787
+ def get_user_directreports(user_id, opts = {})
788
+ data, _status_code, _headers = get_user_directreports_with_http_info(user_id, opts)
789
+ return data
790
+ end
791
+
792
+ # Get direct reports
793
+ #
794
+ # @param user_id User ID
795
+ # @param [Hash] opts the optional parameters
796
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
797
+ # @return [Array<(Array<User>, Fixnum, Hash)>] Array<User> data, response status code and response headers
798
+ def get_user_directreports_with_http_info(user_id, opts = {})
799
+ if @api_client.config.debugging
800
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_directreports ..."
801
+ end
802
+
803
+
804
+ # verify the required parameter 'user_id' is set
805
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_directreports" if user_id.nil?
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+ # resource path
818
+ local_var_path = "/api/v2/users/{userId}/directreports".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
819
+
820
+ # query parameters
821
+ query_params = {}
822
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
823
+
824
+ # header parameters
825
+ header_params = {}
826
+
827
+ # HTTP header 'Accept' (if needed)
828
+ local_header_accept = ['application/json']
829
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
830
+
831
+ # HTTP header 'Content-Type'
832
+ local_header_content_type = ['application/json']
833
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
834
+
835
+ # form parameters
836
+ form_params = {}
837
+
838
+ # http body (model)
839
+ post_body = nil
840
+
841
+ auth_names = ['PureCloud Auth']
842
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
843
+ :header_params => header_params,
844
+ :query_params => query_params,
845
+ :form_params => form_params,
846
+ :body => post_body,
847
+ :auth_names => auth_names,
848
+ :return_type => 'Array<User>')
849
+ if @api_client.config.debugging
850
+ @api_client.config.logger.debug "API called: UsersApi#get_user_directreports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
851
+ end
852
+ return data, status_code, headers
853
+ end
854
+
855
+ # Get favorites
856
+ #
857
+ # @param user_id User ID
858
+ # @param [Hash] opts the optional parameters
859
+ # @option opts [Integer] :page_size Page size (default to 25)
860
+ # @option opts [Integer] :page_number Page number (default to 1)
861
+ # @option opts [String] :sort_order Sort order (default to ASC)
862
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
863
+ # @return [UserEntityListing]
864
+ def get_user_favorites(user_id, opts = {})
865
+ data, _status_code, _headers = get_user_favorites_with_http_info(user_id, opts)
866
+ return data
867
+ end
868
+
869
+ # Get favorites
870
+ #
871
+ # @param user_id User ID
872
+ # @param [Hash] opts the optional parameters
873
+ # @option opts [Integer] :page_size Page size
874
+ # @option opts [Integer] :page_number Page number
875
+ # @option opts [String] :sort_order Sort order
876
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
877
+ # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
878
+ def get_user_favorites_with_http_info(user_id, opts = {})
879
+ if @api_client.config.debugging
880
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_favorites ..."
881
+ end
882
+
883
+
884
+ # verify the required parameter 'user_id' is set
885
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_favorites" if user_id.nil?
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+
894
+
895
+
896
+
897
+
898
+
899
+
900
+
901
+
902
+
903
+
904
+
905
+
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+ # resource path
916
+ local_var_path = "/api/v2/users/{userId}/favorites".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
917
+
918
+ # query parameters
919
+ query_params = {}
920
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
921
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
922
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
923
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
924
+
925
+ # header parameters
926
+ header_params = {}
927
+
928
+ # HTTP header 'Accept' (if needed)
929
+ local_header_accept = ['application/json']
930
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
931
+
932
+ # HTTP header 'Content-Type'
933
+ local_header_content_type = ['application/json']
934
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
935
+
936
+ # form parameters
937
+ form_params = {}
938
+
939
+ # http body (model)
940
+ post_body = nil
941
+
942
+ auth_names = ['PureCloud Auth']
943
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
944
+ :header_params => header_params,
945
+ :query_params => query_params,
946
+ :form_params => form_params,
947
+ :body => post_body,
948
+ :auth_names => auth_names,
949
+ :return_type => 'UserEntityListing')
950
+ if @api_client.config.debugging
951
+ @api_client.config.logger.debug "API called: UsersApi#get_user_favorites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
952
+ end
953
+ return data, status_code, headers
954
+ end
955
+
956
+ # Get a user's Geolocation
957
+ #
958
+ # @param user_id user Id
959
+ # @param client_id client Id
960
+ # @param [Hash] opts the optional parameters
961
+ # @return [Geolocation]
962
+ def get_user_geolocation(user_id, client_id, opts = {})
963
+ data, _status_code, _headers = get_user_geolocation_with_http_info(user_id, client_id, opts)
964
+ return data
965
+ end
966
+
967
+ # Get a user&#39;s Geolocation
968
+ #
969
+ # @param user_id user Id
970
+ # @param client_id client Id
971
+ # @param [Hash] opts the optional parameters
972
+ # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
973
+ def get_user_geolocation_with_http_info(user_id, client_id, opts = {})
974
+ if @api_client.config.debugging
975
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_geolocation ..."
976
+ end
977
+
978
+
979
+ # verify the required parameter 'user_id' is set
980
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_geolocation" if user_id.nil?
981
+
982
+
983
+
984
+
985
+
986
+
987
+ # verify the required parameter 'client_id' is set
988
+ fail ArgumentError, "Missing the required parameter 'client_id' when calling UsersApi.get_user_geolocation" if client_id.nil?
989
+
990
+
991
+
992
+
993
+
994
+ # resource path
995
+ local_var_path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
996
+
997
+ # query parameters
998
+ query_params = {}
999
+
1000
+ # header parameters
1001
+ header_params = {}
1002
+
1003
+ # HTTP header 'Accept' (if needed)
1004
+ local_header_accept = ['application/json']
1005
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1006
+
1007
+ # HTTP header 'Content-Type'
1008
+ local_header_content_type = ['application/json']
1009
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1010
+
1011
+ # form parameters
1012
+ form_params = {}
1013
+
1014
+ # http body (model)
1015
+ post_body = nil
1016
+
1017
+ auth_names = ['PureCloud Auth']
1018
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1019
+ :header_params => header_params,
1020
+ :query_params => query_params,
1021
+ :form_params => form_params,
1022
+ :body => post_body,
1023
+ :auth_names => auth_names,
1024
+ :return_type => 'Geolocation')
1025
+ if @api_client.config.debugging
1026
+ @api_client.config.logger.debug "API called: UsersApi#get_user_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1027
+ end
1028
+ return data, status_code, headers
1029
+ end
1030
+
1031
+ # Get a OutOfOffice
1032
+ #
1033
+ # @param user_id User ID
1034
+ # @param [Hash] opts the optional parameters
1035
+ # @return [OutOfOffice]
1036
+ def get_user_outofoffice(user_id, opts = {})
1037
+ data, _status_code, _headers = get_user_outofoffice_with_http_info(user_id, opts)
1038
+ return data
1039
+ end
1040
+
1041
+ # Get a OutOfOffice
1042
+ #
1043
+ # @param user_id User ID
1044
+ # @param [Hash] opts the optional parameters
1045
+ # @return [Array<(OutOfOffice, Fixnum, Hash)>] OutOfOffice data, response status code and response headers
1046
+ def get_user_outofoffice_with_http_info(user_id, opts = {})
1047
+ if @api_client.config.debugging
1048
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_outofoffice ..."
1049
+ end
1050
+
1051
+
1052
+ # verify the required parameter 'user_id' is set
1053
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_outofoffice" if user_id.nil?
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+ # resource path
1060
+ local_var_path = "/api/v2/users/{userId}/outofoffice".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1061
+
1062
+ # query parameters
1063
+ query_params = {}
1064
+
1065
+ # header parameters
1066
+ header_params = {}
1067
+
1068
+ # HTTP header 'Accept' (if needed)
1069
+ local_header_accept = ['application/json']
1070
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1071
+
1072
+ # HTTP header 'Content-Type'
1073
+ local_header_content_type = ['application/json']
1074
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1075
+
1076
+ # form parameters
1077
+ form_params = {}
1078
+
1079
+ # http body (model)
1080
+ post_body = nil
1081
+
1082
+ auth_names = ['PureCloud Auth']
1083
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1084
+ :header_params => header_params,
1085
+ :query_params => query_params,
1086
+ :form_params => form_params,
1087
+ :body => post_body,
1088
+ :auth_names => auth_names,
1089
+ :return_type => 'OutOfOffice')
1090
+ if @api_client.config.debugging
1091
+ @api_client.config.logger.debug "API called: UsersApi#get_user_outofoffice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1092
+ end
1093
+ return data, status_code, headers
1094
+ end
1095
+
1096
+ # Get user profile
1097
+ #
1098
+ # @param user_id userId
1099
+ # @param [Hash] opts the optional parameters
1100
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1101
+ # @return [UserProfile]
1102
+ def get_user_profile(user_id, opts = {})
1103
+ data, _status_code, _headers = get_user_profile_with_http_info(user_id, opts)
1104
+ return data
1105
+ end
1106
+
1107
+ # Get user profile
1108
+ #
1109
+ # @param user_id userId
1110
+ # @param [Hash] opts the optional parameters
1111
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1112
+ # @return [Array<(UserProfile, Fixnum, Hash)>] UserProfile data, response status code and response headers
1113
+ def get_user_profile_with_http_info(user_id, opts = {})
1114
+ if @api_client.config.debugging
1115
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_profile ..."
1116
+ end
1117
+
1118
+
1119
+ # verify the required parameter 'user_id' is set
1120
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_profile" if user_id.nil?
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+ # resource path
1133
+ local_var_path = "/api/v2/users/{userId}/profile".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1134
+
1135
+ # query parameters
1136
+ query_params = {}
1137
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1138
+
1139
+ # header parameters
1140
+ header_params = {}
1141
+
1142
+ # HTTP header 'Accept' (if needed)
1143
+ local_header_accept = ['application/json']
1144
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1145
+
1146
+ # HTTP header 'Content-Type'
1147
+ local_header_content_type = ['application/json']
1148
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1149
+
1150
+ # form parameters
1151
+ form_params = {}
1152
+
1153
+ # http body (model)
1154
+ post_body = nil
1155
+
1156
+ auth_names = ['PureCloud Auth']
1157
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1158
+ :header_params => header_params,
1159
+ :query_params => query_params,
1160
+ :form_params => form_params,
1161
+ :body => post_body,
1162
+ :auth_names => auth_names,
1163
+ :return_type => 'UserProfile')
1164
+ if @api_client.config.debugging
1165
+ @api_client.config.logger.debug "API called: UsersApi#get_user_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1166
+ end
1167
+ return data, status_code, headers
1168
+ end
1169
+
1170
+ # List profile skills for a user
1171
+ #
1172
+ # @param user_id User ID
1173
+ # @param [Hash] opts the optional parameters
1174
+ # @return [Array<String>]
1175
+ def get_user_profileskills(user_id, opts = {})
1176
+ data, _status_code, _headers = get_user_profileskills_with_http_info(user_id, opts)
1177
+ return data
1178
+ end
1179
+
1180
+ # List profile skills for a user
1181
+ #
1182
+ # @param user_id User ID
1183
+ # @param [Hash] opts the optional parameters
1184
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
1185
+ def get_user_profileskills_with_http_info(user_id, opts = {})
1186
+ if @api_client.config.debugging
1187
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_profileskills ..."
1188
+ end
1189
+
1190
+
1191
+ # verify the required parameter 'user_id' is set
1192
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_profileskills" if user_id.nil?
1193
+
1194
+
1195
+
1196
+
1197
+
1198
+ # resource path
1199
+ local_var_path = "/api/v2/users/{userId}/profileskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1200
+
1201
+ # query parameters
1202
+ query_params = {}
1203
+
1204
+ # header parameters
1205
+ header_params = {}
1206
+
1207
+ # HTTP header 'Accept' (if needed)
1208
+ local_header_accept = ['application/json']
1209
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1210
+
1211
+ # HTTP header 'Content-Type'
1212
+ local_header_content_type = ['application/json']
1213
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1214
+
1215
+ # form parameters
1216
+ form_params = {}
1217
+
1218
+ # http body (model)
1219
+ post_body = nil
1220
+
1221
+ auth_names = ['PureCloud Auth']
1222
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1223
+ :header_params => header_params,
1224
+ :query_params => query_params,
1225
+ :form_params => form_params,
1226
+ :body => post_body,
1227
+ :auth_names => auth_names,
1228
+ :return_type => 'Array<String>')
1229
+ if @api_client.config.debugging
1230
+ @api_client.config.logger.debug "API called: UsersApi#get_user_profileskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1231
+ end
1232
+ return data, status_code, headers
1233
+ end
1234
+
1235
+ # Get queues for user
1236
+ #
1237
+ # @param user_id User ID
1238
+ # @param [Hash] opts the optional parameters
1239
+ # @option opts [Integer] :page_size Page size (default to 25)
1240
+ # @option opts [Integer] :page_number Page number (default to 1)
1241
+ # @option opts [BOOLEAN] :joined Is joined to the queue (default to true)
1242
+ # @return [UserQueueEntityListing]
1243
+ def get_user_queues(user_id, opts = {})
1244
+ data, _status_code, _headers = get_user_queues_with_http_info(user_id, opts)
1245
+ return data
1246
+ end
1247
+
1248
+ # Get queues for user
1249
+ #
1250
+ # @param user_id User ID
1251
+ # @param [Hash] opts the optional parameters
1252
+ # @option opts [Integer] :page_size Page size
1253
+ # @option opts [Integer] :page_number Page number
1254
+ # @option opts [BOOLEAN] :joined Is joined to the queue
1255
+ # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
1256
+ def get_user_queues_with_http_info(user_id, opts = {})
1257
+ if @api_client.config.debugging
1258
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_queues ..."
1259
+ end
1260
+
1261
+
1262
+ # verify the required parameter 'user_id' is set
1263
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_queues" if user_id.nil?
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+ # resource path
1288
+ local_var_path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1289
+
1290
+ # query parameters
1291
+ query_params = {}
1292
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1293
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1294
+ query_params[:'joined'] = opts[:'joined'] if opts[:'joined']
1295
+
1296
+ # header parameters
1297
+ header_params = {}
1298
+
1299
+ # HTTP header 'Accept' (if needed)
1300
+ local_header_accept = ['application/json']
1301
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1302
+
1303
+ # HTTP header 'Content-Type'
1304
+ local_header_content_type = ['application/json']
1305
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1306
+
1307
+ # form parameters
1308
+ form_params = {}
1309
+
1310
+ # http body (model)
1311
+ post_body = nil
1312
+
1313
+ auth_names = ['PureCloud Auth']
1314
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1315
+ :header_params => header_params,
1316
+ :query_params => query_params,
1317
+ :form_params => form_params,
1318
+ :body => post_body,
1319
+ :auth_names => auth_names,
1320
+ :return_type => 'UserQueueEntityListing')
1321
+ if @api_client.config.debugging
1322
+ @api_client.config.logger.debug "API called: UsersApi#get_user_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1323
+ end
1324
+ return data, status_code, headers
1325
+ end
1326
+
1327
+ # Returns a listing of roles and permissions for a user.
1328
+ #
1329
+ # @param user_id User ID
1330
+ # @param [Hash] opts the optional parameters
1331
+ # @return [UserAuthorization]
1332
+ def get_user_roles(user_id, opts = {})
1333
+ data, _status_code, _headers = get_user_roles_with_http_info(user_id, opts)
1334
+ return data
1335
+ end
1336
+
1337
+ # Returns a listing of roles and permissions for a user.
1338
+ #
1339
+ # @param user_id User ID
1340
+ # @param [Hash] opts the optional parameters
1341
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
1342
+ def get_user_roles_with_http_info(user_id, opts = {})
1343
+ if @api_client.config.debugging
1344
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_roles ..."
1345
+ end
1346
+
1347
+
1348
+ # verify the required parameter 'user_id' is set
1349
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_roles" if user_id.nil?
1350
+
1351
+
1352
+
1353
+
1354
+
1355
+ # resource path
1356
+ local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1357
+
1358
+ # query parameters
1359
+ query_params = {}
1360
+
1361
+ # header parameters
1362
+ header_params = {}
1363
+
1364
+ # HTTP header 'Accept' (if needed)
1365
+ local_header_accept = ['application/json']
1366
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1367
+
1368
+ # HTTP header 'Content-Type'
1369
+ local_header_content_type = ['application/json']
1370
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1371
+
1372
+ # form parameters
1373
+ form_params = {}
1374
+
1375
+ # http body (model)
1376
+ post_body = nil
1377
+
1378
+ auth_names = ['PureCloud Auth']
1379
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1380
+ :header_params => header_params,
1381
+ :query_params => query_params,
1382
+ :form_params => form_params,
1383
+ :body => post_body,
1384
+ :auth_names => auth_names,
1385
+ :return_type => 'UserAuthorization')
1386
+ if @api_client.config.debugging
1387
+ @api_client.config.logger.debug "API called: UsersApi#get_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1388
+ end
1389
+ return data, status_code, headers
1390
+ end
1391
+
1392
+ # List routing skills for user
1393
+ #
1394
+ # @param user_id User ID
1395
+ # @param [Hash] opts the optional parameters
1396
+ # @option opts [Integer] :page_size Page size (default to 25)
1397
+ # @option opts [Integer] :page_number Page number (default to 1)
1398
+ # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
1399
+ # @return [UserSkillEntityListing]
1400
+ def get_user_routingskills(user_id, opts = {})
1401
+ data, _status_code, _headers = get_user_routingskills_with_http_info(user_id, opts)
1402
+ return data
1403
+ end
1404
+
1405
+ # List routing skills for user
1406
+ #
1407
+ # @param user_id User ID
1408
+ # @param [Hash] opts the optional parameters
1409
+ # @option opts [Integer] :page_size Page size
1410
+ # @option opts [Integer] :page_number Page number
1411
+ # @option opts [String] :sort_order Ascending or descending sort order
1412
+ # @return [Array<(UserSkillEntityListing, Fixnum, Hash)>] UserSkillEntityListing data, response status code and response headers
1413
+ def get_user_routingskills_with_http_info(user_id, opts = {})
1414
+ if @api_client.config.debugging
1415
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_routingskills ..."
1416
+ end
1417
+
1418
+
1419
+ # verify the required parameter 'user_id' is set
1420
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_routingskills" if user_id.nil?
1421
+
1422
+
1423
+
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+
1432
+
1433
+
1434
+
1435
+
1436
+
1437
+
1438
+
1439
+
1440
+
1441
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
1442
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
1443
+ end
1444
+
1445
+
1446
+
1447
+
1448
+ # resource path
1449
+ local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1450
+
1451
+ # query parameters
1452
+ query_params = {}
1453
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1454
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1455
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1456
+
1457
+ # header parameters
1458
+ header_params = {}
1459
+
1460
+ # HTTP header 'Accept' (if needed)
1461
+ local_header_accept = ['application/json']
1462
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1463
+
1464
+ # HTTP header 'Content-Type'
1465
+ local_header_content_type = ['application/json']
1466
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1467
+
1468
+ # form parameters
1469
+ form_params = {}
1470
+
1471
+ # http body (model)
1472
+ post_body = nil
1473
+
1474
+ auth_names = ['PureCloud Auth']
1475
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1476
+ :header_params => header_params,
1477
+ :query_params => query_params,
1478
+ :form_params => form_params,
1479
+ :body => post_body,
1480
+ :auth_names => auth_names,
1481
+ :return_type => 'UserSkillEntityListing')
1482
+ if @api_client.config.debugging
1483
+ @api_client.config.logger.debug "API called: UsersApi#get_user_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1484
+ end
1485
+ return data, status_code, headers
1486
+ end
1487
+
1488
+ # Fetch the routing status of a user
1489
+ #
1490
+ # @param user_id User ID
1491
+ # @param [Hash] opts the optional parameters
1492
+ # @return [RoutingStatus]
1493
+ def get_user_routingstatus(user_id, opts = {})
1494
+ data, _status_code, _headers = get_user_routingstatus_with_http_info(user_id, opts)
1495
+ return data
1496
+ end
1497
+
1498
+ # Fetch the routing status of a user
1499
+ #
1500
+ # @param user_id User ID
1501
+ # @param [Hash] opts the optional parameters
1502
+ # @return [Array<(RoutingStatus, Fixnum, Hash)>] RoutingStatus data, response status code and response headers
1503
+ def get_user_routingstatus_with_http_info(user_id, opts = {})
1504
+ if @api_client.config.debugging
1505
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_routingstatus ..."
1506
+ end
1507
+
1508
+
1509
+ # verify the required parameter 'user_id' is set
1510
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_routingstatus" if user_id.nil?
1511
+
1512
+
1513
+
1514
+
1515
+
1516
+ # resource path
1517
+ local_var_path = "/api/v2/users/{userId}/routingstatus".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1518
+
1519
+ # query parameters
1520
+ query_params = {}
1521
+
1522
+ # header parameters
1523
+ header_params = {}
1524
+
1525
+ # HTTP header 'Accept' (if needed)
1526
+ local_header_accept = ['application/json']
1527
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1528
+
1529
+ # HTTP header 'Content-Type'
1530
+ local_header_content_type = ['application/json']
1531
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1532
+
1533
+ # form parameters
1534
+ form_params = {}
1535
+
1536
+ # http body (model)
1537
+ post_body = nil
1538
+
1539
+ auth_names = ['PureCloud Auth']
1540
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1541
+ :header_params => header_params,
1542
+ :query_params => query_params,
1543
+ :form_params => form_params,
1544
+ :body => post_body,
1545
+ :auth_names => auth_names,
1546
+ :return_type => 'RoutingStatus')
1547
+ if @api_client.config.debugging
1548
+ @api_client.config.logger.debug "API called: UsersApi#get_user_routingstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1549
+ end
1550
+ return data, status_code, headers
1551
+ end
1552
+
1553
+ # Get station information for user
1554
+ #
1555
+ # @param user_id User ID
1556
+ # @param [Hash] opts the optional parameters
1557
+ # @return [UserStations]
1558
+ def get_user_station(user_id, opts = {})
1559
+ data, _status_code, _headers = get_user_station_with_http_info(user_id, opts)
1560
+ return data
1561
+ end
1562
+
1563
+ # Get station information for user
1564
+ #
1565
+ # @param user_id User ID
1566
+ # @param [Hash] opts the optional parameters
1567
+ # @return [Array<(UserStations, Fixnum, Hash)>] UserStations data, response status code and response headers
1568
+ def get_user_station_with_http_info(user_id, opts = {})
1569
+ if @api_client.config.debugging
1570
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_station ..."
1571
+ end
1572
+
1573
+
1574
+ # verify the required parameter 'user_id' is set
1575
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_station" if user_id.nil?
1576
+
1577
+
1578
+
1579
+
1580
+
1581
+ # resource path
1582
+ local_var_path = "/api/v2/users/{userId}/station".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1583
+
1584
+ # query parameters
1585
+ query_params = {}
1586
+
1587
+ # header parameters
1588
+ header_params = {}
1589
+
1590
+ # HTTP header 'Accept' (if needed)
1591
+ local_header_accept = ['application/json']
1592
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1593
+
1594
+ # HTTP header 'Content-Type'
1595
+ local_header_content_type = ['application/json']
1596
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1597
+
1598
+ # form parameters
1599
+ form_params = {}
1600
+
1601
+ # http body (model)
1602
+ post_body = nil
1603
+
1604
+ auth_names = ['PureCloud Auth']
1605
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1606
+ :header_params => header_params,
1607
+ :query_params => query_params,
1608
+ :form_params => form_params,
1609
+ :body => post_body,
1610
+ :auth_names => auth_names,
1611
+ :return_type => 'UserStations')
1612
+ if @api_client.config.debugging
1613
+ @api_client.config.logger.debug "API called: UsersApi#get_user_station\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1614
+ end
1615
+ return data, status_code, headers
1616
+ end
1617
+
1618
+ # Get superiors
1619
+ #
1620
+ # @param user_id User ID
1621
+ # @param [Hash] opts the optional parameters
1622
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1623
+ # @return [Array<User>]
1624
+ def get_user_superiors(user_id, opts = {})
1625
+ data, _status_code, _headers = get_user_superiors_with_http_info(user_id, opts)
1626
+ return data
1627
+ end
1628
+
1629
+ # Get superiors
1630
+ #
1631
+ # @param user_id User ID
1632
+ # @param [Hash] opts the optional parameters
1633
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1634
+ # @return [Array<(Array<User>, Fixnum, Hash)>] Array<User> data, response status code and response headers
1635
+ def get_user_superiors_with_http_info(user_id, opts = {})
1636
+ if @api_client.config.debugging
1637
+ @api_client.config.logger.debug "Calling API: UsersApi.get_user_superiors ..."
1638
+ end
1639
+
1640
+
1641
+ # verify the required parameter 'user_id' is set
1642
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_superiors" if user_id.nil?
1643
+
1644
+
1645
+
1646
+
1647
+
1648
+
1649
+
1650
+
1651
+
1652
+
1653
+
1654
+ # resource path
1655
+ local_var_path = "/api/v2/users/{userId}/superiors".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1656
+
1657
+ # query parameters
1658
+ query_params = {}
1659
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1660
+
1661
+ # header parameters
1662
+ header_params = {}
1663
+
1664
+ # HTTP header 'Accept' (if needed)
1665
+ local_header_accept = ['application/json']
1666
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1667
+
1668
+ # HTTP header 'Content-Type'
1669
+ local_header_content_type = ['application/json']
1670
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1671
+
1672
+ # form parameters
1673
+ form_params = {}
1674
+
1675
+ # http body (model)
1676
+ post_body = nil
1677
+
1678
+ auth_names = ['PureCloud Auth']
1679
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1680
+ :header_params => header_params,
1681
+ :query_params => query_params,
1682
+ :form_params => form_params,
1683
+ :body => post_body,
1684
+ :auth_names => auth_names,
1685
+ :return_type => 'Array<User>')
1686
+ if @api_client.config.debugging
1687
+ @api_client.config.logger.debug "API called: UsersApi#get_user_superiors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1688
+ end
1689
+ return data, status_code, headers
1690
+ end
1691
+
1692
+ # Get the list of available users.
1693
+ #
1694
+ # @param [Hash] opts the optional parameters
1695
+ # @option opts [Integer] :page_size Page size (default to 25)
1696
+ # @option opts [Integer] :page_number Page number (default to 1)
1697
+ # @option opts [Array<String>] :id id
1698
+ # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
1699
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1700
+ # @option opts [String] :state Only list users of this state (default to active)
1701
+ # @return [UserEntityListing]
1702
+ def get_users(opts = {})
1703
+ data, _status_code, _headers = get_users_with_http_info(opts)
1704
+ return data
1705
+ end
1706
+
1707
+ # Get the list of available users.
1708
+ #
1709
+ # @param [Hash] opts the optional parameters
1710
+ # @option opts [Integer] :page_size Page size
1711
+ # @option opts [Integer] :page_number Page number
1712
+ # @option opts [Array<String>] :id id
1713
+ # @option opts [String] :sort_order Ascending or descending sort order
1714
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
1715
+ # @option opts [String] :state Only list users of this state
1716
+ # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
1717
+ def get_users_with_http_info(opts = {})
1718
+ if @api_client.config.debugging
1719
+ @api_client.config.logger.debug "Calling API: UsersApi.get_users ..."
1720
+ end
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+
1730
+
1731
+
1732
+
1733
+
1734
+
1735
+
1736
+
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+
1743
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
1744
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
1745
+ end
1746
+
1747
+
1748
+
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+
1755
+
1756
+
1757
+
1758
+
1759
+ if opts[:'state'] && !['active', 'inactive', 'deleted'].include?(opts[:'state'])
1760
+ fail ArgumentError, 'invalid value for "state", must be one of active, inactive, deleted'
1761
+ end
1762
+
1763
+
1764
+
1765
+
1766
+ # resource path
1767
+ local_var_path = "/api/v2/users".sub('{format}','json')
1768
+
1769
+ # query parameters
1770
+ query_params = {}
1771
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1772
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1773
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
1774
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1775
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1776
+ query_params[:'state'] = opts[:'state'] if opts[:'state']
1777
+
1778
+ # header parameters
1779
+ header_params = {}
1780
+
1781
+ # HTTP header 'Accept' (if needed)
1782
+ local_header_accept = ['application/json']
1783
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1784
+
1785
+ # HTTP header 'Content-Type'
1786
+ local_header_content_type = ['application/json']
1787
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1788
+
1789
+ # form parameters
1790
+ form_params = {}
1791
+
1792
+ # http body (model)
1793
+ post_body = nil
1794
+
1795
+ auth_names = ['PureCloud Auth']
1796
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1797
+ :header_params => header_params,
1798
+ :query_params => query_params,
1799
+ :form_params => form_params,
1800
+ :body => post_body,
1801
+ :auth_names => auth_names,
1802
+ :return_type => 'UserEntityListing')
1803
+ if @api_client.config.debugging
1804
+ @api_client.config.logger.debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1805
+ end
1806
+ return data, status_code, headers
1807
+ end
1808
+
1809
+ # Get current user details.
1810
+ # This request is not valid when using the Client Credentials OAuth grant.
1811
+ # @param [Hash] opts the optional parameters
1812
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
1813
+ # @return [UserMe]
1814
+ def get_users_me(opts = {})
1815
+ data, _status_code, _headers = get_users_me_with_http_info(opts)
1816
+ return data
1817
+ end
1818
+
1819
+ # Get current user details.
1820
+ # This request is not valid when using the Client Credentials OAuth grant.
1821
+ # @param [Hash] opts the optional parameters
1822
+ # @option opts [Array<String>] :expand Which fields, if any, to expand.
1823
+ # @return [Array<(UserMe, Fixnum, Hash)>] UserMe data, response status code and response headers
1824
+ def get_users_me_with_http_info(opts = {})
1825
+ if @api_client.config.debugging
1826
+ @api_client.config.logger.debug "Calling API: UsersApi.get_users_me ..."
1827
+ end
1828
+
1829
+
1830
+
1831
+
1832
+
1833
+
1834
+
1835
+ # resource path
1836
+ local_var_path = "/api/v2/users/me".sub('{format}','json')
1837
+
1838
+ # query parameters
1839
+ query_params = {}
1840
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1841
+
1842
+ # header parameters
1843
+ header_params = {}
1844
+
1845
+ # HTTP header 'Accept' (if needed)
1846
+ local_header_accept = ['application/json']
1847
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1848
+
1849
+ # HTTP header 'Content-Type'
1850
+ local_header_content_type = ['application/json']
1851
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1852
+
1853
+ # form parameters
1854
+ form_params = {}
1855
+
1856
+ # http body (model)
1857
+ post_body = nil
1858
+
1859
+ auth_names = ['PureCloud Auth']
1860
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1861
+ :header_params => header_params,
1862
+ :query_params => query_params,
1863
+ :form_params => form_params,
1864
+ :body => post_body,
1865
+ :auth_names => auth_names,
1866
+ :return_type => 'UserMe')
1867
+ if @api_client.config.debugging
1868
+ @api_client.config.logger.debug "API called: UsersApi#get_users_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1869
+ end
1870
+ return data, status_code, headers
1871
+ end
1872
+
1873
+ # Search users using the q64 value returned from a previous search
1874
+ #
1875
+ # @param q64 q64
1876
+ # @param [Hash] opts the optional parameters
1877
+ # @option opts [Array<String>] :expand expand
1878
+ # @return [UsersSearchResponse]
1879
+ def get_users_search(q64, opts = {})
1880
+ data, _status_code, _headers = get_users_search_with_http_info(q64, opts)
1881
+ return data
1882
+ end
1883
+
1884
+ # Search users using the q64 value returned from a previous search
1885
+ #
1886
+ # @param q64 q64
1887
+ # @param [Hash] opts the optional parameters
1888
+ # @option opts [Array<String>] :expand expand
1889
+ # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
1890
+ def get_users_search_with_http_info(q64, opts = {})
1891
+ if @api_client.config.debugging
1892
+ @api_client.config.logger.debug "Calling API: UsersApi.get_users_search ..."
1893
+ end
1894
+
1895
+
1896
+ # verify the required parameter 'q64' is set
1897
+ fail ArgumentError, "Missing the required parameter 'q64' when calling UsersApi.get_users_search" if q64.nil?
1898
+
1899
+
1900
+
1901
+
1902
+
1903
+
1904
+
1905
+
1906
+
1907
+
1908
+
1909
+ # resource path
1910
+ local_var_path = "/api/v2/users/search".sub('{format}','json')
1911
+
1912
+ # query parameters
1913
+ query_params = {}
1914
+ query_params[:'q64'] = q64
1915
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1916
+
1917
+ # header parameters
1918
+ header_params = {}
1919
+
1920
+ # HTTP header 'Accept' (if needed)
1921
+ local_header_accept = ['application/json']
1922
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1923
+
1924
+ # HTTP header 'Content-Type'
1925
+ local_header_content_type = ['application/json']
1926
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1927
+
1928
+ # form parameters
1929
+ form_params = {}
1930
+
1931
+ # http body (model)
1932
+ post_body = nil
1933
+
1934
+ auth_names = ['PureCloud Auth']
1935
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1936
+ :header_params => header_params,
1937
+ :query_params => query_params,
1938
+ :form_params => form_params,
1939
+ :body => post_body,
1940
+ :auth_names => auth_names,
1941
+ :return_type => 'UsersSearchResponse')
1942
+ if @api_client.config.debugging
1943
+ @api_client.config.logger.debug "API called: UsersApi#get_users_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1944
+ end
1945
+ return data, status_code, headers
1946
+ end
1947
+
1948
+ # Update user
1949
+ #
1950
+ # @param user_id User ID
1951
+ # @param body User
1952
+ # @param [Hash] opts the optional parameters
1953
+ # @return [User]
1954
+ def patch_user(user_id, body, opts = {})
1955
+ data, _status_code, _headers = patch_user_with_http_info(user_id, body, opts)
1956
+ return data
1957
+ end
1958
+
1959
+ # Update user
1960
+ #
1961
+ # @param user_id User ID
1962
+ # @param body User
1963
+ # @param [Hash] opts the optional parameters
1964
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
1965
+ def patch_user_with_http_info(user_id, body, opts = {})
1966
+ if @api_client.config.debugging
1967
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user ..."
1968
+ end
1969
+
1970
+
1971
+ # verify the required parameter 'user_id' is set
1972
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user" if user_id.nil?
1973
+
1974
+
1975
+
1976
+
1977
+
1978
+
1979
+ # verify the required parameter 'body' is set
1980
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user" if body.nil?
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+ # resource path
1987
+ local_var_path = "/api/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1988
+
1989
+ # query parameters
1990
+ query_params = {}
1991
+
1992
+ # header parameters
1993
+ header_params = {}
1994
+
1995
+ # HTTP header 'Accept' (if needed)
1996
+ local_header_accept = ['application/json']
1997
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1998
+
1999
+ # HTTP header 'Content-Type'
2000
+ local_header_content_type = ['application/json']
2001
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2002
+
2003
+ # form parameters
2004
+ form_params = {}
2005
+
2006
+ # http body (model)
2007
+ post_body = @api_client.object_to_http_body(body)
2008
+
2009
+ auth_names = ['PureCloud Auth']
2010
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
2011
+ :header_params => header_params,
2012
+ :query_params => query_params,
2013
+ :form_params => form_params,
2014
+ :body => post_body,
2015
+ :auth_names => auth_names,
2016
+ :return_type => 'User')
2017
+ if @api_client.config.debugging
2018
+ @api_client.config.logger.debug "API called: UsersApi#patch_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2019
+ end
2020
+ return data, status_code, headers
2021
+ end
2022
+
2023
+ # Patch a user's CallForwarding
2024
+ #
2025
+ # @param user_id User ID
2026
+ # @param body Call forwarding
2027
+ # @param [Hash] opts the optional parameters
2028
+ # @return [CallForwarding]
2029
+ def patch_user_callforwarding(user_id, body, opts = {})
2030
+ data, _status_code, _headers = patch_user_callforwarding_with_http_info(user_id, body, opts)
2031
+ return data
2032
+ end
2033
+
2034
+ # Patch a user&#39;s CallForwarding
2035
+ #
2036
+ # @param user_id User ID
2037
+ # @param body Call forwarding
2038
+ # @param [Hash] opts the optional parameters
2039
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
2040
+ def patch_user_callforwarding_with_http_info(user_id, body, opts = {})
2041
+ if @api_client.config.debugging
2042
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user_callforwarding ..."
2043
+ end
2044
+
2045
+
2046
+ # verify the required parameter 'user_id' is set
2047
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_callforwarding" if user_id.nil?
2048
+
2049
+
2050
+
2051
+
2052
+
2053
+
2054
+ # verify the required parameter 'body' is set
2055
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user_callforwarding" if body.nil?
2056
+
2057
+
2058
+
2059
+
2060
+
2061
+ # resource path
2062
+ local_var_path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2063
+
2064
+ # query parameters
2065
+ query_params = {}
2066
+
2067
+ # header parameters
2068
+ header_params = {}
2069
+
2070
+ # HTTP header 'Accept' (if needed)
2071
+ local_header_accept = ['application/json']
2072
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2073
+
2074
+ # HTTP header 'Content-Type'
2075
+ local_header_content_type = ['application/json']
2076
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2077
+
2078
+ # form parameters
2079
+ form_params = {}
2080
+
2081
+ # http body (model)
2082
+ post_body = @api_client.object_to_http_body(body)
2083
+
2084
+ auth_names = ['PureCloud Auth']
2085
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
2086
+ :header_params => header_params,
2087
+ :query_params => query_params,
2088
+ :form_params => form_params,
2089
+ :body => post_body,
2090
+ :auth_names => auth_names,
2091
+ :return_type => 'CallForwarding')
2092
+ if @api_client.config.debugging
2093
+ @api_client.config.logger.debug "API called: UsersApi#patch_user_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2094
+ end
2095
+ return data, status_code, headers
2096
+ end
2097
+
2098
+ # Patch a user's Geolocation
2099
+ # The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
2100
+ # @param user_id user Id
2101
+ # @param client_id client Id
2102
+ # @param body Geolocation
2103
+ # @param [Hash] opts the optional parameters
2104
+ # @return [Geolocation]
2105
+ def patch_user_geolocation(user_id, client_id, body, opts = {})
2106
+ data, _status_code, _headers = patch_user_geolocation_with_http_info(user_id, client_id, body, opts)
2107
+ return data
2108
+ end
2109
+
2110
+ # Patch a user&#39;s Geolocation
2111
+ # The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source. Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values. This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;. Option 3: Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
2112
+ # @param user_id user Id
2113
+ # @param client_id client Id
2114
+ # @param body Geolocation
2115
+ # @param [Hash] opts the optional parameters
2116
+ # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
2117
+ def patch_user_geolocation_with_http_info(user_id, client_id, body, opts = {})
2118
+ if @api_client.config.debugging
2119
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user_geolocation ..."
2120
+ end
2121
+
2122
+
2123
+ # verify the required parameter 'user_id' is set
2124
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_geolocation" if user_id.nil?
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+
2131
+ # verify the required parameter 'client_id' is set
2132
+ fail ArgumentError, "Missing the required parameter 'client_id' when calling UsersApi.patch_user_geolocation" if client_id.nil?
2133
+
2134
+
2135
+
2136
+
2137
+
2138
+
2139
+ # verify the required parameter 'body' is set
2140
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user_geolocation" if body.nil?
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+ # resource path
2147
+ local_var_path = "/api/v2/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
2148
+
2149
+ # query parameters
2150
+ query_params = {}
2151
+
2152
+ # header parameters
2153
+ header_params = {}
2154
+
2155
+ # HTTP header 'Accept' (if needed)
2156
+ local_header_accept = ['application/json']
2157
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2158
+
2159
+ # HTTP header 'Content-Type'
2160
+ local_header_content_type = ['application/json']
2161
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2162
+
2163
+ # form parameters
2164
+ form_params = {}
2165
+
2166
+ # http body (model)
2167
+ post_body = @api_client.object_to_http_body(body)
2168
+
2169
+ auth_names = ['PureCloud Auth']
2170
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
2171
+ :header_params => header_params,
2172
+ :query_params => query_params,
2173
+ :form_params => form_params,
2174
+ :body => post_body,
2175
+ :auth_names => auth_names,
2176
+ :return_type => 'Geolocation')
2177
+ if @api_client.config.debugging
2178
+ @api_client.config.logger.debug "API called: UsersApi#patch_user_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2179
+ end
2180
+ return data, status_code, headers
2181
+ end
2182
+
2183
+ # Join or unjoin a queue for a user
2184
+ #
2185
+ # @param queue_id Queue ID
2186
+ # @param user_id User ID
2187
+ # @param body Queue Member
2188
+ # @param [Hash] opts the optional parameters
2189
+ # @return [UserQueue]
2190
+ def patch_user_queue(queue_id, user_id, body, opts = {})
2191
+ data, _status_code, _headers = patch_user_queue_with_http_info(queue_id, user_id, body, opts)
2192
+ return data
2193
+ end
2194
+
2195
+ # Join or unjoin a queue for a user
2196
+ #
2197
+ # @param queue_id Queue ID
2198
+ # @param user_id User ID
2199
+ # @param body Queue Member
2200
+ # @param [Hash] opts the optional parameters
2201
+ # @return [Array<(UserQueue, Fixnum, Hash)>] UserQueue data, response status code and response headers
2202
+ def patch_user_queue_with_http_info(queue_id, user_id, body, opts = {})
2203
+ if @api_client.config.debugging
2204
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user_queue ..."
2205
+ end
2206
+
2207
+
2208
+ # verify the required parameter 'queue_id' is set
2209
+ fail ArgumentError, "Missing the required parameter 'queue_id' when calling UsersApi.patch_user_queue" if queue_id.nil?
2210
+
2211
+
2212
+
2213
+
2214
+
2215
+
2216
+ # verify the required parameter 'user_id' is set
2217
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_queue" if user_id.nil?
2218
+
2219
+
2220
+
2221
+
2222
+
2223
+
2224
+ # verify the required parameter 'body' is set
2225
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user_queue" if body.nil?
2226
+
2227
+
2228
+
2229
+
2230
+
2231
+ # resource path
2232
+ local_var_path = "/api/v2/users/{userId}/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
2233
+
2234
+ # query parameters
2235
+ query_params = {}
2236
+
2237
+ # header parameters
2238
+ header_params = {}
2239
+
2240
+ # HTTP header 'Accept' (if needed)
2241
+ local_header_accept = ['application/json']
2242
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2243
+
2244
+ # HTTP header 'Content-Type'
2245
+ local_header_content_type = ['application/json']
2246
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2247
+
2248
+ # form parameters
2249
+ form_params = {}
2250
+
2251
+ # http body (model)
2252
+ post_body = @api_client.object_to_http_body(body)
2253
+
2254
+ auth_names = ['PureCloud Auth']
2255
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
2256
+ :header_params => header_params,
2257
+ :query_params => query_params,
2258
+ :form_params => form_params,
2259
+ :body => post_body,
2260
+ :auth_names => auth_names,
2261
+ :return_type => 'UserQueue')
2262
+ if @api_client.config.debugging
2263
+ @api_client.config.logger.debug "API called: UsersApi#patch_user_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2264
+ end
2265
+ return data, status_code, headers
2266
+ end
2267
+
2268
+ # Join or unjoin a set of queues for a user
2269
+ #
2270
+ # @param user_id User ID
2271
+ # @param body User Queues
2272
+ # @param [Hash] opts the optional parameters
2273
+ # @return [UserQueueEntityListing]
2274
+ def patch_user_queues(user_id, body, opts = {})
2275
+ data, _status_code, _headers = patch_user_queues_with_http_info(user_id, body, opts)
2276
+ return data
2277
+ end
2278
+
2279
+ # Join or unjoin a set of queues for a user
2280
+ #
2281
+ # @param user_id User ID
2282
+ # @param body User Queues
2283
+ # @param [Hash] opts the optional parameters
2284
+ # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
2285
+ def patch_user_queues_with_http_info(user_id, body, opts = {})
2286
+ if @api_client.config.debugging
2287
+ @api_client.config.logger.debug "Calling API: UsersApi.patch_user_queues ..."
2288
+ end
2289
+
2290
+
2291
+ # verify the required parameter 'user_id' is set
2292
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_queues" if user_id.nil?
2293
+
2294
+
2295
+
2296
+
2297
+
2298
+
2299
+ # verify the required parameter 'body' is set
2300
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.patch_user_queues" if body.nil?
2301
+
2302
+
2303
+
2304
+
2305
+
2306
+ # resource path
2307
+ local_var_path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2308
+
2309
+ # query parameters
2310
+ query_params = {}
2311
+
2312
+ # header parameters
2313
+ header_params = {}
2314
+
2315
+ # HTTP header 'Accept' (if needed)
2316
+ local_header_accept = ['application/json']
2317
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2318
+
2319
+ # HTTP header 'Content-Type'
2320
+ local_header_content_type = ['application/json']
2321
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2322
+
2323
+ # form parameters
2324
+ form_params = {}
2325
+
2326
+ # http body (model)
2327
+ post_body = @api_client.object_to_http_body(body)
2328
+
2329
+ auth_names = ['PureCloud Auth']
2330
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
2331
+ :header_params => header_params,
2332
+ :query_params => query_params,
2333
+ :form_params => form_params,
2334
+ :body => post_body,
2335
+ :auth_names => auth_names,
2336
+ :return_type => 'UserQueueEntityListing')
2337
+ if @api_client.config.debugging
2338
+ @api_client.config.logger.debug "API called: UsersApi#patch_user_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2339
+ end
2340
+ return data, status_code, headers
2341
+ end
2342
+
2343
+ # Query for user aggregates
2344
+ #
2345
+ # @param body query
2346
+ # @param [Hash] opts the optional parameters
2347
+ # @return [PresenceQueryResponse]
2348
+ def post_analytics_users_aggregates_query(body, opts = {})
2349
+ data, _status_code, _headers = post_analytics_users_aggregates_query_with_http_info(body, opts)
2350
+ return data
2351
+ end
2352
+
2353
+ # Query for user aggregates
2354
+ #
2355
+ # @param body query
2356
+ # @param [Hash] opts the optional parameters
2357
+ # @return [Array<(PresenceQueryResponse, Fixnum, Hash)>] PresenceQueryResponse data, response status code and response headers
2358
+ def post_analytics_users_aggregates_query_with_http_info(body, opts = {})
2359
+ if @api_client.config.debugging
2360
+ @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_aggregates_query ..."
2361
+ end
2362
+
2363
+
2364
+ # verify the required parameter 'body' is set
2365
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_analytics_users_aggregates_query" if body.nil?
2366
+
2367
+
2368
+
2369
+
2370
+
2371
+ # resource path
2372
+ local_var_path = "/api/v2/analytics/users/aggregates/query".sub('{format}','json')
2373
+
2374
+ # query parameters
2375
+ query_params = {}
2376
+
2377
+ # header parameters
2378
+ header_params = {}
2379
+
2380
+ # HTTP header 'Accept' (if needed)
2381
+ local_header_accept = ['application/json']
2382
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2383
+
2384
+ # HTTP header 'Content-Type'
2385
+ local_header_content_type = ['application/json']
2386
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2387
+
2388
+ # form parameters
2389
+ form_params = {}
2390
+
2391
+ # http body (model)
2392
+ post_body = @api_client.object_to_http_body(body)
2393
+
2394
+ auth_names = ['PureCloud Auth']
2395
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2396
+ :header_params => header_params,
2397
+ :query_params => query_params,
2398
+ :form_params => form_params,
2399
+ :body => post_body,
2400
+ :auth_names => auth_names,
2401
+ :return_type => 'PresenceQueryResponse')
2402
+ if @api_client.config.debugging
2403
+ @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2404
+ end
2405
+ return data, status_code, headers
2406
+ end
2407
+
2408
+ # Query for user details
2409
+ #
2410
+ # @param body query
2411
+ # @param [Hash] opts the optional parameters
2412
+ # @return [AnalyticsUserDetailsQueryResponse]
2413
+ def post_analytics_users_details_query(body, opts = {})
2414
+ data, _status_code, _headers = post_analytics_users_details_query_with_http_info(body, opts)
2415
+ return data
2416
+ end
2417
+
2418
+ # Query for user details
2419
+ #
2420
+ # @param body query
2421
+ # @param [Hash] opts the optional parameters
2422
+ # @return [Array<(AnalyticsUserDetailsQueryResponse, Fixnum, Hash)>] AnalyticsUserDetailsQueryResponse data, response status code and response headers
2423
+ def post_analytics_users_details_query_with_http_info(body, opts = {})
2424
+ if @api_client.config.debugging
2425
+ @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_details_query ..."
2426
+ end
2427
+
2428
+
2429
+ # verify the required parameter 'body' is set
2430
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_analytics_users_details_query" if body.nil?
2431
+
2432
+
2433
+
2434
+
2435
+
2436
+ # resource path
2437
+ local_var_path = "/api/v2/analytics/users/details/query".sub('{format}','json')
2438
+
2439
+ # query parameters
2440
+ query_params = {}
2441
+
2442
+ # header parameters
2443
+ header_params = {}
2444
+
2445
+ # HTTP header 'Accept' (if needed)
2446
+ local_header_accept = ['application/json']
2447
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2448
+
2449
+ # HTTP header 'Content-Type'
2450
+ local_header_content_type = ['application/json']
2451
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2452
+
2453
+ # form parameters
2454
+ form_params = {}
2455
+
2456
+ # http body (model)
2457
+ post_body = @api_client.object_to_http_body(body)
2458
+
2459
+ auth_names = ['PureCloud Auth']
2460
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2461
+ :header_params => header_params,
2462
+ :query_params => query_params,
2463
+ :form_params => form_params,
2464
+ :body => post_body,
2465
+ :auth_names => auth_names,
2466
+ :return_type => 'AnalyticsUserDetailsQueryResponse')
2467
+ if @api_client.config.debugging
2468
+ @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_details_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2469
+ end
2470
+ return data, status_code, headers
2471
+ end
2472
+
2473
+ # Query for user observations
2474
+ #
2475
+ # @param body query
2476
+ # @param [Hash] opts the optional parameters
2477
+ # @return [ObservationQueryResponse]
2478
+ def post_analytics_users_observations_query(body, opts = {})
2479
+ data, _status_code, _headers = post_analytics_users_observations_query_with_http_info(body, opts)
2480
+ return data
2481
+ end
2482
+
2483
+ # Query for user observations
2484
+ #
2485
+ # @param body query
2486
+ # @param [Hash] opts the optional parameters
2487
+ # @return [Array<(ObservationQueryResponse, Fixnum, Hash)>] ObservationQueryResponse data, response status code and response headers
2488
+ def post_analytics_users_observations_query_with_http_info(body, opts = {})
2489
+ if @api_client.config.debugging
2490
+ @api_client.config.logger.debug "Calling API: UsersApi.post_analytics_users_observations_query ..."
2491
+ end
2492
+
2493
+
2494
+ # verify the required parameter 'body' is set
2495
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_analytics_users_observations_query" if body.nil?
2496
+
2497
+
2498
+
2499
+
2500
+
2501
+ # resource path
2502
+ local_var_path = "/api/v2/analytics/users/observations/query".sub('{format}','json')
2503
+
2504
+ # query parameters
2505
+ query_params = {}
2506
+
2507
+ # header parameters
2508
+ header_params = {}
2509
+
2510
+ # HTTP header 'Accept' (if needed)
2511
+ local_header_accept = ['application/json']
2512
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2513
+
2514
+ # HTTP header 'Content-Type'
2515
+ local_header_content_type = ['application/json']
2516
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2517
+
2518
+ # form parameters
2519
+ form_params = {}
2520
+
2521
+ # http body (model)
2522
+ post_body = @api_client.object_to_http_body(body)
2523
+
2524
+ auth_names = ['PureCloud Auth']
2525
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2526
+ :header_params => header_params,
2527
+ :query_params => query_params,
2528
+ :form_params => form_params,
2529
+ :body => post_body,
2530
+ :auth_names => auth_names,
2531
+ :return_type => 'ObservationQueryResponse')
2532
+ if @api_client.config.debugging
2533
+ @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2534
+ end
2535
+ return data, status_code, headers
2536
+ end
2537
+
2538
+ # Send an activation email to the user
2539
+ #
2540
+ # @param user_id User ID
2541
+ # @param [Hash] opts the optional parameters
2542
+ # @option opts [BOOLEAN] :force Resend the invitation even if one is already outstanding (default to false)
2543
+ # @return [nil]
2544
+ def post_user_invite(user_id, opts = {})
2545
+ post_user_invite_with_http_info(user_id, opts)
2546
+ return nil
2547
+ end
2548
+
2549
+ # Send an activation email to the user
2550
+ #
2551
+ # @param user_id User ID
2552
+ # @param [Hash] opts the optional parameters
2553
+ # @option opts [BOOLEAN] :force Resend the invitation even if one is already outstanding
2554
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2555
+ def post_user_invite_with_http_info(user_id, opts = {})
2556
+ if @api_client.config.debugging
2557
+ @api_client.config.logger.debug "Calling API: UsersApi.post_user_invite ..."
2558
+ end
2559
+
2560
+
2561
+ # verify the required parameter 'user_id' is set
2562
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.post_user_invite" if user_id.nil?
2563
+
2564
+
2565
+
2566
+
2567
+
2568
+
2569
+
2570
+
2571
+
2572
+
2573
+
2574
+ # resource path
2575
+ local_var_path = "/api/v2/users/{userId}/invite".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2576
+
2577
+ # query parameters
2578
+ query_params = {}
2579
+ query_params[:'force'] = opts[:'force'] if opts[:'force']
2580
+
2581
+ # header parameters
2582
+ header_params = {}
2583
+
2584
+ # HTTP header 'Accept' (if needed)
2585
+ local_header_accept = ['application/json']
2586
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2587
+
2588
+ # HTTP header 'Content-Type'
2589
+ local_header_content_type = ['application/json']
2590
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2591
+
2592
+ # form parameters
2593
+ form_params = {}
2594
+
2595
+ # http body (model)
2596
+ post_body = nil
2597
+
2598
+ auth_names = ['PureCloud Auth']
2599
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2600
+ :header_params => header_params,
2601
+ :query_params => query_params,
2602
+ :form_params => form_params,
2603
+ :body => post_body,
2604
+ :auth_names => auth_names)
2605
+ if @api_client.config.debugging
2606
+ @api_client.config.logger.debug "API called: UsersApi#post_user_invite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2607
+ end
2608
+ return data, status_code, headers
2609
+ end
2610
+
2611
+ # Add routing skill to user
2612
+ #
2613
+ # @param user_id User ID
2614
+ # @param body Skill
2615
+ # @param [Hash] opts the optional parameters
2616
+ # @return [UserRoutingSkill]
2617
+ def post_user_routingskills(user_id, body, opts = {})
2618
+ data, _status_code, _headers = post_user_routingskills_with_http_info(user_id, body, opts)
2619
+ return data
2620
+ end
2621
+
2622
+ # Add routing skill to user
2623
+ #
2624
+ # @param user_id User ID
2625
+ # @param body Skill
2626
+ # @param [Hash] opts the optional parameters
2627
+ # @return [Array<(UserRoutingSkill, Fixnum, Hash)>] UserRoutingSkill data, response status code and response headers
2628
+ def post_user_routingskills_with_http_info(user_id, body, opts = {})
2629
+ if @api_client.config.debugging
2630
+ @api_client.config.logger.debug "Calling API: UsersApi.post_user_routingskills ..."
2631
+ end
2632
+
2633
+
2634
+ # verify the required parameter 'user_id' is set
2635
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.post_user_routingskills" if user_id.nil?
2636
+
2637
+
2638
+
2639
+
2640
+
2641
+
2642
+ # verify the required parameter 'body' is set
2643
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_user_routingskills" if body.nil?
2644
+
2645
+
2646
+
2647
+
2648
+
2649
+ # resource path
2650
+ local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2651
+
2652
+ # query parameters
2653
+ query_params = {}
2654
+
2655
+ # header parameters
2656
+ header_params = {}
2657
+
2658
+ # HTTP header 'Accept' (if needed)
2659
+ local_header_accept = ['application/json']
2660
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2661
+
2662
+ # HTTP header 'Content-Type'
2663
+ local_header_content_type = ['application/json']
2664
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2665
+
2666
+ # form parameters
2667
+ form_params = {}
2668
+
2669
+ # http body (model)
2670
+ post_body = @api_client.object_to_http_body(body)
2671
+
2672
+ auth_names = ['PureCloud Auth']
2673
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2674
+ :header_params => header_params,
2675
+ :query_params => query_params,
2676
+ :form_params => form_params,
2677
+ :body => post_body,
2678
+ :auth_names => auth_names,
2679
+ :return_type => 'UserRoutingSkill')
2680
+ if @api_client.config.debugging
2681
+ @api_client.config.logger.debug "API called: UsersApi#post_user_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2682
+ end
2683
+ return data, status_code, headers
2684
+ end
2685
+
2686
+ # Create user
2687
+ #
2688
+ # @param body User
2689
+ # @param [Hash] opts the optional parameters
2690
+ # @return [User]
2691
+ def post_users(body, opts = {})
2692
+ data, _status_code, _headers = post_users_with_http_info(body, opts)
2693
+ return data
2694
+ end
2695
+
2696
+ # Create user
2697
+ #
2698
+ # @param body User
2699
+ # @param [Hash] opts the optional parameters
2700
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
2701
+ def post_users_with_http_info(body, opts = {})
2702
+ if @api_client.config.debugging
2703
+ @api_client.config.logger.debug "Calling API: UsersApi.post_users ..."
2704
+ end
2705
+
2706
+
2707
+ # verify the required parameter 'body' is set
2708
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_users" if body.nil?
2709
+
2710
+
2711
+
2712
+
2713
+
2714
+ # resource path
2715
+ local_var_path = "/api/v2/users".sub('{format}','json')
2716
+
2717
+ # query parameters
2718
+ query_params = {}
2719
+
2720
+ # header parameters
2721
+ header_params = {}
2722
+
2723
+ # HTTP header 'Accept' (if needed)
2724
+ local_header_accept = ['application/json']
2725
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2726
+
2727
+ # HTTP header 'Content-Type'
2728
+ local_header_content_type = ['application/json']
2729
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2730
+
2731
+ # form parameters
2732
+ form_params = {}
2733
+
2734
+ # http body (model)
2735
+ post_body = @api_client.object_to_http_body(body)
2736
+
2737
+ auth_names = ['PureCloud Auth']
2738
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2739
+ :header_params => header_params,
2740
+ :query_params => query_params,
2741
+ :form_params => form_params,
2742
+ :body => post_body,
2743
+ :auth_names => auth_names,
2744
+ :return_type => 'User')
2745
+ if @api_client.config.debugging
2746
+ @api_client.config.logger.debug "API called: UsersApi#post_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2747
+ end
2748
+ return data, status_code, headers
2749
+ end
2750
+
2751
+ # Search users
2752
+ #
2753
+ # @param body Search request options
2754
+ # @param [Hash] opts the optional parameters
2755
+ # @return [UsersSearchResponse]
2756
+ def post_users_search(body, opts = {})
2757
+ data, _status_code, _headers = post_users_search_with_http_info(body, opts)
2758
+ return data
2759
+ end
2760
+
2761
+ # Search users
2762
+ #
2763
+ # @param body Search request options
2764
+ # @param [Hash] opts the optional parameters
2765
+ # @return [Array<(UsersSearchResponse, Fixnum, Hash)>] UsersSearchResponse data, response status code and response headers
2766
+ def post_users_search_with_http_info(body, opts = {})
2767
+ if @api_client.config.debugging
2768
+ @api_client.config.logger.debug "Calling API: UsersApi.post_users_search ..."
2769
+ end
2770
+
2771
+
2772
+ # verify the required parameter 'body' is set
2773
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.post_users_search" if body.nil?
2774
+
2775
+
2776
+
2777
+
2778
+
2779
+ # resource path
2780
+ local_var_path = "/api/v2/users/search".sub('{format}','json')
2781
+
2782
+ # query parameters
2783
+ query_params = {}
2784
+
2785
+ # header parameters
2786
+ header_params = {}
2787
+
2788
+ # HTTP header 'Accept' (if needed)
2789
+ local_header_accept = ['application/json']
2790
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2791
+
2792
+ # HTTP header 'Content-Type'
2793
+ local_header_content_type = ['application/json']
2794
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2795
+
2796
+ # form parameters
2797
+ form_params = {}
2798
+
2799
+ # http body (model)
2800
+ post_body = @api_client.object_to_http_body(body)
2801
+
2802
+ auth_names = ['PureCloud Auth']
2803
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2804
+ :header_params => header_params,
2805
+ :query_params => query_params,
2806
+ :form_params => form_params,
2807
+ :body => post_body,
2808
+ :auth_names => auth_names,
2809
+ :return_type => 'UsersSearchResponse')
2810
+ if @api_client.config.debugging
2811
+ @api_client.config.logger.debug "API called: UsersApi#post_users_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2812
+ end
2813
+ return data, status_code, headers
2814
+ end
2815
+
2816
+ # Update a user's CallForwarding
2817
+ #
2818
+ # @param user_id User ID
2819
+ # @param body Call forwarding
2820
+ # @param [Hash] opts the optional parameters
2821
+ # @return [CallForwarding]
2822
+ def put_user_callforwarding(user_id, body, opts = {})
2823
+ data, _status_code, _headers = put_user_callforwarding_with_http_info(user_id, body, opts)
2824
+ return data
2825
+ end
2826
+
2827
+ # Update a user&#39;s CallForwarding
2828
+ #
2829
+ # @param user_id User ID
2830
+ # @param body Call forwarding
2831
+ # @param [Hash] opts the optional parameters
2832
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
2833
+ def put_user_callforwarding_with_http_info(user_id, body, opts = {})
2834
+ if @api_client.config.debugging
2835
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_callforwarding ..."
2836
+ end
2837
+
2838
+
2839
+ # verify the required parameter 'user_id' is set
2840
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_callforwarding" if user_id.nil?
2841
+
2842
+
2843
+
2844
+
2845
+
2846
+
2847
+ # verify the required parameter 'body' is set
2848
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_callforwarding" if body.nil?
2849
+
2850
+
2851
+
2852
+
2853
+
2854
+ # resource path
2855
+ local_var_path = "/api/v2/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2856
+
2857
+ # query parameters
2858
+ query_params = {}
2859
+
2860
+ # header parameters
2861
+ header_params = {}
2862
+
2863
+ # HTTP header 'Accept' (if needed)
2864
+ local_header_accept = ['application/json']
2865
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2866
+
2867
+ # HTTP header 'Content-Type'
2868
+ local_header_content_type = ['application/json']
2869
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2870
+
2871
+ # form parameters
2872
+ form_params = {}
2873
+
2874
+ # http body (model)
2875
+ post_body = @api_client.object_to_http_body(body)
2876
+
2877
+ auth_names = ['PureCloud Auth']
2878
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2879
+ :header_params => header_params,
2880
+ :query_params => query_params,
2881
+ :form_params => form_params,
2882
+ :body => post_body,
2883
+ :auth_names => auth_names,
2884
+ :return_type => 'CallForwarding')
2885
+ if @api_client.config.debugging
2886
+ @api_client.config.logger.debug "API called: UsersApi#put_user_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2887
+ end
2888
+ return data, status_code, headers
2889
+ end
2890
+
2891
+ # Update an OutOfOffice
2892
+ #
2893
+ # @param user_id User ID
2894
+ # @param body The updated OutOffOffice
2895
+ # @param [Hash] opts the optional parameters
2896
+ # @return [OutOfOffice]
2897
+ def put_user_outofoffice(user_id, body, opts = {})
2898
+ data, _status_code, _headers = put_user_outofoffice_with_http_info(user_id, body, opts)
2899
+ return data
2900
+ end
2901
+
2902
+ # Update an OutOfOffice
2903
+ #
2904
+ # @param user_id User ID
2905
+ # @param body The updated OutOffOffice
2906
+ # @param [Hash] opts the optional parameters
2907
+ # @return [Array<(OutOfOffice, Fixnum, Hash)>] OutOfOffice data, response status code and response headers
2908
+ def put_user_outofoffice_with_http_info(user_id, body, opts = {})
2909
+ if @api_client.config.debugging
2910
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_outofoffice ..."
2911
+ end
2912
+
2913
+
2914
+ # verify the required parameter 'user_id' is set
2915
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_outofoffice" if user_id.nil?
2916
+
2917
+
2918
+
2919
+
2920
+
2921
+
2922
+ # verify the required parameter 'body' is set
2923
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_outofoffice" if body.nil?
2924
+
2925
+
2926
+
2927
+
2928
+
2929
+ # resource path
2930
+ local_var_path = "/api/v2/users/{userId}/outofoffice".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
2931
+
2932
+ # query parameters
2933
+ query_params = {}
2934
+
2935
+ # header parameters
2936
+ header_params = {}
2937
+
2938
+ # HTTP header 'Accept' (if needed)
2939
+ local_header_accept = ['application/json']
2940
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
2941
+
2942
+ # HTTP header 'Content-Type'
2943
+ local_header_content_type = ['application/json']
2944
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
2945
+
2946
+ # form parameters
2947
+ form_params = {}
2948
+
2949
+ # http body (model)
2950
+ post_body = @api_client.object_to_http_body(body)
2951
+
2952
+ auth_names = ['PureCloud Auth']
2953
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2954
+ :header_params => header_params,
2955
+ :query_params => query_params,
2956
+ :form_params => form_params,
2957
+ :body => post_body,
2958
+ :auth_names => auth_names,
2959
+ :return_type => 'OutOfOffice')
2960
+ if @api_client.config.debugging
2961
+ @api_client.config.logger.debug "API called: UsersApi#put_user_outofoffice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2962
+ end
2963
+ return data, status_code, headers
2964
+ end
2965
+
2966
+ # Update profile skills for a user
2967
+ #
2968
+ # @param user_id User ID
2969
+ # @param [Hash] opts the optional parameters
2970
+ # @option opts [Array<String>] :body Skills
2971
+ # @return [Array<String>]
2972
+ def put_user_profileskills(user_id, opts = {})
2973
+ data, _status_code, _headers = put_user_profileskills_with_http_info(user_id, opts)
2974
+ return data
2975
+ end
2976
+
2977
+ # Update profile skills for a user
2978
+ #
2979
+ # @param user_id User ID
2980
+ # @param [Hash] opts the optional parameters
2981
+ # @option opts [Array<String>] :body Skills
2982
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
2983
+ def put_user_profileskills_with_http_info(user_id, opts = {})
2984
+ if @api_client.config.debugging
2985
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_profileskills ..."
2986
+ end
2987
+
2988
+
2989
+ # verify the required parameter 'user_id' is set
2990
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_profileskills" if user_id.nil?
2991
+
2992
+
2993
+
2994
+
2995
+
2996
+
2997
+
2998
+
2999
+
3000
+
3001
+
3002
+ # resource path
3003
+ local_var_path = "/api/v2/users/{userId}/profileskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
3004
+
3005
+ # query parameters
3006
+ query_params = {}
3007
+
3008
+ # header parameters
3009
+ header_params = {}
3010
+
3011
+ # HTTP header 'Accept' (if needed)
3012
+ local_header_accept = ['application/json']
3013
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3014
+
3015
+ # HTTP header 'Content-Type'
3016
+ local_header_content_type = ['application/json']
3017
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3018
+
3019
+ # form parameters
3020
+ form_params = {}
3021
+
3022
+ # http body (model)
3023
+ post_body = @api_client.object_to_http_body(opts[:'body'])
3024
+
3025
+ auth_names = ['PureCloud Auth']
3026
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3027
+ :header_params => header_params,
3028
+ :query_params => query_params,
3029
+ :form_params => form_params,
3030
+ :body => post_body,
3031
+ :auth_names => auth_names,
3032
+ :return_type => 'Array<String>')
3033
+ if @api_client.config.debugging
3034
+ @api_client.config.logger.debug "API called: UsersApi#put_user_profileskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3035
+ end
3036
+ return data, status_code, headers
3037
+ end
3038
+
3039
+ # Sets the user's roles
3040
+ #
3041
+ # @param user_id User ID
3042
+ # @param body List of roles
3043
+ # @param [Hash] opts the optional parameters
3044
+ # @return [UserAuthorization]
3045
+ def put_user_roles(user_id, body, opts = {})
3046
+ data, _status_code, _headers = put_user_roles_with_http_info(user_id, body, opts)
3047
+ return data
3048
+ end
3049
+
3050
+ # Sets the user&#39;s roles
3051
+ #
3052
+ # @param user_id User ID
3053
+ # @param body List of roles
3054
+ # @param [Hash] opts the optional parameters
3055
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
3056
+ def put_user_roles_with_http_info(user_id, body, opts = {})
3057
+ if @api_client.config.debugging
3058
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_roles ..."
3059
+ end
3060
+
3061
+
3062
+ # verify the required parameter 'user_id' is set
3063
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_roles" if user_id.nil?
3064
+
3065
+
3066
+
3067
+
3068
+
3069
+
3070
+ # verify the required parameter 'body' is set
3071
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_roles" if body.nil?
3072
+
3073
+
3074
+
3075
+
3076
+
3077
+ # resource path
3078
+ local_var_path = "/api/v2/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
3079
+
3080
+ # query parameters
3081
+ query_params = {}
3082
+
3083
+ # header parameters
3084
+ header_params = {}
3085
+
3086
+ # HTTP header 'Accept' (if needed)
3087
+ local_header_accept = ['application/json']
3088
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3089
+
3090
+ # HTTP header 'Content-Type'
3091
+ local_header_content_type = ['application/json']
3092
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3093
+
3094
+ # form parameters
3095
+ form_params = {}
3096
+
3097
+ # http body (model)
3098
+ post_body = @api_client.object_to_http_body(body)
3099
+
3100
+ auth_names = ['PureCloud Auth']
3101
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3102
+ :header_params => header_params,
3103
+ :query_params => query_params,
3104
+ :form_params => form_params,
3105
+ :body => post_body,
3106
+ :auth_names => auth_names,
3107
+ :return_type => 'UserAuthorization')
3108
+ if @api_client.config.debugging
3109
+ @api_client.config.logger.debug "API called: UsersApi#put_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3110
+ end
3111
+ return data, status_code, headers
3112
+ end
3113
+
3114
+ # Update routing skill proficiency or state.
3115
+ #
3116
+ # @param user_id User ID
3117
+ # @param skill_id skillId
3118
+ # @param body Skill
3119
+ # @param [Hash] opts the optional parameters
3120
+ # @return [UserRoutingSkill]
3121
+ def put_user_routingskill(user_id, skill_id, body, opts = {})
3122
+ data, _status_code, _headers = put_user_routingskill_with_http_info(user_id, skill_id, body, opts)
3123
+ return data
3124
+ end
3125
+
3126
+ # Update routing skill proficiency or state.
3127
+ #
3128
+ # @param user_id User ID
3129
+ # @param skill_id skillId
3130
+ # @param body Skill
3131
+ # @param [Hash] opts the optional parameters
3132
+ # @return [Array<(UserRoutingSkill, Fixnum, Hash)>] UserRoutingSkill data, response status code and response headers
3133
+ def put_user_routingskill_with_http_info(user_id, skill_id, body, opts = {})
3134
+ if @api_client.config.debugging
3135
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_routingskill ..."
3136
+ end
3137
+
3138
+
3139
+ # verify the required parameter 'user_id' is set
3140
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_routingskill" if user_id.nil?
3141
+
3142
+
3143
+
3144
+
3145
+
3146
+
3147
+ # verify the required parameter 'skill_id' is set
3148
+ fail ArgumentError, "Missing the required parameter 'skill_id' when calling UsersApi.put_user_routingskill" if skill_id.nil?
3149
+
3150
+
3151
+
3152
+
3153
+
3154
+
3155
+ # verify the required parameter 'body' is set
3156
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_routingskill" if body.nil?
3157
+
3158
+
3159
+
3160
+
3161
+
3162
+ # resource path
3163
+ local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s)
3164
+
3165
+ # query parameters
3166
+ query_params = {}
3167
+
3168
+ # header parameters
3169
+ header_params = {}
3170
+
3171
+ # HTTP header 'Accept' (if needed)
3172
+ local_header_accept = ['application/json']
3173
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3174
+
3175
+ # HTTP header 'Content-Type'
3176
+ local_header_content_type = ['application/json']
3177
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3178
+
3179
+ # form parameters
3180
+ form_params = {}
3181
+
3182
+ # http body (model)
3183
+ post_body = @api_client.object_to_http_body(body)
3184
+
3185
+ auth_names = ['PureCloud Auth']
3186
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3187
+ :header_params => header_params,
3188
+ :query_params => query_params,
3189
+ :form_params => form_params,
3190
+ :body => post_body,
3191
+ :auth_names => auth_names,
3192
+ :return_type => 'UserRoutingSkill')
3193
+ if @api_client.config.debugging
3194
+ @api_client.config.logger.debug "API called: UsersApi#put_user_routingskill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3195
+ end
3196
+ return data, status_code, headers
3197
+ end
3198
+
3199
+ # Update the routing status of a user
3200
+ #
3201
+ # @param user_id User ID
3202
+ # @param body Routing Status
3203
+ # @param [Hash] opts the optional parameters
3204
+ # @return [RoutingStatus]
3205
+ def put_user_routingstatus(user_id, body, opts = {})
3206
+ data, _status_code, _headers = put_user_routingstatus_with_http_info(user_id, body, opts)
3207
+ return data
3208
+ end
3209
+
3210
+ # Update the routing status of a user
3211
+ #
3212
+ # @param user_id User ID
3213
+ # @param body Routing Status
3214
+ # @param [Hash] opts the optional parameters
3215
+ # @return [Array<(RoutingStatus, Fixnum, Hash)>] RoutingStatus data, response status code and response headers
3216
+ def put_user_routingstatus_with_http_info(user_id, body, opts = {})
3217
+ if @api_client.config.debugging
3218
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_routingstatus ..."
3219
+ end
3220
+
3221
+
3222
+ # verify the required parameter 'user_id' is set
3223
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_routingstatus" if user_id.nil?
3224
+
3225
+
3226
+
3227
+
3228
+
3229
+
3230
+ # verify the required parameter 'body' is set
3231
+ fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_routingstatus" if body.nil?
3232
+
3233
+
3234
+
3235
+
3236
+
3237
+ # resource path
3238
+ local_var_path = "/api/v2/users/{userId}/routingstatus".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
3239
+
3240
+ # query parameters
3241
+ query_params = {}
3242
+
3243
+ # header parameters
3244
+ header_params = {}
3245
+
3246
+ # HTTP header 'Accept' (if needed)
3247
+ local_header_accept = ['application/json']
3248
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3249
+
3250
+ # HTTP header 'Content-Type'
3251
+ local_header_content_type = ['application/json']
3252
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3253
+
3254
+ # form parameters
3255
+ form_params = {}
3256
+
3257
+ # http body (model)
3258
+ post_body = @api_client.object_to_http_body(body)
3259
+
3260
+ auth_names = ['PureCloud Auth']
3261
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3262
+ :header_params => header_params,
3263
+ :query_params => query_params,
3264
+ :form_params => form_params,
3265
+ :body => post_body,
3266
+ :auth_names => auth_names,
3267
+ :return_type => 'RoutingStatus')
3268
+ if @api_client.config.debugging
3269
+ @api_client.config.logger.debug "API called: UsersApi#put_user_routingstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3270
+ end
3271
+ return data, status_code, headers
3272
+ end
3273
+
3274
+ # Set associated station
3275
+ #
3276
+ # @param user_id User ID
3277
+ # @param station_id stationId
3278
+ # @param [Hash] opts the optional parameters
3279
+ # @return [nil]
3280
+ def put_user_station_associatedstation_station_id(user_id, station_id, opts = {})
3281
+ put_user_station_associatedstation_station_id_with_http_info(user_id, station_id, opts)
3282
+ return nil
3283
+ end
3284
+
3285
+ # Set associated station
3286
+ #
3287
+ # @param user_id User ID
3288
+ # @param station_id stationId
3289
+ # @param [Hash] opts the optional parameters
3290
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3291
+ def put_user_station_associatedstation_station_id_with_http_info(user_id, station_id, opts = {})
3292
+ if @api_client.config.debugging
3293
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_station_associatedstation_station_id ..."
3294
+ end
3295
+
3296
+
3297
+ # verify the required parameter 'user_id' is set
3298
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_station_associatedstation_station_id" if user_id.nil?
3299
+
3300
+
3301
+
3302
+
3303
+
3304
+
3305
+ # verify the required parameter 'station_id' is set
3306
+ fail ArgumentError, "Missing the required parameter 'station_id' when calling UsersApi.put_user_station_associatedstation_station_id" if station_id.nil?
3307
+
3308
+
3309
+
3310
+
3311
+
3312
+ # resource path
3313
+ local_var_path = "/api/v2/users/{userId}/station/associatedstation/{stationId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'stationId' + '}', station_id.to_s)
3314
+
3315
+ # query parameters
3316
+ query_params = {}
3317
+
3318
+ # header parameters
3319
+ header_params = {}
3320
+
3321
+ # HTTP header 'Accept' (if needed)
3322
+ local_header_accept = ['application/json']
3323
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3324
+
3325
+ # HTTP header 'Content-Type'
3326
+ local_header_content_type = ['application/json']
3327
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3328
+
3329
+ # form parameters
3330
+ form_params = {}
3331
+
3332
+ # http body (model)
3333
+ post_body = nil
3334
+
3335
+ auth_names = ['PureCloud Auth']
3336
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3337
+ :header_params => header_params,
3338
+ :query_params => query_params,
3339
+ :form_params => form_params,
3340
+ :body => post_body,
3341
+ :auth_names => auth_names)
3342
+ if @api_client.config.debugging
3343
+ @api_client.config.logger.debug "API called: UsersApi#put_user_station_associatedstation_station_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3344
+ end
3345
+ return data, status_code, headers
3346
+ end
3347
+
3348
+ # Set default station
3349
+ #
3350
+ # @param user_id User ID
3351
+ # @param station_id stationId
3352
+ # @param [Hash] opts the optional parameters
3353
+ # @return [nil]
3354
+ def put_user_station_defaultstation_station_id(user_id, station_id, opts = {})
3355
+ put_user_station_defaultstation_station_id_with_http_info(user_id, station_id, opts)
3356
+ return nil
3357
+ end
3358
+
3359
+ # Set default station
3360
+ #
3361
+ # @param user_id User ID
3362
+ # @param station_id stationId
3363
+ # @param [Hash] opts the optional parameters
3364
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
3365
+ def put_user_station_defaultstation_station_id_with_http_info(user_id, station_id, opts = {})
3366
+ if @api_client.config.debugging
3367
+ @api_client.config.logger.debug "Calling API: UsersApi.put_user_station_defaultstation_station_id ..."
3368
+ end
3369
+
3370
+
3371
+ # verify the required parameter 'user_id' is set
3372
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.put_user_station_defaultstation_station_id" if user_id.nil?
3373
+
3374
+
3375
+
3376
+
3377
+
3378
+
3379
+ # verify the required parameter 'station_id' is set
3380
+ fail ArgumentError, "Missing the required parameter 'station_id' when calling UsersApi.put_user_station_defaultstation_station_id" if station_id.nil?
3381
+
3382
+
3383
+
3384
+
3385
+
3386
+ # resource path
3387
+ local_var_path = "/api/v2/users/{userId}/station/defaultstation/{stationId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'stationId' + '}', station_id.to_s)
3388
+
3389
+ # query parameters
3390
+ query_params = {}
3391
+
3392
+ # header parameters
3393
+ header_params = {}
3394
+
3395
+ # HTTP header 'Accept' (if needed)
3396
+ local_header_accept = ['application/json']
3397
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3398
+
3399
+ # HTTP header 'Content-Type'
3400
+ local_header_content_type = ['application/json']
3401
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3402
+
3403
+ # form parameters
3404
+ form_params = {}
3405
+
3406
+ # http body (model)
3407
+ post_body = nil
3408
+
3409
+ auth_names = ['PureCloud Auth']
3410
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
3411
+ :header_params => header_params,
3412
+ :query_params => query_params,
3413
+ :form_params => form_params,
3414
+ :body => post_body,
3415
+ :auth_names => auth_names)
3416
+ if @api_client.config.debugging
3417
+ @api_client.config.logger.debug "API called: UsersApi#put_user_station_defaultstation_station_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3418
+ end
3419
+ return data, status_code, headers
3420
+ end
3421
+ end
3422
+ end