purecloud 0.0.0

Sign up to get free protection for your applications and to get access to all the features.
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,2457 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class ContentManagementApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Query audits
12
+ #
13
+ # @param body Allows for a filtered query returning facet information
14
+ # @param [Hash] opts the optional parameters
15
+ # @return [QueryResults]
16
+ def post_contentmanagement_auditquery(body, opts = {})
17
+ data, status_code, headers = post_contentmanagement_auditquery_with_http_info(body, opts)
18
+ return data
19
+ end
20
+
21
+ # Query audits
22
+ #
23
+ # @param body Allows for a filtered query returning facet information
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [Array<(QueryResults, Fixnum, Hash)>] QueryResults data, response status code and response headers
26
+ def post_contentmanagement_auditquery_with_http_info(body, opts = {})
27
+ if @api_client.config.debugging
28
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_auditquery ..."
29
+ end
30
+
31
+ # verify the required parameter 'body' is set
32
+ fail "Missing the required parameter 'body' when calling post_contentmanagement_auditquery" if body.nil?
33
+
34
+ # resource path
35
+ path = "/api/v1/contentmanagement/auditquery".sub('{format}','json')
36
+
37
+ # query parameters
38
+ query_params = {}
39
+
40
+ # header parameters
41
+ header_params = {}
42
+
43
+ # HTTP header 'Accept' (if needed)
44
+ _header_accept = ['application/json']
45
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
46
+
47
+ # HTTP header 'Content-Type'
48
+ _header_content_type = ['application/json']
49
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
50
+
51
+ # form parameters
52
+ form_params = {}
53
+
54
+ # http body (model)
55
+ post_body = @api_client.object_to_http_body(body)
56
+
57
+
58
+ auth_names = ['PureCloud Auth']
59
+ data, status_code, headers = @api_client.call_api(:POST, path,
60
+ :header_params => header_params,
61
+ :query_params => query_params,
62
+ :form_params => form_params,
63
+ :body => post_body,
64
+ :auth_names => auth_names,
65
+ :return_type => 'QueryResults')
66
+ if @api_client.config.debugging
67
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_auditquery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
68
+ end
69
+ return data, status_code, headers
70
+ end
71
+
72
+ # Get a list of documents.
73
+ #
74
+ # @param workspace_id Workspace ID
75
+ # @param [Hash] opts the optional parameters
76
+ # @option opts [String] :name Name
77
+ # @option opts [String] :expand Expand some document fields
78
+ # @option opts [Integer] :page_size Page size
79
+ # @option opts [Integer] :page_number Page number
80
+ # @option opts [String] :sort_by name or dateCreated
81
+ # @option opts [String] :sort_order ascending or descending
82
+ # @return [DocumentEntityListing]
83
+ def get_contentmanagement_documents(workspace_id, opts = {})
84
+ data, status_code, headers = get_contentmanagement_documents_with_http_info(workspace_id, opts)
85
+ return data
86
+ end
87
+
88
+ # Get a list of documents.
89
+ #
90
+ # @param workspace_id Workspace ID
91
+ # @param [Hash] opts the optional parameters
92
+ # @option opts [String] :name Name
93
+ # @option opts [String] :expand Expand some document fields
94
+ # @option opts [Integer] :page_size Page size
95
+ # @option opts [Integer] :page_number Page number
96
+ # @option opts [String] :sort_by name or dateCreated
97
+ # @option opts [String] :sort_order ascending or descending
98
+ # @return [Array<(DocumentEntityListing, Fixnum, Hash)>] DocumentEntityListing data, response status code and response headers
99
+ def get_contentmanagement_documents_with_http_info(workspace_id, opts = {})
100
+ if @api_client.config.debugging
101
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_documents ..."
102
+ end
103
+
104
+ # verify the required parameter 'workspace_id' is set
105
+ fail "Missing the required parameter 'workspace_id' when calling get_contentmanagement_documents" if workspace_id.nil?
106
+
107
+ if opts[:'expand'] && !['acl', 'workspace'].include?(opts[:'expand'])
108
+ fail 'invalid value for "expand", must be one of acl, workspace'
109
+ end
110
+
111
+ # resource path
112
+ path = "/api/v1/contentmanagement/documents".sub('{format}','json')
113
+
114
+ # query parameters
115
+ query_params = {}
116
+ query_params[:'workspaceId'] = workspace_id
117
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
118
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
119
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
120
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
121
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
122
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
123
+
124
+ # header parameters
125
+ header_params = {}
126
+
127
+ # HTTP header 'Accept' (if needed)
128
+ _header_accept = ['application/json']
129
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
130
+
131
+ # HTTP header 'Content-Type'
132
+ _header_content_type = ['application/json']
133
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
134
+
135
+ # form parameters
136
+ form_params = {}
137
+
138
+ # http body (model)
139
+ post_body = nil
140
+
141
+
142
+ auth_names = ['PureCloud Auth']
143
+ data, status_code, headers = @api_client.call_api(:GET, path,
144
+ :header_params => header_params,
145
+ :query_params => query_params,
146
+ :form_params => form_params,
147
+ :body => post_body,
148
+ :auth_names => auth_names,
149
+ :return_type => 'DocumentEntityListing')
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Add a document.
157
+ #
158
+ # @param [Hash] opts the optional parameters
159
+ # @option opts [DocumentUpload] :body Document
160
+ # @option opts [String] :copy_source Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.
161
+ # @option opts [String] :move_source Move a document to a new workspace. Provide a document ID as the move source.
162
+ # @option opts [BOOLEAN] :override Override any lock on the source document
163
+ # @return [Document]
164
+ def post_contentmanagement_documents(opts = {})
165
+ data, status_code, headers = post_contentmanagement_documents_with_http_info(opts)
166
+ return data
167
+ end
168
+
169
+ # Add a document.
170
+ #
171
+ # @param [Hash] opts the optional parameters
172
+ # @option opts [DocumentUpload] :body Document
173
+ # @option opts [String] :copy_source Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.
174
+ # @option opts [String] :move_source Move a document to a new workspace. Provide a document ID as the move source.
175
+ # @option opts [BOOLEAN] :override Override any lock on the source document
176
+ # @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
177
+ def post_contentmanagement_documents_with_http_info(opts = {})
178
+ if @api_client.config.debugging
179
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_documents ..."
180
+ end
181
+
182
+ # resource path
183
+ path = "/api/v1/contentmanagement/documents".sub('{format}','json')
184
+
185
+ # query parameters
186
+ query_params = {}
187
+ query_params[:'copySource'] = opts[:'copy_source'] if opts[:'copy_source']
188
+ query_params[:'moveSource'] = opts[:'move_source'] if opts[:'move_source']
189
+ query_params[:'override'] = opts[:'override'] if opts[:'override']
190
+
191
+ # header parameters
192
+ header_params = {}
193
+
194
+ # HTTP header 'Accept' (if needed)
195
+ _header_accept = ['application/json']
196
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
197
+
198
+ # HTTP header 'Content-Type'
199
+ _header_content_type = ['application/json']
200
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
201
+
202
+ # form parameters
203
+ form_params = {}
204
+
205
+ # http body (model)
206
+ post_body = @api_client.object_to_http_body(opts[:'body'])
207
+
208
+
209
+ auth_names = ['PureCloud Auth']
210
+ data, status_code, headers = @api_client.call_api(:POST, path,
211
+ :header_params => header_params,
212
+ :query_params => query_params,
213
+ :form_params => form_params,
214
+ :body => post_body,
215
+ :auth_names => auth_names,
216
+ :return_type => 'Document')
217
+ if @api_client.config.debugging
218
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
219
+ end
220
+ return data, status_code, headers
221
+ end
222
+
223
+ # Get a document.
224
+ #
225
+ # @param document_id Document ID
226
+ # @param [Hash] opts the optional parameters
227
+ # @option opts [String] :expand Expand some document fields
228
+ # @return [Document]
229
+ def get_contentmanagement_document(document_id, opts = {})
230
+ data, status_code, headers = get_contentmanagement_document_with_http_info(document_id, opts)
231
+ return data
232
+ end
233
+
234
+ # Get a document.
235
+ #
236
+ # @param document_id Document ID
237
+ # @param [Hash] opts the optional parameters
238
+ # @option opts [String] :expand Expand some document fields
239
+ # @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
240
+ def get_contentmanagement_document_with_http_info(document_id, opts = {})
241
+ if @api_client.config.debugging
242
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_document ..."
243
+ end
244
+
245
+ # verify the required parameter 'document_id' is set
246
+ fail "Missing the required parameter 'document_id' when calling get_contentmanagement_document" if document_id.nil?
247
+
248
+ if opts[:'expand'] && !['lockInfo', 'acl', 'workspace'].include?(opts[:'expand'])
249
+ fail 'invalid value for "expand", must be one of lockInfo, acl, workspace'
250
+ end
251
+
252
+ # resource path
253
+ path = "/api/v1/contentmanagement/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
254
+
255
+ # query parameters
256
+ query_params = {}
257
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
258
+
259
+ # header parameters
260
+ header_params = {}
261
+
262
+ # HTTP header 'Accept' (if needed)
263
+ _header_accept = ['application/json']
264
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
265
+
266
+ # HTTP header 'Content-Type'
267
+ _header_content_type = ['application/json']
268
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
269
+
270
+ # form parameters
271
+ form_params = {}
272
+
273
+ # http body (model)
274
+ post_body = nil
275
+
276
+
277
+ auth_names = ['PureCloud Auth']
278
+ data, status_code, headers = @api_client.call_api(:GET, path,
279
+ :header_params => header_params,
280
+ :query_params => query_params,
281
+ :form_params => form_params,
282
+ :body => post_body,
283
+ :auth_names => auth_names,
284
+ :return_type => 'Document')
285
+ if @api_client.config.debugging
286
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
287
+ end
288
+ return data, status_code, headers
289
+ end
290
+
291
+ # Update a document.
292
+ #
293
+ # @param document_id Document ID
294
+ # @param [Hash] opts the optional parameters
295
+ # @option opts [DocumentUpdate] :body Document
296
+ # @option opts [String] :expand Expand some document fields
297
+ # @option opts [BOOLEAN] :override Override any lock on the document
298
+ # @return [Document]
299
+ def post_contentmanagement_document(document_id, opts = {})
300
+ data, status_code, headers = post_contentmanagement_document_with_http_info(document_id, opts)
301
+ return data
302
+ end
303
+
304
+ # Update a document.
305
+ #
306
+ # @param document_id Document ID
307
+ # @param [Hash] opts the optional parameters
308
+ # @option opts [DocumentUpdate] :body Document
309
+ # @option opts [String] :expand Expand some document fields
310
+ # @option opts [BOOLEAN] :override Override any lock on the document
311
+ # @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
312
+ def post_contentmanagement_document_with_http_info(document_id, opts = {})
313
+ if @api_client.config.debugging
314
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_document ..."
315
+ end
316
+
317
+ # verify the required parameter 'document_id' is set
318
+ fail "Missing the required parameter 'document_id' when calling post_contentmanagement_document" if document_id.nil?
319
+
320
+ if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
321
+ fail 'invalid value for "expand", must be one of acl'
322
+ end
323
+
324
+ # resource path
325
+ path = "/api/v1/contentmanagement/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
326
+
327
+ # query parameters
328
+ query_params = {}
329
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
330
+ query_params[:'override'] = opts[:'override'] if opts[:'override']
331
+
332
+ # header parameters
333
+ header_params = {}
334
+
335
+ # HTTP header 'Accept' (if needed)
336
+ _header_accept = ['application/json']
337
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
338
+
339
+ # HTTP header 'Content-Type'
340
+ _header_content_type = ['application/json']
341
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
342
+
343
+ # form parameters
344
+ form_params = {}
345
+
346
+ # http body (model)
347
+ post_body = @api_client.object_to_http_body(opts[:'body'])
348
+
349
+
350
+ auth_names = ['PureCloud Auth']
351
+ data, status_code, headers = @api_client.call_api(:POST, path,
352
+ :header_params => header_params,
353
+ :query_params => query_params,
354
+ :form_params => form_params,
355
+ :body => post_body,
356
+ :auth_names => auth_names,
357
+ :return_type => 'Document')
358
+ if @api_client.config.debugging
359
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
360
+ end
361
+ return data, status_code, headers
362
+ end
363
+
364
+ # Delete a document.
365
+ #
366
+ # @param document_id Document ID
367
+ # @param [Hash] opts the optional parameters
368
+ # @option opts [BOOLEAN] :override Override any lock on the document
369
+ # @return [nil]
370
+ def delete_contentmanagement_document(document_id, opts = {})
371
+ delete_contentmanagement_document_with_http_info(document_id, opts)
372
+ return nil
373
+ end
374
+
375
+ # Delete a document.
376
+ #
377
+ # @param document_id Document ID
378
+ # @param [Hash] opts the optional parameters
379
+ # @option opts [BOOLEAN] :override Override any lock on the document
380
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
381
+ def delete_contentmanagement_document_with_http_info(document_id, opts = {})
382
+ if @api_client.config.debugging
383
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_contentmanagement_document ..."
384
+ end
385
+
386
+ # verify the required parameter 'document_id' is set
387
+ fail "Missing the required parameter 'document_id' when calling delete_contentmanagement_document" if document_id.nil?
388
+
389
+ # resource path
390
+ path = "/api/v1/contentmanagement/documents/{documentId}".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
391
+
392
+ # query parameters
393
+ query_params = {}
394
+ query_params[:'override'] = opts[:'override'] if opts[:'override']
395
+
396
+ # header parameters
397
+ header_params = {}
398
+
399
+ # HTTP header 'Accept' (if needed)
400
+ _header_accept = ['application/json']
401
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
402
+
403
+ # HTTP header 'Content-Type'
404
+ _header_content_type = ['application/json']
405
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
406
+
407
+ # form parameters
408
+ form_params = {}
409
+
410
+ # http body (model)
411
+ post_body = nil
412
+
413
+
414
+ auth_names = ['PureCloud Auth']
415
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
416
+ :header_params => header_params,
417
+ :query_params => query_params,
418
+ :form_params => form_params,
419
+ :body => post_body,
420
+ :auth_names => auth_names)
421
+ if @api_client.config.debugging
422
+ @api_client.config.logger.debug "API called: ContentManagementApi#delete_contentmanagement_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
423
+ end
424
+ return data, status_code, headers
425
+ end
426
+
427
+ # Get a list of audits for a document.
428
+ #
429
+ # @param document_id Document ID
430
+ # @param [Hash] opts the optional parameters
431
+ # @option opts [Integer] :page_size Page size
432
+ # @option opts [Integer] :page_number Page number
433
+ # @option opts [String] :transaction_filter Transaction filter
434
+ # @option opts [String] :level level
435
+ # @option opts [String] :sort_by Sort by
436
+ # @option opts [String] :sort_order Sort order
437
+ # @return [DocumentAuditEntityListing]
438
+ def get_contentmanagement_document_audits(document_id, opts = {})
439
+ data, status_code, headers = get_contentmanagement_document_audits_with_http_info(document_id, opts)
440
+ return data
441
+ end
442
+
443
+ # Get a list of audits for a document.
444
+ #
445
+ # @param document_id Document ID
446
+ # @param [Hash] opts the optional parameters
447
+ # @option opts [Integer] :page_size Page size
448
+ # @option opts [Integer] :page_number Page number
449
+ # @option opts [String] :transaction_filter Transaction filter
450
+ # @option opts [String] :level level
451
+ # @option opts [String] :sort_by Sort by
452
+ # @option opts [String] :sort_order Sort order
453
+ # @return [Array<(DocumentAuditEntityListing, Fixnum, Hash)>] DocumentAuditEntityListing data, response status code and response headers
454
+ def get_contentmanagement_document_audits_with_http_info(document_id, opts = {})
455
+ if @api_client.config.debugging
456
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_document_audits ..."
457
+ end
458
+
459
+ # verify the required parameter 'document_id' is set
460
+ fail "Missing the required parameter 'document_id' when calling get_contentmanagement_document_audits" if document_id.nil?
461
+
462
+ # resource path
463
+ path = "/api/v1/contentmanagement/documents/{documentId}/audits".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
464
+
465
+ # query parameters
466
+ query_params = {}
467
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
468
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
469
+ query_params[:'transactionFilter'] = opts[:'transaction_filter'] if opts[:'transaction_filter']
470
+ query_params[:'level'] = opts[:'level'] if opts[:'level']
471
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
472
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
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 => 'DocumentAuditEntityListing')
500
+ if @api_client.config.debugging
501
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_document_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
502
+ end
503
+ return data, status_code, headers
504
+ end
505
+
506
+ # Download a document.
507
+ #
508
+ # @param document_id Document ID
509
+ # @param [Hash] opts the optional parameters
510
+ # @option opts [String] :disposition Request how the content will be downloaded: attached as a file or inline. Default is attachment.
511
+ # @option opts [String] :content_type The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
512
+ # @return [nil]
513
+ def get_contentmanagement_document_content(document_id, opts = {})
514
+ get_contentmanagement_document_content_with_http_info(document_id, opts)
515
+ return nil
516
+ end
517
+
518
+ # Download a document.
519
+ #
520
+ # @param document_id Document ID
521
+ # @param [Hash] opts the optional parameters
522
+ # @option opts [String] :disposition Request how the content will be downloaded: attached as a file or inline. Default is attachment.
523
+ # @option opts [String] :content_type The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
524
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
525
+ def get_contentmanagement_document_content_with_http_info(document_id, opts = {})
526
+ if @api_client.config.debugging
527
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_document_content ..."
528
+ end
529
+
530
+ # verify the required parameter 'document_id' is set
531
+ fail "Missing the required parameter 'document_id' when calling get_contentmanagement_document_content" if document_id.nil?
532
+
533
+ if opts[:'disposition'] && !['attachment', 'inline'].include?(opts[:'disposition'])
534
+ fail 'invalid value for "disposition", must be one of attachment, inline'
535
+ end
536
+
537
+ # resource path
538
+ path = "/api/v1/contentmanagement/documents/{documentId}/content".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
539
+
540
+ # query parameters
541
+ query_params = {}
542
+ query_params[:'disposition'] = opts[:'disposition'] if opts[:'disposition']
543
+ query_params[:'contentType'] = opts[:'content_type'] if opts[:'content_type']
544
+
545
+ # header parameters
546
+ header_params = {}
547
+
548
+ # HTTP header 'Accept' (if needed)
549
+ _header_accept = ['application/json']
550
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
551
+
552
+ # HTTP header 'Content-Type'
553
+ _header_content_type = ['application/json']
554
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
555
+
556
+ # form parameters
557
+ form_params = {}
558
+
559
+ # http body (model)
560
+ post_body = nil
561
+
562
+
563
+ auth_names = ['PureCloud Auth']
564
+ data, status_code, headers = @api_client.call_api(:GET, path,
565
+ :header_params => header_params,
566
+ :query_params => query_params,
567
+ :form_params => form_params,
568
+ :body => post_body,
569
+ :auth_names => auth_names)
570
+ if @api_client.config.debugging
571
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_document_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
572
+ end
573
+ return data, status_code, headers
574
+ end
575
+
576
+ # Replace the contents of a document.
577
+ #
578
+ # @param document_id Document ID
579
+ # @param [Hash] opts the optional parameters
580
+ # @option opts [ReplaceRequest] :body Replace Request
581
+ # @option opts [BOOLEAN] :override Override any lock on the document
582
+ # @return [ReplaceResponse]
583
+ def post_contentmanagement_document_content(document_id, opts = {})
584
+ data, status_code, headers = post_contentmanagement_document_content_with_http_info(document_id, opts)
585
+ return data
586
+ end
587
+
588
+ # Replace the contents of a document.
589
+ #
590
+ # @param document_id Document ID
591
+ # @param [Hash] opts the optional parameters
592
+ # @option opts [ReplaceRequest] :body Replace Request
593
+ # @option opts [BOOLEAN] :override Override any lock on the document
594
+ # @return [Array<(ReplaceResponse, Fixnum, Hash)>] ReplaceResponse data, response status code and response headers
595
+ def post_contentmanagement_document_content_with_http_info(document_id, opts = {})
596
+ if @api_client.config.debugging
597
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_document_content ..."
598
+ end
599
+
600
+ # verify the required parameter 'document_id' is set
601
+ fail "Missing the required parameter 'document_id' when calling post_contentmanagement_document_content" if document_id.nil?
602
+
603
+ # resource path
604
+ path = "/api/v1/contentmanagement/documents/{documentId}/content".sub('{format}','json').sub('{' + 'documentId' + '}', document_id.to_s)
605
+
606
+ # query parameters
607
+ query_params = {}
608
+ query_params[:'override'] = opts[:'override'] if opts[:'override']
609
+
610
+ # header parameters
611
+ header_params = {}
612
+
613
+ # HTTP header 'Accept' (if needed)
614
+ _header_accept = ['application/json']
615
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
616
+
617
+ # HTTP header 'Content-Type'
618
+ _header_content_type = ['application/json']
619
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
620
+
621
+ # form parameters
622
+ form_params = {}
623
+
624
+ # http body (model)
625
+ post_body = @api_client.object_to_http_body(opts[:'body'])
626
+
627
+
628
+ auth_names = ['PureCloud Auth']
629
+ data, status_code, headers = @api_client.call_api(:POST, path,
630
+ :header_params => header_params,
631
+ :query_params => query_params,
632
+ :form_params => form_params,
633
+ :body => post_body,
634
+ :auth_names => auth_names,
635
+ :return_type => 'ReplaceResponse')
636
+ if @api_client.config.debugging
637
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_document_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
638
+ end
639
+ return data, status_code, headers
640
+ end
641
+
642
+ # Query content
643
+ #
644
+ # @param query_phrase Phrase tokens are ANDed together over all searchable fields
645
+ # @param [Hash] opts the optional parameters
646
+ # @option opts [Integer] :page_size Page size
647
+ # @option opts [Integer] :page_number Page number
648
+ # @option opts [String] :sort_by name or dateCreated
649
+ # @option opts [String] :sort_order ascending or descending
650
+ # @option opts [String] :expand Expand some document fields
651
+ # @return [QueryResults]
652
+ def get_contentmanagement_query(query_phrase, opts = {})
653
+ data, status_code, headers = get_contentmanagement_query_with_http_info(query_phrase, opts)
654
+ return data
655
+ end
656
+
657
+ # Query content
658
+ #
659
+ # @param query_phrase Phrase tokens are ANDed together over all searchable fields
660
+ # @param [Hash] opts the optional parameters
661
+ # @option opts [Integer] :page_size Page size
662
+ # @option opts [Integer] :page_number Page number
663
+ # @option opts [String] :sort_by name or dateCreated
664
+ # @option opts [String] :sort_order ascending or descending
665
+ # @option opts [String] :expand Expand some document fields
666
+ # @return [Array<(QueryResults, Fixnum, Hash)>] QueryResults data, response status code and response headers
667
+ def get_contentmanagement_query_with_http_info(query_phrase, opts = {})
668
+ if @api_client.config.debugging
669
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_query ..."
670
+ end
671
+
672
+ # verify the required parameter 'query_phrase' is set
673
+ fail "Missing the required parameter 'query_phrase' when calling get_contentmanagement_query" if query_phrase.nil?
674
+
675
+ if opts[:'expand'] && !['acl', 'workspace'].include?(opts[:'expand'])
676
+ fail 'invalid value for "expand", must be one of acl, workspace'
677
+ end
678
+
679
+ # resource path
680
+ path = "/api/v1/contentmanagement/query".sub('{format}','json')
681
+
682
+ # query parameters
683
+ query_params = {}
684
+ query_params[:'queryPhrase'] = query_phrase
685
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
686
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
687
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
688
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
689
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
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 => 'QueryResults')
717
+ if @api_client.config.debugging
718
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
719
+ end
720
+ return data, status_code, headers
721
+ end
722
+
723
+ # Query content
724
+ #
725
+ # @param body Allows for a filtered query returning facet information
726
+ # @param [Hash] opts the optional parameters
727
+ # @option opts [String] :expand Expand some document fields
728
+ # @return [QueryResults]
729
+ def post_contentmanagement_query(body, opts = {})
730
+ data, status_code, headers = post_contentmanagement_query_with_http_info(body, opts)
731
+ return data
732
+ end
733
+
734
+ # Query content
735
+ #
736
+ # @param body Allows for a filtered query returning facet information
737
+ # @param [Hash] opts the optional parameters
738
+ # @option opts [String] :expand Expand some document fields
739
+ # @return [Array<(QueryResults, Fixnum, Hash)>] QueryResults data, response status code and response headers
740
+ def post_contentmanagement_query_with_http_info(body, opts = {})
741
+ if @api_client.config.debugging
742
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_query ..."
743
+ end
744
+
745
+ # verify the required parameter 'body' is set
746
+ fail "Missing the required parameter 'body' when calling post_contentmanagement_query" if body.nil?
747
+
748
+ if opts[:'expand'] && !['acl', 'workspace'].include?(opts[:'expand'])
749
+ fail 'invalid value for "expand", must be one of acl, workspace'
750
+ end
751
+
752
+ # resource path
753
+ path = "/api/v1/contentmanagement/query".sub('{format}','json')
754
+
755
+ # query parameters
756
+ query_params = {}
757
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
758
+
759
+ # header parameters
760
+ header_params = {}
761
+
762
+ # HTTP header 'Accept' (if needed)
763
+ _header_accept = ['application/json']
764
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
765
+
766
+ # HTTP header 'Content-Type'
767
+ _header_content_type = ['application/json']
768
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
769
+
770
+ # form parameters
771
+ form_params = {}
772
+
773
+ # http body (model)
774
+ post_body = @api_client.object_to_http_body(body)
775
+
776
+
777
+ auth_names = ['PureCloud Auth']
778
+ data, status_code, headers = @api_client.call_api(:POST, path,
779
+ :header_params => header_params,
780
+ :query_params => query_params,
781
+ :form_params => form_params,
782
+ :body => post_body,
783
+ :auth_names => auth_names,
784
+ :return_type => 'QueryResults')
785
+ if @api_client.config.debugging
786
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
787
+ end
788
+ return data, status_code, headers
789
+ end
790
+
791
+ # Get a List of Security Profiles
792
+ #
793
+ # @param [Hash] opts the optional parameters
794
+ # @return [SecurityProfileEntityListing]
795
+ def get_contentmanagement_securityprofiles(opts = {})
796
+ data, status_code, headers = get_contentmanagement_securityprofiles_with_http_info(opts)
797
+ return data
798
+ end
799
+
800
+ # Get a List of Security Profiles
801
+ #
802
+ # @param [Hash] opts the optional parameters
803
+ # @return [Array<(SecurityProfileEntityListing, Fixnum, Hash)>] SecurityProfileEntityListing data, response status code and response headers
804
+ def get_contentmanagement_securityprofiles_with_http_info(opts = {})
805
+ if @api_client.config.debugging
806
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_securityprofiles ..."
807
+ end
808
+
809
+ # resource path
810
+ path = "/api/v1/contentmanagement/securityprofiles".sub('{format}','json')
811
+
812
+ # query parameters
813
+ query_params = {}
814
+
815
+ # header parameters
816
+ header_params = {}
817
+
818
+ # HTTP header 'Accept' (if needed)
819
+ _header_accept = ['application/json']
820
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
821
+
822
+ # HTTP header 'Content-Type'
823
+ _header_content_type = ['application/json']
824
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
825
+
826
+ # form parameters
827
+ form_params = {}
828
+
829
+ # http body (model)
830
+ post_body = nil
831
+
832
+
833
+ auth_names = ['PureCloud Auth']
834
+ data, status_code, headers = @api_client.call_api(:GET, path,
835
+ :header_params => header_params,
836
+ :query_params => query_params,
837
+ :form_params => form_params,
838
+ :body => post_body,
839
+ :auth_names => auth_names,
840
+ :return_type => 'SecurityProfileEntityListing')
841
+ if @api_client.config.debugging
842
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_securityprofiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
843
+ end
844
+ return data, status_code, headers
845
+ end
846
+
847
+ # Get a Security Profile
848
+ #
849
+ # @param security_profile_id Security Profile Id
850
+ # @param [Hash] opts the optional parameters
851
+ # @return [SecurityProfile]
852
+ def get_contentmanagement_securityprofile(security_profile_id, opts = {})
853
+ data, status_code, headers = get_contentmanagement_securityprofile_with_http_info(security_profile_id, opts)
854
+ return data
855
+ end
856
+
857
+ # Get a Security Profile
858
+ #
859
+ # @param security_profile_id Security Profile Id
860
+ # @param [Hash] opts the optional parameters
861
+ # @return [Array<(SecurityProfile, Fixnum, Hash)>] SecurityProfile data, response status code and response headers
862
+ def get_contentmanagement_securityprofile_with_http_info(security_profile_id, opts = {})
863
+ if @api_client.config.debugging
864
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_securityprofile ..."
865
+ end
866
+
867
+ # verify the required parameter 'security_profile_id' is set
868
+ fail "Missing the required parameter 'security_profile_id' when calling get_contentmanagement_securityprofile" if security_profile_id.nil?
869
+
870
+ # resource path
871
+ path = "/api/v1/contentmanagement/securityprofiles/{securityProfileId}".sub('{format}','json').sub('{' + 'securityProfileId' + '}', security_profile_id.to_s)
872
+
873
+ # query parameters
874
+ query_params = {}
875
+
876
+ # header parameters
877
+ header_params = {}
878
+
879
+ # HTTP header 'Accept' (if needed)
880
+ _header_accept = ['application/json']
881
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
882
+
883
+ # HTTP header 'Content-Type'
884
+ _header_content_type = ['application/json']
885
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
886
+
887
+ # form parameters
888
+ form_params = {}
889
+
890
+ # http body (model)
891
+ post_body = nil
892
+
893
+
894
+ auth_names = ['PureCloud Auth']
895
+ data, status_code, headers = @api_client.call_api(:GET, path,
896
+ :header_params => header_params,
897
+ :query_params => query_params,
898
+ :form_params => form_params,
899
+ :body => post_body,
900
+ :auth_names => auth_names,
901
+ :return_type => 'SecurityProfile')
902
+ if @api_client.config.debugging
903
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_securityprofile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
904
+ end
905
+ return data, status_code, headers
906
+ end
907
+
908
+ # Get shared documents. Securely download a shared document.
909
+ # This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
910
+ # @param shared_id Shared ID
911
+ # @param [Hash] opts the optional parameters
912
+ # @option opts [BOOLEAN] :redirect Turn on or off redirect
913
+ # @option opts [String] :disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment.
914
+ # @option opts [String] :content_type The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
915
+ # @option opts [String] :expand Expand some document fields
916
+ # @return [nil]
917
+ def get_contentmanagement_shared(shared_id, opts = {})
918
+ get_contentmanagement_shared_with_http_info(shared_id, opts)
919
+ return nil
920
+ end
921
+
922
+ # Get shared documents. Securely download a shared document.
923
+ # This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
924
+ # @param shared_id Shared ID
925
+ # @param [Hash] opts the optional parameters
926
+ # @option opts [BOOLEAN] :redirect Turn on or off redirect
927
+ # @option opts [String] :disposition Request how the share content will be downloaded: attached as a file or inline. Default is attachment.
928
+ # @option opts [String] :content_type The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav
929
+ # @option opts [String] :expand Expand some document fields
930
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
931
+ def get_contentmanagement_shared_with_http_info(shared_id, opts = {})
932
+ if @api_client.config.debugging
933
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_shared ..."
934
+ end
935
+
936
+ # verify the required parameter 'shared_id' is set
937
+ fail "Missing the required parameter 'shared_id' when calling get_contentmanagement_shared" if shared_id.nil?
938
+
939
+ if opts[:'disposition'] && !['attachment', 'inline', 'none'].include?(opts[:'disposition'])
940
+ fail 'invalid value for "disposition", must be one of attachment, inline, none'
941
+ end
942
+
943
+ if opts[:'expand'] && !['document.acl'].include?(opts[:'expand'])
944
+ fail 'invalid value for "expand", must be one of document.acl'
945
+ end
946
+
947
+ # resource path
948
+ path = "/api/v1/contentmanagement/shared/{sharedId}".sub('{format}','json').sub('{' + 'sharedId' + '}', shared_id.to_s)
949
+
950
+ # query parameters
951
+ query_params = {}
952
+ query_params[:'redirect'] = opts[:'redirect'] if opts[:'redirect']
953
+ query_params[:'disposition'] = opts[:'disposition'] if opts[:'disposition']
954
+ query_params[:'contentType'] = opts[:'content_type'] if opts[:'content_type']
955
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
956
+
957
+ # header parameters
958
+ header_params = {}
959
+
960
+ # HTTP header 'Accept' (if needed)
961
+ _header_accept = ['application/json']
962
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
963
+
964
+ # HTTP header 'Content-Type'
965
+ _header_content_type = ['application/json']
966
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
967
+
968
+ # form parameters
969
+ form_params = {}
970
+
971
+ # http body (model)
972
+ post_body = nil
973
+
974
+
975
+ auth_names = ['PureCloud Auth']
976
+ data, status_code, headers = @api_client.call_api(:GET, path,
977
+ :header_params => header_params,
978
+ :query_params => query_params,
979
+ :form_params => form_params,
980
+ :body => post_body,
981
+ :auth_names => auth_names)
982
+ if @api_client.config.debugging
983
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_shared\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
984
+ end
985
+ return data, status_code, headers
986
+ end
987
+
988
+ # Gets a list of shares. You must specify at least one filter (e.g. entityId).
989
+ # Failing to specify a filter will return 400.
990
+ # @param [Hash] opts the optional parameters
991
+ # @option opts [String] :entity_id Filters the shares returned to only the entity specified by the value of this parameter.
992
+ # @option opts [String] :expand Expand share fields
993
+ # @option opts [Integer] :page_size Page size
994
+ # @option opts [Integer] :page_number Page number
995
+ # @return [ShareEntityListing]
996
+ def get_contentmanagement_shares(opts = {})
997
+ data, status_code, headers = get_contentmanagement_shares_with_http_info(opts)
998
+ return data
999
+ end
1000
+
1001
+ # Gets a list of shares. You must specify at least one filter (e.g. entityId).
1002
+ # Failing to specify a filter will return 400.
1003
+ # @param [Hash] opts the optional parameters
1004
+ # @option opts [String] :entity_id Filters the shares returned to only the entity specified by the value of this parameter.
1005
+ # @option opts [String] :expand Expand share fields
1006
+ # @option opts [Integer] :page_size Page size
1007
+ # @option opts [Integer] :page_number Page number
1008
+ # @return [Array<(ShareEntityListing, Fixnum, Hash)>] ShareEntityListing data, response status code and response headers
1009
+ def get_contentmanagement_shares_with_http_info(opts = {})
1010
+ if @api_client.config.debugging
1011
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_shares ..."
1012
+ end
1013
+
1014
+ if opts[:'expand'] && !['member'].include?(opts[:'expand'])
1015
+ fail 'invalid value for "expand", must be one of member'
1016
+ end
1017
+
1018
+ # resource path
1019
+ path = "/api/v1/contentmanagement/shares".sub('{format}','json')
1020
+
1021
+ # query parameters
1022
+ query_params = {}
1023
+ query_params[:'entityId'] = opts[:'entity_id'] if opts[:'entity_id']
1024
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1025
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1026
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1027
+
1028
+ # header parameters
1029
+ header_params = {}
1030
+
1031
+ # HTTP header 'Accept' (if needed)
1032
+ _header_accept = ['application/json']
1033
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1034
+
1035
+ # HTTP header 'Content-Type'
1036
+ _header_content_type = ['application/json']
1037
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1038
+
1039
+ # form parameters
1040
+ form_params = {}
1041
+
1042
+ # http body (model)
1043
+ post_body = nil
1044
+
1045
+
1046
+ auth_names = ['PureCloud Auth']
1047
+ data, status_code, headers = @api_client.call_api(:GET, path,
1048
+ :header_params => header_params,
1049
+ :query_params => query_params,
1050
+ :form_params => form_params,
1051
+ :body => post_body,
1052
+ :auth_names => auth_names,
1053
+ :return_type => 'ShareEntityListing')
1054
+ if @api_client.config.debugging
1055
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1056
+ end
1057
+ return data, status_code, headers
1058
+ end
1059
+
1060
+ # Creates a new share or updates an existing share if the entity has already been shared
1061
+ #
1062
+ # @param [Hash] opts the optional parameters
1063
+ # @option opts [CreateShareRequest] :body CreateShareRequest - entity id and type and a single member or list of members are required
1064
+ # @return [CreateShareResponse]
1065
+ def post_contentmanagement_shares(opts = {})
1066
+ data, status_code, headers = post_contentmanagement_shares_with_http_info(opts)
1067
+ return data
1068
+ end
1069
+
1070
+ # Creates a new share or updates an existing share if the entity has already been shared
1071
+ #
1072
+ # @param [Hash] opts the optional parameters
1073
+ # @option opts [CreateShareRequest] :body CreateShareRequest - entity id and type and a single member or list of members are required
1074
+ # @return [Array<(CreateShareResponse, Fixnum, Hash)>] CreateShareResponse data, response status code and response headers
1075
+ def post_contentmanagement_shares_with_http_info(opts = {})
1076
+ if @api_client.config.debugging
1077
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_shares ..."
1078
+ end
1079
+
1080
+ # resource path
1081
+ path = "/api/v1/contentmanagement/shares".sub('{format}','json')
1082
+
1083
+ # query parameters
1084
+ query_params = {}
1085
+
1086
+ # header parameters
1087
+ header_params = {}
1088
+
1089
+ # HTTP header 'Accept' (if needed)
1090
+ _header_accept = ['application/json']
1091
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1092
+
1093
+ # HTTP header 'Content-Type'
1094
+ _header_content_type = ['application/json']
1095
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1096
+
1097
+ # form parameters
1098
+ form_params = {}
1099
+
1100
+ # http body (model)
1101
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1102
+
1103
+
1104
+ auth_names = ['PureCloud Auth']
1105
+ data, status_code, headers = @api_client.call_api(:POST, path,
1106
+ :header_params => header_params,
1107
+ :query_params => query_params,
1108
+ :form_params => form_params,
1109
+ :body => post_body,
1110
+ :auth_names => auth_names,
1111
+ :return_type => 'CreateShareResponse')
1112
+ if @api_client.config.debugging
1113
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1114
+ end
1115
+ return data, status_code, headers
1116
+ end
1117
+
1118
+ # Retrieve details about an existing share.
1119
+ #
1120
+ # @param share_id Share ID
1121
+ # @param [Hash] opts the optional parameters
1122
+ # @option opts [String] :expand Expand share fields
1123
+ # @return [Share]
1124
+ def get_contentmanagement_share(share_id, opts = {})
1125
+ data, status_code, headers = get_contentmanagement_share_with_http_info(share_id, opts)
1126
+ return data
1127
+ end
1128
+
1129
+ # Retrieve details about an existing share.
1130
+ #
1131
+ # @param share_id Share ID
1132
+ # @param [Hash] opts the optional parameters
1133
+ # @option opts [String] :expand Expand share fields
1134
+ # @return [Array<(Share, Fixnum, Hash)>] Share data, response status code and response headers
1135
+ def get_contentmanagement_share_with_http_info(share_id, opts = {})
1136
+ if @api_client.config.debugging
1137
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_share ..."
1138
+ end
1139
+
1140
+ # verify the required parameter 'share_id' is set
1141
+ fail "Missing the required parameter 'share_id' when calling get_contentmanagement_share" if share_id.nil?
1142
+
1143
+ if opts[:'expand'] && !['member'].include?(opts[:'expand'])
1144
+ fail 'invalid value for "expand", must be one of member'
1145
+ end
1146
+
1147
+ # resource path
1148
+ path = "/api/v1/contentmanagement/shares/{shareId}".sub('{format}','json').sub('{' + 'shareId' + '}', share_id.to_s)
1149
+
1150
+ # query parameters
1151
+ query_params = {}
1152
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1153
+
1154
+ # header parameters
1155
+ header_params = {}
1156
+
1157
+ # HTTP header 'Accept' (if needed)
1158
+ _header_accept = ['application/json']
1159
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1160
+
1161
+ # HTTP header 'Content-Type'
1162
+ _header_content_type = ['application/json']
1163
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1164
+
1165
+ # form parameters
1166
+ form_params = {}
1167
+
1168
+ # http body (model)
1169
+ post_body = nil
1170
+
1171
+
1172
+ auth_names = ['PureCloud Auth']
1173
+ data, status_code, headers = @api_client.call_api(:GET, path,
1174
+ :header_params => header_params,
1175
+ :query_params => query_params,
1176
+ :form_params => form_params,
1177
+ :body => post_body,
1178
+ :auth_names => auth_names,
1179
+ :return_type => 'Share')
1180
+ if @api_client.config.debugging
1181
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1182
+ end
1183
+ return data, status_code, headers
1184
+ end
1185
+
1186
+ # Deletes an existing share.
1187
+ # This revokes sharing rights specified in the share record
1188
+ # @param share_id Share ID
1189
+ # @param [Hash] opts the optional parameters
1190
+ # @return [nil]
1191
+ def delete_contentmanagement_share(share_id, opts = {})
1192
+ delete_contentmanagement_share_with_http_info(share_id, opts)
1193
+ return nil
1194
+ end
1195
+
1196
+ # Deletes an existing share.
1197
+ # This revokes sharing rights specified in the share record
1198
+ # @param share_id Share ID
1199
+ # @param [Hash] opts the optional parameters
1200
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1201
+ def delete_contentmanagement_share_with_http_info(share_id, opts = {})
1202
+ if @api_client.config.debugging
1203
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_contentmanagement_share ..."
1204
+ end
1205
+
1206
+ # verify the required parameter 'share_id' is set
1207
+ fail "Missing the required parameter 'share_id' when calling delete_contentmanagement_share" if share_id.nil?
1208
+
1209
+ # resource path
1210
+ path = "/api/v1/contentmanagement/shares/{shareId}".sub('{format}','json').sub('{' + 'shareId' + '}', share_id.to_s)
1211
+
1212
+ # query parameters
1213
+ query_params = {}
1214
+
1215
+ # header parameters
1216
+ header_params = {}
1217
+
1218
+ # HTTP header 'Accept' (if needed)
1219
+ _header_accept = ['application/json']
1220
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1221
+
1222
+ # HTTP header 'Content-Type'
1223
+ _header_content_type = ['application/json']
1224
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1225
+
1226
+ # form parameters
1227
+ form_params = {}
1228
+
1229
+ # http body (model)
1230
+ post_body = nil
1231
+
1232
+
1233
+ auth_names = ['PureCloud Auth']
1234
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1235
+ :header_params => header_params,
1236
+ :query_params => query_params,
1237
+ :form_params => form_params,
1238
+ :body => post_body,
1239
+ :auth_names => auth_names)
1240
+ if @api_client.config.debugging
1241
+ @api_client.config.logger.debug "API called: ContentManagementApi#delete_contentmanagement_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1242
+ end
1243
+ return data, status_code, headers
1244
+ end
1245
+
1246
+ # Get a list of statuses for pending operations
1247
+ #
1248
+ # @param [Hash] opts the optional parameters
1249
+ # @option opts [Integer] :page_size Page size
1250
+ # @option opts [Integer] :page_number Page number
1251
+ # @return [CommandStatusEntityListing]
1252
+ def get_contentmanagement_status(opts = {})
1253
+ data, status_code, headers = get_contentmanagement_status_with_http_info(opts)
1254
+ return data
1255
+ end
1256
+
1257
+ # Get a list of statuses for pending operations
1258
+ #
1259
+ # @param [Hash] opts the optional parameters
1260
+ # @option opts [Integer] :page_size Page size
1261
+ # @option opts [Integer] :page_number Page number
1262
+ # @return [Array<(CommandStatusEntityListing, Fixnum, Hash)>] CommandStatusEntityListing data, response status code and response headers
1263
+ def get_contentmanagement_status_with_http_info(opts = {})
1264
+ if @api_client.config.debugging
1265
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_status ..."
1266
+ end
1267
+
1268
+ # resource path
1269
+ path = "/api/v1/contentmanagement/status".sub('{format}','json')
1270
+
1271
+ # query parameters
1272
+ query_params = {}
1273
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1274
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1275
+
1276
+ # header parameters
1277
+ header_params = {}
1278
+
1279
+ # HTTP header 'Accept' (if needed)
1280
+ _header_accept = ['application/json']
1281
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1282
+
1283
+ # HTTP header 'Content-Type'
1284
+ _header_content_type = ['application/json']
1285
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1286
+
1287
+ # form parameters
1288
+ form_params = {}
1289
+
1290
+ # http body (model)
1291
+ post_body = nil
1292
+
1293
+
1294
+ auth_names = ['PureCloud Auth']
1295
+ data, status_code, headers = @api_client.call_api(:GET, path,
1296
+ :header_params => header_params,
1297
+ :query_params => query_params,
1298
+ :form_params => form_params,
1299
+ :body => post_body,
1300
+ :auth_names => auth_names,
1301
+ :return_type => 'CommandStatusEntityListing')
1302
+ if @api_client.config.debugging
1303
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1304
+ end
1305
+ return data, status_code, headers
1306
+ end
1307
+
1308
+ # Get a status.
1309
+ #
1310
+ # @param status_id Status ID
1311
+ # @param [Hash] opts the optional parameters
1312
+ # @return [CommandStatus]
1313
+ def get_contentmanagement_statu(status_id, opts = {})
1314
+ data, status_code, headers = get_contentmanagement_statu_with_http_info(status_id, opts)
1315
+ return data
1316
+ end
1317
+
1318
+ # Get a status.
1319
+ #
1320
+ # @param status_id Status ID
1321
+ # @param [Hash] opts the optional parameters
1322
+ # @return [Array<(CommandStatus, Fixnum, Hash)>] CommandStatus data, response status code and response headers
1323
+ def get_contentmanagement_statu_with_http_info(status_id, opts = {})
1324
+ if @api_client.config.debugging
1325
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_statu ..."
1326
+ end
1327
+
1328
+ # verify the required parameter 'status_id' is set
1329
+ fail "Missing the required parameter 'status_id' when calling get_contentmanagement_statu" if status_id.nil?
1330
+
1331
+ # resource path
1332
+ path = "/api/v1/contentmanagement/status/{statusId}".sub('{format}','json').sub('{' + 'statusId' + '}', status_id.to_s)
1333
+
1334
+ # query parameters
1335
+ query_params = {}
1336
+
1337
+ # header parameters
1338
+ header_params = {}
1339
+
1340
+ # HTTP header 'Accept' (if needed)
1341
+ _header_accept = ['application/json']
1342
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1343
+
1344
+ # HTTP header 'Content-Type'
1345
+ _header_content_type = ['application/json']
1346
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1347
+
1348
+ # form parameters
1349
+ form_params = {}
1350
+
1351
+ # http body (model)
1352
+ post_body = nil
1353
+
1354
+
1355
+ auth_names = ['PureCloud Auth']
1356
+ data, status_code, headers = @api_client.call_api(:GET, path,
1357
+ :header_params => header_params,
1358
+ :query_params => query_params,
1359
+ :form_params => form_params,
1360
+ :body => post_body,
1361
+ :auth_names => auth_names,
1362
+ :return_type => 'CommandStatus')
1363
+ if @api_client.config.debugging
1364
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_statu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1365
+ end
1366
+ return data, status_code, headers
1367
+ end
1368
+
1369
+ # Cancel the command for this status
1370
+ #
1371
+ # @param status_id Status ID
1372
+ # @param [Hash] opts the optional parameters
1373
+ # @return [nil]
1374
+ def delete_contentmanagement_statu(status_id, opts = {})
1375
+ delete_contentmanagement_statu_with_http_info(status_id, opts)
1376
+ return nil
1377
+ end
1378
+
1379
+ # Cancel the command for this status
1380
+ #
1381
+ # @param status_id Status ID
1382
+ # @param [Hash] opts the optional parameters
1383
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1384
+ def delete_contentmanagement_statu_with_http_info(status_id, opts = {})
1385
+ if @api_client.config.debugging
1386
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_contentmanagement_statu ..."
1387
+ end
1388
+
1389
+ # verify the required parameter 'status_id' is set
1390
+ fail "Missing the required parameter 'status_id' when calling delete_contentmanagement_statu" if status_id.nil?
1391
+
1392
+ # resource path
1393
+ path = "/api/v1/contentmanagement/status/{statusId}".sub('{format}','json').sub('{' + 'statusId' + '}', status_id.to_s)
1394
+
1395
+ # query parameters
1396
+ query_params = {}
1397
+
1398
+ # header parameters
1399
+ header_params = {}
1400
+
1401
+ # HTTP header 'Accept' (if needed)
1402
+ _header_accept = ['application/json']
1403
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1404
+
1405
+ # HTTP header 'Content-Type'
1406
+ _header_content_type = ['application/json']
1407
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1408
+
1409
+ # form parameters
1410
+ form_params = {}
1411
+
1412
+ # http body (model)
1413
+ post_body = nil
1414
+
1415
+
1416
+ auth_names = ['PureCloud Auth']
1417
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1418
+ :header_params => header_params,
1419
+ :query_params => query_params,
1420
+ :form_params => form_params,
1421
+ :body => post_body,
1422
+ :auth_names => auth_names)
1423
+ if @api_client.config.debugging
1424
+ @api_client.config.logger.debug "API called: ContentManagementApi#delete_contentmanagement_statu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1425
+ end
1426
+ return data, status_code, headers
1427
+ end
1428
+
1429
+ # Get a list of workspaces.
1430
+ # Specifying &#39;content&#39; access will return all workspaces the user has document access to, while &#39;admin&#39; access will return all group workspaces the user has administrative rights to.
1431
+ # @param [Hash] opts the optional parameters
1432
+ # @option opts [Integer] :page_size Page size
1433
+ # @option opts [Integer] :page_number Page number
1434
+ # @option opts [String] :access Requested access level
1435
+ # @option opts [String] :expand Expand some workspace fields
1436
+ # @return [WorkspaceEntityListing]
1437
+ def get_contentmanagement_workspaces(opts = {})
1438
+ data, status_code, headers = get_contentmanagement_workspaces_with_http_info(opts)
1439
+ return data
1440
+ end
1441
+
1442
+ # Get a list of workspaces.
1443
+ # Specifying &#39;content&#39; access will return all workspaces the user has document access to, while &#39;admin&#39; access will return all group workspaces the user has administrative rights to.
1444
+ # @param [Hash] opts the optional parameters
1445
+ # @option opts [Integer] :page_size Page size
1446
+ # @option opts [Integer] :page_number Page number
1447
+ # @option opts [String] :access Requested access level
1448
+ # @option opts [String] :expand Expand some workspace fields
1449
+ # @return [Array<(WorkspaceEntityListing, Fixnum, Hash)>] WorkspaceEntityListing data, response status code and response headers
1450
+ def get_contentmanagement_workspaces_with_http_info(opts = {})
1451
+ if @api_client.config.debugging
1452
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_workspaces ..."
1453
+ end
1454
+
1455
+ if opts[:'access'] && !['content', 'admin', 'document:create', 'document:viewContent', 'document:viewMetadata', 'document:download', 'document:delete', 'document:update', 'document:share', 'document:shareView', 'document:email', 'document:print', 'document:auditView', 'document:replace', 'document:tag', 'tag:create', 'tag:view', 'tag:update', 'tag:apply', 'tag:remove', 'tag:delete'].include?(opts[:'access'])
1456
+ fail 'invalid value for "access", must be one of content, admin, document:create, document:viewContent, document:viewMetadata, document:download, document:delete, document:update, document:share, document:shareView, document:email, document:print, document:auditView, document:replace, document:tag, tag:create, tag:view, tag:update, tag:apply, tag:remove, tag:delete'
1457
+ end
1458
+
1459
+ if opts[:'expand'] && !['summary', 'acl'].include?(opts[:'expand'])
1460
+ fail 'invalid value for "expand", must be one of summary, acl'
1461
+ end
1462
+
1463
+ # resource path
1464
+ path = "/api/v1/contentmanagement/workspaces".sub('{format}','json')
1465
+
1466
+ # query parameters
1467
+ query_params = {}
1468
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1469
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1470
+ query_params[:'access'] = opts[:'access'] if opts[:'access']
1471
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1472
+
1473
+ # header parameters
1474
+ header_params = {}
1475
+
1476
+ # HTTP header 'Accept' (if needed)
1477
+ _header_accept = ['application/json']
1478
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1479
+
1480
+ # HTTP header 'Content-Type'
1481
+ _header_content_type = ['application/json']
1482
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1483
+
1484
+ # form parameters
1485
+ form_params = {}
1486
+
1487
+ # http body (model)
1488
+ post_body = nil
1489
+
1490
+
1491
+ auth_names = ['PureCloud Auth']
1492
+ data, status_code, headers = @api_client.call_api(:GET, path,
1493
+ :header_params => header_params,
1494
+ :query_params => query_params,
1495
+ :form_params => form_params,
1496
+ :body => post_body,
1497
+ :auth_names => auth_names,
1498
+ :return_type => 'WorkspaceEntityListing')
1499
+ if @api_client.config.debugging
1500
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1501
+ end
1502
+ return data, status_code, headers
1503
+ end
1504
+
1505
+ # Create a group workspace
1506
+ #
1507
+ # @param [Hash] opts the optional parameters
1508
+ # @option opts [WorkspaceCreate] :body Workspace
1509
+ # @return [Workspace]
1510
+ def post_contentmanagement_workspaces(opts = {})
1511
+ data, status_code, headers = post_contentmanagement_workspaces_with_http_info(opts)
1512
+ return data
1513
+ end
1514
+
1515
+ # Create a group workspace
1516
+ #
1517
+ # @param [Hash] opts the optional parameters
1518
+ # @option opts [WorkspaceCreate] :body Workspace
1519
+ # @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
1520
+ def post_contentmanagement_workspaces_with_http_info(opts = {})
1521
+ if @api_client.config.debugging
1522
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_workspaces ..."
1523
+ end
1524
+
1525
+ # resource path
1526
+ path = "/api/v1/contentmanagement/workspaces".sub('{format}','json')
1527
+
1528
+ # query parameters
1529
+ query_params = {}
1530
+
1531
+ # header parameters
1532
+ header_params = {}
1533
+
1534
+ # HTTP header 'Accept' (if needed)
1535
+ _header_accept = ['application/json']
1536
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1537
+
1538
+ # HTTP header 'Content-Type'
1539
+ _header_content_type = ['application/json']
1540
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1541
+
1542
+ # form parameters
1543
+ form_params = {}
1544
+
1545
+ # http body (model)
1546
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1547
+
1548
+
1549
+ auth_names = ['PureCloud Auth']
1550
+ data, status_code, headers = @api_client.call_api(:POST, path,
1551
+ :header_params => header_params,
1552
+ :query_params => query_params,
1553
+ :form_params => form_params,
1554
+ :body => post_body,
1555
+ :auth_names => auth_names,
1556
+ :return_type => 'Workspace')
1557
+ if @api_client.config.debugging
1558
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1559
+ end
1560
+ return data, status_code, headers
1561
+ end
1562
+
1563
+ # Get a workspace.
1564
+ #
1565
+ # @param workspace_id Workspace ID
1566
+ # @param [Hash] opts the optional parameters
1567
+ # @option opts [String] :expand Expand some workspace fields
1568
+ # @return [Workspace]
1569
+ def get_contentmanagement_workspace(workspace_id, opts = {})
1570
+ data, status_code, headers = get_contentmanagement_workspace_with_http_info(workspace_id, opts)
1571
+ return data
1572
+ end
1573
+
1574
+ # Get a workspace.
1575
+ #
1576
+ # @param workspace_id Workspace ID
1577
+ # @param [Hash] opts the optional parameters
1578
+ # @option opts [String] :expand Expand some workspace fields
1579
+ # @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
1580
+ def get_contentmanagement_workspace_with_http_info(workspace_id, opts = {})
1581
+ if @api_client.config.debugging
1582
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_workspace ..."
1583
+ end
1584
+
1585
+ # verify the required parameter 'workspace_id' is set
1586
+ fail "Missing the required parameter 'workspace_id' when calling get_contentmanagement_workspace" if workspace_id.nil?
1587
+
1588
+ if opts[:'expand'] && !['summary', 'acl'].include?(opts[:'expand'])
1589
+ fail 'invalid value for "expand", must be one of summary, acl'
1590
+ end
1591
+
1592
+ # resource path
1593
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
1594
+
1595
+ # query parameters
1596
+ query_params = {}
1597
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1598
+
1599
+ # header parameters
1600
+ header_params = {}
1601
+
1602
+ # HTTP header 'Accept' (if needed)
1603
+ _header_accept = ['application/json']
1604
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1605
+
1606
+ # HTTP header 'Content-Type'
1607
+ _header_content_type = ['application/json']
1608
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1609
+
1610
+ # form parameters
1611
+ form_params = {}
1612
+
1613
+ # http body (model)
1614
+ post_body = nil
1615
+
1616
+
1617
+ auth_names = ['PureCloud Auth']
1618
+ data, status_code, headers = @api_client.call_api(:GET, path,
1619
+ :header_params => header_params,
1620
+ :query_params => query_params,
1621
+ :form_params => form_params,
1622
+ :body => post_body,
1623
+ :auth_names => auth_names,
1624
+ :return_type => 'Workspace')
1625
+ if @api_client.config.debugging
1626
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1627
+ end
1628
+ return data, status_code, headers
1629
+ end
1630
+
1631
+ # Update a workspace
1632
+ #
1633
+ # @param workspace_id Workspace ID
1634
+ # @param [Hash] opts the optional parameters
1635
+ # @option opts [Workspace] :body Workspace
1636
+ # @return [Workspace]
1637
+ def put_contentmanagement_workspace(workspace_id, opts = {})
1638
+ data, status_code, headers = put_contentmanagement_workspace_with_http_info(workspace_id, opts)
1639
+ return data
1640
+ end
1641
+
1642
+ # Update a workspace
1643
+ #
1644
+ # @param workspace_id Workspace ID
1645
+ # @param [Hash] opts the optional parameters
1646
+ # @option opts [Workspace] :body Workspace
1647
+ # @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
1648
+ def put_contentmanagement_workspace_with_http_info(workspace_id, opts = {})
1649
+ if @api_client.config.debugging
1650
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#put_contentmanagement_workspace ..."
1651
+ end
1652
+
1653
+ # verify the required parameter 'workspace_id' is set
1654
+ fail "Missing the required parameter 'workspace_id' when calling put_contentmanagement_workspace" if workspace_id.nil?
1655
+
1656
+ # resource path
1657
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
1658
+
1659
+ # query parameters
1660
+ query_params = {}
1661
+
1662
+ # header parameters
1663
+ header_params = {}
1664
+
1665
+ # HTTP header 'Accept' (if needed)
1666
+ _header_accept = ['application/json']
1667
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1668
+
1669
+ # HTTP header 'Content-Type'
1670
+ _header_content_type = ['application/json']
1671
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1672
+
1673
+ # form parameters
1674
+ form_params = {}
1675
+
1676
+ # http body (model)
1677
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1678
+
1679
+
1680
+ auth_names = ['PureCloud Auth']
1681
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1682
+ :header_params => header_params,
1683
+ :query_params => query_params,
1684
+ :form_params => form_params,
1685
+ :body => post_body,
1686
+ :auth_names => auth_names,
1687
+ :return_type => 'Workspace')
1688
+ if @api_client.config.debugging
1689
+ @api_client.config.logger.debug "API called: ContentManagementApi#put_contentmanagement_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1690
+ end
1691
+ return data, status_code, headers
1692
+ end
1693
+
1694
+ # Delete a workspace
1695
+ #
1696
+ # @param workspace_id Workspace ID
1697
+ # @param [Hash] opts the optional parameters
1698
+ # @option opts [String] :move_children_to_workspace_id New location for objects in deleted workspace.
1699
+ # @return [nil]
1700
+ def delete_contentmanagement_workspace(workspace_id, opts = {})
1701
+ delete_contentmanagement_workspace_with_http_info(workspace_id, opts)
1702
+ return nil
1703
+ end
1704
+
1705
+ # Delete a workspace
1706
+ #
1707
+ # @param workspace_id Workspace ID
1708
+ # @param [Hash] opts the optional parameters
1709
+ # @option opts [String] :move_children_to_workspace_id New location for objects in deleted workspace.
1710
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1711
+ def delete_contentmanagement_workspace_with_http_info(workspace_id, opts = {})
1712
+ if @api_client.config.debugging
1713
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_contentmanagement_workspace ..."
1714
+ end
1715
+
1716
+ # verify the required parameter 'workspace_id' is set
1717
+ fail "Missing the required parameter 'workspace_id' when calling delete_contentmanagement_workspace" if workspace_id.nil?
1718
+
1719
+ # resource path
1720
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
1721
+
1722
+ # query parameters
1723
+ query_params = {}
1724
+ query_params[:'moveChildrenToWorkspaceId'] = opts[:'move_children_to_workspace_id'] if opts[:'move_children_to_workspace_id']
1725
+
1726
+ # header parameters
1727
+ header_params = {}
1728
+
1729
+ # HTTP header 'Accept' (if needed)
1730
+ _header_accept = ['application/json']
1731
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1732
+
1733
+ # HTTP header 'Content-Type'
1734
+ _header_content_type = ['application/json']
1735
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1736
+
1737
+ # form parameters
1738
+ form_params = {}
1739
+
1740
+ # http body (model)
1741
+ post_body = nil
1742
+
1743
+
1744
+ auth_names = ['PureCloud Auth']
1745
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1746
+ :header_params => header_params,
1747
+ :query_params => query_params,
1748
+ :form_params => form_params,
1749
+ :body => post_body,
1750
+ :auth_names => auth_names)
1751
+ if @api_client.config.debugging
1752
+ @api_client.config.logger.debug "API called: ContentManagementApi#delete_contentmanagement_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1753
+ end
1754
+ return data, status_code, headers
1755
+ end
1756
+
1757
+ # Get a list workspace members
1758
+ #
1759
+ # @param workspace_id Workspace ID
1760
+ # @param [Hash] opts the optional parameters
1761
+ # @option opts [Integer] :page_size Page size
1762
+ # @option opts [Integer] :page_number Page number
1763
+ # @option opts [String] :expand Expand workspace member fields
1764
+ # @return [WorkspaceMemberEntityListing]
1765
+ def get_contentmanagement_workspace_members(workspace_id, opts = {})
1766
+ data, status_code, headers = get_contentmanagement_workspace_members_with_http_info(workspace_id, opts)
1767
+ return data
1768
+ end
1769
+
1770
+ # Get a list workspace members
1771
+ #
1772
+ # @param workspace_id Workspace ID
1773
+ # @param [Hash] opts the optional parameters
1774
+ # @option opts [Integer] :page_size Page size
1775
+ # @option opts [Integer] :page_number Page number
1776
+ # @option opts [String] :expand Expand workspace member fields
1777
+ # @return [Array<(WorkspaceMemberEntityListing, Fixnum, Hash)>] WorkspaceMemberEntityListing data, response status code and response headers
1778
+ def get_contentmanagement_workspace_members_with_http_info(workspace_id, opts = {})
1779
+ if @api_client.config.debugging
1780
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_workspace_members ..."
1781
+ end
1782
+
1783
+ # verify the required parameter 'workspace_id' is set
1784
+ fail "Missing the required parameter 'workspace_id' when calling get_contentmanagement_workspace_members" if workspace_id.nil?
1785
+
1786
+ if opts[:'expand'] && !['member'].include?(opts[:'expand'])
1787
+ fail 'invalid value for "expand", must be one of member'
1788
+ end
1789
+
1790
+ # resource path
1791
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/members".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
1792
+
1793
+ # query parameters
1794
+ query_params = {}
1795
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1796
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1797
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1798
+
1799
+ # header parameters
1800
+ header_params = {}
1801
+
1802
+ # HTTP header 'Accept' (if needed)
1803
+ _header_accept = ['application/json']
1804
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1805
+
1806
+ # HTTP header 'Content-Type'
1807
+ _header_content_type = ['application/json']
1808
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1809
+
1810
+ # form parameters
1811
+ form_params = {}
1812
+
1813
+ # http body (model)
1814
+ post_body = nil
1815
+
1816
+
1817
+ auth_names = ['PureCloud Auth']
1818
+ data, status_code, headers = @api_client.call_api(:GET, path,
1819
+ :header_params => header_params,
1820
+ :query_params => query_params,
1821
+ :form_params => form_params,
1822
+ :body => post_body,
1823
+ :auth_names => auth_names,
1824
+ :return_type => 'WorkspaceMemberEntityListing')
1825
+ if @api_client.config.debugging
1826
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_workspace_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1827
+ end
1828
+ return data, status_code, headers
1829
+ end
1830
+
1831
+ # Get a workspace member
1832
+ #
1833
+ # @param workspace_id Workspace ID
1834
+ # @param member_id Member ID
1835
+ # @param [Hash] opts the optional parameters
1836
+ # @option opts [String] :expand Expand workspace member fields
1837
+ # @return [WorkspaceMember]
1838
+ def get_contentmanagement_workspace_member(workspace_id, member_id, opts = {})
1839
+ data, status_code, headers = get_contentmanagement_workspace_member_with_http_info(workspace_id, member_id, opts)
1840
+ return data
1841
+ end
1842
+
1843
+ # Get a workspace member
1844
+ #
1845
+ # @param workspace_id Workspace ID
1846
+ # @param member_id Member ID
1847
+ # @param [Hash] opts the optional parameters
1848
+ # @option opts [String] :expand Expand workspace member fields
1849
+ # @return [Array<(WorkspaceMember, Fixnum, Hash)>] WorkspaceMember data, response status code and response headers
1850
+ def get_contentmanagement_workspace_member_with_http_info(workspace_id, member_id, opts = {})
1851
+ if @api_client.config.debugging
1852
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_workspace_member ..."
1853
+ end
1854
+
1855
+ # verify the required parameter 'workspace_id' is set
1856
+ fail "Missing the required parameter 'workspace_id' when calling get_contentmanagement_workspace_member" if workspace_id.nil?
1857
+
1858
+ # verify the required parameter 'member_id' is set
1859
+ fail "Missing the required parameter 'member_id' when calling get_contentmanagement_workspace_member" if member_id.nil?
1860
+
1861
+ if opts[:'expand'] && !['member'].include?(opts[:'expand'])
1862
+ fail 'invalid value for "expand", must be one of member'
1863
+ end
1864
+
1865
+ # resource path
1866
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/members/{memberId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
1867
+
1868
+ # query parameters
1869
+ query_params = {}
1870
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
1871
+
1872
+ # header parameters
1873
+ header_params = {}
1874
+
1875
+ # HTTP header 'Accept' (if needed)
1876
+ _header_accept = ['application/json']
1877
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1878
+
1879
+ # HTTP header 'Content-Type'
1880
+ _header_content_type = ['application/json']
1881
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1882
+
1883
+ # form parameters
1884
+ form_params = {}
1885
+
1886
+ # http body (model)
1887
+ post_body = nil
1888
+
1889
+
1890
+ auth_names = ['PureCloud Auth']
1891
+ data, status_code, headers = @api_client.call_api(:GET, path,
1892
+ :header_params => header_params,
1893
+ :query_params => query_params,
1894
+ :form_params => form_params,
1895
+ :body => post_body,
1896
+ :auth_names => auth_names,
1897
+ :return_type => 'WorkspaceMember')
1898
+ if @api_client.config.debugging
1899
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_workspace_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1900
+ end
1901
+ return data, status_code, headers
1902
+ end
1903
+
1904
+ # Add a member to a workspace
1905
+ #
1906
+ # @param workspace_id Workspace ID
1907
+ # @param member_id Member ID
1908
+ # @param [Hash] opts the optional parameters
1909
+ # @option opts [WorkspaceMember] :body Workspace
1910
+ # @return [WorkspaceMember]
1911
+ def put_contentmanagement_workspace_member(workspace_id, member_id, opts = {})
1912
+ data, status_code, headers = put_contentmanagement_workspace_member_with_http_info(workspace_id, member_id, opts)
1913
+ return data
1914
+ end
1915
+
1916
+ # Add a member to a workspace
1917
+ #
1918
+ # @param workspace_id Workspace ID
1919
+ # @param member_id Member ID
1920
+ # @param [Hash] opts the optional parameters
1921
+ # @option opts [WorkspaceMember] :body Workspace
1922
+ # @return [Array<(WorkspaceMember, Fixnum, Hash)>] WorkspaceMember data, response status code and response headers
1923
+ def put_contentmanagement_workspace_member_with_http_info(workspace_id, member_id, opts = {})
1924
+ if @api_client.config.debugging
1925
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#put_contentmanagement_workspace_member ..."
1926
+ end
1927
+
1928
+ # verify the required parameter 'workspace_id' is set
1929
+ fail "Missing the required parameter 'workspace_id' when calling put_contentmanagement_workspace_member" if workspace_id.nil?
1930
+
1931
+ # verify the required parameter 'member_id' is set
1932
+ fail "Missing the required parameter 'member_id' when calling put_contentmanagement_workspace_member" if member_id.nil?
1933
+
1934
+ # resource path
1935
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/members/{memberId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
1936
+
1937
+ # query parameters
1938
+ query_params = {}
1939
+
1940
+ # header parameters
1941
+ header_params = {}
1942
+
1943
+ # HTTP header 'Accept' (if needed)
1944
+ _header_accept = ['application/json']
1945
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1946
+
1947
+ # HTTP header 'Content-Type'
1948
+ _header_content_type = ['application/json']
1949
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1950
+
1951
+ # form parameters
1952
+ form_params = {}
1953
+
1954
+ # http body (model)
1955
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1956
+
1957
+
1958
+ auth_names = ['PureCloud Auth']
1959
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1960
+ :header_params => header_params,
1961
+ :query_params => query_params,
1962
+ :form_params => form_params,
1963
+ :body => post_body,
1964
+ :auth_names => auth_names,
1965
+ :return_type => 'WorkspaceMember')
1966
+ if @api_client.config.debugging
1967
+ @api_client.config.logger.debug "API called: ContentManagementApi#put_contentmanagement_workspace_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1968
+ end
1969
+ return data, status_code, headers
1970
+ end
1971
+
1972
+ # Delete a member from a workspace
1973
+ #
1974
+ # @param workspace_id Workspace ID
1975
+ # @param member_id Member ID
1976
+ # @param [Hash] opts the optional parameters
1977
+ # @return [nil]
1978
+ def delete_contentmanagement_workspace_member(workspace_id, member_id, opts = {})
1979
+ delete_contentmanagement_workspace_member_with_http_info(workspace_id, member_id, opts)
1980
+ return nil
1981
+ end
1982
+
1983
+ # Delete a member from a workspace
1984
+ #
1985
+ # @param workspace_id Workspace ID
1986
+ # @param member_id Member ID
1987
+ # @param [Hash] opts the optional parameters
1988
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1989
+ def delete_contentmanagement_workspace_member_with_http_info(workspace_id, member_id, opts = {})
1990
+ if @api_client.config.debugging
1991
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_contentmanagement_workspace_member ..."
1992
+ end
1993
+
1994
+ # verify the required parameter 'workspace_id' is set
1995
+ fail "Missing the required parameter 'workspace_id' when calling delete_contentmanagement_workspace_member" if workspace_id.nil?
1996
+
1997
+ # verify the required parameter 'member_id' is set
1998
+ fail "Missing the required parameter 'member_id' when calling delete_contentmanagement_workspace_member" if member_id.nil?
1999
+
2000
+ # resource path
2001
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/members/{memberId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)
2002
+
2003
+ # query parameters
2004
+ query_params = {}
2005
+
2006
+ # header parameters
2007
+ header_params = {}
2008
+
2009
+ # HTTP header 'Accept' (if needed)
2010
+ _header_accept = ['application/json']
2011
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2012
+
2013
+ # HTTP header 'Content-Type'
2014
+ _header_content_type = ['application/json']
2015
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2016
+
2017
+ # form parameters
2018
+ form_params = {}
2019
+
2020
+ # http body (model)
2021
+ post_body = nil
2022
+
2023
+
2024
+ auth_names = ['PureCloud Auth']
2025
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
2026
+ :header_params => header_params,
2027
+ :query_params => query_params,
2028
+ :form_params => form_params,
2029
+ :body => post_body,
2030
+ :auth_names => auth_names)
2031
+ if @api_client.config.debugging
2032
+ @api_client.config.logger.debug "API called: ContentManagementApi#delete_contentmanagement_workspace_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2033
+ end
2034
+ return data, status_code, headers
2035
+ end
2036
+
2037
+ # Get a list of workspace tags
2038
+ #
2039
+ # @param workspace_id Workspace ID
2040
+ # @param [Hash] opts the optional parameters
2041
+ # @option opts [String] :value filter the list of tags returned
2042
+ # @option opts [Integer] :page_size Page size
2043
+ # @option opts [Integer] :page_number Page number
2044
+ # @option opts [String] :expand Expand some document fields
2045
+ # @return [TagValueEntityListing]
2046
+ def get_contentmanagement_workspace_tagvalues(workspace_id, opts = {})
2047
+ data, status_code, headers = get_contentmanagement_workspace_tagvalues_with_http_info(workspace_id, opts)
2048
+ return data
2049
+ end
2050
+
2051
+ # Get a list of workspace tags
2052
+ #
2053
+ # @param workspace_id Workspace ID
2054
+ # @param [Hash] opts the optional parameters
2055
+ # @option opts [String] :value filter the list of tags returned
2056
+ # @option opts [Integer] :page_size Page size
2057
+ # @option opts [Integer] :page_number Page number
2058
+ # @option opts [String] :expand Expand some document fields
2059
+ # @return [Array<(TagValueEntityListing, Fixnum, Hash)>] TagValueEntityListing data, response status code and response headers
2060
+ def get_contentmanagement_workspace_tagvalues_with_http_info(workspace_id, opts = {})
2061
+ if @api_client.config.debugging
2062
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_workspace_tagvalues ..."
2063
+ end
2064
+
2065
+ # verify the required parameter 'workspace_id' is set
2066
+ fail "Missing the required parameter 'workspace_id' when calling get_contentmanagement_workspace_tagvalues" if workspace_id.nil?
2067
+
2068
+ if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
2069
+ fail 'invalid value for "expand", must be one of acl'
2070
+ end
2071
+
2072
+ # resource path
2073
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
2074
+
2075
+ # query parameters
2076
+ query_params = {}
2077
+ query_params[:'value'] = opts[:'value'] if opts[:'value']
2078
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2079
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2080
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2081
+
2082
+ # header parameters
2083
+ header_params = {}
2084
+
2085
+ # HTTP header 'Accept' (if needed)
2086
+ _header_accept = ['application/json']
2087
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2088
+
2089
+ # HTTP header 'Content-Type'
2090
+ _header_content_type = ['application/json']
2091
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2092
+
2093
+ # form parameters
2094
+ form_params = {}
2095
+
2096
+ # http body (model)
2097
+ post_body = nil
2098
+
2099
+
2100
+ auth_names = ['PureCloud Auth']
2101
+ data, status_code, headers = @api_client.call_api(:GET, path,
2102
+ :header_params => header_params,
2103
+ :query_params => query_params,
2104
+ :form_params => form_params,
2105
+ :body => post_body,
2106
+ :auth_names => auth_names,
2107
+ :return_type => 'TagValueEntityListing')
2108
+ if @api_client.config.debugging
2109
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_workspace_tagvalues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2110
+ end
2111
+ return data, status_code, headers
2112
+ end
2113
+
2114
+ # Create a workspace tag
2115
+ #
2116
+ # @param workspace_id Workspace ID
2117
+ # @param [Hash] opts the optional parameters
2118
+ # @option opts [TagValue] :body tag
2119
+ # @return [TagValue]
2120
+ def post_contentmanagement_workspace_tagvalues(workspace_id, opts = {})
2121
+ data, status_code, headers = post_contentmanagement_workspace_tagvalues_with_http_info(workspace_id, opts)
2122
+ return data
2123
+ end
2124
+
2125
+ # Create a workspace tag
2126
+ #
2127
+ # @param workspace_id Workspace ID
2128
+ # @param [Hash] opts the optional parameters
2129
+ # @option opts [TagValue] :body tag
2130
+ # @return [Array<(TagValue, Fixnum, Hash)>] TagValue data, response status code and response headers
2131
+ def post_contentmanagement_workspace_tagvalues_with_http_info(workspace_id, opts = {})
2132
+ if @api_client.config.debugging
2133
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_workspace_tagvalues ..."
2134
+ end
2135
+
2136
+ # verify the required parameter 'workspace_id' is set
2137
+ fail "Missing the required parameter 'workspace_id' when calling post_contentmanagement_workspace_tagvalues" if workspace_id.nil?
2138
+
2139
+ # resource path
2140
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
2141
+
2142
+ # query parameters
2143
+ query_params = {}
2144
+
2145
+ # header parameters
2146
+ header_params = {}
2147
+
2148
+ # HTTP header 'Accept' (if needed)
2149
+ _header_accept = ['application/json']
2150
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2151
+
2152
+ # HTTP header 'Content-Type'
2153
+ _header_content_type = ['application/json']
2154
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2155
+
2156
+ # form parameters
2157
+ form_params = {}
2158
+
2159
+ # http body (model)
2160
+ post_body = @api_client.object_to_http_body(opts[:'body'])
2161
+
2162
+
2163
+ auth_names = ['PureCloud Auth']
2164
+ data, status_code, headers = @api_client.call_api(:POST, path,
2165
+ :header_params => header_params,
2166
+ :query_params => query_params,
2167
+ :form_params => form_params,
2168
+ :body => post_body,
2169
+ :auth_names => auth_names,
2170
+ :return_type => 'TagValue')
2171
+ if @api_client.config.debugging
2172
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_workspace_tagvalues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2173
+ end
2174
+ return data, status_code, headers
2175
+ end
2176
+
2177
+ # Perform a prefix query on tags in the workspace
2178
+ #
2179
+ # @param workspace_id Workspace ID
2180
+ # @param [Hash] opts the optional parameters
2181
+ # @option opts [TagQueryRequest] :body query
2182
+ # @option opts [String] :expand Expand some document fields
2183
+ # @return [TagValueEntityListing]
2184
+ def post_contentmanagement_workspace_tagvalues_query(workspace_id, opts = {})
2185
+ data, status_code, headers = post_contentmanagement_workspace_tagvalues_query_with_http_info(workspace_id, opts)
2186
+ return data
2187
+ end
2188
+
2189
+ # Perform a prefix query on tags in the workspace
2190
+ #
2191
+ # @param workspace_id Workspace ID
2192
+ # @param [Hash] opts the optional parameters
2193
+ # @option opts [TagQueryRequest] :body query
2194
+ # @option opts [String] :expand Expand some document fields
2195
+ # @return [Array<(TagValueEntityListing, Fixnum, Hash)>] TagValueEntityListing data, response status code and response headers
2196
+ def post_contentmanagement_workspace_tagvalues_query_with_http_info(workspace_id, opts = {})
2197
+ if @api_client.config.debugging
2198
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#post_contentmanagement_workspace_tagvalues_query ..."
2199
+ end
2200
+
2201
+ # verify the required parameter 'workspace_id' is set
2202
+ fail "Missing the required parameter 'workspace_id' when calling post_contentmanagement_workspace_tagvalues_query" if workspace_id.nil?
2203
+
2204
+ if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
2205
+ fail 'invalid value for "expand", must be one of acl'
2206
+ end
2207
+
2208
+ # resource path
2209
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues/query".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s)
2210
+
2211
+ # query parameters
2212
+ query_params = {}
2213
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2214
+
2215
+ # header parameters
2216
+ header_params = {}
2217
+
2218
+ # HTTP header 'Accept' (if needed)
2219
+ _header_accept = ['application/json']
2220
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2221
+
2222
+ # HTTP header 'Content-Type'
2223
+ _header_content_type = ['application/json']
2224
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2225
+
2226
+ # form parameters
2227
+ form_params = {}
2228
+
2229
+ # http body (model)
2230
+ post_body = @api_client.object_to_http_body(opts[:'body'])
2231
+
2232
+
2233
+ auth_names = ['PureCloud Auth']
2234
+ data, status_code, headers = @api_client.call_api(:POST, path,
2235
+ :header_params => header_params,
2236
+ :query_params => query_params,
2237
+ :form_params => form_params,
2238
+ :body => post_body,
2239
+ :auth_names => auth_names,
2240
+ :return_type => 'TagValueEntityListing')
2241
+ if @api_client.config.debugging
2242
+ @api_client.config.logger.debug "API called: ContentManagementApi#post_contentmanagement_workspace_tagvalues_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2243
+ end
2244
+ return data, status_code, headers
2245
+ end
2246
+
2247
+ # Get a workspace tag
2248
+ #
2249
+ # @param workspace_id Workspace ID
2250
+ # @param tag_id Tag ID
2251
+ # @param [Hash] opts the optional parameters
2252
+ # @option opts [String] :expand Expand some document fields
2253
+ # @return [TagValue]
2254
+ def get_contentmanagement_workspace_tagvalue(workspace_id, tag_id, opts = {})
2255
+ data, status_code, headers = get_contentmanagement_workspace_tagvalue_with_http_info(workspace_id, tag_id, opts)
2256
+ return data
2257
+ end
2258
+
2259
+ # Get a workspace tag
2260
+ #
2261
+ # @param workspace_id Workspace ID
2262
+ # @param tag_id Tag ID
2263
+ # @param [Hash] opts the optional parameters
2264
+ # @option opts [String] :expand Expand some document fields
2265
+ # @return [Array<(TagValue, Fixnum, Hash)>] TagValue data, response status code and response headers
2266
+ def get_contentmanagement_workspace_tagvalue_with_http_info(workspace_id, tag_id, opts = {})
2267
+ if @api_client.config.debugging
2268
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#get_contentmanagement_workspace_tagvalue ..."
2269
+ end
2270
+
2271
+ # verify the required parameter 'workspace_id' is set
2272
+ fail "Missing the required parameter 'workspace_id' when calling get_contentmanagement_workspace_tagvalue" if workspace_id.nil?
2273
+
2274
+ # verify the required parameter 'tag_id' is set
2275
+ fail "Missing the required parameter 'tag_id' when calling get_contentmanagement_workspace_tagvalue" if tag_id.nil?
2276
+
2277
+ if opts[:'expand'] && !['acl'].include?(opts[:'expand'])
2278
+ fail 'invalid value for "expand", must be one of acl'
2279
+ end
2280
+
2281
+ # resource path
2282
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s)
2283
+
2284
+ # query parameters
2285
+ query_params = {}
2286
+ query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
2287
+
2288
+ # header parameters
2289
+ header_params = {}
2290
+
2291
+ # HTTP header 'Accept' (if needed)
2292
+ _header_accept = ['application/json']
2293
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2294
+
2295
+ # HTTP header 'Content-Type'
2296
+ _header_content_type = ['application/json']
2297
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2298
+
2299
+ # form parameters
2300
+ form_params = {}
2301
+
2302
+ # http body (model)
2303
+ post_body = nil
2304
+
2305
+
2306
+ auth_names = ['PureCloud Auth']
2307
+ data, status_code, headers = @api_client.call_api(:GET, path,
2308
+ :header_params => header_params,
2309
+ :query_params => query_params,
2310
+ :form_params => form_params,
2311
+ :body => post_body,
2312
+ :auth_names => auth_names,
2313
+ :return_type => 'TagValue')
2314
+ if @api_client.config.debugging
2315
+ @api_client.config.logger.debug "API called: ContentManagementApi#get_contentmanagement_workspace_tagvalue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2316
+ end
2317
+ return data, status_code, headers
2318
+ end
2319
+
2320
+ # Update a workspace tag. Will update all documents with the new tag value.
2321
+ #
2322
+ # @param workspace_id Workspace ID
2323
+ # @param tag_id Tag ID
2324
+ # @param [Hash] opts the optional parameters
2325
+ # @option opts [TagValue] :body Workspace
2326
+ # @return [TagValue]
2327
+ def put_contentmanagement_workspace_tagvalue(workspace_id, tag_id, opts = {})
2328
+ data, status_code, headers = put_contentmanagement_workspace_tagvalue_with_http_info(workspace_id, tag_id, opts)
2329
+ return data
2330
+ end
2331
+
2332
+ # Update a workspace tag. Will update all documents with the new tag value.
2333
+ #
2334
+ # @param workspace_id Workspace ID
2335
+ # @param tag_id Tag ID
2336
+ # @param [Hash] opts the optional parameters
2337
+ # @option opts [TagValue] :body Workspace
2338
+ # @return [Array<(TagValue, Fixnum, Hash)>] TagValue data, response status code and response headers
2339
+ def put_contentmanagement_workspace_tagvalue_with_http_info(workspace_id, tag_id, opts = {})
2340
+ if @api_client.config.debugging
2341
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#put_contentmanagement_workspace_tagvalue ..."
2342
+ end
2343
+
2344
+ # verify the required parameter 'workspace_id' is set
2345
+ fail "Missing the required parameter 'workspace_id' when calling put_contentmanagement_workspace_tagvalue" if workspace_id.nil?
2346
+
2347
+ # verify the required parameter 'tag_id' is set
2348
+ fail "Missing the required parameter 'tag_id' when calling put_contentmanagement_workspace_tagvalue" if tag_id.nil?
2349
+
2350
+ # resource path
2351
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s)
2352
+
2353
+ # query parameters
2354
+ query_params = {}
2355
+
2356
+ # header parameters
2357
+ header_params = {}
2358
+
2359
+ # HTTP header 'Accept' (if needed)
2360
+ _header_accept = ['application/json']
2361
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2362
+
2363
+ # HTTP header 'Content-Type'
2364
+ _header_content_type = ['application/json']
2365
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2366
+
2367
+ # form parameters
2368
+ form_params = {}
2369
+
2370
+ # http body (model)
2371
+ post_body = @api_client.object_to_http_body(opts[:'body'])
2372
+
2373
+
2374
+ auth_names = ['PureCloud Auth']
2375
+ data, status_code, headers = @api_client.call_api(:PUT, path,
2376
+ :header_params => header_params,
2377
+ :query_params => query_params,
2378
+ :form_params => form_params,
2379
+ :body => post_body,
2380
+ :auth_names => auth_names,
2381
+ :return_type => 'TagValue')
2382
+ if @api_client.config.debugging
2383
+ @api_client.config.logger.debug "API called: ContentManagementApi#put_contentmanagement_workspace_tagvalue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2384
+ end
2385
+ return data, status_code, headers
2386
+ end
2387
+
2388
+ # Delete workspace tag
2389
+ # Delete a tag from a workspace. Will remove this tag from all documents.
2390
+ # @param workspace_id Workspace ID
2391
+ # @param tag_id Tag ID
2392
+ # @param [Hash] opts the optional parameters
2393
+ # @return [nil]
2394
+ def delete_contentmanagement_workspace_tagvalue(workspace_id, tag_id, opts = {})
2395
+ delete_contentmanagement_workspace_tagvalue_with_http_info(workspace_id, tag_id, opts)
2396
+ return nil
2397
+ end
2398
+
2399
+ # Delete workspace tag
2400
+ # Delete a tag from a workspace. Will remove this tag from all documents.
2401
+ # @param workspace_id Workspace ID
2402
+ # @param tag_id Tag ID
2403
+ # @param [Hash] opts the optional parameters
2404
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
2405
+ def delete_contentmanagement_workspace_tagvalue_with_http_info(workspace_id, tag_id, opts = {})
2406
+ if @api_client.config.debugging
2407
+ @api_client.config.logger.debug "Calling API: ContentManagementApi#delete_contentmanagement_workspace_tagvalue ..."
2408
+ end
2409
+
2410
+ # verify the required parameter 'workspace_id' is set
2411
+ fail "Missing the required parameter 'workspace_id' when calling delete_contentmanagement_workspace_tagvalue" if workspace_id.nil?
2412
+
2413
+ # verify the required parameter 'tag_id' is set
2414
+ fail "Missing the required parameter 'tag_id' when calling delete_contentmanagement_workspace_tagvalue" if tag_id.nil?
2415
+
2416
+ # resource path
2417
+ path = "/api/v1/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}".sub('{format}','json').sub('{' + 'workspaceId' + '}', workspace_id.to_s).sub('{' + 'tagId' + '}', tag_id.to_s)
2418
+
2419
+ # query parameters
2420
+ query_params = {}
2421
+
2422
+ # header parameters
2423
+ header_params = {}
2424
+
2425
+ # HTTP header 'Accept' (if needed)
2426
+ _header_accept = ['application/json']
2427
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2428
+
2429
+ # HTTP header 'Content-Type'
2430
+ _header_content_type = ['application/json']
2431
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2432
+
2433
+ # form parameters
2434
+ form_params = {}
2435
+
2436
+ # http body (model)
2437
+ post_body = nil
2438
+
2439
+
2440
+ auth_names = ['PureCloud Auth']
2441
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
2442
+ :header_params => header_params,
2443
+ :query_params => query_params,
2444
+ :form_params => form_params,
2445
+ :body => post_body,
2446
+ :auth_names => auth_names)
2447
+ if @api_client.config.debugging
2448
+ @api_client.config.logger.debug "API called: ContentManagementApi#delete_contentmanagement_workspace_tagvalue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2449
+ end
2450
+ return data, status_code, headers
2451
+ end
2452
+ end
2453
+ end
2454
+
2455
+
2456
+
2457
+