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,1135 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class AuthorizationApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Retrieve a list of all licenses defined in the system
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
+ # @return [DomainLicenseEntityListing]
17
+ def get_licenses(opts = {})
18
+ data, status_code, headers = get_licenses_with_http_info(opts)
19
+ return data
20
+ end
21
+
22
+ # Retrieve a list of all licenses defined in the system
23
+ #
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [Integer] :page_size Page size
26
+ # @option opts [Integer] :page_number Page number
27
+ # @return [Array<(DomainLicenseEntityListing, Fixnum, Hash)>] DomainLicenseEntityListing data, response status code and response headers
28
+ def get_licenses_with_http_info(opts = {})
29
+ if @api_client.config.debugging
30
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#get_licenses ..."
31
+ end
32
+
33
+ # resource path
34
+ path = "/api/v1/authorization/licenses".sub('{format}','json')
35
+
36
+ # query parameters
37
+ query_params = {}
38
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
39
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
40
+
41
+ # header parameters
42
+ header_params = {}
43
+
44
+ # HTTP header 'Accept' (if needed)
45
+ _header_accept = ['application/json']
46
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
47
+
48
+ # HTTP header 'Content-Type'
49
+ _header_content_type = ['application/json']
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
51
+
52
+ # form parameters
53
+ form_params = {}
54
+
55
+ # http body (model)
56
+ post_body = nil
57
+
58
+
59
+ auth_names = ['PureCloud Auth']
60
+ data, status_code, headers = @api_client.call_api(:GET, path,
61
+ :header_params => header_params,
62
+ :query_params => query_params,
63
+ :form_params => form_params,
64
+ :body => post_body,
65
+ :auth_names => auth_names,
66
+ :return_type => 'DomainLicenseEntityListing')
67
+ if @api_client.config.debugging
68
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_licenses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
69
+ end
70
+ return data, status_code, headers
71
+ end
72
+
73
+ # Get all permissions.
74
+ # Retrieve a list of all permission defined in the system.
75
+ # @param [Hash] opts the optional parameters
76
+ # @option opts [Integer] :page_size Page size
77
+ # @option opts [Integer] :page_number Page number
78
+ # @return [PermissionCollectionEntityListing]
79
+ def get_permissions(opts = {})
80
+ data, status_code, headers = get_permissions_with_http_info(opts)
81
+ return data
82
+ end
83
+
84
+ # Get all permissions.
85
+ # Retrieve a list of all permission defined in the system.
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [Integer] :page_size Page size
88
+ # @option opts [Integer] :page_number Page number
89
+ # @return [Array<(PermissionCollectionEntityListing, Fixnum, Hash)>] PermissionCollectionEntityListing data, response status code and response headers
90
+ def get_permissions_with_http_info(opts = {})
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#get_permissions ..."
93
+ end
94
+
95
+ # resource path
96
+ path = "/api/v1/authorization/permissions".sub('{format}','json')
97
+
98
+ # query parameters
99
+ query_params = {}
100
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
101
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
102
+
103
+ # header parameters
104
+ header_params = {}
105
+
106
+ # HTTP header 'Accept' (if needed)
107
+ _header_accept = ['application/json']
108
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
109
+
110
+ # HTTP header 'Content-Type'
111
+ _header_content_type = ['application/json']
112
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
113
+
114
+ # form parameters
115
+ form_params = {}
116
+
117
+ # http body (model)
118
+ post_body = nil
119
+
120
+
121
+ auth_names = ['PureCloud Auth']
122
+ data, status_code, headers = @api_client.call_api(:GET, path,
123
+ :header_params => header_params,
124
+ :query_params => query_params,
125
+ :form_params => form_params,
126
+ :body => post_body,
127
+ :auth_names => auth_names,
128
+ :return_type => 'PermissionCollectionEntityListing')
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
131
+ end
132
+ return data, status_code, headers
133
+ end
134
+
135
+ # Get the list of enabled products
136
+ # Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
137
+ # @param [Hash] opts the optional parameters
138
+ # @return [OrganizationProductEntityListing]
139
+ def get_products(opts = {})
140
+ data, status_code, headers = get_products_with_http_info(opts)
141
+ return data
142
+ end
143
+
144
+ # Get the list of enabled products
145
+ # Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
146
+ # @param [Hash] opts the optional parameters
147
+ # @return [Array<(OrganizationProductEntityListing, Fixnum, Hash)>] OrganizationProductEntityListing data, response status code and response headers
148
+ def get_products_with_http_info(opts = {})
149
+ if @api_client.config.debugging
150
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#get_products ..."
151
+ end
152
+
153
+ # resource path
154
+ path = "/api/v1/authorization/products".sub('{format}','json')
155
+
156
+ # query parameters
157
+ query_params = {}
158
+
159
+ # header parameters
160
+ header_params = {}
161
+
162
+ # HTTP header 'Accept' (if needed)
163
+ _header_accept = ['application/json']
164
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
165
+
166
+ # HTTP header 'Content-Type'
167
+ _header_content_type = ['application/json']
168
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
169
+
170
+ # form parameters
171
+ form_params = {}
172
+
173
+ # http body (model)
174
+ post_body = nil
175
+
176
+
177
+ auth_names = ['PureCloud Auth']
178
+ data, status_code, headers = @api_client.call_api(:GET, path,
179
+ :header_params => header_params,
180
+ :query_params => query_params,
181
+ :form_params => form_params,
182
+ :body => post_body,
183
+ :auth_names => auth_names,
184
+ :return_type => 'OrganizationProductEntityListing')
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
187
+ end
188
+ return data, status_code, headers
189
+ end
190
+
191
+ # Retrieve a list of all roles defined for the organization
192
+ #
193
+ # @param [Hash] opts the optional parameters
194
+ # @option opts [Integer] :page_size The total page size requested
195
+ # @option opts [Integer] :page_number The page number requested
196
+ # @option opts [String] :sort_by variable name requested to sort by
197
+ # @option opts [Array<String>] :expand variable name requested by expand list
198
+ # @option opts [Array<String>] :permission
199
+ # @option opts [BOOLEAN] :user_count
200
+ # @return [OrganizationRoleEntityListing]
201
+ def get_roles(opts = {})
202
+ data, status_code, headers = get_roles_with_http_info(opts)
203
+ return data
204
+ end
205
+
206
+ # Retrieve a list of all roles defined for the organization
207
+ #
208
+ # @param [Hash] opts the optional parameters
209
+ # @option opts [Integer] :page_size The total page size requested
210
+ # @option opts [Integer] :page_number The page number requested
211
+ # @option opts [String] :sort_by variable name requested to sort by
212
+ # @option opts [Array<String>] :expand variable name requested by expand list
213
+ # @option opts [Array<String>] :permission
214
+ # @option opts [BOOLEAN] :user_count
215
+ # @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers
216
+ def get_roles_with_http_info(opts = {})
217
+ if @api_client.config.debugging
218
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#get_roles ..."
219
+ end
220
+
221
+ # resource path
222
+ path = "/api/v1/authorization/roles".sub('{format}','json')
223
+
224
+ # query parameters
225
+ query_params = {}
226
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
227
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
228
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
229
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
230
+ query_params[:'permission'] = @api_client.build_collection_param(opts[:'permission'], :multi) if opts[:'permission']
231
+ query_params[:'userCount'] = opts[:'user_count'] if opts[:'user_count']
232
+
233
+ # header parameters
234
+ header_params = {}
235
+
236
+ # HTTP header 'Accept' (if needed)
237
+ _header_accept = ['application/json']
238
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
239
+
240
+ # HTTP header 'Content-Type'
241
+ _header_content_type = ['application/json']
242
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
243
+
244
+ # form parameters
245
+ form_params = {}
246
+
247
+ # http body (model)
248
+ post_body = nil
249
+
250
+
251
+ auth_names = ['PureCloud Auth']
252
+ data, status_code, headers = @api_client.call_api(:GET, path,
253
+ :header_params => header_params,
254
+ :query_params => query_params,
255
+ :form_params => form_params,
256
+ :body => post_body,
257
+ :auth_names => auth_names,
258
+ :return_type => 'OrganizationRoleEntityListing')
259
+ if @api_client.config.debugging
260
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
261
+ end
262
+ return data, status_code, headers
263
+ end
264
+
265
+ # Create an organization role.
266
+ #
267
+ # @param [Hash] opts the optional parameters
268
+ # @option opts [DomainOrganizationRole] :body
269
+ # @return [DomainOrganizationRole]
270
+ def post_roles(opts = {})
271
+ data, status_code, headers = post_roles_with_http_info(opts)
272
+ return data
273
+ end
274
+
275
+ # Create an organization role.
276
+ #
277
+ # @param [Hash] opts the optional parameters
278
+ # @option opts [DomainOrganizationRole] :body
279
+ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
280
+ def post_roles_with_http_info(opts = {})
281
+ if @api_client.config.debugging
282
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#post_roles ..."
283
+ end
284
+
285
+ # resource path
286
+ path = "/api/v1/authorization/roles".sub('{format}','json')
287
+
288
+ # query parameters
289
+ query_params = {}
290
+
291
+ # header parameters
292
+ header_params = {}
293
+
294
+ # HTTP header 'Accept' (if needed)
295
+ _header_accept = ['application/json']
296
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
297
+
298
+ # HTTP header 'Content-Type'
299
+ _header_content_type = ['application/json']
300
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
301
+
302
+ # form parameters
303
+ form_params = {}
304
+
305
+ # http body (model)
306
+ post_body = @api_client.object_to_http_body(opts[:'body'])
307
+
308
+
309
+ auth_names = ['PureCloud Auth']
310
+ data, status_code, headers = @api_client.call_api(:POST, path,
311
+ :header_params => header_params,
312
+ :query_params => query_params,
313
+ :form_params => form_params,
314
+ :body => post_body,
315
+ :auth_names => auth_names,
316
+ :return_type => 'DomainOrganizationRole')
317
+ if @api_client.config.debugging
318
+ @api_client.config.logger.debug "API called: AuthorizationApi#post_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
319
+ end
320
+ return data, status_code, headers
321
+ end
322
+
323
+ # Restore specified default roles
324
+ #
325
+ # @param [Hash] opts the optional parameters
326
+ # @option opts [Array<DomainOrganizationRole>] :body
327
+ # @return [OrganizationRoleEntityListing]
328
+ def put_roles_default(opts = {})
329
+ data, status_code, headers = put_roles_default_with_http_info(opts)
330
+ return data
331
+ end
332
+
333
+ # Restore specified default roles
334
+ #
335
+ # @param [Hash] opts the optional parameters
336
+ # @option opts [Array<DomainOrganizationRole>] :body
337
+ # @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers
338
+ def put_roles_default_with_http_info(opts = {})
339
+ if @api_client.config.debugging
340
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#put_roles_default ..."
341
+ end
342
+
343
+ # resource path
344
+ path = "/api/v1/authorization/roles/default".sub('{format}','json')
345
+
346
+ # query parameters
347
+ query_params = {}
348
+
349
+ # header parameters
350
+ header_params = {}
351
+
352
+ # HTTP header 'Accept' (if needed)
353
+ _header_accept = ['application/json']
354
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
355
+
356
+ # HTTP header 'Content-Type'
357
+ _header_content_type = ['application/json']
358
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
359
+
360
+ # form parameters
361
+ form_params = {}
362
+
363
+ # http body (model)
364
+ post_body = @api_client.object_to_http_body(opts[:'body'])
365
+
366
+
367
+ auth_names = ['PureCloud Auth']
368
+ data, status_code, headers = @api_client.call_api(:PUT, path,
369
+ :header_params => header_params,
370
+ :query_params => query_params,
371
+ :form_params => form_params,
372
+ :body => post_body,
373
+ :auth_names => auth_names,
374
+ :return_type => 'OrganizationRoleEntityListing')
375
+ if @api_client.config.debugging
376
+ @api_client.config.logger.debug "API called: AuthorizationApi#put_roles_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
377
+ end
378
+ return data, status_code, headers
379
+ end
380
+
381
+ # Restores all default roles
382
+ # This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.
383
+ # @param [Hash] opts the optional parameters
384
+ # @option opts [BOOLEAN] :force Restore default roles
385
+ # @return [OrganizationRoleEntityListing]
386
+ def post_roles_default(opts = {})
387
+ data, status_code, headers = post_roles_default_with_http_info(opts)
388
+ return data
389
+ end
390
+
391
+ # Restores all default roles
392
+ # This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.
393
+ # @param [Hash] opts the optional parameters
394
+ # @option opts [BOOLEAN] :force Restore default roles
395
+ # @return [Array<(OrganizationRoleEntityListing, Fixnum, Hash)>] OrganizationRoleEntityListing data, response status code and response headers
396
+ def post_roles_default_with_http_info(opts = {})
397
+ if @api_client.config.debugging
398
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#post_roles_default ..."
399
+ end
400
+
401
+ # resource path
402
+ path = "/api/v1/authorization/roles/default".sub('{format}','json')
403
+
404
+ # query parameters
405
+ query_params = {}
406
+ query_params[:'force'] = opts[:'force'] if opts[:'force']
407
+
408
+ # header parameters
409
+ header_params = {}
410
+
411
+ # HTTP header 'Accept' (if needed)
412
+ _header_accept = ['application/json']
413
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
414
+
415
+ # HTTP header 'Content-Type'
416
+ _header_content_type = ['application/json']
417
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
418
+
419
+ # form parameters
420
+ form_params = {}
421
+
422
+ # http body (model)
423
+ post_body = nil
424
+
425
+
426
+ auth_names = ['PureCloud Auth']
427
+ data, status_code, headers = @api_client.call_api(:POST, path,
428
+ :header_params => header_params,
429
+ :query_params => query_params,
430
+ :form_params => form_params,
431
+ :body => post_body,
432
+ :auth_names => auth_names,
433
+ :return_type => 'OrganizationRoleEntityListing')
434
+ if @api_client.config.debugging
435
+ @api_client.config.logger.debug "API called: AuthorizationApi#post_roles_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
436
+ end
437
+ return data, status_code, headers
438
+ end
439
+
440
+ # Get an org role to default role comparison comparison
441
+ # Compares any organization role to a default role id and show differences
442
+ # @param left_role_id Left Role ID
443
+ # @param right_role_id Right Role id
444
+ # @param [Hash] opts the optional parameters
445
+ # @return [DomainOrgRoleDifference]
446
+ def get_role_comparedefault(left_role_id, right_role_id, opts = {})
447
+ data, status_code, headers = get_role_comparedefault_with_http_info(left_role_id, right_role_id, opts)
448
+ return data
449
+ end
450
+
451
+ # Get an org role to default role comparison comparison
452
+ # Compares any organization role to a default role id and show differences
453
+ # @param left_role_id Left Role ID
454
+ # @param right_role_id Right Role id
455
+ # @param [Hash] opts the optional parameters
456
+ # @return [Array<(DomainOrgRoleDifference, Fixnum, Hash)>] DomainOrgRoleDifference data, response status code and response headers
457
+ def get_role_comparedefault_with_http_info(left_role_id, right_role_id, opts = {})
458
+ if @api_client.config.debugging
459
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#get_role_comparedefault ..."
460
+ end
461
+
462
+ # verify the required parameter 'left_role_id' is set
463
+ fail "Missing the required parameter 'left_role_id' when calling get_role_comparedefault" if left_role_id.nil?
464
+
465
+ # verify the required parameter 'right_role_id' is set
466
+ fail "Missing the required parameter 'right_role_id' when calling get_role_comparedefault" if right_role_id.nil?
467
+
468
+ # resource path
469
+ path = "/api/v1/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".sub('{format}','json').sub('{' + 'leftRoleId' + '}', left_role_id.to_s).sub('{' + 'rightRoleId' + '}', right_role_id.to_s)
470
+
471
+ # query parameters
472
+ query_params = {}
473
+
474
+ # header parameters
475
+ header_params = {}
476
+
477
+ # HTTP header 'Accept' (if needed)
478
+ _header_accept = ['application/json']
479
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
480
+
481
+ # HTTP header 'Content-Type'
482
+ _header_content_type = ['application/json']
483
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
484
+
485
+ # form parameters
486
+ form_params = {}
487
+
488
+ # http body (model)
489
+ post_body = nil
490
+
491
+
492
+ auth_names = ['PureCloud Auth']
493
+ data, status_code, headers = @api_client.call_api(:GET, path,
494
+ :header_params => header_params,
495
+ :query_params => query_params,
496
+ :form_params => form_params,
497
+ :body => post_body,
498
+ :auth_names => auth_names,
499
+ :return_type => 'DomainOrgRoleDifference')
500
+ if @api_client.config.debugging
501
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_role_comparedefault\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
502
+ end
503
+ return data, status_code, headers
504
+ end
505
+
506
+ # Get an unsaved org role to default role comparison
507
+ # Allows users to compare their existing roles in an unsaved state to its default role
508
+ # @param left_role_id Left Role ID
509
+ # @param right_role_id Right Role id
510
+ # @param [Hash] opts the optional parameters
511
+ # @option opts [DomainOrganizationRole] :body
512
+ # @return [DomainOrgRoleDifference]
513
+ def post_role_comparedefault(left_role_id, right_role_id, opts = {})
514
+ data, status_code, headers = post_role_comparedefault_with_http_info(left_role_id, right_role_id, opts)
515
+ return data
516
+ end
517
+
518
+ # Get an unsaved org role to default role comparison
519
+ # Allows users to compare their existing roles in an unsaved state to its default role
520
+ # @param left_role_id Left Role ID
521
+ # @param right_role_id Right Role id
522
+ # @param [Hash] opts the optional parameters
523
+ # @option opts [DomainOrganizationRole] :body
524
+ # @return [Array<(DomainOrgRoleDifference, Fixnum, Hash)>] DomainOrgRoleDifference data, response status code and response headers
525
+ def post_role_comparedefault_with_http_info(left_role_id, right_role_id, opts = {})
526
+ if @api_client.config.debugging
527
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#post_role_comparedefault ..."
528
+ end
529
+
530
+ # verify the required parameter 'left_role_id' is set
531
+ fail "Missing the required parameter 'left_role_id' when calling post_role_comparedefault" if left_role_id.nil?
532
+
533
+ # verify the required parameter 'right_role_id' is set
534
+ fail "Missing the required parameter 'right_role_id' when calling post_role_comparedefault" if right_role_id.nil?
535
+
536
+ # resource path
537
+ path = "/api/v1/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}".sub('{format}','json').sub('{' + 'leftRoleId' + '}', left_role_id.to_s).sub('{' + 'rightRoleId' + '}', right_role_id.to_s)
538
+
539
+ # query parameters
540
+ query_params = {}
541
+
542
+ # header parameters
543
+ header_params = {}
544
+
545
+ # HTTP header 'Accept' (if needed)
546
+ _header_accept = ['application/json']
547
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
548
+
549
+ # HTTP header 'Content-Type'
550
+ _header_content_type = ['application/json']
551
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
552
+
553
+ # form parameters
554
+ form_params = {}
555
+
556
+ # http body (model)
557
+ post_body = @api_client.object_to_http_body(opts[:'body'])
558
+
559
+
560
+ auth_names = ['PureCloud Auth']
561
+ data, status_code, headers = @api_client.call_api(:POST, path,
562
+ :header_params => header_params,
563
+ :query_params => query_params,
564
+ :form_params => form_params,
565
+ :body => post_body,
566
+ :auth_names => auth_names,
567
+ :return_type => 'DomainOrgRoleDifference')
568
+ if @api_client.config.debugging
569
+ @api_client.config.logger.debug "API called: AuthorizationApi#post_role_comparedefault\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
570
+ end
571
+ return data, status_code, headers
572
+ end
573
+
574
+ # Get a single organization role.
575
+ # Get the organization role specified by its ID.
576
+ # @param role_id Role ID
577
+ # @param [Hash] opts the optional parameters
578
+ # @return [DomainOrganizationRole]
579
+ def get_role(role_id, opts = {})
580
+ data, status_code, headers = get_role_with_http_info(role_id, opts)
581
+ return data
582
+ end
583
+
584
+ # Get a single organization role.
585
+ # Get the organization role specified by its ID.
586
+ # @param role_id Role ID
587
+ # @param [Hash] opts the optional parameters
588
+ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
589
+ def get_role_with_http_info(role_id, opts = {})
590
+ if @api_client.config.debugging
591
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#get_role ..."
592
+ end
593
+
594
+ # verify the required parameter 'role_id' is set
595
+ fail "Missing the required parameter 'role_id' when calling get_role" if role_id.nil?
596
+
597
+ # resource path
598
+ path = "/api/v1/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
599
+
600
+ # query parameters
601
+ query_params = {}
602
+
603
+ # header parameters
604
+ header_params = {}
605
+
606
+ # HTTP header 'Accept' (if needed)
607
+ _header_accept = ['application/json']
608
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
609
+
610
+ # HTTP header 'Content-Type'
611
+ _header_content_type = ['application/json']
612
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
613
+
614
+ # form parameters
615
+ form_params = {}
616
+
617
+ # http body (model)
618
+ post_body = nil
619
+
620
+
621
+ auth_names = ['PureCloud Auth']
622
+ data, status_code, headers = @api_client.call_api(:GET, path,
623
+ :header_params => header_params,
624
+ :query_params => query_params,
625
+ :form_params => form_params,
626
+ :body => post_body,
627
+ :auth_names => auth_names,
628
+ :return_type => 'DomainOrganizationRole')
629
+ if @api_client.config.debugging
630
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
631
+ end
632
+ return data, status_code, headers
633
+ end
634
+
635
+ # Update an organization role.
636
+ # Update
637
+ # @param role_id Role ID
638
+ # @param [Hash] opts the optional parameters
639
+ # @option opts [DomainOrganizationRole] :body
640
+ # @return [DomainOrganizationRole]
641
+ def put_role(role_id, opts = {})
642
+ data, status_code, headers = put_role_with_http_info(role_id, opts)
643
+ return data
644
+ end
645
+
646
+ # Update an organization role.
647
+ # Update
648
+ # @param role_id Role ID
649
+ # @param [Hash] opts the optional parameters
650
+ # @option opts [DomainOrganizationRole] :body
651
+ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
652
+ def put_role_with_http_info(role_id, opts = {})
653
+ if @api_client.config.debugging
654
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#put_role ..."
655
+ end
656
+
657
+ # verify the required parameter 'role_id' is set
658
+ fail "Missing the required parameter 'role_id' when calling put_role" if role_id.nil?
659
+
660
+ # resource path
661
+ path = "/api/v1/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
662
+
663
+ # query parameters
664
+ query_params = {}
665
+
666
+ # header parameters
667
+ header_params = {}
668
+
669
+ # HTTP header 'Accept' (if needed)
670
+ _header_accept = ['application/json']
671
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
672
+
673
+ # HTTP header 'Content-Type'
674
+ _header_content_type = ['application/json']
675
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
676
+
677
+ # form parameters
678
+ form_params = {}
679
+
680
+ # http body (model)
681
+ post_body = @api_client.object_to_http_body(opts[:'body'])
682
+
683
+
684
+ auth_names = ['PureCloud Auth']
685
+ data, status_code, headers = @api_client.call_api(:PUT, path,
686
+ :header_params => header_params,
687
+ :query_params => query_params,
688
+ :form_params => form_params,
689
+ :body => post_body,
690
+ :auth_names => auth_names,
691
+ :return_type => 'DomainOrganizationRole')
692
+ if @api_client.config.debugging
693
+ @api_client.config.logger.debug "API called: AuthorizationApi#put_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
694
+ end
695
+ return data, status_code, headers
696
+ end
697
+
698
+ # Delete an organization role.
699
+ #
700
+ # @param role_id Role ID
701
+ # @param [Hash] opts the optional parameters
702
+ # @return [nil]
703
+ def delete_role(role_id, opts = {})
704
+ delete_role_with_http_info(role_id, opts)
705
+ return nil
706
+ end
707
+
708
+ # Delete an organization role.
709
+ #
710
+ # @param role_id Role ID
711
+ # @param [Hash] opts the optional parameters
712
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
713
+ def delete_role_with_http_info(role_id, opts = {})
714
+ if @api_client.config.debugging
715
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#delete_role ..."
716
+ end
717
+
718
+ # verify the required parameter 'role_id' is set
719
+ fail "Missing the required parameter 'role_id' when calling delete_role" if role_id.nil?
720
+
721
+ # resource path
722
+ path = "/api/v1/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
723
+
724
+ # query parameters
725
+ query_params = {}
726
+
727
+ # header parameters
728
+ header_params = {}
729
+
730
+ # HTTP header 'Accept' (if needed)
731
+ _header_accept = ['application/json']
732
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
733
+
734
+ # HTTP header 'Content-Type'
735
+ _header_content_type = ['application/json']
736
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
737
+
738
+ # form parameters
739
+ form_params = {}
740
+
741
+ # http body (model)
742
+ post_body = nil
743
+
744
+
745
+ auth_names = ['PureCloud Auth']
746
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
747
+ :header_params => header_params,
748
+ :query_params => query_params,
749
+ :form_params => form_params,
750
+ :body => post_body,
751
+ :auth_names => auth_names)
752
+ if @api_client.config.debugging
753
+ @api_client.config.logger.debug "API called: AuthorizationApi#delete_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
754
+ end
755
+ return data, status_code, headers
756
+ end
757
+
758
+ # Patch Organization Role for needsUpdate Field
759
+ # Patch Organization Role for needsUpdate Field
760
+ # @param role_id Role ID
761
+ # @param [Hash] opts the optional parameters
762
+ # @option opts [DomainOrganizationRole] :body
763
+ # @return [DomainOrganizationRole]
764
+ def patch_role(role_id, opts = {})
765
+ data, status_code, headers = patch_role_with_http_info(role_id, opts)
766
+ return data
767
+ end
768
+
769
+ # Patch Organization Role for needsUpdate Field
770
+ # Patch Organization Role for needsUpdate Field
771
+ # @param role_id Role ID
772
+ # @param [Hash] opts the optional parameters
773
+ # @option opts [DomainOrganizationRole] :body
774
+ # @return [Array<(DomainOrganizationRole, Fixnum, Hash)>] DomainOrganizationRole data, response status code and response headers
775
+ def patch_role_with_http_info(role_id, opts = {})
776
+ if @api_client.config.debugging
777
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#patch_role ..."
778
+ end
779
+
780
+ # verify the required parameter 'role_id' is set
781
+ fail "Missing the required parameter 'role_id' when calling patch_role" if role_id.nil?
782
+
783
+ # resource path
784
+ path = "/api/v1/authorization/roles/{roleId}".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
785
+
786
+ # query parameters
787
+ query_params = {}
788
+
789
+ # header parameters
790
+ header_params = {}
791
+
792
+ # HTTP header 'Accept' (if needed)
793
+ _header_accept = ['application/json']
794
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
795
+
796
+ # HTTP header 'Content-Type'
797
+ _header_content_type = ['application/json']
798
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
799
+
800
+ # form parameters
801
+ form_params = {}
802
+
803
+ # http body (model)
804
+ post_body = @api_client.object_to_http_body(opts[:'body'])
805
+
806
+
807
+ auth_names = ['PureCloud Auth']
808
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
809
+ :header_params => header_params,
810
+ :query_params => query_params,
811
+ :form_params => form_params,
812
+ :body => post_body,
813
+ :auth_names => auth_names,
814
+ :return_type => 'DomainOrganizationRole')
815
+ if @api_client.config.debugging
816
+ @api_client.config.logger.debug "API called: AuthorizationApi#patch_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
817
+ end
818
+ return data, status_code, headers
819
+ end
820
+
821
+ # Sets the users for the role
822
+ #
823
+ # @param role_id Role ID
824
+ # @param [Hash] opts the optional parameters
825
+ # @option opts [Array<String>] :body
826
+ # @return [Array<String>]
827
+ def put_role_users_add(role_id, opts = {})
828
+ data, status_code, headers = put_role_users_add_with_http_info(role_id, opts)
829
+ return data
830
+ end
831
+
832
+ # Sets the users for the role
833
+ #
834
+ # @param role_id Role ID
835
+ # @param [Hash] opts the optional parameters
836
+ # @option opts [Array<String>] :body
837
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
838
+ def put_role_users_add_with_http_info(role_id, opts = {})
839
+ if @api_client.config.debugging
840
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#put_role_users_add ..."
841
+ end
842
+
843
+ # verify the required parameter 'role_id' is set
844
+ fail "Missing the required parameter 'role_id' when calling put_role_users_add" if role_id.nil?
845
+
846
+ # resource path
847
+ path = "/api/v1/authorization/roles/{roleId}/users/add".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
848
+
849
+ # query parameters
850
+ query_params = {}
851
+
852
+ # header parameters
853
+ header_params = {}
854
+
855
+ # HTTP header 'Accept' (if needed)
856
+ _header_accept = ['application/json']
857
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
858
+
859
+ # HTTP header 'Content-Type'
860
+ _header_content_type = ['application/json']
861
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
862
+
863
+ # form parameters
864
+ form_params = {}
865
+
866
+ # http body (model)
867
+ post_body = @api_client.object_to_http_body(opts[:'body'])
868
+
869
+
870
+ auth_names = ['PureCloud Auth']
871
+ data, status_code, headers = @api_client.call_api(:PUT, path,
872
+ :header_params => header_params,
873
+ :query_params => query_params,
874
+ :form_params => form_params,
875
+ :body => post_body,
876
+ :auth_names => auth_names,
877
+ :return_type => 'Array<String>')
878
+ if @api_client.config.debugging
879
+ @api_client.config.logger.debug "API called: AuthorizationApi#put_role_users_add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
880
+ end
881
+ return data, status_code, headers
882
+ end
883
+
884
+ # Removes the users from the role
885
+ #
886
+ # @param role_id Role ID
887
+ # @param [Hash] opts the optional parameters
888
+ # @option opts [Array<String>] :body
889
+ # @return [Array<String>]
890
+ def put_role_users_remove(role_id, opts = {})
891
+ data, status_code, headers = put_role_users_remove_with_http_info(role_id, opts)
892
+ return data
893
+ end
894
+
895
+ # Removes the users from the role
896
+ #
897
+ # @param role_id Role ID
898
+ # @param [Hash] opts the optional parameters
899
+ # @option opts [Array<String>] :body
900
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
901
+ def put_role_users_remove_with_http_info(role_id, opts = {})
902
+ if @api_client.config.debugging
903
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#put_role_users_remove ..."
904
+ end
905
+
906
+ # verify the required parameter 'role_id' is set
907
+ fail "Missing the required parameter 'role_id' when calling put_role_users_remove" if role_id.nil?
908
+
909
+ # resource path
910
+ path = "/api/v1/authorization/roles/{roleId}/users/remove".sub('{format}','json').sub('{' + 'roleId' + '}', role_id.to_s)
911
+
912
+ # query parameters
913
+ query_params = {}
914
+
915
+ # header parameters
916
+ header_params = {}
917
+
918
+ # HTTP header 'Accept' (if needed)
919
+ _header_accept = ['application/json']
920
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
921
+
922
+ # HTTP header 'Content-Type'
923
+ _header_content_type = ['application/json']
924
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
925
+
926
+ # form parameters
927
+ form_params = {}
928
+
929
+ # http body (model)
930
+ post_body = @api_client.object_to_http_body(opts[:'body'])
931
+
932
+
933
+ auth_names = ['PureCloud Auth']
934
+ data, status_code, headers = @api_client.call_api(:PUT, path,
935
+ :header_params => header_params,
936
+ :query_params => query_params,
937
+ :form_params => form_params,
938
+ :body => post_body,
939
+ :auth_names => auth_names,
940
+ :return_type => 'Array<String>')
941
+ if @api_client.config.debugging
942
+ @api_client.config.logger.debug "API called: AuthorizationApi#put_role_users_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
943
+ end
944
+ return data, status_code, headers
945
+ end
946
+
947
+ # Get the list of roles for a user.
948
+ #
949
+ # @param user_id User ID
950
+ # @param [Hash] opts the optional parameters
951
+ # @return [UserAuthorization]
952
+ def get_user_roles(user_id, opts = {})
953
+ data, status_code, headers = get_user_roles_with_http_info(user_id, opts)
954
+ return data
955
+ end
956
+
957
+ # Get the list of roles for a user.
958
+ #
959
+ # @param user_id User ID
960
+ # @param [Hash] opts the optional parameters
961
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
962
+ def get_user_roles_with_http_info(user_id, opts = {})
963
+ if @api_client.config.debugging
964
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#get_user_roles ..."
965
+ end
966
+
967
+ # verify the required parameter 'user_id' is set
968
+ fail "Missing the required parameter 'user_id' when calling get_user_roles" if user_id.nil?
969
+
970
+ # resource path
971
+ path = "/api/v1/authorization/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
972
+
973
+ # query parameters
974
+ query_params = {}
975
+
976
+ # header parameters
977
+ header_params = {}
978
+
979
+ # HTTP header 'Accept' (if needed)
980
+ _header_accept = ['application/json']
981
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
982
+
983
+ # HTTP header 'Content-Type'
984
+ _header_content_type = ['application/json']
985
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
986
+
987
+ # form parameters
988
+ form_params = {}
989
+
990
+ # http body (model)
991
+ post_body = nil
992
+
993
+
994
+ auth_names = ['PureCloud Auth']
995
+ data, status_code, headers = @api_client.call_api(:GET, path,
996
+ :header_params => header_params,
997
+ :query_params => query_params,
998
+ :form_params => form_params,
999
+ :body => post_body,
1000
+ :auth_names => auth_names,
1001
+ :return_type => 'UserAuthorization')
1002
+ if @api_client.config.debugging
1003
+ @api_client.config.logger.debug "API called: AuthorizationApi#get_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1004
+ end
1005
+ return data, status_code, headers
1006
+ end
1007
+
1008
+ # Sets the user&#39;s roles
1009
+ #
1010
+ # @param user_id User ID
1011
+ # @param [Hash] opts the optional parameters
1012
+ # @option opts [Array<String>] :body
1013
+ # @return [Array<String>]
1014
+ def put_user_roles(user_id, opts = {})
1015
+ data, status_code, headers = put_user_roles_with_http_info(user_id, opts)
1016
+ return data
1017
+ end
1018
+
1019
+ # Sets the user&#39;s roles
1020
+ #
1021
+ # @param user_id User ID
1022
+ # @param [Hash] opts the optional parameters
1023
+ # @option opts [Array<String>] :body
1024
+ # @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
1025
+ def put_user_roles_with_http_info(user_id, opts = {})
1026
+ if @api_client.config.debugging
1027
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#put_user_roles ..."
1028
+ end
1029
+
1030
+ # verify the required parameter 'user_id' is set
1031
+ fail "Missing the required parameter 'user_id' when calling put_user_roles" if user_id.nil?
1032
+
1033
+ # resource path
1034
+ path = "/api/v1/authorization/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1035
+
1036
+ # query parameters
1037
+ query_params = {}
1038
+
1039
+ # header parameters
1040
+ header_params = {}
1041
+
1042
+ # HTTP header 'Accept' (if needed)
1043
+ _header_accept = ['application/json']
1044
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1045
+
1046
+ # HTTP header 'Content-Type'
1047
+ _header_content_type = ['application/json']
1048
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1049
+
1050
+ # form parameters
1051
+ form_params = {}
1052
+
1053
+ # http body (model)
1054
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1055
+
1056
+
1057
+ auth_names = ['PureCloud Auth']
1058
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1059
+ :header_params => header_params,
1060
+ :query_params => query_params,
1061
+ :form_params => form_params,
1062
+ :body => post_body,
1063
+ :auth_names => auth_names,
1064
+ :return_type => 'Array<String>')
1065
+ if @api_client.config.debugging
1066
+ @api_client.config.logger.debug "API called: AuthorizationApi#put_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1067
+ end
1068
+ return data, status_code, headers
1069
+ end
1070
+
1071
+ # Removes all the roles from the user.
1072
+ #
1073
+ # @param user_id User ID
1074
+ # @param [Hash] opts the optional parameters
1075
+ # @return [nil]
1076
+ def delete_user_roles(user_id, opts = {})
1077
+ delete_user_roles_with_http_info(user_id, opts)
1078
+ return nil
1079
+ end
1080
+
1081
+ # Removes all the roles from the user.
1082
+ #
1083
+ # @param user_id User ID
1084
+ # @param [Hash] opts the optional parameters
1085
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1086
+ def delete_user_roles_with_http_info(user_id, opts = {})
1087
+ if @api_client.config.debugging
1088
+ @api_client.config.logger.debug "Calling API: AuthorizationApi#delete_user_roles ..."
1089
+ end
1090
+
1091
+ # verify the required parameter 'user_id' is set
1092
+ fail "Missing the required parameter 'user_id' when calling delete_user_roles" if user_id.nil?
1093
+
1094
+ # resource path
1095
+ path = "/api/v1/authorization/users/{userId}/roles".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
1096
+
1097
+ # query parameters
1098
+ query_params = {}
1099
+
1100
+ # header parameters
1101
+ header_params = {}
1102
+
1103
+ # HTTP header 'Accept' (if needed)
1104
+ _header_accept = ['application/json']
1105
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1106
+
1107
+ # HTTP header 'Content-Type'
1108
+ _header_content_type = ['application/json']
1109
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1110
+
1111
+ # form parameters
1112
+ form_params = {}
1113
+
1114
+ # http body (model)
1115
+ post_body = nil
1116
+
1117
+
1118
+ auth_names = ['PureCloud Auth']
1119
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1120
+ :header_params => header_params,
1121
+ :query_params => query_params,
1122
+ :form_params => form_params,
1123
+ :body => post_body,
1124
+ :auth_names => auth_names)
1125
+ if @api_client.config.debugging
1126
+ @api_client.config.logger.debug "API called: AuthorizationApi#delete_user_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1127
+ end
1128
+ return data, status_code, headers
1129
+ end
1130
+ end
1131
+ end
1132
+
1133
+
1134
+
1135
+