purecloud 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (667) hide show
  1. checksums.yaml +7 -0
  2. data/CONTRIBUTING.md +0 -0
  3. data/Gemfile +7 -0
  4. data/Gemfile.lock +39 -0
  5. data/LICENSE +22 -0
  6. data/PureCloud.gemspec +32 -0
  7. data/README.md +64 -0
  8. data/config-ruby.json +1 -0
  9. data/doc/template/default/layout/html/layout.erb +4 -0
  10. data/doc/template/default/method_details/html/source.erb +0 -0
  11. data/doc/template/default/module/html/attribute_summary.erb +8 -0
  12. data/doc/template/default/module/html/box_info.erb +0 -0
  13. data/doc/template/default/module/html/children.erb +0 -0
  14. data/extensions/auth.rb +40 -0
  15. data/external/swagger-codegen-cli.jar +0 -0
  16. data/lib/purecloud.rb +707 -0
  17. data/lib/purecloud/api/analytics_api.rb +1554 -0
  18. data/lib/purecloud/api/architect_api.rb +232 -0
  19. data/lib/purecloud/api/attributes_api.rb +377 -0
  20. data/lib/purecloud/api/authorization_api.rb +1135 -0
  21. data/lib/purecloud/api/compliance_api.rb +129 -0
  22. data/lib/purecloud/api/configuration_api.rb +5049 -0
  23. data/lib/purecloud/api/content_management_api.rb +2457 -0
  24. data/lib/purecloud/api/conversations_api.rb +1699 -0
  25. data/lib/purecloud/api/downloads_api.rb +140 -0
  26. data/lib/purecloud/api/fax_api.rb +378 -0
  27. data/lib/purecloud/api/geolocation_api.rb +263 -0
  28. data/lib/purecloud/api/greetings_api.rb +771 -0
  29. data/lib/purecloud/api/groups_api.rb +208 -0
  30. data/lib/purecloud/api/languages_api.rb +138 -0
  31. data/lib/purecloud/api/licensing_api.rb +428 -0
  32. data/lib/purecloud/api/locations_api.rb +148 -0
  33. data/lib/purecloud/api/notifications_api.rb +431 -0
  34. data/lib/purecloud/api/o_auth_api.rb +1269 -0
  35. data/lib/purecloud/api/orphaned_recordings_api.rb +205 -0
  36. data/lib/purecloud/api/outbound_api.rb +4262 -0
  37. data/lib/purecloud/api/presence_api.rb +662 -0
  38. data/lib/purecloud/api/quality_api.rb +1663 -0
  39. data/lib/purecloud/api/routing_api.rb +2133 -0
  40. data/lib/purecloud/api/scripts_api.rb +712 -0
  41. data/lib/purecloud/api/search_api.rb +73 -0
  42. data/lib/purecloud/api/stations_api.rb +205 -0
  43. data/lib/purecloud/api/telephony_providers_edge_api.rb +2407 -0
  44. data/lib/purecloud/api/tokens_api.rb +71 -0
  45. data/lib/purecloud/api/user_recordings_api.rb +394 -0
  46. data/lib/purecloud/api/users_api.rb +1361 -0
  47. data/lib/purecloud/api/utilities_api.rb +249 -0
  48. data/lib/purecloud/api/voicemail_api.rb +677 -0
  49. data/lib/purecloud/api_client.rb +304 -0
  50. data/lib/purecloud/api_error.rb +24 -0
  51. data/lib/purecloud/configuration.rb +170 -0
  52. data/lib/purecloud/models/account.rb +450 -0
  53. data/lib/purecloud/models/account_manager.rb +176 -0
  54. data/lib/purecloud/models/account_overview.rb +224 -0
  55. data/lib/purecloud/models/account_status.rb +230 -0
  56. data/lib/purecloud/models/action.rb +178 -0
  57. data/lib/purecloud/models/actions.rb +148 -0
  58. data/lib/purecloud/models/acw_settings.rb +165 -0
  59. data/lib/purecloud/models/address.rb +218 -0
  60. data/lib/purecloud/models/address_listing.rb +238 -0
  61. data/lib/purecloud/models/agent.rb +146 -0
  62. data/lib/purecloud/models/agent_activity.rb +210 -0
  63. data/lib/purecloud/models/agent_activity_entity_listing.rb +238 -0
  64. data/lib/purecloud/models/agent_evaluator_activity.rb +208 -0
  65. data/lib/purecloud/models/alert.rb +312 -0
  66. data/lib/purecloud/models/alert_entity_listing.rb +238 -0
  67. data/lib/purecloud/models/annotation.rb +218 -0
  68. data/lib/purecloud/models/app.rb +156 -0
  69. data/lib/purecloud/models/archive_retention.rb +165 -0
  70. data/lib/purecloud/models/associated_document.rb +168 -0
  71. data/lib/purecloud/models/attachment.rb +186 -0
  72. data/lib/purecloud/models/attribute.rb +230 -0
  73. data/lib/purecloud/models/attribute_entity_listing.rb +238 -0
  74. data/lib/purecloud/models/attribute_query_request.rb +170 -0
  75. data/lib/purecloud/models/attribute_value.rb +250 -0
  76. data/lib/purecloud/models/audit_change.rb +180 -0
  77. data/lib/purecloud/models/audit_entity_reference.rb +195 -0
  78. data/lib/purecloud/models/audit_message.rb +300 -0
  79. data/lib/purecloud/models/audit_search_result.rb +200 -0
  80. data/lib/purecloud/models/automate_queue.rb +214 -0
  81. data/lib/purecloud/models/automate_queue_member.rb +178 -0
  82. data/lib/purecloud/models/available_additional_service.rb +214 -0
  83. data/lib/purecloud/models/available_additional_service_listing.rb +238 -0
  84. data/lib/purecloud/models/available_topic.rb +147 -0
  85. data/lib/purecloud/models/backend_flow_available_actions.rb +148 -0
  86. data/lib/purecloud/models/backend_work_item_data_element.rb +176 -0
  87. data/lib/purecloud/models/basic_transform.rb +160 -0
  88. data/lib/purecloud/models/batch_command.rb +158 -0
  89. data/lib/purecloud/models/batch_item.rb +166 -0
  90. data/lib/purecloud/models/batch_item_body.rb +146 -0
  91. data/lib/purecloud/models/batch_reply.rb +148 -0
  92. data/lib/purecloud/models/batch_reply_item.rb +166 -0
  93. data/lib/purecloud/models/billing_period.rb +190 -0
  94. data/lib/purecloud/models/body.rb +136 -0
  95. data/lib/purecloud/models/body_1.rb +136 -0
  96. data/lib/purecloud/models/body_2.rb +136 -0
  97. data/lib/purecloud/models/bullseye.rb +148 -0
  98. data/lib/purecloud/models/byte_buffer.rb +220 -0
  99. data/lib/purecloud/models/calibration.rb +303 -0
  100. data/lib/purecloud/models/calibration_assignment.rb +178 -0
  101. data/lib/purecloud/models/calibration_entity_listing.rb +238 -0
  102. data/lib/purecloud/models/call.rb +323 -0
  103. data/lib/purecloud/models/call_forwarding.rb +211 -0
  104. data/lib/purecloud/models/call_record.rb +157 -0
  105. data/lib/purecloud/models/callable_contacts_diagnostic.rb +170 -0
  106. data/lib/purecloud/models/callable_time.rb +158 -0
  107. data/lib/purecloud/models/callable_time_set.rb +212 -0
  108. data/lib/purecloud/models/callable_time_set_entity_listing.rb +238 -0
  109. data/lib/purecloud/models/callback.rb +302 -0
  110. data/lib/purecloud/models/campaign.rb +200 -0
  111. data/lib/purecloud/models/campaign_diagnostics.rb +166 -0
  112. data/lib/purecloud/models/campaign_entity_listing.rb +238 -0
  113. data/lib/purecloud/models/campaign_schedule.rb +232 -0
  114. data/lib/purecloud/models/campaign_schedule_intervals.rb +158 -0
  115. data/lib/purecloud/models/campaign_sequence.rb +263 -0
  116. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +238 -0
  117. data/lib/purecloud/models/campaign_stats.rb +176 -0
  118. data/lib/purecloud/models/carrier.rb +220 -0
  119. data/lib/purecloud/models/carrier_address.rb +186 -0
  120. data/lib/purecloud/models/carrier_entity_listing.rb +238 -0
  121. data/lib/purecloud/models/certificate.rb +148 -0
  122. data/lib/purecloud/models/certificate_authority_entity_listing.rb +238 -0
  123. data/lib/purecloud/models/certificate_details.rb +218 -0
  124. data/lib/purecloud/models/change.rb +180 -0
  125. data/lib/purecloud/models/channel.rb +157 -0
  126. data/lib/purecloud/models/channel_entity_listing.rb +238 -0
  127. data/lib/purecloud/models/channel_topic.rb +158 -0
  128. data/lib/purecloud/models/charge.rb +206 -0
  129. data/lib/purecloud/models/chat.rb +146 -0
  130. data/lib/purecloud/models/chat_message.rb +226 -0
  131. data/lib/purecloud/models/chat_message_user.rb +188 -0
  132. data/lib/purecloud/models/chat_participant.rb +155 -0
  133. data/lib/purecloud/models/chat_search_item.rb +208 -0
  134. data/lib/purecloud/models/chat_search_listing.rb +238 -0
  135. data/lib/purecloud/models/chat_search_request.rb +244 -0
  136. data/lib/purecloud/models/client_spreadsheet_transform.rb +214 -0
  137. data/lib/purecloud/models/client_transform_model.rb +190 -0
  138. data/lib/purecloud/models/column_collapse.rb +158 -0
  139. data/lib/purecloud/models/command_status.rb +237 -0
  140. data/lib/purecloud/models/command_status_entity_listing.rb +238 -0
  141. data/lib/purecloud/models/common_audit_request.rb +214 -0
  142. data/lib/purecloud/models/condition.rb +228 -0
  143. data/lib/purecloud/models/connect_rate.rb +166 -0
  144. data/lib/purecloud/models/consult_transfer.rb +167 -0
  145. data/lib/purecloud/models/consult_transfer_response.rb +147 -0
  146. data/lib/purecloud/models/consult_transfer_update.rb +156 -0
  147. data/lib/purecloud/models/consumed_resources_entity_listing.rb +238 -0
  148. data/lib/purecloud/models/consuming_resources_entity_listing.rb +238 -0
  149. data/lib/purecloud/models/contact.rb +226 -0
  150. data/lib/purecloud/models/contact_callback_request.rb +186 -0
  151. data/lib/purecloud/models/contact_list.rb +266 -0
  152. data/lib/purecloud/models/contact_list_entity_listing.rb +238 -0
  153. data/lib/purecloud/models/contact_sales.rb +288 -0
  154. data/lib/purecloud/models/contact_sales_response.rb +178 -0
  155. data/lib/purecloud/models/content_facet_filter_item.rb +196 -0
  156. data/lib/purecloud/models/content_query_request.rb +202 -0
  157. data/lib/purecloud/models/content_sort_item.rb +158 -0
  158. data/lib/purecloud/models/contract.rb +198 -0
  159. data/lib/purecloud/models/contract_job.rb +198 -0
  160. data/lib/purecloud/models/conversation.rb +258 -0
  161. data/lib/purecloud/models/conversation_entity_listing.rb +238 -0
  162. data/lib/purecloud/models/conversation_historical_query_request_body.rb +185 -0
  163. data/lib/purecloud/models/conversation_historical_query_request_filter.rb +181 -0
  164. data/lib/purecloud/models/conversation_query_response.rb +366 -0
  165. data/lib/purecloud/models/conversation_response.rb +168 -0
  166. data/lib/purecloud/models/cover_sheet.rb +158 -0
  167. data/lib/purecloud/models/create_share_request.rb +206 -0
  168. data/lib/purecloud/models/create_share_request_member.rb +165 -0
  169. data/lib/purecloud/models/create_share_response.rb +270 -0
  170. data/lib/purecloud/models/create_template_from_script_request_data.rb +188 -0
  171. data/lib/purecloud/models/csv_schema.rb +224 -0
  172. data/lib/purecloud/models/customer_account.rb +238 -0
  173. data/lib/purecloud/models/data_item.rb +166 -0
  174. data/lib/purecloud/models/data_value_info.rb +148 -0
  175. data/lib/purecloud/models/default_greeting_list.rb +251 -0
  176. data/lib/purecloud/models/delete_retention.rb +146 -0
  177. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +238 -0
  178. data/lib/purecloud/models/delta_document.rb +216 -0
  179. data/lib/purecloud/models/delta_request.rb +146 -0
  180. data/lib/purecloud/models/delta_response.rb +170 -0
  181. data/lib/purecloud/models/dependency.rb +209 -0
  182. data/lib/purecloud/models/dependency_object.rb +233 -0
  183. data/lib/purecloud/models/dependency_object_entity_listing.rb +238 -0
  184. data/lib/purecloud/models/dependency_status.rb +241 -0
  185. data/lib/purecloud/models/dependency_type.rb +180 -0
  186. data/lib/purecloud/models/dependency_type_entity_listing.rb +238 -0
  187. data/lib/purecloud/models/destination.rb +197 -0
  188. data/lib/purecloud/models/detail.rb +176 -0
  189. data/lib/purecloud/models/diagnostic_email.rb +225 -0
  190. data/lib/purecloud/models/dialer_audit_request.rb +182 -0
  191. data/lib/purecloud/models/dialer_call.rb +156 -0
  192. data/lib/purecloud/models/dialer_disposition_call_command.rb +166 -0
  193. data/lib/purecloud/models/dialer_place_call_command.rb +156 -0
  194. data/lib/purecloud/models/dialer_preview.rb +188 -0
  195. data/lib/purecloud/models/did.rb +319 -0
  196. data/lib/purecloud/models/did_entity_listing.rb +238 -0
  197. data/lib/purecloud/models/did_pool.rb +321 -0
  198. data/lib/purecloud/models/did_pool_entity_listing.rb +238 -0
  199. data/lib/purecloud/models/digit_length.rb +156 -0
  200. data/lib/purecloud/models/dnc_list.rb +242 -0
  201. data/lib/purecloud/models/dnc_list_entity_listing.rb +238 -0
  202. data/lib/purecloud/models/dns.rb +166 -0
  203. data/lib/purecloud/models/document.rb +479 -0
  204. data/lib/purecloud/models/document_audit.rb +339 -0
  205. data/lib/purecloud/models/document_audit_entity_listing.rb +238 -0
  206. data/lib/purecloud/models/document_entity_listing.rb +238 -0
  207. data/lib/purecloud/models/document_thumbnail.rb +156 -0
  208. data/lib/purecloud/models/document_update.rb +228 -0
  209. data/lib/purecloud/models/document_upload.rb +192 -0
  210. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +238 -0
  211. data/lib/purecloud/models/domain_capabilities.rb +170 -0
  212. data/lib/purecloud/models/domain_certificate_authority.rb +327 -0
  213. data/lib/purecloud/models/domain_edge_software_update_dto.rb +242 -0
  214. data/lib/purecloud/models/domain_edge_software_version_dto.rb +223 -0
  215. data/lib/purecloud/models/domain_entity.rb +168 -0
  216. data/lib/purecloud/models/domain_entity_listing.rb +238 -0
  217. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +238 -0
  218. data/lib/purecloud/models/domain_entity_listing_query_result.rb +238 -0
  219. data/lib/purecloud/models/domain_invoice_entity_listing.rb +238 -0
  220. data/lib/purecloud/models/domain_license.rb +200 -0
  221. data/lib/purecloud/models/domain_license_entity_listing.rb +238 -0
  222. data/lib/purecloud/models/domain_logical_interface.rb +526 -0
  223. data/lib/purecloud/models/domain_network_address.rb +178 -0
  224. data/lib/purecloud/models/domain_network_command_response.rb +178 -0
  225. data/lib/purecloud/models/domain_network_route.rb +188 -0
  226. data/lib/purecloud/models/domain_org_role_difference.rb +192 -0
  227. data/lib/purecloud/models/domain_organization_product.rb +146 -0
  228. data/lib/purecloud/models/domain_organization_role.rb +268 -0
  229. data/lib/purecloud/models/domain_permission.rb +200 -0
  230. data/lib/purecloud/models/domain_permission_collection.rb +190 -0
  231. data/lib/purecloud/models/domain_permission_policy.rb +222 -0
  232. data/lib/purecloud/models/domain_physical_capabilities.rb +160 -0
  233. data/lib/purecloud/models/domain_physical_interface.rb +218 -0
  234. data/lib/purecloud/models/domain_resource_condition_node.rb +208 -0
  235. data/lib/purecloud/models/domain_resource_condition_value.rb +185 -0
  236. data/lib/purecloud/models/domain_schema_reference.rb +168 -0
  237. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +238 -0
  238. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +238 -0
  239. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +238 -0
  240. data/lib/purecloud/models/download_response.rb +156 -0
  241. data/lib/purecloud/models/duration_condition.rb +175 -0
  242. data/lib/purecloud/models/edge.rb +523 -0
  243. data/lib/purecloud/models/edge_auto_update_config.rb +178 -0
  244. data/lib/purecloud/models/edge_entity_listing.rb +238 -0
  245. data/lib/purecloud/models/edge_group.rb +306 -0
  246. data/lib/purecloud/models/edge_group_entity_listing.rb +238 -0
  247. data/lib/purecloud/models/edge_interface.rb +220 -0
  248. data/lib/purecloud/models/edge_line.rb +259 -0
  249. data/lib/purecloud/models/edge_line_entity_listing.rb +238 -0
  250. data/lib/purecloud/models/edge_version_information.rb +146 -0
  251. data/lib/purecloud/models/edge_version_report.rb +156 -0
  252. data/lib/purecloud/models/email.rb +278 -0
  253. data/lib/purecloud/models/email_address.rb +156 -0
  254. data/lib/purecloud/models/email_attachment.rb +186 -0
  255. data/lib/purecloud/models/email_message.rb +245 -0
  256. data/lib/purecloud/models/email_message_listing.rb +238 -0
  257. data/lib/purecloud/models/email_setup.rb +147 -0
  258. data/lib/purecloud/models/embedded_signature_view.rb +146 -0
  259. data/lib/purecloud/models/encryption_key.rb +198 -0
  260. data/lib/purecloud/models/encryption_key_entity_listing.rb +238 -0
  261. data/lib/purecloud/models/endpoint.rb +335 -0
  262. data/lib/purecloud/models/endpoint_entity_listing.rb +238 -0
  263. data/lib/purecloud/models/entity.rb +166 -0
  264. data/lib/purecloud/models/entry.rb +156 -0
  265. data/lib/purecloud/models/error_body.rb +242 -0
  266. data/lib/purecloud/models/error_details.rb +218 -0
  267. data/lib/purecloud/models/evaluation.rb +358 -0
  268. data/lib/purecloud/models/evaluation_assignment.rb +156 -0
  269. data/lib/purecloud/models/evaluation_entity_listing.rb +238 -0
  270. data/lib/purecloud/models/evaluation_form.rb +233 -0
  271. data/lib/purecloud/models/evaluation_form_and_scoring_set.rb +156 -0
  272. data/lib/purecloud/models/evaluation_form_entity_listing.rb +238 -0
  273. data/lib/purecloud/models/evaluation_query_request.rb +263 -0
  274. data/lib/purecloud/models/evaluation_scoring_set.rb +200 -0
  275. data/lib/purecloud/models/evaluator_activity.rb +238 -0
  276. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +238 -0
  277. data/lib/purecloud/models/expansion_criterium.rb +165 -0
  278. data/lib/purecloud/models/expression_response.rb +256 -0
  279. data/lib/purecloud/models/extension.rb +319 -0
  280. data/lib/purecloud/models/extension_entity_listing.rb +238 -0
  281. data/lib/purecloud/models/extension_pool.rb +291 -0
  282. data/lib/purecloud/models/extension_pool_entity_listing.rb +238 -0
  283. data/lib/purecloud/models/facet.rb +156 -0
  284. data/lib/purecloud/models/facet_entry.rb +227 -0
  285. data/lib/purecloud/models/facet_filter_item.rb +196 -0
  286. data/lib/purecloud/models/facet_group.rb +168 -0
  287. data/lib/purecloud/models/facet_info.rb +158 -0
  288. data/lib/purecloud/models/facet_item.rb +166 -0
  289. data/lib/purecloud/models/facet_key_attribute.rb +166 -0
  290. data/lib/purecloud/models/facet_request.rb +232 -0
  291. data/lib/purecloud/models/facet_result.rb +211 -0
  292. data/lib/purecloud/models/facet_result_item.rb +208 -0
  293. data/lib/purecloud/models/facet_statistics.rb +208 -0
  294. data/lib/purecloud/models/facet_term.rb +197 -0
  295. data/lib/purecloud/models/facets.rb +158 -0
  296. data/lib/purecloud/models/failed_object.rb +176 -0
  297. data/lib/purecloud/models/favorite_template_request_data.rb +146 -0
  298. data/lib/purecloud/models/fax_document.rb +324 -0
  299. data/lib/purecloud/models/fax_document_entity_listing.rb +238 -0
  300. data/lib/purecloud/models/fax_send_request.rb +220 -0
  301. data/lib/purecloud/models/fax_send_response.rb +197 -0
  302. data/lib/purecloud/models/fax_summary.rb +166 -0
  303. data/lib/purecloud/models/filter.rb +178 -0
  304. data/lib/purecloud/models/filter_item.rb +208 -0
  305. data/lib/purecloud/models/flow.rb +273 -0
  306. data/lib/purecloud/models/flow_activate_request.rb +150 -0
  307. data/lib/purecloud/models/flow_associate_workspaces_request.rb +150 -0
  308. data/lib/purecloud/models/flow_body.rb +160 -0
  309. data/lib/purecloud/models/flow_body_format.rb +166 -0
  310. data/lib/purecloud/models/flow_config_id.rb +180 -0
  311. data/lib/purecloud/models/flow_config_meta_data.rb +279 -0
  312. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +238 -0
  313. data/lib/purecloud/models/flow_details.rb +288 -0
  314. data/lib/purecloud/models/flow_details_search_result.rb +161 -0
  315. data/lib/purecloud/models/flow_entity_listing.rb +238 -0
  316. data/lib/purecloud/models/flow_exec_id.rb +169 -0
  317. data/lib/purecloud/models/flow_history_item.rb +238 -0
  318. data/lib/purecloud/models/flow_history_result_item.rb +172 -0
  319. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +238 -0
  320. data/lib/purecloud/models/flow_input_data.rb +150 -0
  321. data/lib/purecloud/models/flow_launch_request.rb +190 -0
  322. data/lib/purecloud/models/flow_lock_request.rb +150 -0
  323. data/lib/purecloud/models/flow_publish.rb +191 -0
  324. data/lib/purecloud/models/flow_report_result_item.rb +280 -0
  325. data/lib/purecloud/models/flow_state.rb +170 -0
  326. data/lib/purecloud/models/flow_terminate_request.rb +161 -0
  327. data/lib/purecloud/models/flow_upload_response.rb +159 -0
  328. data/lib/purecloud/models/flow_version.rb +257 -0
  329. data/lib/purecloud/models/flow_version_config_meta_data.rb +224 -0
  330. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +238 -0
  331. data/lib/purecloud/models/flow_version_entity_listing.rb +238 -0
  332. data/lib/purecloud/models/gateway.rb +166 -0
  333. data/lib/purecloud/models/geolocation.rb +242 -0
  334. data/lib/purecloud/models/geolocation_settings.rb +180 -0
  335. data/lib/purecloud/models/gistener.rb +282 -0
  336. data/lib/purecloud/models/greeting.rb +278 -0
  337. data/lib/purecloud/models/greeting_audio_file.rb +166 -0
  338. data/lib/purecloud/models/greeting_media_info.rb +167 -0
  339. data/lib/purecloud/models/greeting_owner.rb +168 -0
  340. data/lib/purecloud/models/group.rb +236 -0
  341. data/lib/purecloud/models/group_entity_listing.rb +238 -0
  342. data/lib/purecloud/models/group_images.rb +148 -0
  343. data/lib/purecloud/models/group_tag.rb +223 -0
  344. data/lib/purecloud/models/hardware_rate.rb +198 -0
  345. data/lib/purecloud/models/hardware_rate_listing.rb +238 -0
  346. data/lib/purecloud/models/hipaa_config.rb +180 -0
  347. data/lib/purecloud/models/import_status.rb +195 -0
  348. data/lib/purecloud/models/inbound_domain.rb +200 -0
  349. data/lib/purecloud/models/inbound_domain_entity_listing.rb +238 -0
  350. data/lib/purecloud/models/inbound_route.rb +247 -0
  351. data/lib/purecloud/models/inbound_route_entity_listing.rb +238 -0
  352. data/lib/purecloud/models/indexed_transform.rb +180 -0
  353. data/lib/purecloud/models/invoice.rb +230 -0
  354. data/lib/purecloud/models/ivr.rb +341 -0
  355. data/lib/purecloud/models/ivr_entity_listing.rb +238 -0
  356. data/lib/purecloud/models/key_rotation_schedule.rb +187 -0
  357. data/lib/purecloud/models/language.rb +168 -0
  358. data/lib/purecloud/models/language_entity_listing.rb +238 -0
  359. data/lib/purecloud/models/library.rb +199 -0
  360. data/lib/purecloud/models/library_entity_listing.rb +238 -0
  361. data/lib/purecloud/models/license.rb +157 -0
  362. data/lib/purecloud/models/licenses_by_permission.rb +169 -0
  363. data/lib/purecloud/models/line.rb +351 -0
  364. data/lib/purecloud/models/line_base.rb +190 -0
  365. data/lib/purecloud/models/line_base_entity_listing.rb +238 -0
  366. data/lib/purecloud/models/line_entity_listing.rb +238 -0
  367. data/lib/purecloud/models/line_properties.rb +136 -0
  368. data/lib/purecloud/models/line_status.rb +195 -0
  369. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +238 -0
  370. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +238 -0
  371. data/lib/purecloud/models/location.rb +274 -0
  372. data/lib/purecloud/models/location_address_fields.rb +206 -0
  373. data/lib/purecloud/models/location_emergency_number.rb +176 -0
  374. data/lib/purecloud/models/location_entity_listing.rb +238 -0
  375. data/lib/purecloud/models/lock_info.rb +187 -0
  376. data/lib/purecloud/models/logical_interface_entity_listing.rb +238 -0
  377. data/lib/purecloud/models/management_unit.rb +186 -0
  378. data/lib/purecloud/models/management_unit_timezone.rb +146 -0
  379. data/lib/purecloud/models/max_participants.rb +146 -0
  380. data/lib/purecloud/models/media_result.rb +168 -0
  381. data/lib/purecloud/models/media_setting.rb +156 -0
  382. data/lib/purecloud/models/media_summary.rb +156 -0
  383. data/lib/purecloud/models/metabase.rb +178 -0
  384. data/lib/purecloud/models/metered_evaluation_assignment.rb +200 -0
  385. data/lib/purecloud/models/metric_threshold.rb +165 -0
  386. data/lib/purecloud/models/noc_support.rb +156 -0
  387. data/lib/purecloud/models/number.rb +156 -0
  388. data/lib/purecloud/models/number_order_request.rb +201 -0
  389. data/lib/purecloud/models/number_plan.rb +351 -0
  390. data/lib/purecloud/models/o_auth_client.rb +240 -0
  391. data/lib/purecloud/models/o_auth_client_entity_listing.rb +238 -0
  392. data/lib/purecloud/models/o_auth_provider.rb +168 -0
  393. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +238 -0
  394. data/lib/purecloud/models/occurrence.rb +165 -0
  395. data/lib/purecloud/models/okta.rb +198 -0
  396. data/lib/purecloud/models/one_login.rb +198 -0
  397. data/lib/purecloud/models/order.rb +188 -0
  398. data/lib/purecloud/models/org_license_assignment.rb +178 -0
  399. data/lib/purecloud/models/org_media_utilization.rb +160 -0
  400. data/lib/purecloud/models/organization.rb +279 -0
  401. data/lib/purecloud/models/organization_address.rb +194 -0
  402. data/lib/purecloud/models/organization_create.rb +205 -0
  403. data/lib/purecloud/models/organization_presence.rb +253 -0
  404. data/lib/purecloud/models/organization_presence_entity_listing.rb +238 -0
  405. data/lib/purecloud/models/organization_product_entity_listing.rb +188 -0
  406. data/lib/purecloud/models/organization_role_entity_listing.rb +238 -0
  407. data/lib/purecloud/models/orphan_recording.rb +277 -0
  408. data/lib/purecloud/models/orphan_recording_listing.rb +238 -0
  409. data/lib/purecloud/models/out_of_office.rb +212 -0
  410. data/lib/purecloud/models/outbound_route.rb +347 -0
  411. data/lib/purecloud/models/outbound_route_entity_listing.rb +238 -0
  412. data/lib/purecloud/models/page.rb +224 -0
  413. data/lib/purecloud/models/parameter.rb +196 -0
  414. data/lib/purecloud/models/parsed_certificate.rb +150 -0
  415. data/lib/purecloud/models/participant.rb +490 -0
  416. data/lib/purecloud/models/participant_attributes.rb +148 -0
  417. data/lib/purecloud/models/participant_request.rb +235 -0
  418. data/lib/purecloud/models/penetration_rate.rb +176 -0
  419. data/lib/purecloud/models/penetration_rate_id.rb +156 -0
  420. data/lib/purecloud/models/permission_collection_entity_listing.rb +238 -0
  421. data/lib/purecloud/models/permissions.rb +169 -0
  422. data/lib/purecloud/models/phone.rb +375 -0
  423. data/lib/purecloud/models/phone_base.rb +212 -0
  424. data/lib/purecloud/models/phone_base_entity_listing.rb +238 -0
  425. data/lib/purecloud/models/phone_capabilities.rb +206 -0
  426. data/lib/purecloud/models/phone_column.rb +156 -0
  427. data/lib/purecloud/models/phone_entity_listing.rb +238 -0
  428. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +238 -0
  429. data/lib/purecloud/models/phone_number_column.rb +156 -0
  430. data/lib/purecloud/models/phone_number_status.rb +148 -0
  431. data/lib/purecloud/models/phone_status.rb +263 -0
  432. data/lib/purecloud/models/phones_reboot.rb +148 -0
  433. data/lib/purecloud/models/physical_interface_entity_listing.rb +238 -0
  434. data/lib/purecloud/models/pin_configuration.rb +156 -0
  435. data/lib/purecloud/models/policy.rb +252 -0
  436. data/lib/purecloud/models/policy_actions.rb +206 -0
  437. data/lib/purecloud/models/policy_conditions.rb +228 -0
  438. data/lib/purecloud/models/policy_entity_listing.rb +238 -0
  439. data/lib/purecloud/models/policy_error_message.rb +209 -0
  440. data/lib/purecloud/models/policy_errors.rb +148 -0
  441. data/lib/purecloud/models/preview.rb +230 -0
  442. data/lib/purecloud/models/primary_user_presence_source.rb +188 -0
  443. data/lib/purecloud/models/product.rb +199 -0
  444. data/lib/purecloud/models/progress_model.rb +169 -0
  445. data/lib/purecloud/models/prompt.rb +190 -0
  446. data/lib/purecloud/models/prompt_asset.rb +238 -0
  447. data/lib/purecloud/models/prompt_asset_entity_listing.rb +238 -0
  448. data/lib/purecloud/models/prompt_entity_listing.rb +238 -0
  449. data/lib/purecloud/models/provision_info.rb +169 -0
  450. data/lib/purecloud/models/publication.rb +224 -0
  451. data/lib/purecloud/models/publish_script_request_data.rb +156 -0
  452. data/lib/purecloud/models/published_result.rb +208 -0
  453. data/lib/purecloud/models/pure_cloud.rb +168 -0
  454. data/lib/purecloud/models/put_management_unit.rb +175 -0
  455. data/lib/purecloud/models/quality_audit.rb +250 -0
  456. data/lib/purecloud/models/quality_audit_page.rb +238 -0
  457. data/lib/purecloud/models/query_facet_info.rb +160 -0
  458. data/lib/purecloud/models/query_request.rb +202 -0
  459. data/lib/purecloud/models/query_result.rb +178 -0
  460. data/lib/purecloud/models/query_results.rb +156 -0
  461. data/lib/purecloud/models/question_group.rb +236 -0
  462. data/lib/purecloud/models/question_group_score.rb +250 -0
  463. data/lib/purecloud/models/question_score.rb +200 -0
  464. data/lib/purecloud/models/queue.rb +382 -0
  465. data/lib/purecloud/models/queue_entity_listing.rb +238 -0
  466. data/lib/purecloud/models/queue_member.rb +220 -0
  467. data/lib/purecloud/models/queue_member_entity_listing.rb +238 -0
  468. data/lib/purecloud/models/queue_utilization_diagnostic.rb +216 -0
  469. data/lib/purecloud/models/queues_entity_listing.rb +238 -0
  470. data/lib/purecloud/models/quote.rb +392 -0
  471. data/lib/purecloud/models/quote_charge.rb +281 -0
  472. data/lib/purecloud/models/quote_listing.rb +238 -0
  473. data/lib/purecloud/models/rate.rb +190 -0
  474. data/lib/purecloud/models/reaction.rb +175 -0
  475. data/lib/purecloud/models/recording.rb +407 -0
  476. data/lib/purecloud/models/replace_request.rb +166 -0
  477. data/lib/purecloud/models/replace_response.rb +205 -0
  478. data/lib/purecloud/models/report_meta_data.rb +234 -0
  479. data/lib/purecloud/models/report_meta_data_entity_listing.rb +238 -0
  480. data/lib/purecloud/models/report_request.rb +210 -0
  481. data/lib/purecloud/models/report_run_entry.rb +258 -0
  482. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +238 -0
  483. data/lib/purecloud/models/report_schedule.rb +315 -0
  484. data/lib/purecloud/models/report_schedule_entity_listing.rb +238 -0
  485. data/lib/purecloud/models/reservation.rb +187 -0
  486. data/lib/purecloud/models/resource_condition_node.rb +208 -0
  487. data/lib/purecloud/models/resource_condition_value.rb +165 -0
  488. data/lib/purecloud/models/resource_permission_policy.rb +250 -0
  489. data/lib/purecloud/models/response.rb +228 -0
  490. data/lib/purecloud/models/response_entity_list.rb +239 -0
  491. data/lib/purecloud/models/response_entity_listing.rb +238 -0
  492. data/lib/purecloud/models/response_query_request.rb +172 -0
  493. data/lib/purecloud/models/response_query_results.rb +148 -0
  494. data/lib/purecloud/models/response_set.rb +212 -0
  495. data/lib/purecloud/models/response_set_entity_listing.rb +238 -0
  496. data/lib/purecloud/models/response_text.rb +159 -0
  497. data/lib/purecloud/models/rest_error_detail.rb +156 -0
  498. data/lib/purecloud/models/retention_duration.rb +156 -0
  499. data/lib/purecloud/models/ring.rb +158 -0
  500. data/lib/purecloud/models/routing_status.rb +176 -0
  501. data/lib/purecloud/models/rule.rb +200 -0
  502. data/lib/purecloud/models/rule_entity_listing.rb +238 -0
  503. data/lib/purecloud/models/rule_set.rb +232 -0
  504. data/lib/purecloud/models/rule_set_entity_listing.rb +238 -0
  505. data/lib/purecloud/models/run_now_response.rb +168 -0
  506. data/lib/purecloud/models/salesforce.rb +198 -0
  507. data/lib/purecloud/models/schedule.rb +314 -0
  508. data/lib/purecloud/models/schedule_entity_listing.rb +238 -0
  509. data/lib/purecloud/models/schedule_group.rb +303 -0
  510. data/lib/purecloud/models/schedule_group_entity_listing.rb +238 -0
  511. data/lib/purecloud/models/schema_category.rb +168 -0
  512. data/lib/purecloud/models/schema_category_entity_listing.rb +238 -0
  513. data/lib/purecloud/models/schema_reference_entity_listing.rb +238 -0
  514. data/lib/purecloud/models/script.rb +272 -0
  515. data/lib/purecloud/models/script_entity_listing.rb +238 -0
  516. data/lib/purecloud/models/search_request.rb +222 -0
  517. data/lib/purecloud/models/security_profile.rb +180 -0
  518. data/lib/purecloud/models/security_profile_entity_listing.rb +238 -0
  519. data/lib/purecloud/models/segment.rb +188 -0
  520. data/lib/purecloud/models/sequence_schedule.rb +232 -0
  521. data/lib/purecloud/models/server_date.rb +147 -0
  522. data/lib/purecloud/models/service.rb +245 -0
  523. data/lib/purecloud/models/service_context.rb +146 -0
  524. data/lib/purecloud/models/service_entity_listing.rb +238 -0
  525. data/lib/purecloud/models/service_level.rb +156 -0
  526. data/lib/purecloud/models/service_type.rb +200 -0
  527. data/lib/purecloud/models/session.rb +219 -0
  528. data/lib/purecloud/models/session_entity_listing.rb +238 -0
  529. data/lib/purecloud/models/session_request.rb +146 -0
  530. data/lib/purecloud/models/share.rb +256 -0
  531. data/lib/purecloud/models/share_entity_listing.rb +238 -0
  532. data/lib/purecloud/models/shared_response.rb +186 -0
  533. data/lib/purecloud/models/sheet_schema.rb +213 -0
  534. data/lib/purecloud/models/sheet_transform.rb +166 -0
  535. data/lib/purecloud/models/signature_document_info.rb +166 -0
  536. data/lib/purecloud/models/site.rb +374 -0
  537. data/lib/purecloud/models/site_entity_listing.rb +238 -0
  538. data/lib/purecloud/models/skill.rb +269 -0
  539. data/lib/purecloud/models/skill_entity_listing.rb +238 -0
  540. data/lib/purecloud/models/skills_to_remove.rb +166 -0
  541. data/lib/purecloud/models/social_account.rb +273 -0
  542. data/lib/purecloud/models/social_expression.rb +259 -0
  543. data/lib/purecloud/models/socialize_entity_filter.rb +178 -0
  544. data/lib/purecloud/models/socialize_filter_request.rb +198 -0
  545. data/lib/purecloud/models/sort_by.rb +158 -0
  546. data/lib/purecloud/models/sort_field.rb +165 -0
  547. data/lib/purecloud/models/sort_item.rb +158 -0
  548. data/lib/purecloud/models/spreadsheet_transform.rb +236 -0
  549. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +238 -0
  550. data/lib/purecloud/models/station.rb +227 -0
  551. data/lib/purecloud/models/station_entity_listing.rb +238 -0
  552. data/lib/purecloud/models/sub_data_item.rb +192 -0
  553. data/lib/purecloud/models/support.rb +166 -0
  554. data/lib/purecloud/models/system_prompt.rb +190 -0
  555. data/lib/purecloud/models/system_prompt_asset.rb +259 -0
  556. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +238 -0
  557. data/lib/purecloud/models/system_prompt_entity_listing.rb +238 -0
  558. data/lib/purecloud/models/table_transform.rb +204 -0
  559. data/lib/purecloud/models/tag.rb +158 -0
  560. data/lib/purecloud/models/tag_model.rb +156 -0
  561. data/lib/purecloud/models/tag_query_request.rb +166 -0
  562. data/lib/purecloud/models/tag_value.rb +192 -0
  563. data/lib/purecloud/models/tag_value_entity_listing.rb +238 -0
  564. data/lib/purecloud/models/template.rb +253 -0
  565. data/lib/purecloud/models/template_entity_listing.rb +238 -0
  566. data/lib/purecloud/models/term_attribute.rb +175 -0
  567. data/lib/purecloud/models/text_table_transform.rb +232 -0
  568. data/lib/purecloud/models/text_table_transform_entity_listing.rb +238 -0
  569. data/lib/purecloud/models/third_party_account.rb +212 -0
  570. data/lib/purecloud/models/third_party_subscription.rb +199 -0
  571. data/lib/purecloud/models/tier.rb +156 -0
  572. data/lib/purecloud/models/time_allowed.rb +170 -0
  573. data/lib/purecloud/models/time_interval.rb +156 -0
  574. data/lib/purecloud/models/time_slot.rb +166 -0
  575. data/lib/purecloud/models/time_zone.rb +188 -0
  576. data/lib/purecloud/models/time_zone_entity_listing.rb +238 -0
  577. data/lib/purecloud/models/topic_entity_listing.rb +238 -0
  578. data/lib/purecloud/models/trace.rb +216 -0
  579. data/lib/purecloud/models/trace_list.rb +158 -0
  580. data/lib/purecloud/models/transform_endpoint.rb +271 -0
  581. data/lib/purecloud/models/transform_lens.rb +156 -0
  582. data/lib/purecloud/models/transform_model.rb +212 -0
  583. data/lib/purecloud/models/transform_progress.rb +260 -0
  584. data/lib/purecloud/models/trunk_base.rb +325 -0
  585. data/lib/purecloud/models/trunk_base_assignment.rb +158 -0
  586. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +238 -0
  587. data/lib/purecloud/models/twitter_expression.rb +412 -0
  588. data/lib/purecloud/models/twitter_expression_buffer.rb +149 -0
  589. data/lib/purecloud/models/unpivot_columns.rb +148 -0
  590. data/lib/purecloud/models/unread_metric.rb +146 -0
  591. data/lib/purecloud/models/upload_progress.rb +213 -0
  592. data/lib/purecloud/models/uri_reference.rb +166 -0
  593. data/lib/purecloud/models/url_response.rb +146 -0
  594. data/lib/purecloud/models/user.rb +396 -0
  595. data/lib/purecloud/models/user_action_category.rb +168 -0
  596. data/lib/purecloud/models/user_action_category_entity_listing.rb +238 -0
  597. data/lib/purecloud/models/user_action_metadata.rb +246 -0
  598. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +218 -0
  599. data/lib/purecloud/models/user_action_metadata_request.rb +196 -0
  600. data/lib/purecloud/models/user_authorization.rb +216 -0
  601. data/lib/purecloud/models/user_conversation_summary.rb +206 -0
  602. data/lib/purecloud/models/user_entity_listing.rb +238 -0
  603. data/lib/purecloud/models/user_image.rb +156 -0
  604. data/lib/purecloud/models/user_license_assignment.rb +188 -0
  605. data/lib/purecloud/models/user_param.rb +156 -0
  606. data/lib/purecloud/models/user_presence.rb +230 -0
  607. data/lib/purecloud/models/user_presence_entity_listing.rb +238 -0
  608. data/lib/purecloud/models/user_queue.rb +394 -0
  609. data/lib/purecloud/models/user_queue_entity_listing.rb +238 -0
  610. data/lib/purecloud/models/user_recording.rb +274 -0
  611. data/lib/purecloud/models/user_recording_entity_listing.rb +238 -0
  612. data/lib/purecloud/models/user_skill.rb +290 -0
  613. data/lib/purecloud/models/user_skill_entity_listing.rb +238 -0
  614. data/lib/purecloud/models/user_station_resource.rb +228 -0
  615. data/lib/purecloud/models/user_status.rb +210 -0
  616. data/lib/purecloud/models/users_entity_listing.rb +238 -0
  617. data/lib/purecloud/models/utilization.rb +181 -0
  618. data/lib/purecloud/models/validate_address_request.rb +146 -0
  619. data/lib/purecloud/models/validate_address_response.rb +158 -0
  620. data/lib/purecloud/models/value.rb +220 -0
  621. data/lib/purecloud/models/video.rb +240 -0
  622. data/lib/purecloud/models/view.rb +146 -0
  623. data/lib/purecloud/models/voice_rate.rb +254 -0
  624. data/lib/purecloud/models/voice_rate_extended.rb +355 -0
  625. data/lib/purecloud/models/voice_rate_international.rb +276 -0
  626. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +238 -0
  627. data/lib/purecloud/models/voice_rate_update.rb +282 -0
  628. data/lib/purecloud/models/voice_rates_csv.rb +180 -0
  629. data/lib/purecloud/models/voice_xml_operation.rb +285 -0
  630. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +238 -0
  631. data/lib/purecloud/models/voicemail_mailbox_info.rb +198 -0
  632. data/lib/purecloud/models/voicemail_media_info.rb +167 -0
  633. data/lib/purecloud/models/voicemail_message.rb +252 -0
  634. data/lib/purecloud/models/voicemail_message_entity_listing.rb +238 -0
  635. data/lib/purecloud/models/voicemail_organization_policy.rb +296 -0
  636. data/lib/purecloud/models/voicemail_user_policy.rb +250 -0
  637. data/lib/purecloud/models/vpn.rb +166 -0
  638. data/lib/purecloud/models/work_item.rb +170 -0
  639. data/lib/purecloud/models/work_item_actions.rb +148 -0
  640. data/lib/purecloud/models/work_item_cache.rb +193 -0
  641. data/lib/purecloud/models/work_item_command.rb +156 -0
  642. data/lib/purecloud/models/work_item_command_group.rb +168 -0
  643. data/lib/purecloud/models/work_item_definition.rb +183 -0
  644. data/lib/purecloud/models/work_item_details.rb +361 -0
  645. data/lib/purecloud/models/work_item_search_details.rb +147 -0
  646. data/lib/purecloud/models/work_item_search_details_search_result.rb +161 -0
  647. data/lib/purecloud/models/work_item_submit_request.rb +161 -0
  648. data/lib/purecloud/models/work_item_transfer_request.rb +168 -0
  649. data/lib/purecloud/models/workspace.rb +263 -0
  650. data/lib/purecloud/models/workspace_create.rb +156 -0
  651. data/lib/purecloud/models/workspace_entity_listing.rb +238 -0
  652. data/lib/purecloud/models/workspace_member.rb +237 -0
  653. data/lib/purecloud/models/workspace_member_entity_listing.rb +238 -0
  654. data/lib/purecloud/models/workspace_summary.rb +146 -0
  655. data/lib/purecloud/models/wrap_up_code_mapping.rb +224 -0
  656. data/lib/purecloud/models/wrapup.rb +211 -0
  657. data/lib/purecloud/models/wrapup_code.rb +198 -0
  658. data/lib/purecloud/models/wrapup_code_entity_listing.rb +238 -0
  659. data/lib/purecloud/models/xlsx_schema.rb +171 -0
  660. data/lib/purecloud/version.rb +3 -0
  661. data/newVersion.md +1 -0
  662. data/purecloud.gemspec +32 -0
  663. data/rakefile +101 -0
  664. data/spec/test.rb +37 -0
  665. data/swagger.json +1 -0
  666. data/version.json +1 -0
  667. metadata +891 -0
