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,263 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class GeolocationApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Get a organization's GeolocationSettings
12
+ #
13
+ # @param [Hash] opts the optional parameters
14
+ # @return [GeolocationSettings]
15
+ def get_geolocations_settings(opts = {})
16
+ data, status_code, headers = get_geolocations_settings_with_http_info(opts)
17
+ return data
18
+ end
19
+
20
+ # Get a organization's GeolocationSettings
21
+ #
22
+ # @param [Hash] opts the optional parameters
23
+ # @return [Array<(GeolocationSettings, Fixnum, Hash)>] GeolocationSettings data, response status code and response headers
24
+ def get_geolocations_settings_with_http_info(opts = {})
25
+ if @api_client.config.debugging
26
+ @api_client.config.logger.debug "Calling API: GeolocationApi#get_geolocations_settings ..."
27
+ end
28
+
29
+ # resource path
30
+ path = "/api/v1/geolocations/settings".sub('{format}','json')
31
+
32
+ # query parameters
33
+ query_params = {}
34
+
35
+ # header parameters
36
+ header_params = {}
37
+
38
+ # HTTP header 'Accept' (if needed)
39
+ _header_accept = ['application/json']
40
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
41
+
42
+ # HTTP header 'Content-Type'
43
+ _header_content_type = ['application/json']
44
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
45
+
46
+ # form parameters
47
+ form_params = {}
48
+
49
+ # http body (model)
50
+ post_body = nil
51
+
52
+
53
+ auth_names = ['PureCloud Auth']
54
+ data, status_code, headers = @api_client.call_api(:GET, path,
55
+ :header_params => header_params,
56
+ :query_params => query_params,
57
+ :form_params => form_params,
58
+ :body => post_body,
59
+ :auth_names => auth_names,
60
+ :return_type => 'GeolocationSettings')
61
+ if @api_client.config.debugging
62
+ @api_client.config.logger.debug "API called: GeolocationApi#get_geolocations_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
63
+ end
64
+ return data, status_code, headers
65
+ end
66
+
67
+ # Patch a organization&#39;s GeolocationSettings
68
+ #
69
+ # @param [Hash] opts the optional parameters
70
+ # @option opts [GeolocationSettings] :body
71
+ # @return [GeolocationSettings]
72
+ def patch_geolocations_settings(opts = {})
73
+ data, status_code, headers = patch_geolocations_settings_with_http_info(opts)
74
+ return data
75
+ end
76
+
77
+ # Patch a organization&#39;s GeolocationSettings
78
+ #
79
+ # @param [Hash] opts the optional parameters
80
+ # @option opts [GeolocationSettings] :body
81
+ # @return [Array<(GeolocationSettings, Fixnum, Hash)>] GeolocationSettings data, response status code and response headers
82
+ def patch_geolocations_settings_with_http_info(opts = {})
83
+ if @api_client.config.debugging
84
+ @api_client.config.logger.debug "Calling API: GeolocationApi#patch_geolocations_settings ..."
85
+ end
86
+
87
+ # resource path
88
+ path = "/api/v1/geolocations/settings".sub('{format}','json')
89
+
90
+ # query parameters
91
+ query_params = {}
92
+
93
+ # header parameters
94
+ header_params = {}
95
+
96
+ # HTTP header 'Accept' (if needed)
97
+ _header_accept = ['application/json']
98
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
99
+
100
+ # HTTP header 'Content-Type'
101
+ _header_content_type = ['application/json']
102
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
103
+
104
+ # form parameters
105
+ form_params = {}
106
+
107
+ # http body (model)
108
+ post_body = @api_client.object_to_http_body(opts[:'body'])
109
+
110
+
111
+ auth_names = ['PureCloud Auth']
112
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
113
+ :header_params => header_params,
114
+ :query_params => query_params,
115
+ :form_params => form_params,
116
+ :body => post_body,
117
+ :auth_names => auth_names,
118
+ :return_type => 'GeolocationSettings')
119
+ if @api_client.config.debugging
120
+ @api_client.config.logger.debug "API called: GeolocationApi#patch_geolocations_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
121
+ end
122
+ return data, status_code, headers
123
+ end
124
+
125
+ # Get a user&#39;s Geolocation
126
+ #
127
+ # @param user_id user Id
128
+ # @param client_id client Id
129
+ # @param [Hash] opts the optional parameters
130
+ # @return [Geolocation]
131
+ def get_geolocation(user_id, client_id, opts = {})
132
+ data, status_code, headers = get_geolocation_with_http_info(user_id, client_id, opts)
133
+ return data
134
+ end
135
+
136
+ # Get a user&#39;s Geolocation
137
+ #
138
+ # @param user_id user Id
139
+ # @param client_id client Id
140
+ # @param [Hash] opts the optional parameters
141
+ # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
142
+ def get_geolocation_with_http_info(user_id, client_id, opts = {})
143
+ if @api_client.config.debugging
144
+ @api_client.config.logger.debug "Calling API: GeolocationApi#get_geolocation ..."
145
+ end
146
+
147
+ # verify the required parameter 'user_id' is set
148
+ fail "Missing the required parameter 'user_id' when calling get_geolocation" if user_id.nil?
149
+
150
+ # verify the required parameter 'client_id' is set
151
+ fail "Missing the required parameter 'client_id' when calling get_geolocation" if client_id.nil?
152
+
153
+ # resource path
154
+ path = "/api/v1/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
155
+
156
+ # query parameters
157
+ query_params = {}
158
+
159
+ # header parameters
160
+ header_params = {}
161
+
162
+ # HTTP header 'Accept' (if needed)
163
+ _header_accept = ['application/json']
164
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
165
+
166
+ # HTTP header 'Content-Type'
167
+ _header_content_type = ['application/json']
168
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
169
+
170
+ # form parameters
171
+ form_params = {}
172
+
173
+ # http body (model)
174
+ post_body = nil
175
+
176
+
177
+ auth_names = ['PureCloud Auth']
178
+ data, status_code, headers = @api_client.call_api(:GET, path,
179
+ :header_params => header_params,
180
+ :query_params => query_params,
181
+ :form_params => form_params,
182
+ :body => post_body,
183
+ :auth_names => auth_names,
184
+ :return_type => 'Geolocation')
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug "API called: GeolocationApi#get_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
187
+ end
188
+ return data, status_code, headers
189
+ end
190
+
191
+ # Patch a user&#39;s Geolocation
192
+ # The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source. Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values. This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;. Option 3: Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
193
+ # @param user_id user Id
194
+ # @param client_id client Id
195
+ # @param [Hash] opts the optional parameters
196
+ # @option opts [Geolocation] :body
197
+ # @return [Geolocation]
198
+ def patch_geolocation(user_id, client_id, opts = {})
199
+ data, status_code, headers = patch_geolocation_with_http_info(user_id, client_id, opts)
200
+ return data
201
+ end
202
+
203
+ # Patch a user&#39;s Geolocation
204
+ # The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source. Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values. This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;. Option 3: Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
205
+ # @param user_id user Id
206
+ # @param client_id client Id
207
+ # @param [Hash] opts the optional parameters
208
+ # @option opts [Geolocation] :body
209
+ # @return [Array<(Geolocation, Fixnum, Hash)>] Geolocation data, response status code and response headers
210
+ def patch_geolocation_with_http_info(user_id, client_id, opts = {})
211
+ if @api_client.config.debugging
212
+ @api_client.config.logger.debug "Calling API: GeolocationApi#patch_geolocation ..."
213
+ end
214
+
215
+ # verify the required parameter 'user_id' is set
216
+ fail "Missing the required parameter 'user_id' when calling patch_geolocation" if user_id.nil?
217
+
218
+ # verify the required parameter 'client_id' is set
219
+ fail "Missing the required parameter 'client_id' when calling patch_geolocation" if client_id.nil?
220
+
221
+ # resource path
222
+ path = "/api/v1/users/{userId}/geolocations/{clientId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'clientId' + '}', client_id.to_s)
223
+
224
+ # query parameters
225
+ query_params = {}
226
+
227
+ # header parameters
228
+ header_params = {}
229
+
230
+ # HTTP header 'Accept' (if needed)
231
+ _header_accept = ['application/json']
232
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
233
+
234
+ # HTTP header 'Content-Type'
235
+ _header_content_type = ['application/json']
236
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
237
+
238
+ # form parameters
239
+ form_params = {}
240
+
241
+ # http body (model)
242
+ post_body = @api_client.object_to_http_body(opts[:'body'])
243
+
244
+
245
+ auth_names = ['PureCloud Auth']
246
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
247
+ :header_params => header_params,
248
+ :query_params => query_params,
249
+ :form_params => form_params,
250
+ :body => post_body,
251
+ :auth_names => auth_names,
252
+ :return_type => 'Geolocation')
253
+ if @api_client.config.debugging
254
+ @api_client.config.logger.debug "API called: GeolocationApi#patch_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
255
+ end
256
+ return data, status_code, headers
257
+ end
258
+ end
259
+ end
260
+
261
+
262
+
263
+
@@ -0,0 +1,771 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class GreetingsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Gets an Organization&#39;s Greetings
12
+ #
13
+ # @param [Hash] opts the optional parameters
14
+ # @option opts [Integer] :page_size Page size
15
+ # @option opts [Integer] :page_number Page number
16
+ # @return [DomainEntityListing]
17
+ def get_greetings(opts = {})
18
+ data, status_code, headers = get_greetings_with_http_info(opts)
19
+ return data
20
+ end
21
+
22
+ # Gets an Organization&#39;s Greetings
23
+ #
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [Integer] :page_size Page size
26
+ # @option opts [Integer] :page_number Page number
27
+ # @return [Array<(DomainEntityListing, Fixnum, Hash)>] DomainEntityListing data, response status code and response headers
28
+ def get_greetings_with_http_info(opts = {})
29
+ if @api_client.config.debugging
30
+ @api_client.config.logger.debug "Calling API: GreetingsApi#get_greetings ..."
31
+ end
32
+
33
+ # resource path
34
+ path = "/api/v1/greetings".sub('{format}','json')
35
+
36
+ # query parameters
37
+ query_params = {}
38
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
39
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
40
+
41
+ # header parameters
42
+ header_params = {}
43
+
44
+ # HTTP header 'Accept' (if needed)
45
+ _header_accept = ['application/json']
46
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
47
+
48
+ # HTTP header 'Content-Type'
49
+ _header_content_type = ['application/json']
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
51
+
52
+ # form parameters
53
+ form_params = {}
54
+
55
+ # http body (model)
56
+ post_body = nil
57
+
58
+
59
+ auth_names = ['PureCloud Auth']
60
+ data, status_code, headers = @api_client.call_api(:GET, path,
61
+ :header_params => header_params,
62
+ :query_params => query_params,
63
+ :form_params => form_params,
64
+ :body => post_body,
65
+ :auth_names => auth_names,
66
+ :return_type => 'DomainEntityListing')
67
+ if @api_client.config.debugging
68
+ @api_client.config.logger.debug "API called: GreetingsApi#get_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
69
+ end
70
+ return data, status_code, headers
71
+ end
72
+
73
+ # Create a Greeting for an Organization
74
+ #
75
+ # @param body The Greeting to create
76
+ # @param [Hash] opts the optional parameters
77
+ # @return [DefaultGreetingList]
78
+ def post_greetings(body, opts = {})
79
+ data, status_code, headers = post_greetings_with_http_info(body, opts)
80
+ return data
81
+ end
82
+
83
+ # Create a Greeting for an Organization
84
+ #
85
+ # @param body The Greeting to create
86
+ # @param [Hash] opts the optional parameters
87
+ # @return [Array<(DefaultGreetingList, Fixnum, Hash)>] DefaultGreetingList data, response status code and response headers
88
+ def post_greetings_with_http_info(body, opts = {})
89
+ if @api_client.config.debugging
90
+ @api_client.config.logger.debug "Calling API: GreetingsApi#post_greetings ..."
91
+ end
92
+
93
+ # verify the required parameter 'body' is set
94
+ fail "Missing the required parameter 'body' when calling post_greetings" if body.nil?
95
+
96
+ # resource path
97
+ path = "/api/v1/greetings".sub('{format}','json')
98
+
99
+ # query parameters
100
+ query_params = {}
101
+
102
+ # header parameters
103
+ header_params = {}
104
+
105
+ # HTTP header 'Accept' (if needed)
106
+ _header_accept = ['application/json']
107
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
108
+
109
+ # HTTP header 'Content-Type'
110
+ _header_content_type = ['application/json']
111
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
112
+
113
+ # form parameters
114
+ form_params = {}
115
+
116
+ # http body (model)
117
+ post_body = @api_client.object_to_http_body(body)
118
+
119
+
120
+ auth_names = ['PureCloud Auth']
121
+ data, status_code, headers = @api_client.call_api(:POST, path,
122
+ :header_params => header_params,
123
+ :query_params => query_params,
124
+ :form_params => form_params,
125
+ :body => post_body,
126
+ :auth_names => auth_names,
127
+ :return_type => 'DefaultGreetingList')
128
+ if @api_client.config.debugging
129
+ @api_client.config.logger.debug "API called: GreetingsApi#post_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
130
+ end
131
+ return data, status_code, headers
132
+ end
133
+
134
+ # Get an Organization&#39;s DefaultGreetingList
135
+ #
136
+ # @param [Hash] opts the optional parameters
137
+ # @return [DefaultGreetingList]
138
+ def get_defaults(opts = {})
139
+ data, status_code, headers = get_defaults_with_http_info(opts)
140
+ return data
141
+ end
142
+
143
+ # Get an Organization&#39;s DefaultGreetingList
144
+ #
145
+ # @param [Hash] opts the optional parameters
146
+ # @return [Array<(DefaultGreetingList, Fixnum, Hash)>] DefaultGreetingList data, response status code and response headers
147
+ def get_defaults_with_http_info(opts = {})
148
+ if @api_client.config.debugging
149
+ @api_client.config.logger.debug "Calling API: GreetingsApi#get_defaults ..."
150
+ end
151
+
152
+ # resource path
153
+ path = "/api/v1/greetings/defaults".sub('{format}','json')
154
+
155
+ # query parameters
156
+ query_params = {}
157
+
158
+ # header parameters
159
+ header_params = {}
160
+
161
+ # HTTP header 'Accept' (if needed)
162
+ _header_accept = ['application/json']
163
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
164
+
165
+ # HTTP header 'Content-Type'
166
+ _header_content_type = ['application/json']
167
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
168
+
169
+ # form parameters
170
+ form_params = {}
171
+
172
+ # http body (model)
173
+ post_body = nil
174
+
175
+
176
+ auth_names = ['PureCloud Auth']
177
+ data, status_code, headers = @api_client.call_api(:GET, path,
178
+ :header_params => header_params,
179
+ :query_params => query_params,
180
+ :form_params => form_params,
181
+ :body => post_body,
182
+ :auth_names => auth_names,
183
+ :return_type => 'DefaultGreetingList')
184
+ if @api_client.config.debugging
185
+ @api_client.config.logger.debug "API called: GreetingsApi#get_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
186
+ end
187
+ return data, status_code, headers
188
+ end
189
+
190
+ # Update an Organization&#39;s DefaultGreetingList
191
+ #
192
+ # @param body The updated defaultGreetingList
193
+ # @param [Hash] opts the optional parameters
194
+ # @return [DefaultGreetingList]
195
+ def put_defaults(body, opts = {})
196
+ data, status_code, headers = put_defaults_with_http_info(body, opts)
197
+ return data
198
+ end
199
+
200
+ # Update an Organization&#39;s DefaultGreetingList
201
+ #
202
+ # @param body The updated defaultGreetingList
203
+ # @param [Hash] opts the optional parameters
204
+ # @return [Array<(DefaultGreetingList, Fixnum, Hash)>] DefaultGreetingList data, response status code and response headers
205
+ def put_defaults_with_http_info(body, opts = {})
206
+ if @api_client.config.debugging
207
+ @api_client.config.logger.debug "Calling API: GreetingsApi#put_defaults ..."
208
+ end
209
+
210
+ # verify the required parameter 'body' is set
211
+ fail "Missing the required parameter 'body' when calling put_defaults" if body.nil?
212
+
213
+ # resource path
214
+ path = "/api/v1/greetings/defaults".sub('{format}','json')
215
+
216
+ # query parameters
217
+ query_params = {}
218
+
219
+ # header parameters
220
+ header_params = {}
221
+
222
+ # HTTP header 'Accept' (if needed)
223
+ _header_accept = ['application/json']
224
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
225
+
226
+ # HTTP header 'Content-Type'
227
+ _header_content_type = ['application/json']
228
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
229
+
230
+ # form parameters
231
+ form_params = {}
232
+
233
+ # http body (model)
234
+ post_body = @api_client.object_to_http_body(body)
235
+
236
+
237
+ auth_names = ['PureCloud Auth']
238
+ data, status_code, headers = @api_client.call_api(:PUT, path,
239
+ :header_params => header_params,
240
+ :query_params => query_params,
241
+ :form_params => form_params,
242
+ :body => post_body,
243
+ :auth_names => auth_names,
244
+ :return_type => 'DefaultGreetingList')
245
+ if @api_client.config.debugging
246
+ @api_client.config.logger.debug "API called: GreetingsApi#put_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
247
+ end
248
+ return data, status_code, headers
249
+ end
250
+
251
+ # Get a Greeting with the given GreetingId
252
+ #
253
+ # @param greeting_id Greeting ID
254
+ # @param [Hash] opts the optional parameters
255
+ # @return [Greeting]
256
+ def get(greeting_id, opts = {})
257
+ data, status_code, headers = get_with_http_info(greeting_id, opts)
258
+ return data
259
+ end
260
+
261
+ # Get a Greeting with the given GreetingId
262
+ #
263
+ # @param greeting_id Greeting ID
264
+ # @param [Hash] opts the optional parameters
265
+ # @return [Array<(Greeting, Fixnum, Hash)>] Greeting data, response status code and response headers
266
+ def get_with_http_info(greeting_id, opts = {})
267
+ if @api_client.config.debugging
268
+ @api_client.config.logger.debug "Calling API: GreetingsApi#get ..."
269
+ end
270
+
271
+ # verify the required parameter 'greeting_id' is set
272
+ fail "Missing the required parameter 'greeting_id' when calling get" if greeting_id.nil?
273
+
274
+ # resource path
275
+ path = "/api/v1/greetings/{greetingId}".sub('{format}','json').sub('{' + 'greetingId' + '}', greeting_id.to_s)
276
+
277
+ # query parameters
278
+ query_params = {}
279
+
280
+ # header parameters
281
+ header_params = {}
282
+
283
+ # HTTP header 'Accept' (if needed)
284
+ _header_accept = ['application/json']
285
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
286
+
287
+ # HTTP header 'Content-Type'
288
+ _header_content_type = ['application/json']
289
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
290
+
291
+ # form parameters
292
+ form_params = {}
293
+
294
+ # http body (model)
295
+ post_body = nil
296
+
297
+
298
+ auth_names = ['PureCloud Auth']
299
+ data, status_code, headers = @api_client.call_api(:GET, path,
300
+ :header_params => header_params,
301
+ :query_params => query_params,
302
+ :form_params => form_params,
303
+ :body => post_body,
304
+ :auth_names => auth_names,
305
+ :return_type => 'Greeting')
306
+ if @api_client.config.debugging
307
+ @api_client.config.logger.debug "API called: GreetingsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
308
+ end
309
+ return data, status_code, headers
310
+ end
311
+
312
+ # Updates the Greeting with the given GreetingId
313
+ #
314
+ # @param greeting_id Greeting ID
315
+ # @param body The updated Greeting
316
+ # @param [Hash] opts the optional parameters
317
+ # @return [Greeting]
318
+ def put(greeting_id, body, opts = {})
319
+ data, status_code, headers = put_with_http_info(greeting_id, body, opts)
320
+ return data
321
+ end
322
+
323
+ # Updates the Greeting with the given GreetingId
324
+ #
325
+ # @param greeting_id Greeting ID
326
+ # @param body The updated Greeting
327
+ # @param [Hash] opts the optional parameters
328
+ # @return [Array<(Greeting, Fixnum, Hash)>] Greeting data, response status code and response headers
329
+ def put_with_http_info(greeting_id, body, opts = {})
330
+ if @api_client.config.debugging
331
+ @api_client.config.logger.debug "Calling API: GreetingsApi#put ..."
332
+ end
333
+
334
+ # verify the required parameter 'greeting_id' is set
335
+ fail "Missing the required parameter 'greeting_id' when calling put" if greeting_id.nil?
336
+
337
+ # verify the required parameter 'body' is set
338
+ fail "Missing the required parameter 'body' when calling put" if body.nil?
339
+
340
+ # resource path
341
+ path = "/api/v1/greetings/{greetingId}".sub('{format}','json').sub('{' + 'greetingId' + '}', greeting_id.to_s)
342
+
343
+ # query parameters
344
+ query_params = {}
345
+
346
+ # header parameters
347
+ header_params = {}
348
+
349
+ # HTTP header 'Accept' (if needed)
350
+ _header_accept = ['application/json']
351
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
352
+
353
+ # HTTP header 'Content-Type'
354
+ _header_content_type = ['application/json']
355
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
356
+
357
+ # form parameters
358
+ form_params = {}
359
+
360
+ # http body (model)
361
+ post_body = @api_client.object_to_http_body(body)
362
+
363
+
364
+ auth_names = ['PureCloud Auth']
365
+ data, status_code, headers = @api_client.call_api(:PUT, path,
366
+ :header_params => header_params,
367
+ :query_params => query_params,
368
+ :form_params => form_params,
369
+ :body => post_body,
370
+ :auth_names => auth_names,
371
+ :return_type => 'Greeting')
372
+ if @api_client.config.debugging
373
+ @api_client.config.logger.debug "API called: GreetingsApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
374
+ end
375
+ return data, status_code, headers
376
+ end
377
+
378
+ # Deletes a Greeting with the given GreetingId
379
+ #
380
+ # @param greeting_id Greeting ID
381
+ # @param [Hash] opts the optional parameters
382
+ # @return [Greeting]
383
+ def delete(greeting_id, opts = {})
384
+ data, status_code, headers = delete_with_http_info(greeting_id, opts)
385
+ return data
386
+ end
387
+
388
+ # Deletes a Greeting with the given GreetingId
389
+ #
390
+ # @param greeting_id Greeting ID
391
+ # @param [Hash] opts the optional parameters
392
+ # @return [Array<(Greeting, Fixnum, Hash)>] Greeting data, response status code and response headers
393
+ def delete_with_http_info(greeting_id, opts = {})
394
+ if @api_client.config.debugging
395
+ @api_client.config.logger.debug "Calling API: GreetingsApi#delete ..."
396
+ end
397
+
398
+ # verify the required parameter 'greeting_id' is set
399
+ fail "Missing the required parameter 'greeting_id' when calling delete" if greeting_id.nil?
400
+
401
+ # resource path
402
+ path = "/api/v1/greetings/{greetingId}".sub('{format}','json').sub('{' + 'greetingId' + '}', greeting_id.to_s)
403
+
404
+ # query parameters
405
+ query_params = {}
406
+
407
+ # header parameters
408
+ header_params = {}
409
+
410
+ # HTTP header 'Accept' (if needed)
411
+ _header_accept = ['application/json']
412
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
413
+
414
+ # HTTP header 'Content-Type'
415
+ _header_content_type = ['application/json']
416
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
417
+
418
+ # form parameters
419
+ form_params = {}
420
+
421
+ # http body (model)
422
+ post_body = nil
423
+
424
+
425
+ auth_names = ['PureCloud Auth']
426
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
427
+ :header_params => header_params,
428
+ :query_params => query_params,
429
+ :form_params => form_params,
430
+ :body => post_body,
431
+ :auth_names => auth_names,
432
+ :return_type => 'Greeting')
433
+ if @api_client.config.debugging
434
+ @api_client.config.logger.debug "API called: GreetingsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
435
+ end
436
+ return data, status_code, headers
437
+ end
438
+
439
+ # Get media playback URI for this greeting
440
+ #
441
+ # @param greeting_id Greeting ID
442
+ # @param [Hash] opts the optional parameters
443
+ # @option opts [String] :format_id The desired format (WAV, etc.)
444
+ # @return [GreetingMediaInfo]
445
+ def get_media(greeting_id, opts = {})
446
+ data, status_code, headers = get_media_with_http_info(greeting_id, opts)
447
+ return data
448
+ end
449
+
450
+ # Get media playback URI for this greeting
451
+ #
452
+ # @param greeting_id Greeting ID
453
+ # @param [Hash] opts the optional parameters
454
+ # @option opts [String] :format_id The desired format (WAV, etc.)
455
+ # @return [Array<(GreetingMediaInfo, Fixnum, Hash)>] GreetingMediaInfo data, response status code and response headers
456
+ def get_media_with_http_info(greeting_id, opts = {})
457
+ if @api_client.config.debugging
458
+ @api_client.config.logger.debug "Calling API: GreetingsApi#get_media ..."
459
+ end
460
+
461
+ # verify the required parameter 'greeting_id' is set
462
+ fail "Missing the required parameter 'greeting_id' when calling get_media" if greeting_id.nil?
463
+
464
+ if opts[:'format_id'] && !['WAV'].include?(opts[:'format_id'])
465
+ fail 'invalid value for "format_id", must be one of WAV'
466
+ end
467
+
468
+ # resource path
469
+ path = "/api/v1/greetings/{greetingId}/media".sub('{format}','json').sub('{' + 'greetingId' + '}', greeting_id.to_s)
470
+
471
+ # query parameters
472
+ query_params = {}
473
+ query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
474
+
475
+ # header parameters
476
+ header_params = {}
477
+
478
+ # HTTP header 'Accept' (if needed)
479
+ _header_accept = ['application/json']
480
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
481
+
482
+ # HTTP header 'Content-Type'
483
+ _header_content_type = ['application/json']
484
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
485
+
486
+ # form parameters
487
+ form_params = {}
488
+
489
+ # http body (model)
490
+ post_body = nil
491
+
492
+
493
+ auth_names = ['PureCloud Auth']
494
+ data, status_code, headers = @api_client.call_api(:GET, path,
495
+ :header_params => header_params,
496
+ :query_params => query_params,
497
+ :form_params => form_params,
498
+ :body => post_body,
499
+ :auth_names => auth_names,
500
+ :return_type => 'GreetingMediaInfo')
501
+ if @api_client.config.debugging
502
+ @api_client.config.logger.debug "API called: GreetingsApi#get_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
503
+ end
504
+ return data, status_code, headers
505
+ end
506
+
507
+ # Get a list of the User&#39;s Greetings
508
+ #
509
+ # @param user_id User ID
510
+ # @param [Hash] opts the optional parameters
511
+ # @option opts [Integer] :page_size Page size
512
+ # @option opts [Integer] :page_number Page number
513
+ # @return [DomainEntityListing]
514
+ def get_user_greetings(user_id, opts = {})
515
+ data, status_code, headers = get_user_greetings_with_http_info(user_id, opts)
516
+ return data
517
+ end
518
+
519
+ # Get a list of the User&#39;s Greetings
520
+ #
521
+ # @param user_id User ID
522
+ # @param [Hash] opts the optional parameters
523
+ # @option opts [Integer] :page_size Page size
524
+ # @option opts [Integer] :page_number Page number
525
+ # @return [Array<(DomainEntityListing, Fixnum, Hash)>] DomainEntityListing data, response status code and response headers
526
+ def get_user_greetings_with_http_info(user_id, opts = {})
527
+ if @api_client.config.debugging
528
+ @api_client.config.logger.debug "Calling API: GreetingsApi#get_user_greetings ..."
529
+ end
530
+
531
+ # verify the required parameter 'user_id' is set
532
+ fail "Missing the required parameter 'user_id' when calling get_user_greetings" if user_id.nil?
533
+
534
+ # resource path
535
+ path = "/api/v1/users/{userId}/greetings".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
536
+
537
+ # query parameters
538
+ query_params = {}
539
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
540
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
541
+
542
+ # header parameters
543
+ header_params = {}
544
+
545
+ # HTTP header 'Accept' (if needed)
546
+ _header_accept = ['application/json']
547
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
548
+
549
+ # HTTP header 'Content-Type'
550
+ _header_content_type = ['application/json']
551
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
552
+
553
+ # form parameters
554
+ form_params = {}
555
+
556
+ # http body (model)
557
+ post_body = nil
558
+
559
+
560
+ auth_names = ['PureCloud Auth']
561
+ data, status_code, headers = @api_client.call_api(:GET, path,
562
+ :header_params => header_params,
563
+ :query_params => query_params,
564
+ :form_params => form_params,
565
+ :body => post_body,
566
+ :auth_names => auth_names,
567
+ :return_type => 'DomainEntityListing')
568
+ if @api_client.config.debugging
569
+ @api_client.config.logger.debug "API called: GreetingsApi#get_user_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
570
+ end
571
+ return data, status_code, headers
572
+ end
573
+
574
+ # Creates a Greeting for a User
575
+ #
576
+ # @param user_id User ID
577
+ # @param body The Greeting to create
578
+ # @param [Hash] opts the optional parameters
579
+ # @return [Greeting]
580
+ def post_user_greetings(user_id, body, opts = {})
581
+ data, status_code, headers = post_user_greetings_with_http_info(user_id, body, opts)
582
+ return data
583
+ end
584
+
585
+ # Creates a Greeting for a User
586
+ #
587
+ # @param user_id User ID
588
+ # @param body The Greeting to create
589
+ # @param [Hash] opts the optional parameters
590
+ # @return [Array<(Greeting, Fixnum, Hash)>] Greeting data, response status code and response headers
591
+ def post_user_greetings_with_http_info(user_id, body, opts = {})
592
+ if @api_client.config.debugging
593
+ @api_client.config.logger.debug "Calling API: GreetingsApi#post_user_greetings ..."
594
+ end
595
+
596
+ # verify the required parameter 'user_id' is set
597
+ fail "Missing the required parameter 'user_id' when calling post_user_greetings" if user_id.nil?
598
+
599
+ # verify the required parameter 'body' is set
600
+ fail "Missing the required parameter 'body' when calling post_user_greetings" if body.nil?
601
+
602
+ # resource path
603
+ path = "/api/v1/users/{userId}/greetings".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
604
+
605
+ # query parameters
606
+ query_params = {}
607
+
608
+ # header parameters
609
+ header_params = {}
610
+
611
+ # HTTP header 'Accept' (if needed)
612
+ _header_accept = ['application/json']
613
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
614
+
615
+ # HTTP header 'Content-Type'
616
+ _header_content_type = ['application/json']
617
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
618
+
619
+ # form parameters
620
+ form_params = {}
621
+
622
+ # http body (model)
623
+ post_body = @api_client.object_to_http_body(body)
624
+
625
+
626
+ auth_names = ['PureCloud Auth']
627
+ data, status_code, headers = @api_client.call_api(:POST, path,
628
+ :header_params => header_params,
629
+ :query_params => query_params,
630
+ :form_params => form_params,
631
+ :body => post_body,
632
+ :auth_names => auth_names,
633
+ :return_type => 'Greeting')
634
+ if @api_client.config.debugging
635
+ @api_client.config.logger.debug "API called: GreetingsApi#post_user_greetings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
636
+ end
637
+ return data, status_code, headers
638
+ end
639
+
640
+ # Grabs the list of Default Greetings given a User&#39;s ID
641
+ #
642
+ # @param user_id User ID
643
+ # @param [Hash] opts the optional parameters
644
+ # @return [DefaultGreetingList]
645
+ def get_user_greetings_defaults(user_id, opts = {})
646
+ data, status_code, headers = get_user_greetings_defaults_with_http_info(user_id, opts)
647
+ return data
648
+ end
649
+
650
+ # Grabs the list of Default Greetings given a User&#39;s ID
651
+ #
652
+ # @param user_id User ID
653
+ # @param [Hash] opts the optional parameters
654
+ # @return [Array<(DefaultGreetingList, Fixnum, Hash)>] DefaultGreetingList data, response status code and response headers
655
+ def get_user_greetings_defaults_with_http_info(user_id, opts = {})
656
+ if @api_client.config.debugging
657
+ @api_client.config.logger.debug "Calling API: GreetingsApi#get_user_greetings_defaults ..."
658
+ end
659
+
660
+ # verify the required parameter 'user_id' is set
661
+ fail "Missing the required parameter 'user_id' when calling get_user_greetings_defaults" if user_id.nil?
662
+
663
+ # resource path
664
+ path = "/api/v1/users/{userId}/greetings/defaults".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
665
+
666
+ # query parameters
667
+ query_params = {}
668
+
669
+ # header parameters
670
+ header_params = {}
671
+
672
+ # HTTP header 'Accept' (if needed)
673
+ _header_accept = ['application/json']
674
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
675
+
676
+ # HTTP header 'Content-Type'
677
+ _header_content_type = ['application/json']
678
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
679
+
680
+ # form parameters
681
+ form_params = {}
682
+
683
+ # http body (model)
684
+ post_body = nil
685
+
686
+
687
+ auth_names = ['PureCloud Auth']
688
+ data, status_code, headers = @api_client.call_api(:GET, path,
689
+ :header_params => header_params,
690
+ :query_params => query_params,
691
+ :form_params => form_params,
692
+ :body => post_body,
693
+ :auth_names => auth_names,
694
+ :return_type => 'DefaultGreetingList')
695
+ if @api_client.config.debugging
696
+ @api_client.config.logger.debug "API called: GreetingsApi#get_user_greetings_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
697
+ end
698
+ return data, status_code, headers
699
+ end
700
+
701
+ # Updates the DefaultGreetingList of the specified User
702
+ #
703
+ # @param user_id User ID
704
+ # @param body The updated defaultGreetingList
705
+ # @param [Hash] opts the optional parameters
706
+ # @return [DefaultGreetingList]
707
+ def put_user_greetings_defaults(user_id, body, opts = {})
708
+ data, status_code, headers = put_user_greetings_defaults_with_http_info(user_id, body, opts)
709
+ return data
710
+ end
711
+
712
+ # Updates the DefaultGreetingList of the specified User
713
+ #
714
+ # @param user_id User ID
715
+ # @param body The updated defaultGreetingList
716
+ # @param [Hash] opts the optional parameters
717
+ # @return [Array<(DefaultGreetingList, Fixnum, Hash)>] DefaultGreetingList data, response status code and response headers
718
+ def put_user_greetings_defaults_with_http_info(user_id, body, opts = {})
719
+ if @api_client.config.debugging
720
+ @api_client.config.logger.debug "Calling API: GreetingsApi#put_user_greetings_defaults ..."
721
+ end
722
+
723
+ # verify the required parameter 'user_id' is set
724
+ fail "Missing the required parameter 'user_id' when calling put_user_greetings_defaults" if user_id.nil?
725
+
726
+ # verify the required parameter 'body' is set
727
+ fail "Missing the required parameter 'body' when calling put_user_greetings_defaults" if body.nil?
728
+
729
+ # resource path
730
+ path = "/api/v1/users/{userId}/greetings/defaults".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
731
+
732
+ # query parameters
733
+ query_params = {}
734
+
735
+ # header parameters
736
+ header_params = {}
737
+
738
+ # HTTP header 'Accept' (if needed)
739
+ _header_accept = ['application/json']
740
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
741
+
742
+ # HTTP header 'Content-Type'
743
+ _header_content_type = ['application/json']
744
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
745
+
746
+ # form parameters
747
+ form_params = {}
748
+
749
+ # http body (model)
750
+ post_body = @api_client.object_to_http_body(body)
751
+
752
+
753
+ auth_names = ['PureCloud Auth']
754
+ data, status_code, headers = @api_client.call_api(:PUT, path,
755
+ :header_params => header_params,
756
+ :query_params => query_params,
757
+ :form_params => form_params,
758
+ :body => post_body,
759
+ :auth_names => auth_names,
760
+ :return_type => 'DefaultGreetingList')
761
+ if @api_client.config.debugging
762
+ @api_client.config.logger.debug "API called: GreetingsApi#put_user_greetings_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
763
+ end
764
+ return data, status_code, headers
765
+ end
766
+ end
767
+ end
768
+
769
+
770
+
771
+