@@ -0,0 +1,1361 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class UsersApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Get the list of available users.
12
+ #
13
+ # @param [Hash] opts the optional parameters
14
+ # @option opts [Integer] :page_size Page size
15
+ # @option opts [Integer] :page_number Page number
16
+ # @option opts [Array<String>] :id id
17
+ # @option opts [String] :sort_by Sort by
18
+ # @option opts [String] :role Role
19
+ # @option opts [String] :name Name
20
+ # @option opts [String] :username Username
21
+ # @option opts [Array<String>] :skill Skill
22
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
23
+ # @return [UsersEntityListing]
24
+ def get_users(opts = {})
25
+ data, status_code, headers = get_users_with_http_info(opts)
26
+ return data
27
+ end
28
+
29
+ # Get the list of available users.
30
+ #
31
+ # @param [Hash] opts the optional parameters
32
+ # @option opts [Integer] :page_size Page size
33
+ # @option opts [Integer] :page_number Page number
34
+ # @option opts [Array<String>] :id id
35
+ # @option opts [String] :sort_by Sort by
36
+ # @option opts [String] :role Role
37
+ # @option opts [String] :name Name
38
+ # @option opts [String] :username Username
39
+ # @option opts [Array<String>] :skill Skill
40
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
41
+ # @return [Array<(UsersEntityListing, Fixnum, Hash)>] UsersEntityListing data, response status code and response headers
42
+ def get_users_with_http_info(opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: UsersApi#get_users ..."
45
+ end
46
+
47
+ # resource path
48
+ path = "/api/v1/users".sub('{format}','json')
49
+
50
+ # query parameters
51
+ query_params = {}
52
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
53
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
54
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
55
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
56
+ query_params[:'role'] = opts[:'role'] if opts[:'role']
57
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
58
+ query_params[:'username'] = opts[:'username'] if opts[:'username']
59
+ query_params[:'skill'] = @api_client.build_collection_param(opts[:'skill'], :multi) if opts[:'skill']
60
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
61
+
62
+ # header parameters
63
+ header_params = {}
64
+
65
+ # HTTP header 'Accept' (if needed)
66
+ _header_accept = ['application/json']
67
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
68
+
69
+ # HTTP header 'Content-Type'
70
+ _header_content_type = ['application/json']
71
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
72
+
73
+ # form parameters
74
+ form_params = {}
75
+
76
+ # http body (model)
77
+ post_body = nil
78
+
79
+
80
+ auth_names = ['PureCloud Auth']
81
+ data, status_code, headers = @api_client.call_api(:GET, path,
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => 'UsersEntityListing')
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
90
+ end
91
+ return data, status_code, headers
92
+ end
93
+
94
+ # Create a configuration service user.
95
+ #
96
+ # @param [Hash] opts the optional parameters
97
+ # @option opts [User] :body User
98
+ # @return [User]
99
+ def post_users(opts = {})
100
+ data, status_code, headers = post_users_with_http_info(opts)
101
+ return data
102
+ end
103
+
104
+ # Create a configuration service user.
105
+ #
106
+ # @param [Hash] opts the optional parameters
107
+ # @option opts [User] :body User
108
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
109
+ def post_users_with_http_info(opts = {})
110
+ if @api_client.config.debugging
111
+ @api_client.config.logger.debug "Calling API: UsersApi#post_users ..."
112
+ end
113
+
114
+ # resource path
115
+ path = "/api/v1/users".sub('{format}','json')
116
+
117
+ # query parameters
118
+ query_params = {}
119
+
120
+ # header parameters
121
+ header_params = {}
122
+
123
+ # HTTP header 'Accept' (if needed)
124
+ _header_accept = ['application/json']
125
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
126
+
127
+ # HTTP header 'Content-Type'
128
+ _header_content_type = ['application/json']
129
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
130
+
131
+ # form parameters
132
+ form_params = {}
133
+
134
+ # http body (model)
135
+ post_body = @api_client.object_to_http_body(opts[:'body'])
136
+
137
+
138
+ auth_names = ['PureCloud Auth']
139
+ data, status_code, headers = @api_client.call_api(:POST, path,
140
+ :header_params => header_params,
141
+ :query_params => query_params,
142
+ :form_params => form_params,
143
+ :body => post_body,
144
+ :auth_names => auth_names,
145
+ :return_type => 'User')
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug "API called: UsersApi#post_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
+ end
149
+ return data, status_code, headers
150
+ end
151
+
152
+ # Get user.
153
+ #
154
+ # @param [Hash] opts the optional parameters
155
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
156
+ # @return [User]
157
+ def get_me(opts = {})
158
+ data, status_code, headers = get_me_with_http_info(opts)
159
+ return data
160
+ end
161
+
162
+ # Get user.
163
+ #
164
+ # @param [Hash] opts the optional parameters
165
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
166
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
167
+ def get_me_with_http_info(opts = {})
168
+ if @api_client.config.debugging
169
+ @api_client.config.logger.debug "Calling API: UsersApi#get_me ..."
170
+ end
171
+
172
+ # resource path
173
+ path = "/api/v1/users/me".sub('{format}','json')
174
+
175
+ # query parameters
176
+ query_params = {}
177
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
178
+
179
+ # header parameters
180
+ header_params = {}
181
+
182
+ # HTTP header 'Accept' (if needed)
183
+ _header_accept = ['application/json']
184
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
185
+
186
+ # HTTP header 'Content-Type'
187
+ _header_content_type = ['application/json']
188
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
189
+
190
+ # form parameters
191
+ form_params = {}
192
+
193
+ # http body (model)
194
+ post_body = nil
195
+
196
+
197
+ auth_names = ['PureCloud Auth']
198
+ data, status_code, headers = @api_client.call_api(:GET, path,
199
+ :header_params => header_params,
200
+ :query_params => query_params,
201
+ :form_params => form_params,
202
+ :body => post_body,
203
+ :auth_names => auth_names,
204
+ :return_type => 'User')
205
+ if @api_client.config.debugging
206
+ @api_client.config.logger.debug "API called: UsersApi#get_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
207
+ end
208
+ return data, status_code, headers
209
+ end
210
+
211
+ # Get user.
212
+ #
213
+ # @param user_id User ID
214
+ # @param [Hash] opts the optional parameters
215
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
216
+ # @return [User]
217
+ def get(user_id, opts = {})
218
+ data, status_code, headers = get_with_http_info(user_id, opts)
219
+ return data
220
+ end
221
+
222
+ # Get user.
223
+ #
224
+ # @param user_id User ID
225
+ # @param [Hash] opts the optional parameters
226
+ # @option opts [Array<String>] :expand Which fields, if any, to expand
227
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
228
+ def get_with_http_info(user_id, opts = {})
229
+ if @api_client.config.debugging
230
+ @api_client.config.logger.debug "Calling API: UsersApi#get ..."
231
+ end
232
+
233
+ # verify the required parameter 'user_id' is set
234
+ fail "Missing the required parameter 'user_id' when calling get" if user_id.nil?
235
+
236
+ # resource path
237
+ path = "/api/v1/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
238
+
239
+ # query parameters
240
+ query_params = {}
241
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
242
+
243
+ # header parameters
244
+ header_params = {}
245
+
246
+ # HTTP header 'Accept' (if needed)
247
+ _header_accept = ['application/json']
248
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
249
+
250
+ # HTTP header 'Content-Type'
251
+ _header_content_type = ['application/json']
252
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
253
+
254
+ # form parameters
255
+ form_params = {}
256
+
257
+ # http body (model)
258
+ post_body = nil
259
+
260
+
261
+ auth_names = ['PureCloud Auth']
262
+ data, status_code, headers = @api_client.call_api(:GET, path,
263
+ :header_params => header_params,
264
+ :query_params => query_params,
265
+ :form_params => form_params,
266
+ :body => post_body,
267
+ :auth_names => auth_names,
268
+ :return_type => 'User')
269
+ if @api_client.config.debugging
270
+ @api_client.config.logger.debug "API called: UsersApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
271
+ end
272
+ return data, status_code, headers
273
+ end
274
+
275
+ # Set user station
276
+ #
277
+ # @param user_id User ID
278
+ # @param body stationUri
279
+ # @param [Hash] opts the optional parameters
280
+ # @return [User]
281
+ def put(user_id, body, opts = {})
282
+ data, status_code, headers = put_with_http_info(user_id, body, opts)
283
+ return data
284
+ end
285
+
286
+ # Set user station
287
+ #
288
+ # @param user_id User ID
289
+ # @param body stationUri
290
+ # @param [Hash] opts the optional parameters
291
+ # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
292
+ def put_with_http_info(user_id, body, opts = {})
293
+ if @api_client.config.debugging
294
+ @api_client.config.logger.debug "Calling API: UsersApi#put ..."
295
+ end
296
+
297
+ # verify the required parameter 'user_id' is set
298
+ fail "Missing the required parameter 'user_id' when calling put" if user_id.nil?
299
+
300
+ # verify the required parameter 'body' is set
301
+ fail "Missing the required parameter 'body' when calling put" if body.nil?
302
+
303
+ # resource path
304
+ path = "/api/v1/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
305
+
306
+ # query parameters
307
+ query_params = {}
308
+
309
+ # header parameters
310
+ header_params = {}
311
+
312
+ # HTTP header 'Accept' (if needed)
313
+ _header_accept = ['application/json']
314
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
315
+
316
+ # HTTP header 'Content-Type'
317
+ _header_content_type = ['application/json']
318
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
319
+
320
+ # form parameters
321
+ form_params = {}
322
+
323
+ # http body (model)
324
+ post_body = @api_client.object_to_http_body(body)
325
+
326
+
327
+ auth_names = ['PureCloud Auth']
328
+ data, status_code, headers = @api_client.call_api(:PUT, path,
329
+ :header_params => header_params,
330
+ :query_params => query_params,
331
+ :form_params => form_params,
332
+ :body => post_body,
333
+ :auth_names => auth_names,
334
+ :return_type => 'User')
335
+ if @api_client.config.debugging
336
+ @api_client.config.logger.debug "API called: UsersApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
337
+ end
338
+ return data, status_code, headers
339
+ end
340
+
341
+ # Get a user&#39;s CallForwarding
342
+ #
343
+ # @param user_id User ID
344
+ # @param [Hash] opts the optional parameters
345
+ # @return [CallForwarding]
346
+ def get_callforwarding(user_id, opts = {})
347
+ data, status_code, headers = get_callforwarding_with_http_info(user_id, opts)
348
+ return data
349
+ end
350
+
351
+ # Get a user&#39;s CallForwarding
352
+ #
353
+ # @param user_id User ID
354
+ # @param [Hash] opts the optional parameters
355
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
356
+ def get_callforwarding_with_http_info(user_id, opts = {})
357
+ if @api_client.config.debugging
358
+ @api_client.config.logger.debug "Calling API: UsersApi#get_callforwarding ..."
359
+ end
360
+
361
+ # verify the required parameter 'user_id' is set
362
+ fail "Missing the required parameter 'user_id' when calling get_callforwarding" if user_id.nil?
363
+
364
+ # resource path
365
+ path = "/api/v1/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
366
+
367
+ # query parameters
368
+ query_params = {}
369
+
370
+ # header parameters
371
+ header_params = {}
372
+
373
+ # HTTP header 'Accept' (if needed)
374
+ _header_accept = ['application/json']
375
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
376
+
377
+ # HTTP header 'Content-Type'
378
+ _header_content_type = ['application/json']
379
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
380
+
381
+ # form parameters
382
+ form_params = {}
383
+
384
+ # http body (model)
385
+ post_body = nil
386
+
387
+
388
+ auth_names = ['PureCloud Auth']
389
+ data, status_code, headers = @api_client.call_api(:GET, path,
390
+ :header_params => header_params,
391
+ :query_params => query_params,
392
+ :form_params => form_params,
393
+ :body => post_body,
394
+ :auth_names => auth_names,
395
+ :return_type => 'CallForwarding')
396
+ if @api_client.config.debugging
397
+ @api_client.config.logger.debug "API called: UsersApi#get_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
398
+ end
399
+ return data, status_code, headers
400
+ end
401
+
402
+ # Update a user&#39;s CallForwarding
403
+ #
404
+ # @param user_id User ID
405
+ # @param [Hash] opts the optional parameters
406
+ # @option opts [CallForwarding] :body
407
+ # @return [CallForwarding]
408
+ def put_callforwarding(user_id, opts = {})
409
+ data, status_code, headers = put_callforwarding_with_http_info(user_id, opts)
410
+ return data
411
+ end
412
+
413
+ # Update a user&#39;s CallForwarding
414
+ #
415
+ # @param user_id User ID
416
+ # @param [Hash] opts the optional parameters
417
+ # @option opts [CallForwarding] :body
418
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
419
+ def put_callforwarding_with_http_info(user_id, opts = {})
420
+ if @api_client.config.debugging
421
+ @api_client.config.logger.debug "Calling API: UsersApi#put_callforwarding ..."
422
+ end
423
+
424
+ # verify the required parameter 'user_id' is set
425
+ fail "Missing the required parameter 'user_id' when calling put_callforwarding" if user_id.nil?
426
+
427
+ # resource path
428
+ path = "/api/v1/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
429
+
430
+ # query parameters
431
+ query_params = {}
432
+
433
+ # header parameters
434
+ header_params = {}
435
+
436
+ # HTTP header 'Accept' (if needed)
437
+ _header_accept = ['application/json']
438
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
439
+
440
+ # HTTP header 'Content-Type'
441
+ _header_content_type = ['application/json']
442
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
443
+
444
+ # form parameters
445
+ form_params = {}
446
+
447
+ # http body (model)
448
+ post_body = @api_client.object_to_http_body(opts[:'body'])
449
+
450
+
451
+ auth_names = ['PureCloud Auth']
452
+ data, status_code, headers = @api_client.call_api(:PUT, path,
453
+ :header_params => header_params,
454
+ :query_params => query_params,
455
+ :form_params => form_params,
456
+ :body => post_body,
457
+ :auth_names => auth_names,
458
+ :return_type => 'CallForwarding')
459
+ if @api_client.config.debugging
460
+ @api_client.config.logger.debug "API called: UsersApi#put_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
461
+ end
462
+ return data, status_code, headers
463
+ end
464
+
465
+ # Patch a user&#39;s CallForwarding
466
+ #
467
+ # @param user_id User ID
468
+ # @param [Hash] opts the optional parameters
469
+ # @option opts [CallForwarding] :body
470
+ # @return [CallForwarding]
471
+ def patch_callforwarding(user_id, opts = {})
472
+ data, status_code, headers = patch_callforwarding_with_http_info(user_id, opts)
473
+ return data
474
+ end
475
+
476
+ # Patch a user&#39;s CallForwarding
477
+ #
478
+ # @param user_id User ID
479
+ # @param [Hash] opts the optional parameters
480
+ # @option opts [CallForwarding] :body
481
+ # @return [Array<(CallForwarding, Fixnum, Hash)>] CallForwarding data, response status code and response headers
482
+ def patch_callforwarding_with_http_info(user_id, opts = {})
483
+ if @api_client.config.debugging
484
+ @api_client.config.logger.debug "Calling API: UsersApi#patch_callforwarding ..."
485
+ end
486
+
487
+ # verify the required parameter 'user_id' is set
488
+ fail "Missing the required parameter 'user_id' when calling patch_callforwarding" if user_id.nil?
489
+
490
+ # resource path
491
+ path = "/api/v1/users/{userId}/callforwarding".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
492
+
493
+ # query parameters
494
+ query_params = {}
495
+
496
+ # header parameters
497
+ header_params = {}
498
+
499
+ # HTTP header 'Accept' (if needed)
500
+ _header_accept = ['application/json']
501
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
502
+
503
+ # HTTP header 'Content-Type'
504
+ _header_content_type = ['application/json']
505
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
506
+
507
+ # form parameters
508
+ form_params = {}
509
+
510
+ # http body (model)
511
+ post_body = @api_client.object_to_http_body(opts[:'body'])
512
+
513
+
514
+ auth_names = ['PureCloud Auth']
515
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
516
+ :header_params => header_params,
517
+ :query_params => query_params,
518
+ :form_params => form_params,
519
+ :body => post_body,
520
+ :auth_names => auth_names,
521
+ :return_type => 'CallForwarding')
522
+ if @api_client.config.debugging
523
+ @api_client.config.logger.debug "API called: UsersApi#patch_callforwarding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
524
+ end
525
+ return data, status_code, headers
526
+ end
527
+
528
+ # Get a user&#39;s Geolocation
529
+ #
530
+ # @param user_id user Id
531
+ # @param client_id client Id
532
+ # @param [Hash] opts the optional parameters
533
+ # @return [Geolocation]
534
+ def get_geolocation(user_id, client_id, opts = {})
535
+ data, status_code, headers = get_geolocation_with_http_info(user_id, client_id, opts)
536
+ return data
537
+ end
538
+
539
+ # Get a user&#39;s Geolocation
540
+ #
541
+ # @param user_id user Id
542
+ # @param client_id client Id
543
+ # @param [Hash] opts the optional parameters
544
+ # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
545
+ def get_geolocation_with_http_info(user_id, client_id, opts = {})
546
+ if @api_client.config.debugging
547
+ @api_client.config.logger.debug "Calling API: UsersApi#get_geolocation ..."
548
+ end
549
+
550
+ # verify the required parameter 'user_id' is set
551
+ fail "Missing the required parameter 'user_id' when calling get_geolocation" if user_id.nil?
552
+
553
+ # verify the required parameter 'client_id' is set
554
+ fail "Missing the required parameter 'client_id' when calling get_geolocation" if client_id.nil?
555
+
556
+ # resource path
557
+ path = "/api/v1/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
558
+
559
+ # query parameters
560
+ query_params = {}
561
+
562
+ # header parameters
563
+ header_params = {}
564
+
565
+ # HTTP header 'Accept' (if needed)
566
+ _header_accept = ['application/json']
567
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
568
+
569
+ # HTTP header 'Content-Type'
570
+ _header_content_type = ['application/json']
571
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
572
+
573
+ # form parameters
574
+ form_params = {}
575
+
576
+ # http body (model)
577
+ post_body = nil
578
+
579
+
580
+ auth_names = ['PureCloud Auth']
581
+ data, status_code, headers = @api_client.call_api(:GET, path,
582
+ :header_params => header_params,
583
+ :query_params => query_params,
584
+ :form_params => form_params,
585
+ :body => post_body,
586
+ :auth_names => auth_names,
587
+ :return_type => 'Geolocation')
588
+ if @api_client.config.debugging
589
+ @api_client.config.logger.debug "API called: UsersApi#get_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
590
+ end
591
+ return data, status_code, headers
592
+ end
593
+
594
+ # Patch a user&#39;s Geolocation
595
+ # 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.
596
+ # @param user_id user Id
597
+ # @param client_id client Id
598
+ # @param [Hash] opts the optional parameters
599
+ # @option opts [Geolocation] :body
600
+ # @return [Geolocation]
601
+ def patch_geolocation(user_id, client_id, opts = {})
602
+ data, status_code, headers = patch_geolocation_with_http_info(user_id, client_id, opts)
603
+ return data
604
+ end
605
+
606
+ # Patch a user&#39;s Geolocation
607
+ # 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.
608
+ # @param user_id user Id
609
+ # @param client_id client Id
610
+ # @param [Hash] opts the optional parameters
611
+ # @option opts [Geolocation] :body
612
+ # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
613
+ def patch_geolocation_with_http_info(user_id, client_id, opts = {})
614
+ if @api_client.config.debugging
615
+ @api_client.config.logger.debug "Calling API: UsersApi#patch_geolocation ..."
616
+ end
617
+
618
+ # verify the required parameter 'user_id' is set
619
+ fail "Missing the required parameter 'user_id' when calling patch_geolocation" if user_id.nil?
620
+
621
+ # verify the required parameter 'client_id' is set
622
+ fail "Missing the required parameter 'client_id' when calling patch_geolocation" if client_id.nil?
623
+
624
+ # resource path
625
+ path = "/api/v1/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
626
+
627
+ # query parameters
628
+ query_params = {}
629
+
630
+ # header parameters
631
+ header_params = {}
632
+
633
+ # HTTP header 'Accept' (if needed)
634
+ _header_accept = ['application/json']
635
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
636
+
637
+ # HTTP header 'Content-Type'
638
+ _header_content_type = ['application/json']
639
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
640
+
641
+ # form parameters
642
+ form_params = {}
643
+
644
+ # http body (model)
645
+ post_body = @api_client.object_to_http_body(opts[:'body'])
646
+
647
+
648
+ auth_names = ['PureCloud Auth']
649
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
650
+ :header_params => header_params,
651
+ :query_params => query_params,
652
+ :form_params => form_params,
653
+ :body => post_body,
654
+ :auth_names => auth_names,
655
+ :return_type => 'Geolocation')
656
+ if @api_client.config.debugging
657
+ @api_client.config.logger.debug "API called: UsersApi#patch_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
658
+ end
659
+ return data, status_code, headers
660
+ end
661
+
662
+ # Get a OutOfOffice
663
+ #
664
+ # @param user_id User ID
665
+ # @param [Hash] opts the optional parameters
666
+ # @return [OutOfOffice]
667
+ def get_outofoffice(user_id, opts = {})
668
+ data, status_code, headers = get_outofoffice_with_http_info(user_id, opts)
669
+ return data
670
+ end
671
+
672
+ # Get a OutOfOffice
673
+ #
674
+ # @param user_id User ID
675
+ # @param [Hash] opts the optional parameters
676
+ # @return [Array<(OutOfOffice, Fixnum, Hash)>] OutOfOffice data, response status code and response headers
677
+ def get_outofoffice_with_http_info(user_id, opts = {})
678
+ if @api_client.config.debugging
679
+ @api_client.config.logger.debug "Calling API: UsersApi#get_outofoffice ..."
680
+ end
681
+
682
+ # verify the required parameter 'user_id' is set
683
+ fail "Missing the required parameter 'user_id' when calling get_outofoffice" if user_id.nil?
684
+
685
+ # resource path
686
+ path = "/api/v1/users/{userId}/outofoffice".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
687
+
688
+ # query parameters
689
+ query_params = {}
690
+
691
+ # header parameters
692
+ header_params = {}
693
+
694
+ # HTTP header 'Accept' (if needed)
695
+ _header_accept = ['application/json']
696
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
697
+
698
+ # HTTP header 'Content-Type'
699
+ _header_content_type = ['application/json']
700
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
701
+
702
+ # form parameters
703
+ form_params = {}
704
+
705
+ # http body (model)
706
+ post_body = nil
707
+
708
+
709
+ auth_names = ['PureCloud Auth']
710
+ data, status_code, headers = @api_client.call_api(:GET, path,
711
+ :header_params => header_params,
712
+ :query_params => query_params,
713
+ :form_params => form_params,
714
+ :body => post_body,
715
+ :auth_names => auth_names,
716
+ :return_type => 'OutOfOffice')
717
+ if @api_client.config.debugging
718
+ @api_client.config.logger.debug "API called: UsersApi#get_outofoffice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
719
+ end
720
+ return data, status_code, headers
721
+ end
722
+
723
+ # Update an OutOfOffice
724
+ #
725
+ # @param user_id User ID
726
+ # @param body The updated UserPresence
727
+ # @param [Hash] opts the optional parameters
728
+ # @return [OutOfOffice]
729
+ def put_outofoffice(user_id, body, opts = {})
730
+ data, status_code, headers = put_outofoffice_with_http_info(user_id, body, opts)
731
+ return data
732
+ end
733
+
734
+ # Update an OutOfOffice
735
+ #
736
+ # @param user_id User ID
737
+ # @param body The updated UserPresence
738
+ # @param [Hash] opts the optional parameters
739
+ # @return [Array<(OutOfOffice, Fixnum, Hash)>] OutOfOffice data, response status code and response headers
740
+ def put_outofoffice_with_http_info(user_id, body, opts = {})
741
+ if @api_client.config.debugging
742
+ @api_client.config.logger.debug "Calling API: UsersApi#put_outofoffice ..."
743
+ end
744
+
745
+ # verify the required parameter 'user_id' is set
746
+ fail "Missing the required parameter 'user_id' when calling put_outofoffice" if user_id.nil?
747
+
748
+ # verify the required parameter 'body' is set
749
+ fail "Missing the required parameter 'body' when calling put_outofoffice" if body.nil?
750
+
751
+ # resource path
752
+ path = "/api/v1/users/{userId}/outofoffice".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
753
+
754
+ # query parameters
755
+ query_params = {}
756
+
757
+ # header parameters
758
+ header_params = {}
759
+
760
+ # HTTP header 'Accept' (if needed)
761
+ _header_accept = ['application/json']
762
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
763
+
764
+ # HTTP header 'Content-Type'
765
+ _header_content_type = ['application/json']
766
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
767
+
768
+ # form parameters
769
+ form_params = {}
770
+
771
+ # http body (model)
772
+ post_body = @api_client.object_to_http_body(body)
773
+
774
+
775
+ auth_names = ['PureCloud Auth']
776
+ data, status_code, headers = @api_client.call_api(:PUT, path,
777
+ :header_params => header_params,
778
+ :query_params => query_params,
779
+ :form_params => form_params,
780
+ :body => post_body,
781
+ :auth_names => auth_names,
782
+ :return_type => 'OutOfOffice')
783
+ if @api_client.config.debugging
784
+ @api_client.config.logger.debug "API called: UsersApi#put_outofoffice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
785
+ end
786
+ return data, status_code, headers
787
+ end
788
+
789
+ # Get a user&#39;s PrimaryUserPresenceSource
790
+ #
791
+ # @param user_id User ID
792
+ # @param [Hash] opts the optional parameters
793
+ # @return [PrimaryUserPresenceSource]
794
+ def get_primarypresencesource(user_id, opts = {})
795
+ data, status_code, headers = get_primarypresencesource_with_http_info(user_id, opts)
796
+ return data
797
+ end
798
+
799
+ # Get a user&#39;s PrimaryUserPresenceSource
800
+ #
801
+ # @param user_id User ID
802
+ # @param [Hash] opts the optional parameters
803
+ # @return [Array<(PrimaryUserPresenceSource, Fixnum, Hash)>] PrimaryUserPresenceSource data, response status code and response headers
804
+ def get_primarypresencesource_with_http_info(user_id, opts = {})
805
+ if @api_client.config.debugging
806
+ @api_client.config.logger.debug "Calling API: UsersApi#get_primarypresencesource ..."
807
+ end
808
+
809
+ # verify the required parameter 'user_id' is set
810
+ fail "Missing the required parameter 'user_id' when calling get_primarypresencesource" if user_id.nil?
811
+
812
+ # resource path
813
+ path = "/api/v1/users/{userId}/primarypresencesource".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
814
+
815
+ # query parameters
816
+ query_params = {}
817
+
818
+ # header parameters
819
+ header_params = {}
820
+
821
+ # HTTP header 'Accept' (if needed)
822
+ _header_accept = ['application/json']
823
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
824
+
825
+ # HTTP header 'Content-Type'
826
+ _header_content_type = ['application/json']
827
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
828
+
829
+ # form parameters
830
+ form_params = {}
831
+
832
+ # http body (model)
833
+ post_body = nil
834
+
835
+
836
+ auth_names = ['PureCloud Auth']
837
+ data, status_code, headers = @api_client.call_api(:GET, path,
838
+ :header_params => header_params,
839
+ :query_params => query_params,
840
+ :form_params => form_params,
841
+ :body => post_body,
842
+ :auth_names => auth_names,
843
+ :return_type => 'PrimaryUserPresenceSource')
844
+ if @api_client.config.debugging
845
+ @api_client.config.logger.debug "API called: UsersApi#get_primarypresencesource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
846
+ end
847
+ return data, status_code, headers
848
+ end
849
+
850
+ # Update a user&#39;s PrimaryUserPresenceSource
851
+ #
852
+ # @param user_id User ID
853
+ # @param [Hash] opts the optional parameters
854
+ # @option opts [PrimaryUserPresenceSource] :body
855
+ # @return [PrimaryUserPresenceSource]
856
+ def put_primarypresencesource(user_id, opts = {})
857
+ data, status_code, headers = put_primarypresencesource_with_http_info(user_id, opts)
858
+ return data
859
+ end
860
+
861
+ # Update a user&#39;s PrimaryUserPresenceSource
862
+ #
863
+ # @param user_id User ID
864
+ # @param [Hash] opts the optional parameters
865
+ # @option opts [PrimaryUserPresenceSource] :body
866
+ # @return [Array<(PrimaryUserPresenceSource, Fixnum, Hash)>] PrimaryUserPresenceSource data, response status code and response headers
867
+ def put_primarypresencesource_with_http_info(user_id, opts = {})
868
+ if @api_client.config.debugging
869
+ @api_client.config.logger.debug "Calling API: UsersApi#put_primarypresencesource ..."
870
+ end
871
+
872
+ # verify the required parameter 'user_id' is set
873
+ fail "Missing the required parameter 'user_id' when calling put_primarypresencesource" if user_id.nil?
874
+
875
+ # resource path
876
+ path = "/api/v1/users/{userId}/primarypresencesource".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
877
+
878
+ # query parameters
879
+ query_params = {}
880
+
881
+ # header parameters
882
+ header_params = {}
883
+
884
+ # HTTP header 'Accept' (if needed)
885
+ _header_accept = ['application/json']
886
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
887
+
888
+ # HTTP header 'Content-Type'
889
+ _header_content_type = ['application/json']
890
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
891
+
892
+ # form parameters
893
+ form_params = {}
894
+
895
+ # http body (model)
896
+ post_body = @api_client.object_to_http_body(opts[:'body'])
897
+
898
+
899
+ auth_names = ['PureCloud Auth']
900
+ data, status_code, headers = @api_client.call_api(:PUT, path,
901
+ :header_params => header_params,
902
+ :query_params => query_params,
903
+ :form_params => form_params,
904
+ :body => post_body,
905
+ :auth_names => auth_names,
906
+ :return_type => 'PrimaryUserPresenceSource')
907
+ if @api_client.config.debugging
908
+ @api_client.config.logger.debug "API called: UsersApi#put_primarypresencesource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
909
+ end
910
+ return data, status_code, headers
911
+ end
912
+
913
+ # Get queues for user
914
+ #
915
+ # @param user_id User ID
916
+ # @param [Hash] opts the optional parameters
917
+ # @option opts [Integer] :page_size Page size
918
+ # @option opts [Integer] :page_number Page number
919
+ # @return [UserQueueEntityListing]
920
+ def get_queues(user_id, opts = {})
921
+ data, status_code, headers = get_queues_with_http_info(user_id, opts)
922
+ return data
923
+ end
924
+
925
+ # Get queues for user
926
+ #
927
+ # @param user_id User ID
928
+ # @param [Hash] opts the optional parameters
929
+ # @option opts [Integer] :page_size Page size
930
+ # @option opts [Integer] :page_number Page number
931
+ # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
932
+ def get_queues_with_http_info(user_id, opts = {})
933
+ if @api_client.config.debugging
934
+ @api_client.config.logger.debug "Calling API: UsersApi#get_queues ..."
935
+ end
936
+
937
+ # verify the required parameter 'user_id' is set
938
+ fail "Missing the required parameter 'user_id' when calling get_queues" if user_id.nil?
939
+
940
+ # resource path
941
+ path = "/api/v1/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
942
+
943
+ # query parameters
944
+ query_params = {}
945
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
946
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
947
+
948
+ # header parameters
949
+ header_params = {}
950
+
951
+ # HTTP header 'Accept' (if needed)
952
+ _header_accept = ['application/json']
953
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
954
+
955
+ # HTTP header 'Content-Type'
956
+ _header_content_type = ['application/json']
957
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
958
+
959
+ # form parameters
960
+ form_params = {}
961
+
962
+ # http body (model)
963
+ post_body = nil
964
+
965
+
966
+ auth_names = ['PureCloud Auth']
967
+ data, status_code, headers = @api_client.call_api(:GET, path,
968
+ :header_params => header_params,
969
+ :query_params => query_params,
970
+ :form_params => form_params,
971
+ :body => post_body,
972
+ :auth_names => auth_names,
973
+ :return_type => 'UserQueueEntityListing')
974
+ if @api_client.config.debugging
975
+ @api_client.config.logger.debug "API called: UsersApi#get_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
976
+ end
977
+ return data, status_code, headers
978
+ end
979
+
980
+ # Join or unjoin a set of queues for a user
981
+ #
982
+ # @param user_id User ID
983
+ # @param [Hash] opts the optional parameters
984
+ # @option opts [Array<UserQueue>] :body User Queues
985
+ # @return [UserQueue]
986
+ def patch_queues(user_id, opts = {})
987
+ data, status_code, headers = patch_queues_with_http_info(user_id, opts)
988
+ return data
989
+ end
990
+
991
+ # Join or unjoin a set of queues for a user
992
+ #
993
+ # @param user_id User ID
994
+ # @param [Hash] opts the optional parameters
995
+ # @option opts [Array<UserQueue>] :body User Queues
996
+ # @return [Array<(UserQueue, Fixnum, Hash)>] UserQueue data, response status code and response headers
997
+ def patch_queues_with_http_info(user_id, opts = {})
998
+ if @api_client.config.debugging
999
+ @api_client.config.logger.debug "Calling API: UsersApi#patch_queues ..."
1000
+ end
1001
+
1002
+ # verify the required parameter 'user_id' is set
1003
+ fail "Missing the required parameter 'user_id' when calling patch_queues" if user_id.nil?
1004
+
1005
+ # resource path
1006
+ path = "/api/v1/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1007
+
1008
+ # query parameters
1009
+ query_params = {}
1010
+
1011
+ # header parameters
1012
+ header_params = {}
1013
+
1014
+ # HTTP header 'Accept' (if needed)
1015
+ _header_accept = ['application/json']
1016
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1017
+
1018
+ # HTTP header 'Content-Type'
1019
+ _header_content_type = ['application/json']
1020
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1021
+
1022
+ # form parameters
1023
+ form_params = {}
1024
+
1025
+ # http body (model)
1026
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1027
+
1028
+
1029
+ auth_names = ['PureCloud Auth']
1030
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
1031
+ :header_params => header_params,
1032
+ :query_params => query_params,
1033
+ :form_params => form_params,
1034
+ :body => post_body,
1035
+ :auth_names => auth_names,
1036
+ :return_type => 'UserQueue')
1037
+ if @api_client.config.debugging
1038
+ @api_client.config.logger.debug "API called: UsersApi#patch_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1039
+ end
1040
+ return data, status_code, headers
1041
+ end
1042
+
1043
+ # Join or unjoin a queue for a user
1044
+ #
1045
+ # @param queue_id Queue ID
1046
+ # @param user_id User ID
1047
+ # @param [Hash] opts the optional parameters
1048
+ # @option opts [UserQueue] :body Queue Member
1049
+ # @return [UserQueue]
1050
+ def patch_queue(queue_id, user_id, opts = {})
1051
+ data, status_code, headers = patch_queue_with_http_info(queue_id, user_id, opts)
1052
+ return data
1053
+ end
1054
+
1055
+ # Join or unjoin a queue for a user
1056
+ #
1057
+ # @param queue_id Queue ID
1058
+ # @param user_id User ID
1059
+ # @param [Hash] opts the optional parameters
1060
+ # @option opts [UserQueue] :body Queue Member
1061
+ # @return [Array<(UserQueue, Fixnum, Hash)>] UserQueue data, response status code and response headers
1062
+ def patch_queue_with_http_info(queue_id, user_id, opts = {})
1063
+ if @api_client.config.debugging
1064
+ @api_client.config.logger.debug "Calling API: UsersApi#patch_queue ..."
1065
+ end
1066
+
1067
+ # verify the required parameter 'queue_id' is set
1068
+ fail "Missing the required parameter 'queue_id' when calling patch_queue" if queue_id.nil?
1069
+
1070
+ # verify the required parameter 'user_id' is set
1071
+ fail "Missing the required parameter 'user_id' when calling patch_queue" if user_id.nil?
1072
+
1073
+ # resource path
1074
+ path = "/api/v1/users/{userId}/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
1075
+
1076
+ # query parameters
1077
+ query_params = {}
1078
+
1079
+ # header parameters
1080
+ header_params = {}
1081
+
1082
+ # HTTP header 'Accept' (if needed)
1083
+ _header_accept = ['application/json']
1084
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1085
+
1086
+ # HTTP header 'Content-Type'
1087
+ _header_content_type = ['application/json']
1088
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1089
+
1090
+ # form parameters
1091
+ form_params = {}
1092
+
1093
+ # http body (model)
1094
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1095
+
1096
+
1097
+ auth_names = ['PureCloud Auth']
1098
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
1099
+ :header_params => header_params,
1100
+ :query_params => query_params,
1101
+ :form_params => form_params,
1102
+ :body => post_body,
1103
+ :auth_names => auth_names,
1104
+ :return_type => 'UserQueue')
1105
+ if @api_client.config.debugging
1106
+ @api_client.config.logger.debug "API called: UsersApi#patch_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1107
+ end
1108
+ return data, status_code, headers
1109
+ end
1110
+
1111
+ # List roles for user
1112
+ #
1113
+ # @param user_id User ID
1114
+ # @param [Hash] opts the optional parameters
1115
+ # @return [Array<DomainOrganizationRole>]
1116
+ def get_roles(user_id, opts = {})
1117
+ data, status_code, headers = get_roles_with_http_info(user_id, opts)
1118
+ return data
1119
+ end
1120
+
1121
+ # List roles for user
1122
+ #
1123
+ # @param user_id User ID
1124
+ # @param [Hash] opts the optional parameters
1125
+ # @return [Array<(Array<DomainOrganizationRole>, Fixnum, Hash)>] Array<DomainOrganizationRole> data, response status code and response headers
1126
+ def get_roles_with_http_info(user_id, opts = {})
1127
+ if @api_client.config.debugging
1128
+ @api_client.config.logger.debug "Calling API: UsersApi#get_roles ..."
1129
+ end
1130
+
1131
+ # verify the required parameter 'user_id' is set
1132
+ fail "Missing the required parameter 'user_id' when calling get_roles" if user_id.nil?
1133
+
1134
+ # resource path
1135
+ path = "/api/v1/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1136
+
1137
+ # query parameters
1138
+ query_params = {}
1139
+
1140
+ # header parameters
1141
+ header_params = {}
1142
+
1143
+ # HTTP header 'Accept' (if needed)
1144
+ _header_accept = ['application/json']
1145
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1146
+
1147
+ # HTTP header 'Content-Type'
1148
+ _header_content_type = ['application/json']
1149
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1150
+
1151
+ # form parameters
1152
+ form_params = {}
1153
+
1154
+ # http body (model)
1155
+ post_body = nil
1156
+
1157
+
1158
+ auth_names = ['PureCloud Auth']
1159
+ data, status_code, headers = @api_client.call_api(:GET, path,
1160
+ :header_params => header_params,
1161
+ :query_params => query_params,
1162
+ :form_params => form_params,
1163
+ :body => post_body,
1164
+ :auth_names => auth_names,
1165
+ :return_type => 'Array<DomainOrganizationRole>')
1166
+ if @api_client.config.debugging
1167
+ @api_client.config.logger.debug "API called: UsersApi#get_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1168
+ end
1169
+ return data, status_code, headers
1170
+ end
1171
+
1172
+ # Fetch the routing status of a user
1173
+ #
1174
+ # @param user_id User ID
1175
+ # @param [Hash] opts the optional parameters
1176
+ # @return [RoutingStatus]
1177
+ def get_routingstatus(user_id, opts = {})
1178
+ data, status_code, headers = get_routingstatus_with_http_info(user_id, opts)
1179
+ return data
1180
+ end
1181
+
1182
+ # Fetch the routing status of a user
1183
+ #
1184
+ # @param user_id User ID
1185
+ # @param [Hash] opts the optional parameters
1186
+ # @return [Array<(RoutingStatus, Fixnum, Hash)>] RoutingStatus data, response status code and response headers
1187
+ def get_routingstatus_with_http_info(user_id, opts = {})
1188
+ if @api_client.config.debugging
1189
+ @api_client.config.logger.debug "Calling API: UsersApi#get_routingstatus ..."
1190
+ end
1191
+
1192
+ # verify the required parameter 'user_id' is set
1193
+ fail "Missing the required parameter 'user_id' when calling get_routingstatus" if user_id.nil?
1194
+
1195
+ # resource path
1196
+ path = "/api/v1/users/{userId}/routingstatus".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1197
+
1198
+ # query parameters
1199
+ query_params = {}
1200
+
1201
+ # header parameters
1202
+ header_params = {}
1203
+
1204
+ # HTTP header 'Accept' (if needed)
1205
+ _header_accept = ['application/json']
1206
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1207
+
1208
+ # HTTP header 'Content-Type'
1209
+ _header_content_type = ['application/json']
1210
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1211
+
1212
+ # form parameters
1213
+ form_params = {}
1214
+
1215
+ # http body (model)
1216
+ post_body = nil
1217
+
1218
+
1219
+ auth_names = ['PureCloud Auth']
1220
+ data, status_code, headers = @api_client.call_api(:GET, path,
1221
+ :header_params => header_params,
1222
+ :query_params => query_params,
1223
+ :form_params => form_params,
1224
+ :body => post_body,
1225
+ :auth_names => auth_names,
1226
+ :return_type => 'RoutingStatus')
1227
+ if @api_client.config.debugging
1228
+ @api_client.config.logger.debug "API called: UsersApi#get_routingstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1229
+ end
1230
+ return data, status_code, headers
1231
+ end
1232
+
1233
+ # Update the routing status of a user
1234
+ #
1235
+ # @param user_id User ID
1236
+ # @param [Hash] opts the optional parameters
1237
+ # @option opts [RoutingStatus] :body Routing Status
1238
+ # @return [RoutingStatus]
1239
+ def put_routingstatus(user_id, opts = {})
1240
+ data, status_code, headers = put_routingstatus_with_http_info(user_id, opts)
1241
+ return data
1242
+ end
1243
+
1244
+ # Update the routing status of a user
1245
+ #
1246
+ # @param user_id User ID
1247
+ # @param [Hash] opts the optional parameters
1248
+ # @option opts [RoutingStatus] :body Routing Status
1249
+ # @return [Array<(RoutingStatus, Fixnum, Hash)>] RoutingStatus data, response status code and response headers
1250
+ def put_routingstatus_with_http_info(user_id, opts = {})
1251
+ if @api_client.config.debugging
1252
+ @api_client.config.logger.debug "Calling API: UsersApi#put_routingstatus ..."
1253
+ end
1254
+
1255
+ # verify the required parameter 'user_id' is set
1256
+ fail "Missing the required parameter 'user_id' when calling put_routingstatus" if user_id.nil?
1257
+
1258
+ # resource path
1259
+ path = "/api/v1/users/{userId}/routingstatus".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1260
+
1261
+ # query parameters
1262
+ query_params = {}
1263
+
1264
+ # header parameters
1265
+ header_params = {}
1266
+
1267
+ # HTTP header 'Accept' (if needed)
1268
+ _header_accept = ['application/json']
1269
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1270
+
1271
+ # HTTP header 'Content-Type'
1272
+ _header_content_type = ['application/json']
1273
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1274
+
1275
+ # form parameters
1276
+ form_params = {}
1277
+
1278
+ # http body (model)
1279
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1280
+
1281
+
1282
+ auth_names = ['PureCloud Auth']
1283
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1284
+ :header_params => header_params,
1285
+ :query_params => query_params,
1286
+ :form_params => form_params,
1287
+ :body => post_body,
1288
+ :auth_names => auth_names,
1289
+ :return_type => 'RoutingStatus')
1290
+ if @api_client.config.debugging
1291
+ @api_client.config.logger.debug "API called: UsersApi#put_routingstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1292
+ end
1293
+ return data, status_code, headers
1294
+ end
1295
+
1296
+ # List skills for user
1297
+ #
1298
+ # @param user_id User ID
1299
+ # @param [Hash] opts the optional parameters
1300
+ # @return [UserSkillEntityListing]
1301
+ def get_skills(user_id, opts = {})
1302
+ data, status_code, headers = get_skills_with_http_info(user_id, opts)
1303
+ return data
1304
+ end
1305
+
1306
+ # List skills for user
1307
+ #
1308
+ # @param user_id User ID
1309
+ # @param [Hash] opts the optional parameters
1310
+ # @return [Array<(UserSkillEntityListing, Fixnum, Hash)>] UserSkillEntityListing data, response status code and response headers
1311
+ def get_skills_with_http_info(user_id, opts = {})
1312
+ if @api_client.config.debugging
1313
+ @api_client.config.logger.debug "Calling API: UsersApi#get_skills ..."
1314
+ end
1315
+
1316
+ # verify the required parameter 'user_id' is set
1317
+ fail "Missing the required parameter 'user_id' when calling get_skills" if user_id.nil?
1318
+
1319
+ # resource path
1320
+ path = "/api/v1/users/{userId}/skills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1321
+
1322
+ # query parameters
1323
+ query_params = {}
1324
+
1325
+ # header parameters
1326
+ header_params = {}
1327
+
1328
+ # HTTP header 'Accept' (if needed)
1329
+ _header_accept = ['application/json']
1330
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1331
+
1332
+ # HTTP header 'Content-Type'
1333
+ _header_content_type = ['application/json']
1334
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1335
+
1336
+ # form parameters
1337
+ form_params = {}
1338
+
1339
+ # http body (model)
1340
+ post_body = nil
1341
+
1342
+
1343
+ auth_names = ['PureCloud Auth']
1344
+ data, status_code, headers = @api_client.call_api(:GET, path,
1345
+ :header_params => header_params,
1346
+ :query_params => query_params,
1347
+ :form_params => form_params,
1348
+ :body => post_body,
1349
+ :auth_names => auth_names,
1350
+ :return_type => 'UserSkillEntityListing')
1351
+ if @api_client.config.debugging
1352
+ @api_client.config.logger.debug "API called: UsersApi#get_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1353
+ end
1354
+ return data, status_code, headers
1355
+ end
1356
+ end
1357
+ end
1358
+
1359
+
1360
+
1361
+