purecloud 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (667) hide show
  1. checksums.yaml +7 -0
  2. data/CONTRIBUTING.md +0 -0
  3. data/Gemfile +7 -0
  4. data/Gemfile.lock +39 -0
  5. data/LICENSE +22 -0
  6. data/PureCloud.gemspec +32 -0
  7. data/README.md +64 -0
  8. data/config-ruby.json +1 -0
  9. data/doc/template/default/layout/html/layout.erb +4 -0
  10. data/doc/template/default/method_details/html/source.erb +0 -0
  11. data/doc/template/default/module/html/attribute_summary.erb +8 -0
  12. data/doc/template/default/module/html/box_info.erb +0 -0
  13. data/doc/template/default/module/html/children.erb +0 -0
  14. data/extensions/auth.rb +40 -0
  15. data/external/swagger-codegen-cli.jar +0 -0
  16. data/lib/purecloud.rb +707 -0
  17. data/lib/purecloud/api/analytics_api.rb +1554 -0
  18. data/lib/purecloud/api/architect_api.rb +232 -0
  19. data/lib/purecloud/api/attributes_api.rb +377 -0
  20. data/lib/purecloud/api/authorization_api.rb +1135 -0
  21. data/lib/purecloud/api/compliance_api.rb +129 -0
  22. data/lib/purecloud/api/configuration_api.rb +5049 -0
  23. data/lib/purecloud/api/content_management_api.rb +2457 -0
  24. data/lib/purecloud/api/conversations_api.rb +1699 -0
  25. data/lib/purecloud/api/downloads_api.rb +140 -0
  26. data/lib/purecloud/api/fax_api.rb +378 -0
  27. data/lib/purecloud/api/geolocation_api.rb +263 -0
  28. data/lib/purecloud/api/greetings_api.rb +771 -0
  29. data/lib/purecloud/api/groups_api.rb +208 -0
  30. data/lib/purecloud/api/languages_api.rb +138 -0
  31. data/lib/purecloud/api/licensing_api.rb +428 -0
  32. data/lib/purecloud/api/locations_api.rb +148 -0
  33. data/lib/purecloud/api/notifications_api.rb +431 -0
  34. data/lib/purecloud/api/o_auth_api.rb +1269 -0
  35. data/lib/purecloud/api/orphaned_recordings_api.rb +205 -0
  36. data/lib/purecloud/api/outbound_api.rb +4262 -0
  37. data/lib/purecloud/api/presence_api.rb +662 -0
  38. data/lib/purecloud/api/quality_api.rb +1663 -0
  39. data/lib/purecloud/api/routing_api.rb +2133 -0
  40. data/lib/purecloud/api/scripts_api.rb +712 -0
  41. data/lib/purecloud/api/search_api.rb +73 -0
  42. data/lib/purecloud/api/stations_api.rb +205 -0
  43. data/lib/purecloud/api/telephony_providers_edge_api.rb +2407 -0
  44. data/lib/purecloud/api/tokens_api.rb +71 -0
  45. data/lib/purecloud/api/user_recordings_api.rb +394 -0
  46. data/lib/purecloud/api/users_api.rb +1361 -0
  47. data/lib/purecloud/api/utilities_api.rb +249 -0
  48. data/lib/purecloud/api/voicemail_api.rb +677 -0
  49. data/lib/purecloud/api_client.rb +304 -0
  50. data/lib/purecloud/api_error.rb +24 -0
  51. data/lib/purecloud/configuration.rb +170 -0
  52. data/lib/purecloud/models/account.rb +450 -0
  53. data/lib/purecloud/models/account_manager.rb +176 -0
  54. data/lib/purecloud/models/account_overview.rb +224 -0
  55. data/lib/purecloud/models/account_status.rb +230 -0
  56. data/lib/purecloud/models/action.rb +178 -0
  57. data/lib/purecloud/models/actions.rb +148 -0
  58. data/lib/purecloud/models/acw_settings.rb +165 -0
  59. data/lib/purecloud/models/address.rb +218 -0
  60. data/lib/purecloud/models/address_listing.rb +238 -0
  61. data/lib/purecloud/models/agent.rb +146 -0
  62. data/lib/purecloud/models/agent_activity.rb +210 -0
  63. data/lib/purecloud/models/agent_activity_entity_listing.rb +238 -0
  64. data/lib/purecloud/models/agent_evaluator_activity.rb +208 -0
  65. data/lib/purecloud/models/alert.rb +312 -0
  66. data/lib/purecloud/models/alert_entity_listing.rb +238 -0
  67. data/lib/purecloud/models/annotation.rb +218 -0
  68. data/lib/purecloud/models/app.rb +156 -0
  69. data/lib/purecloud/models/archive_retention.rb +165 -0
  70. data/lib/purecloud/models/associated_document.rb +168 -0
  71. data/lib/purecloud/models/attachment.rb +186 -0
  72. data/lib/purecloud/models/attribute.rb +230 -0
  73. data/lib/purecloud/models/attribute_entity_listing.rb +238 -0
  74. data/lib/purecloud/models/attribute_query_request.rb +170 -0
  75. data/lib/purecloud/models/attribute_value.rb +250 -0
  76. data/lib/purecloud/models/audit_change.rb +180 -0
  77. data/lib/purecloud/models/audit_entity_reference.rb +195 -0
  78. data/lib/purecloud/models/audit_message.rb +300 -0
  79. data/lib/purecloud/models/audit_search_result.rb +200 -0
  80. data/lib/purecloud/models/automate_queue.rb +214 -0
  81. data/lib/purecloud/models/automate_queue_member.rb +178 -0
  82. data/lib/purecloud/models/available_additional_service.rb +214 -0
  83. data/lib/purecloud/models/available_additional_service_listing.rb +238 -0
  84. data/lib/purecloud/models/available_topic.rb +147 -0
  85. data/lib/purecloud/models/backend_flow_available_actions.rb +148 -0
  86. data/lib/purecloud/models/backend_work_item_data_element.rb +176 -0
  87. data/lib/purecloud/models/basic_transform.rb +160 -0
  88. data/lib/purecloud/models/batch_command.rb +158 -0
  89. data/lib/purecloud/models/batch_item.rb +166 -0
  90. data/lib/purecloud/models/batch_item_body.rb +146 -0
  91. data/lib/purecloud/models/batch_reply.rb +148 -0
  92. data/lib/purecloud/models/batch_reply_item.rb +166 -0
  93. data/lib/purecloud/models/billing_period.rb +190 -0
  94. data/lib/purecloud/models/body.rb +136 -0
  95. data/lib/purecloud/models/body_1.rb +136 -0
  96. data/lib/purecloud/models/body_2.rb +136 -0
  97. data/lib/purecloud/models/bullseye.rb +148 -0
  98. data/lib/purecloud/models/byte_buffer.rb +220 -0
  99. data/lib/purecloud/models/calibration.rb +303 -0
  100. data/lib/purecloud/models/calibration_assignment.rb +178 -0
  101. data/lib/purecloud/models/calibration_entity_listing.rb +238 -0
  102. data/lib/purecloud/models/call.rb +323 -0
  103. data/lib/purecloud/models/call_forwarding.rb +211 -0
  104. data/lib/purecloud/models/call_record.rb +157 -0
  105. data/lib/purecloud/models/callable_contacts_diagnostic.rb +170 -0
  106. data/lib/purecloud/models/callable_time.rb +158 -0
  107. data/lib/purecloud/models/callable_time_set.rb +212 -0
  108. data/lib/purecloud/models/callable_time_set_entity_listing.rb +238 -0
  109. data/lib/purecloud/models/callback.rb +302 -0
  110. data/lib/purecloud/models/campaign.rb +200 -0
  111. data/lib/purecloud/models/campaign_diagnostics.rb +166 -0
  112. data/lib/purecloud/models/campaign_entity_listing.rb +238 -0
  113. data/lib/purecloud/models/campaign_schedule.rb +232 -0
  114. data/lib/purecloud/models/campaign_schedule_intervals.rb +158 -0
  115. data/lib/purecloud/models/campaign_sequence.rb +263 -0
  116. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +238 -0
  117. data/lib/purecloud/models/campaign_stats.rb +176 -0
  118. data/lib/purecloud/models/carrier.rb +220 -0
  119. data/lib/purecloud/models/carrier_address.rb +186 -0
  120. data/lib/purecloud/models/carrier_entity_listing.rb +238 -0
  121. data/lib/purecloud/models/certificate.rb +148 -0
  122. data/lib/purecloud/models/certificate_authority_entity_listing.rb +238 -0
  123. data/lib/purecloud/models/certificate_details.rb +218 -0
  124. data/lib/purecloud/models/change.rb +180 -0
  125. data/lib/purecloud/models/channel.rb +157 -0
  126. data/lib/purecloud/models/channel_entity_listing.rb +238 -0
  127. data/lib/purecloud/models/channel_topic.rb +158 -0
  128. data/lib/purecloud/models/charge.rb +206 -0
  129. data/lib/purecloud/models/chat.rb +146 -0
  130. data/lib/purecloud/models/chat_message.rb +226 -0
  131. data/lib/purecloud/models/chat_message_user.rb +188 -0
  132. data/lib/purecloud/models/chat_participant.rb +155 -0
  133. data/lib/purecloud/models/chat_search_item.rb +208 -0
  134. data/lib/purecloud/models/chat_search_listing.rb +238 -0
  135. data/lib/purecloud/models/chat_search_request.rb +244 -0
  136. data/lib/purecloud/models/client_spreadsheet_transform.rb +214 -0
  137. data/lib/purecloud/models/client_transform_model.rb +190 -0
  138. data/lib/purecloud/models/column_collapse.rb +158 -0
  139. data/lib/purecloud/models/command_status.rb +237 -0
  140. data/lib/purecloud/models/command_status_entity_listing.rb +238 -0
  141. data/lib/purecloud/models/common_audit_request.rb +214 -0
  142. data/lib/purecloud/models/condition.rb +228 -0
  143. data/lib/purecloud/models/connect_rate.rb +166 -0
  144. data/lib/purecloud/models/consult_transfer.rb +167 -0
  145. data/lib/purecloud/models/consult_transfer_response.rb +147 -0
  146. data/lib/purecloud/models/consult_transfer_update.rb +156 -0
  147. data/lib/purecloud/models/consumed_resources_entity_listing.rb +238 -0
  148. data/lib/purecloud/models/consuming_resources_entity_listing.rb +238 -0
  149. data/lib/purecloud/models/contact.rb +226 -0
  150. data/lib/purecloud/models/contact_callback_request.rb +186 -0
  151. data/lib/purecloud/models/contact_list.rb +266 -0
  152. data/lib/purecloud/models/contact_list_entity_listing.rb +238 -0
  153. data/lib/purecloud/models/contact_sales.rb +288 -0
  154. data/lib/purecloud/models/contact_sales_response.rb +178 -0
  155. data/lib/purecloud/models/content_facet_filter_item.rb +196 -0
  156. data/lib/purecloud/models/content_query_request.rb +202 -0
  157. data/lib/purecloud/models/content_sort_item.rb +158 -0
  158. data/lib/purecloud/models/contract.rb +198 -0
  159. data/lib/purecloud/models/contract_job.rb +198 -0
  160. data/lib/purecloud/models/conversation.rb +258 -0
  161. data/lib/purecloud/models/conversation_entity_listing.rb +238 -0
  162. data/lib/purecloud/models/conversation_historical_query_request_body.rb +185 -0
  163. data/lib/purecloud/models/conversation_historical_query_request_filter.rb +181 -0
  164. data/lib/purecloud/models/conversation_query_response.rb +366 -0
  165. data/lib/purecloud/models/conversation_response.rb +168 -0
  166. data/lib/purecloud/models/cover_sheet.rb +158 -0
  167. data/lib/purecloud/models/create_share_request.rb +206 -0
  168. data/lib/purecloud/models/create_share_request_member.rb +165 -0
  169. data/lib/purecloud/models/create_share_response.rb +270 -0
  170. data/lib/purecloud/models/create_template_from_script_request_data.rb +188 -0
  171. data/lib/purecloud/models/csv_schema.rb +224 -0
  172. data/lib/purecloud/models/customer_account.rb +238 -0
  173. data/lib/purecloud/models/data_item.rb +166 -0
  174. data/lib/purecloud/models/data_value_info.rb +148 -0
  175. data/lib/purecloud/models/default_greeting_list.rb +251 -0
  176. data/lib/purecloud/models/delete_retention.rb +146 -0
  177. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +238 -0
  178. data/lib/purecloud/models/delta_document.rb +216 -0
  179. data/lib/purecloud/models/delta_request.rb +146 -0
  180. data/lib/purecloud/models/delta_response.rb +170 -0
  181. data/lib/purecloud/models/dependency.rb +209 -0
  182. data/lib/purecloud/models/dependency_object.rb +233 -0
  183. data/lib/purecloud/models/dependency_object_entity_listing.rb +238 -0
  184. data/lib/purecloud/models/dependency_status.rb +241 -0
  185. data/lib/purecloud/models/dependency_type.rb +180 -0
  186. data/lib/purecloud/models/dependency_type_entity_listing.rb +238 -0
  187. data/lib/purecloud/models/destination.rb +197 -0
  188. data/lib/purecloud/models/detail.rb +176 -0
  189. data/lib/purecloud/models/diagnostic_email.rb +225 -0
  190. data/lib/purecloud/models/dialer_audit_request.rb +182 -0
  191. data/lib/purecloud/models/dialer_call.rb +156 -0
  192. data/lib/purecloud/models/dialer_disposition_call_command.rb +166 -0
  193. data/lib/purecloud/models/dialer_place_call_command.rb +156 -0
  194. data/lib/purecloud/models/dialer_preview.rb +188 -0
  195. data/lib/purecloud/models/did.rb +319 -0
  196. data/lib/purecloud/models/did_entity_listing.rb +238 -0
  197. data/lib/purecloud/models/did_pool.rb +321 -0
  198. data/lib/purecloud/models/did_pool_entity_listing.rb +238 -0
  199. data/lib/purecloud/models/digit_length.rb +156 -0
  200. data/lib/purecloud/models/dnc_list.rb +242 -0
  201. data/lib/purecloud/models/dnc_list_entity_listing.rb +238 -0
  202. data/lib/purecloud/models/dns.rb +166 -0
  203. data/lib/purecloud/models/document.rb +479 -0
  204. data/lib/purecloud/models/document_audit.rb +339 -0
  205. data/lib/purecloud/models/document_audit_entity_listing.rb +238 -0
  206. data/lib/purecloud/models/document_entity_listing.rb +238 -0
  207. data/lib/purecloud/models/document_thumbnail.rb +156 -0
  208. data/lib/purecloud/models/document_update.rb +228 -0
  209. data/lib/purecloud/models/document_upload.rb +192 -0
  210. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +238 -0
  211. data/lib/purecloud/models/domain_capabilities.rb +170 -0
  212. data/lib/purecloud/models/domain_certificate_authority.rb +327 -0
  213. data/lib/purecloud/models/domain_edge_software_update_dto.rb +242 -0
  214. data/lib/purecloud/models/domain_edge_software_version_dto.rb +223 -0
  215. data/lib/purecloud/models/domain_entity.rb +168 -0
  216. data/lib/purecloud/models/domain_entity_listing.rb +238 -0
  217. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +238 -0
  218. data/lib/purecloud/models/domain_entity_listing_query_result.rb +238 -0
  219. data/lib/purecloud/models/domain_invoice_entity_listing.rb +238 -0
  220. data/lib/purecloud/models/domain_license.rb +200 -0
  221. data/lib/purecloud/models/domain_license_entity_listing.rb +238 -0
  222. data/lib/purecloud/models/domain_logical_interface.rb +526 -0
  223. data/lib/purecloud/models/domain_network_address.rb +178 -0
  224. data/lib/purecloud/models/domain_network_command_response.rb +178 -0
  225. data/lib/purecloud/models/domain_network_route.rb +188 -0
  226. data/lib/purecloud/models/domain_org_role_difference.rb +192 -0
  227. data/lib/purecloud/models/domain_organization_product.rb +146 -0
  228. data/lib/purecloud/models/domain_organization_role.rb +268 -0
  229. data/lib/purecloud/models/domain_permission.rb +200 -0
  230. data/lib/purecloud/models/domain_permission_collection.rb +190 -0
  231. data/lib/purecloud/models/domain_permission_policy.rb +222 -0
  232. data/lib/purecloud/models/domain_physical_capabilities.rb +160 -0
  233. data/lib/purecloud/models/domain_physical_interface.rb +218 -0
  234. data/lib/purecloud/models/domain_resource_condition_node.rb +208 -0
  235. data/lib/purecloud/models/domain_resource_condition_value.rb +185 -0
  236. data/lib/purecloud/models/domain_schema_reference.rb +168 -0
  237. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +238 -0
  238. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +238 -0
  239. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +238 -0
  240. data/lib/purecloud/models/download_response.rb +156 -0
  241. data/lib/purecloud/models/duration_condition.rb +175 -0
  242. data/lib/purecloud/models/edge.rb +523 -0
  243. data/lib/purecloud/models/edge_auto_update_config.rb +178 -0
  244. data/lib/purecloud/models/edge_entity_listing.rb +238 -0
  245. data/lib/purecloud/models/edge_group.rb +306 -0
  246. data/lib/purecloud/models/edge_group_entity_listing.rb +238 -0
  247. data/lib/purecloud/models/edge_interface.rb +220 -0
  248. data/lib/purecloud/models/edge_line.rb +259 -0
  249. data/lib/purecloud/models/edge_line_entity_listing.rb +238 -0
  250. data/lib/purecloud/models/edge_version_information.rb +146 -0
  251. data/lib/purecloud/models/edge_version_report.rb +156 -0
  252. data/lib/purecloud/models/email.rb +278 -0
  253. data/lib/purecloud/models/email_address.rb +156 -0
  254. data/lib/purecloud/models/email_attachment.rb +186 -0
  255. data/lib/purecloud/models/email_message.rb +245 -0
  256. data/lib/purecloud/models/email_message_listing.rb +238 -0
  257. data/lib/purecloud/models/email_setup.rb +147 -0
  258. data/lib/purecloud/models/embedded_signature_view.rb +146 -0
  259. data/lib/purecloud/models/encryption_key.rb +198 -0
  260. data/lib/purecloud/models/encryption_key_entity_listing.rb +238 -0
  261. data/lib/purecloud/models/endpoint.rb +335 -0
  262. data/lib/purecloud/models/endpoint_entity_listing.rb +238 -0
  263. data/lib/purecloud/models/entity.rb +166 -0
  264. data/lib/purecloud/models/entry.rb +156 -0
  265. data/lib/purecloud/models/error_body.rb +242 -0
  266. data/lib/purecloud/models/error_details.rb +218 -0
  267. data/lib/purecloud/models/evaluation.rb +358 -0
  268. data/lib/purecloud/models/evaluation_assignment.rb +156 -0
  269. data/lib/purecloud/models/evaluation_entity_listing.rb +238 -0
  270. data/lib/purecloud/models/evaluation_form.rb +233 -0
  271. data/lib/purecloud/models/evaluation_form_and_scoring_set.rb +156 -0
  272. data/lib/purecloud/models/evaluation_form_entity_listing.rb +238 -0
  273. data/lib/purecloud/models/evaluation_query_request.rb +263 -0
  274. data/lib/purecloud/models/evaluation_scoring_set.rb +200 -0
  275. data/lib/purecloud/models/evaluator_activity.rb +238 -0
  276. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +238 -0
  277. data/lib/purecloud/models/expansion_criterium.rb +165 -0
  278. data/lib/purecloud/models/expression_response.rb +256 -0
  279. data/lib/purecloud/models/extension.rb +319 -0
  280. data/lib/purecloud/models/extension_entity_listing.rb +238 -0
  281. data/lib/purecloud/models/extension_pool.rb +291 -0
  282. data/lib/purecloud/models/extension_pool_entity_listing.rb +238 -0
  283. data/lib/purecloud/models/facet.rb +156 -0
  284. data/lib/purecloud/models/facet_entry.rb +227 -0
  285. data/lib/purecloud/models/facet_filter_item.rb +196 -0
  286. data/lib/purecloud/models/facet_group.rb +168 -0
  287. data/lib/purecloud/models/facet_info.rb +158 -0
  288. data/lib/purecloud/models/facet_item.rb +166 -0
  289. data/lib/purecloud/models/facet_key_attribute.rb +166 -0
  290. data/lib/purecloud/models/facet_request.rb +232 -0
  291. data/lib/purecloud/models/facet_result.rb +211 -0
  292. data/lib/purecloud/models/facet_result_item.rb +208 -0
  293. data/lib/purecloud/models/facet_statistics.rb +208 -0
  294. data/lib/purecloud/models/facet_term.rb +197 -0
  295. data/lib/purecloud/models/facets.rb +158 -0
  296. data/lib/purecloud/models/failed_object.rb +176 -0
  297. data/lib/purecloud/models/favorite_template_request_data.rb +146 -0
  298. data/lib/purecloud/models/fax_document.rb +324 -0
  299. data/lib/purecloud/models/fax_document_entity_listing.rb +238 -0
  300. data/lib/purecloud/models/fax_send_request.rb +220 -0
  301. data/lib/purecloud/models/fax_send_response.rb +197 -0
  302. data/lib/purecloud/models/fax_summary.rb +166 -0
  303. data/lib/purecloud/models/filter.rb +178 -0
  304. data/lib/purecloud/models/filter_item.rb +208 -0
  305. data/lib/purecloud/models/flow.rb +273 -0
  306. data/lib/purecloud/models/flow_activate_request.rb +150 -0
  307. data/lib/purecloud/models/flow_associate_workspaces_request.rb +150 -0
  308. data/lib/purecloud/models/flow_body.rb +160 -0
  309. data/lib/purecloud/models/flow_body_format.rb +166 -0
  310. data/lib/purecloud/models/flow_config_id.rb +180 -0
  311. data/lib/purecloud/models/flow_config_meta_data.rb +279 -0
  312. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +238 -0
  313. data/lib/purecloud/models/flow_details.rb +288 -0
  314. data/lib/purecloud/models/flow_details_search_result.rb +161 -0
  315. data/lib/purecloud/models/flow_entity_listing.rb +238 -0
  316. data/lib/purecloud/models/flow_exec_id.rb +169 -0
  317. data/lib/purecloud/models/flow_history_item.rb +238 -0
  318. data/lib/purecloud/models/flow_history_result_item.rb +172 -0
  319. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +238 -0
  320. data/lib/purecloud/models/flow_input_data.rb +150 -0
  321. data/lib/purecloud/models/flow_launch_request.rb +190 -0
  322. data/lib/purecloud/models/flow_lock_request.rb +150 -0
  323. data/lib/purecloud/models/flow_publish.rb +191 -0
  324. data/lib/purecloud/models/flow_report_result_item.rb +280 -0
  325. data/lib/purecloud/models/flow_state.rb +170 -0
  326. data/lib/purecloud/models/flow_terminate_request.rb +161 -0
  327. data/lib/purecloud/models/flow_upload_response.rb +159 -0
  328. data/lib/purecloud/models/flow_version.rb +257 -0
  329. data/lib/purecloud/models/flow_version_config_meta_data.rb +224 -0
  330. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +238 -0
  331. data/lib/purecloud/models/flow_version_entity_listing.rb +238 -0
  332. data/lib/purecloud/models/gateway.rb +166 -0
  333. data/lib/purecloud/models/geolocation.rb +242 -0
  334. data/lib/purecloud/models/geolocation_settings.rb +180 -0
  335. data/lib/purecloud/models/gistener.rb +282 -0
  336. data/lib/purecloud/models/greeting.rb +278 -0
  337. data/lib/purecloud/models/greeting_audio_file.rb +166 -0
  338. data/lib/purecloud/models/greeting_media_info.rb +167 -0
  339. data/lib/purecloud/models/greeting_owner.rb +168 -0
  340. data/lib/purecloud/models/group.rb +236 -0
  341. data/lib/purecloud/models/group_entity_listing.rb +238 -0
  342. data/lib/purecloud/models/group_images.rb +148 -0
  343. data/lib/purecloud/models/group_tag.rb +223 -0
  344. data/lib/purecloud/models/hardware_rate.rb +198 -0
  345. data/lib/purecloud/models/hardware_rate_listing.rb +238 -0
  346. data/lib/purecloud/models/hipaa_config.rb +180 -0
  347. data/lib/purecloud/models/import_status.rb +195 -0
  348. data/lib/purecloud/models/inbound_domain.rb +200 -0
  349. data/lib/purecloud/models/inbound_domain_entity_listing.rb +238 -0
  350. data/lib/purecloud/models/inbound_route.rb +247 -0
  351. data/lib/purecloud/models/inbound_route_entity_listing.rb +238 -0
  352. data/lib/purecloud/models/indexed_transform.rb +180 -0
  353. data/lib/purecloud/models/invoice.rb +230 -0
  354. data/lib/purecloud/models/ivr.rb +341 -0
  355. data/lib/purecloud/models/ivr_entity_listing.rb +238 -0
  356. data/lib/purecloud/models/key_rotation_schedule.rb +187 -0
  357. data/lib/purecloud/models/language.rb +168 -0
  358. data/lib/purecloud/models/language_entity_listing.rb +238 -0
  359. data/lib/purecloud/models/library.rb +199 -0
  360. data/lib/purecloud/models/library_entity_listing.rb +238 -0
  361. data/lib/purecloud/models/license.rb +157 -0
  362. data/lib/purecloud/models/licenses_by_permission.rb +169 -0
  363. data/lib/purecloud/models/line.rb +351 -0
  364. data/lib/purecloud/models/line_base.rb +190 -0
  365. data/lib/purecloud/models/line_base_entity_listing.rb +238 -0
  366. data/lib/purecloud/models/line_entity_listing.rb +238 -0
  367. data/lib/purecloud/models/line_properties.rb +136 -0
  368. data/lib/purecloud/models/line_status.rb +195 -0
  369. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +238 -0
  370. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +238 -0
  371. data/lib/purecloud/models/location.rb +274 -0
  372. data/lib/purecloud/models/location_address_fields.rb +206 -0
  373. data/lib/purecloud/models/location_emergency_number.rb +176 -0
  374. data/lib/purecloud/models/location_entity_listing.rb +238 -0
  375. data/lib/purecloud/models/lock_info.rb +187 -0
  376. data/lib/purecloud/models/logical_interface_entity_listing.rb +238 -0
  377. data/lib/purecloud/models/management_unit.rb +186 -0
  378. data/lib/purecloud/models/management_unit_timezone.rb +146 -0
  379. data/lib/purecloud/models/max_participants.rb +146 -0
  380. data/lib/purecloud/models/media_result.rb +168 -0
  381. data/lib/purecloud/models/media_setting.rb +156 -0
  382. data/lib/purecloud/models/media_summary.rb +156 -0
  383. data/lib/purecloud/models/metabase.rb +178 -0
  384. data/lib/purecloud/models/metered_evaluation_assignment.rb +200 -0
  385. data/lib/purecloud/models/metric_threshold.rb +165 -0
  386. data/lib/purecloud/models/noc_support.rb +156 -0
  387. data/lib/purecloud/models/number.rb +156 -0
  388. data/lib/purecloud/models/number_order_request.rb +201 -0
  389. data/lib/purecloud/models/number_plan.rb +351 -0
  390. data/lib/purecloud/models/o_auth_client.rb +240 -0
  391. data/lib/purecloud/models/o_auth_client_entity_listing.rb +238 -0
  392. data/lib/purecloud/models/o_auth_provider.rb +168 -0
  393. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +238 -0
  394. data/lib/purecloud/models/occurrence.rb +165 -0
  395. data/lib/purecloud/models/okta.rb +198 -0
  396. data/lib/purecloud/models/one_login.rb +198 -0
  397. data/lib/purecloud/models/order.rb +188 -0
  398. data/lib/purecloud/models/org_license_assignment.rb +178 -0
  399. data/lib/purecloud/models/org_media_utilization.rb +160 -0
  400. data/lib/purecloud/models/organization.rb +279 -0
  401. data/lib/purecloud/models/organization_address.rb +194 -0
  402. data/lib/purecloud/models/organization_create.rb +205 -0
  403. data/lib/purecloud/models/organization_presence.rb +253 -0
  404. data/lib/purecloud/models/organization_presence_entity_listing.rb +238 -0
  405. data/lib/purecloud/models/organization_product_entity_listing.rb +188 -0
  406. data/lib/purecloud/models/organization_role_entity_listing.rb +238 -0
  407. data/lib/purecloud/models/orphan_recording.rb +277 -0
  408. data/lib/purecloud/models/orphan_recording_listing.rb +238 -0
  409. data/lib/purecloud/models/out_of_office.rb +212 -0
  410. data/lib/purecloud/models/outbound_route.rb +347 -0
  411. data/lib/purecloud/models/outbound_route_entity_listing.rb +238 -0
  412. data/lib/purecloud/models/page.rb +224 -0
  413. data/lib/purecloud/models/parameter.rb +196 -0
  414. data/lib/purecloud/models/parsed_certificate.rb +150 -0
  415. data/lib/purecloud/models/participant.rb +490 -0
  416. data/lib/purecloud/models/participant_attributes.rb +148 -0
  417. data/lib/purecloud/models/participant_request.rb +235 -0
  418. data/lib/purecloud/models/penetration_rate.rb +176 -0
  419. data/lib/purecloud/models/penetration_rate_id.rb +156 -0
  420. data/lib/purecloud/models/permission_collection_entity_listing.rb +238 -0
  421. data/lib/purecloud/models/permissions.rb +169 -0
  422. data/lib/purecloud/models/phone.rb +375 -0
  423. data/lib/purecloud/models/phone_base.rb +212 -0
  424. data/lib/purecloud/models/phone_base_entity_listing.rb +238 -0
  425. data/lib/purecloud/models/phone_capabilities.rb +206 -0
  426. data/lib/purecloud/models/phone_column.rb +156 -0
  427. data/lib/purecloud/models/phone_entity_listing.rb +238 -0
  428. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +238 -0
  429. data/lib/purecloud/models/phone_number_column.rb +156 -0
  430. data/lib/purecloud/models/phone_number_status.rb +148 -0
  431. data/lib/purecloud/models/phone_status.rb +263 -0
  432. data/lib/purecloud/models/phones_reboot.rb +148 -0
  433. data/lib/purecloud/models/physical_interface_entity_listing.rb +238 -0
  434. data/lib/purecloud/models/pin_configuration.rb +156 -0
  435. data/lib/purecloud/models/policy.rb +252 -0
  436. data/lib/purecloud/models/policy_actions.rb +206 -0
  437. data/lib/purecloud/models/policy_conditions.rb +228 -0
  438. data/lib/purecloud/models/policy_entity_listing.rb +238 -0
  439. data/lib/purecloud/models/policy_error_message.rb +209 -0
  440. data/lib/purecloud/models/policy_errors.rb +148 -0
  441. data/lib/purecloud/models/preview.rb +230 -0
  442. data/lib/purecloud/models/primary_user_presence_source.rb +188 -0
  443. data/lib/purecloud/models/product.rb +199 -0
  444. data/lib/purecloud/models/progress_model.rb +169 -0
  445. data/lib/purecloud/models/prompt.rb +190 -0
  446. data/lib/purecloud/models/prompt_asset.rb +238 -0
  447. data/lib/purecloud/models/prompt_asset_entity_listing.rb +238 -0
  448. data/lib/purecloud/models/prompt_entity_listing.rb +238 -0
  449. data/lib/purecloud/models/provision_info.rb +169 -0
  450. data/lib/purecloud/models/publication.rb +224 -0
  451. data/lib/purecloud/models/publish_script_request_data.rb +156 -0
  452. data/lib/purecloud/models/published_result.rb +208 -0
  453. data/lib/purecloud/models/pure_cloud.rb +168 -0
  454. data/lib/purecloud/models/put_management_unit.rb +175 -0
  455. data/lib/purecloud/models/quality_audit.rb +250 -0
  456. data/lib/purecloud/models/quality_audit_page.rb +238 -0
  457. data/lib/purecloud/models/query_facet_info.rb +160 -0
  458. data/lib/purecloud/models/query_request.rb +202 -0
  459. data/lib/purecloud/models/query_result.rb +178 -0
  460. data/lib/purecloud/models/query_results.rb +156 -0
  461. data/lib/purecloud/models/question_group.rb +236 -0
  462. data/lib/purecloud/models/question_group_score.rb +250 -0
  463. data/lib/purecloud/models/question_score.rb +200 -0
  464. data/lib/purecloud/models/queue.rb +382 -0
  465. data/lib/purecloud/models/queue_entity_listing.rb +238 -0
  466. data/lib/purecloud/models/queue_member.rb +220 -0
  467. data/lib/purecloud/models/queue_member_entity_listing.rb +238 -0
  468. data/lib/purecloud/models/queue_utilization_diagnostic.rb +216 -0
  469. data/lib/purecloud/models/queues_entity_listing.rb +238 -0
  470. data/lib/purecloud/models/quote.rb +392 -0
  471. data/lib/purecloud/models/quote_charge.rb +281 -0
  472. data/lib/purecloud/models/quote_listing.rb +238 -0
  473. data/lib/purecloud/models/rate.rb +190 -0
  474. data/lib/purecloud/models/reaction.rb +175 -0
  475. data/lib/purecloud/models/recording.rb +407 -0
  476. data/lib/purecloud/models/replace_request.rb +166 -0
  477. data/lib/purecloud/models/replace_response.rb +205 -0
  478. data/lib/purecloud/models/report_meta_data.rb +234 -0
  479. data/lib/purecloud/models/report_meta_data_entity_listing.rb +238 -0
  480. data/lib/purecloud/models/report_request.rb +210 -0
  481. data/lib/purecloud/models/report_run_entry.rb +258 -0
  482. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +238 -0
  483. data/lib/purecloud/models/report_schedule.rb +315 -0
  484. data/lib/purecloud/models/report_schedule_entity_listing.rb +238 -0
  485. data/lib/purecloud/models/reservation.rb +187 -0
  486. data/lib/purecloud/models/resource_condition_node.rb +208 -0
  487. data/lib/purecloud/models/resource_condition_value.rb +165 -0
  488. data/lib/purecloud/models/resource_permission_policy.rb +250 -0
  489. data/lib/purecloud/models/response.rb +228 -0
  490. data/lib/purecloud/models/response_entity_list.rb +239 -0
  491. data/lib/purecloud/models/response_entity_listing.rb +238 -0
  492. data/lib/purecloud/models/response_query_request.rb +172 -0
  493. data/lib/purecloud/models/response_query_results.rb +148 -0
  494. data/lib/purecloud/models/response_set.rb +212 -0
  495. data/lib/purecloud/models/response_set_entity_listing.rb +238 -0
  496. data/lib/purecloud/models/response_text.rb +159 -0
  497. data/lib/purecloud/models/rest_error_detail.rb +156 -0
  498. data/lib/purecloud/models/retention_duration.rb +156 -0
  499. data/lib/purecloud/models/ring.rb +158 -0
  500. data/lib/purecloud/models/routing_status.rb +176 -0
  501. data/lib/purecloud/models/rule.rb +200 -0
  502. data/lib/purecloud/models/rule_entity_listing.rb +238 -0
  503. data/lib/purecloud/models/rule_set.rb +232 -0
  504. data/lib/purecloud/models/rule_set_entity_listing.rb +238 -0
  505. data/lib/purecloud/models/run_now_response.rb +168 -0
  506. data/lib/purecloud/models/salesforce.rb +198 -0
  507. data/lib/purecloud/models/schedule.rb +314 -0
  508. data/lib/purecloud/models/schedule_entity_listing.rb +238 -0
  509. data/lib/purecloud/models/schedule_group.rb +303 -0
  510. data/lib/purecloud/models/schedule_group_entity_listing.rb +238 -0
  511. data/lib/purecloud/models/schema_category.rb +168 -0
  512. data/lib/purecloud/models/schema_category_entity_listing.rb +238 -0
  513. data/lib/purecloud/models/schema_reference_entity_listing.rb +238 -0
  514. data/lib/purecloud/models/script.rb +272 -0
  515. data/lib/purecloud/models/script_entity_listing.rb +238 -0
  516. data/lib/purecloud/models/search_request.rb +222 -0
  517. data/lib/purecloud/models/security_profile.rb +180 -0
  518. data/lib/purecloud/models/security_profile_entity_listing.rb +238 -0
  519. data/lib/purecloud/models/segment.rb +188 -0
  520. data/lib/purecloud/models/sequence_schedule.rb +232 -0
  521. data/lib/purecloud/models/server_date.rb +147 -0
  522. data/lib/purecloud/models/service.rb +245 -0
  523. data/lib/purecloud/models/service_context.rb +146 -0
  524. data/lib/purecloud/models/service_entity_listing.rb +238 -0
  525. data/lib/purecloud/models/service_level.rb +156 -0
  526. data/lib/purecloud/models/service_type.rb +200 -0
  527. data/lib/purecloud/models/session.rb +219 -0
  528. data/lib/purecloud/models/session_entity_listing.rb +238 -0
  529. data/lib/purecloud/models/session_request.rb +146 -0
  530. data/lib/purecloud/models/share.rb +256 -0
  531. data/lib/purecloud/models/share_entity_listing.rb +238 -0
  532. data/lib/purecloud/models/shared_response.rb +186 -0
  533. data/lib/purecloud/models/sheet_schema.rb +213 -0
  534. data/lib/purecloud/models/sheet_transform.rb +166 -0
  535. data/lib/purecloud/models/signature_document_info.rb +166 -0
  536. data/lib/purecloud/models/site.rb +374 -0
  537. data/lib/purecloud/models/site_entity_listing.rb +238 -0
  538. data/lib/purecloud/models/skill.rb +269 -0
  539. data/lib/purecloud/models/skill_entity_listing.rb +238 -0
  540. data/lib/purecloud/models/skills_to_remove.rb +166 -0
  541. data/lib/purecloud/models/social_account.rb +273 -0
  542. data/lib/purecloud/models/social_expression.rb +259 -0
  543. data/lib/purecloud/models/socialize_entity_filter.rb +178 -0
  544. data/lib/purecloud/models/socialize_filter_request.rb +198 -0
  545. data/lib/purecloud/models/sort_by.rb +158 -0
  546. data/lib/purecloud/models/sort_field.rb +165 -0
  547. data/lib/purecloud/models/sort_item.rb +158 -0
  548. data/lib/purecloud/models/spreadsheet_transform.rb +236 -0
  549. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +238 -0
  550. data/lib/purecloud/models/station.rb +227 -0
  551. data/lib/purecloud/models/station_entity_listing.rb +238 -0
  552. data/lib/purecloud/models/sub_data_item.rb +192 -0
  553. data/lib/purecloud/models/support.rb +166 -0
  554. data/lib/purecloud/models/system_prompt.rb +190 -0
  555. data/lib/purecloud/models/system_prompt_asset.rb +259 -0
  556. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +238 -0
  557. data/lib/purecloud/models/system_prompt_entity_listing.rb +238 -0
  558. data/lib/purecloud/models/table_transform.rb +204 -0
  559. data/lib/purecloud/models/tag.rb +158 -0
  560. data/lib/purecloud/models/tag_model.rb +156 -0
  561. data/lib/purecloud/models/tag_query_request.rb +166 -0
  562. data/lib/purecloud/models/tag_value.rb +192 -0
  563. data/lib/purecloud/models/tag_value_entity_listing.rb +238 -0
  564. data/lib/purecloud/models/template.rb +253 -0
  565. data/lib/purecloud/models/template_entity_listing.rb +238 -0
  566. data/lib/purecloud/models/term_attribute.rb +175 -0
  567. data/lib/purecloud/models/text_table_transform.rb +232 -0
  568. data/lib/purecloud/models/text_table_transform_entity_listing.rb +238 -0
  569. data/lib/purecloud/models/third_party_account.rb +212 -0
  570. data/lib/purecloud/models/third_party_subscription.rb +199 -0
  571. data/lib/purecloud/models/tier.rb +156 -0
  572. data/lib/purecloud/models/time_allowed.rb +170 -0
  573. data/lib/purecloud/models/time_interval.rb +156 -0
  574. data/lib/purecloud/models/time_slot.rb +166 -0
  575. data/lib/purecloud/models/time_zone.rb +188 -0
  576. data/lib/purecloud/models/time_zone_entity_listing.rb +238 -0
  577. data/lib/purecloud/models/topic_entity_listing.rb +238 -0
  578. data/lib/purecloud/models/trace.rb +216 -0
  579. data/lib/purecloud/models/trace_list.rb +158 -0
  580. data/lib/purecloud/models/transform_endpoint.rb +271 -0
  581. data/lib/purecloud/models/transform_lens.rb +156 -0
  582. data/lib/purecloud/models/transform_model.rb +212 -0
  583. data/lib/purecloud/models/transform_progress.rb +260 -0
  584. data/lib/purecloud/models/trunk_base.rb +325 -0
  585. data/lib/purecloud/models/trunk_base_assignment.rb +158 -0
  586. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +238 -0
  587. data/lib/purecloud/models/twitter_expression.rb +412 -0
  588. data/lib/purecloud/models/twitter_expression_buffer.rb +149 -0
  589. data/lib/purecloud/models/unpivot_columns.rb +148 -0
  590. data/lib/purecloud/models/unread_metric.rb +146 -0
  591. data/lib/purecloud/models/upload_progress.rb +213 -0
  592. data/lib/purecloud/models/uri_reference.rb +166 -0
  593. data/lib/purecloud/models/url_response.rb +146 -0
  594. data/lib/purecloud/models/user.rb +396 -0
  595. data/lib/purecloud/models/user_action_category.rb +168 -0
  596. data/lib/purecloud/models/user_action_category_entity_listing.rb +238 -0
  597. data/lib/purecloud/models/user_action_metadata.rb +246 -0
  598. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +218 -0
  599. data/lib/purecloud/models/user_action_metadata_request.rb +196 -0
  600. data/lib/purecloud/models/user_authorization.rb +216 -0
  601. data/lib/purecloud/models/user_conversation_summary.rb +206 -0
  602. data/lib/purecloud/models/user_entity_listing.rb +238 -0
  603. data/lib/purecloud/models/user_image.rb +156 -0
  604. data/lib/purecloud/models/user_license_assignment.rb +188 -0
  605. data/lib/purecloud/models/user_param.rb +156 -0
  606. data/lib/purecloud/models/user_presence.rb +230 -0
  607. data/lib/purecloud/models/user_presence_entity_listing.rb +238 -0
  608. data/lib/purecloud/models/user_queue.rb +394 -0
  609. data/lib/purecloud/models/user_queue_entity_listing.rb +238 -0
  610. data/lib/purecloud/models/user_recording.rb +274 -0
  611. data/lib/purecloud/models/user_recording_entity_listing.rb +238 -0
  612. data/lib/purecloud/models/user_skill.rb +290 -0
  613. data/lib/purecloud/models/user_skill_entity_listing.rb +238 -0
  614. data/lib/purecloud/models/user_station_resource.rb +228 -0
  615. data/lib/purecloud/models/user_status.rb +210 -0
  616. data/lib/purecloud/models/users_entity_listing.rb +238 -0
  617. data/lib/purecloud/models/utilization.rb +181 -0
  618. data/lib/purecloud/models/validate_address_request.rb +146 -0
  619. data/lib/purecloud/models/validate_address_response.rb +158 -0
  620. data/lib/purecloud/models/value.rb +220 -0
  621. data/lib/purecloud/models/video.rb +240 -0
  622. data/lib/purecloud/models/view.rb +146 -0
  623. data/lib/purecloud/models/voice_rate.rb +254 -0
  624. data/lib/purecloud/models/voice_rate_extended.rb +355 -0
  625. data/lib/purecloud/models/voice_rate_international.rb +276 -0
  626. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +238 -0
  627. data/lib/purecloud/models/voice_rate_update.rb +282 -0
  628. data/lib/purecloud/models/voice_rates_csv.rb +180 -0
  629. data/lib/purecloud/models/voice_xml_operation.rb +285 -0
  630. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +238 -0
  631. data/lib/purecloud/models/voicemail_mailbox_info.rb +198 -0
  632. data/lib/purecloud/models/voicemail_media_info.rb +167 -0
  633. data/lib/purecloud/models/voicemail_message.rb +252 -0
  634. data/lib/purecloud/models/voicemail_message_entity_listing.rb +238 -0
  635. data/lib/purecloud/models/voicemail_organization_policy.rb +296 -0
  636. data/lib/purecloud/models/voicemail_user_policy.rb +250 -0
  637. data/lib/purecloud/models/vpn.rb +166 -0
  638. data/lib/purecloud/models/work_item.rb +170 -0
  639. data/lib/purecloud/models/work_item_actions.rb +148 -0
  640. data/lib/purecloud/models/work_item_cache.rb +193 -0
  641. data/lib/purecloud/models/work_item_command.rb +156 -0
  642. data/lib/purecloud/models/work_item_command_group.rb +168 -0
  643. data/lib/purecloud/models/work_item_definition.rb +183 -0
  644. data/lib/purecloud/models/work_item_details.rb +361 -0
  645. data/lib/purecloud/models/work_item_search_details.rb +147 -0
  646. data/lib/purecloud/models/work_item_search_details_search_result.rb +161 -0
  647. data/lib/purecloud/models/work_item_submit_request.rb +161 -0
  648. data/lib/purecloud/models/work_item_transfer_request.rb +168 -0
  649. data/lib/purecloud/models/workspace.rb +263 -0
  650. data/lib/purecloud/models/workspace_create.rb +156 -0
  651. data/lib/purecloud/models/workspace_entity_listing.rb +238 -0
  652. data/lib/purecloud/models/workspace_member.rb +237 -0
  653. data/lib/purecloud/models/workspace_member_entity_listing.rb +238 -0
  654. data/lib/purecloud/models/workspace_summary.rb +146 -0
  655. data/lib/purecloud/models/wrap_up_code_mapping.rb +224 -0
  656. data/lib/purecloud/models/wrapup.rb +211 -0
  657. data/lib/purecloud/models/wrapup_code.rb +198 -0
  658. data/lib/purecloud/models/wrapup_code_entity_listing.rb +238 -0
  659. data/lib/purecloud/models/xlsx_schema.rb +171 -0
  660. data/lib/purecloud/version.rb +3 -0
  661. data/newVersion.md +1 -0
  662. data/purecloud.gemspec +32 -0
  663. data/rakefile +101 -0
  664. data/spec/test.rb +37 -0
  665. data/swagger.json +1 -0
  666. data/version.json +1 -0
  667. metadata +891 -0
@@ -0,0 +1,73 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class SearchApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Search chat history
12
+ #
13
+ # @param [Hash] opts the optional parameters
14
+ # @option opts [ChatSearchRequest] :body Search request options
15
+ # @return [ChatSearchListing]
16
+ def post_chats(opts = {})
17
+ data, status_code, headers = post_chats_with_http_info(opts)
18
+ return data
19
+ end
20
+
21
+ # Search chat history
22
+ #
23
+ # @param [Hash] opts the optional parameters
24
+ # @option opts [ChatSearchRequest] :body Search request options
25
+ # @return [Array<(ChatSearchListing, Fixnum, Hash)>] ChatSearchListing data, response status code and response headers
26
+ def post_chats_with_http_info(opts = {})
27
+ if @api_client.config.debugging
28
+ @api_client.config.logger.debug "Calling API: SearchApi#post_chats ..."
29
+ end
30
+
31
+ # resource path
32
+ path = "/api/v1/search/chats".sub('{format}','json')
33
+
34
+ # query parameters
35
+ query_params = {}
36
+
37
+ # header parameters
38
+ header_params = {}
39
+
40
+ # HTTP header 'Accept' (if needed)
41
+ _header_accept = ['application/json']
42
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
43
+
44
+ # HTTP header 'Content-Type'
45
+ _header_content_type = ['application/json']
46
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
47
+
48
+ # form parameters
49
+ form_params = {}
50
+
51
+ # http body (model)
52
+ post_body = @api_client.object_to_http_body(opts[:'body'])
53
+
54
+
55
+ auth_names = ['PureCloud Auth']
56
+ data, status_code, headers = @api_client.call_api(:POST, path,
57
+ :header_params => header_params,
58
+ :query_params => query_params,
59
+ :form_params => form_params,
60
+ :body => post_body,
61
+ :auth_names => auth_names,
62
+ :return_type => 'ChatSearchListing')
63
+ if @api_client.config.debugging
64
+ @api_client.config.logger.debug "API called: SearchApi#post_chats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
65
+ end
66
+ return data, status_code, headers
67
+ end
68
+ end
69
+ end
70
+
71
+
72
+
73
+
@@ -0,0 +1,205 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class StationsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Get the list of available stations.
12
+ #
13
+ # @param [Hash] opts the optional parameters
14
+ # @option opts [Integer] :page_size Page size
15
+ # @option opts [Integer] :page_number Page number
16
+ # @option opts [String] :sort_by Sort by
17
+ # @option opts [String] :name Name
18
+ # @return [StationEntityListing]
19
+ def get_stations(opts = {})
20
+ data, status_code, headers = get_stations_with_http_info(opts)
21
+ return data
22
+ end
23
+
24
+ # Get the list of available stations.
25
+ #
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [Integer] :page_size Page size
28
+ # @option opts [Integer] :page_number Page number
29
+ # @option opts [String] :sort_by Sort by
30
+ # @option opts [String] :name Name
31
+ # @return [Array<(StationEntityListing, Fixnum, Hash)>] StationEntityListing data, response status code and response headers
32
+ def get_stations_with_http_info(opts = {})
33
+ if @api_client.config.debugging
34
+ @api_client.config.logger.debug "Calling API: StationsApi#get_stations ..."
35
+ end
36
+
37
+ # resource path
38
+ path = "/api/v1/stations".sub('{format}','json')
39
+
40
+ # query parameters
41
+ query_params = {}
42
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
43
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
44
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
45
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
46
+
47
+ # header parameters
48
+ header_params = {}
49
+
50
+ # HTTP header 'Accept' (if needed)
51
+ _header_accept = ['application/json']
52
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
53
+
54
+ # HTTP header 'Content-Type'
55
+ _header_content_type = ['application/json']
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
57
+
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = nil
63
+
64
+
65
+ auth_names = ['PureCloud Auth']
66
+ data, status_code, headers = @api_client.call_api(:GET, path,
67
+ :header_params => header_params,
68
+ :query_params => query_params,
69
+ :form_params => form_params,
70
+ :body => post_body,
71
+ :auth_names => auth_names,
72
+ :return_type => 'StationEntityListing')
73
+ if @api_client.config.debugging
74
+ @api_client.config.logger.debug "API called: StationsApi#get_stations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
+ end
76
+ return data, status_code, headers
77
+ end
78
+
79
+ # Get station.
80
+ #
81
+ # @param id Station ID
82
+ # @param [Hash] opts the optional parameters
83
+ # @return [UserStationResource]
84
+ def get(id, opts = {})
85
+ data, status_code, headers = get_with_http_info(id, opts)
86
+ return data
87
+ end
88
+
89
+ # Get station.
90
+ #
91
+ # @param id Station ID
92
+ # @param [Hash] opts the optional parameters
93
+ # @return [Array<(UserStationResource, Fixnum, Hash)>] UserStationResource data, response status code and response headers
94
+ def get_with_http_info(id, opts = {})
95
+ if @api_client.config.debugging
96
+ @api_client.config.logger.debug "Calling API: StationsApi#get ..."
97
+ end
98
+
99
+ # verify the required parameter 'id' is set
100
+ fail "Missing the required parameter 'id' when calling get" if id.nil?
101
+
102
+ # resource path
103
+ path = "/api/v1/stations/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
104
+
105
+ # query parameters
106
+ query_params = {}
107
+
108
+ # header parameters
109
+ header_params = {}
110
+
111
+ # HTTP header 'Accept' (if needed)
112
+ _header_accept = ['application/json']
113
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
114
+
115
+ # HTTP header 'Content-Type'
116
+ _header_content_type = ['application/json']
117
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
118
+
119
+ # form parameters
120
+ form_params = {}
121
+
122
+ # http body (model)
123
+ post_body = nil
124
+
125
+
126
+ auth_names = ['PureCloud Auth']
127
+ data, status_code, headers = @api_client.call_api(:GET, path,
128
+ :header_params => header_params,
129
+ :query_params => query_params,
130
+ :form_params => form_params,
131
+ :body => post_body,
132
+ :auth_names => auth_names,
133
+ :return_type => 'UserStationResource')
134
+ if @api_client.config.debugging
135
+ @api_client.config.logger.debug "API called: StationsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
+ end
137
+ return data, status_code, headers
138
+ end
139
+
140
+ # Unassigns the user assigned to this station
141
+ #
142
+ # @param id Station ID
143
+ # @param [Hash] opts the optional parameters
144
+ # @return [String]
145
+ def delete_associateduser(id, opts = {})
146
+ data, status_code, headers = delete_associateduser_with_http_info(id, opts)
147
+ return data
148
+ end
149
+
150
+ # Unassigns the user assigned to this station
151
+ #
152
+ # @param id Station ID
153
+ # @param [Hash] opts the optional parameters
154
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
155
+ def delete_associateduser_with_http_info(id, opts = {})
156
+ if @api_client.config.debugging
157
+ @api_client.config.logger.debug "Calling API: StationsApi#delete_associateduser ..."
158
+ end
159
+
160
+ # verify the required parameter 'id' is set
161
+ fail "Missing the required parameter 'id' when calling delete_associateduser" if id.nil?
162
+
163
+ # resource path
164
+ path = "/api/v1/stations/{id}/associateduser".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
165
+
166
+ # query parameters
167
+ query_params = {}
168
+
169
+ # header parameters
170
+ header_params = {}
171
+
172
+ # HTTP header 'Accept' (if needed)
173
+ _header_accept = ['application/json']
174
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
175
+
176
+ # HTTP header 'Content-Type'
177
+ _header_content_type = ['application/json']
178
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
179
+
180
+ # form parameters
181
+ form_params = {}
182
+
183
+ # http body (model)
184
+ post_body = nil
185
+
186
+
187
+ auth_names = ['PureCloud Auth']
188
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
189
+ :header_params => header_params,
190
+ :query_params => query_params,
191
+ :form_params => form_params,
192
+ :body => post_body,
193
+ :auth_names => auth_names,
194
+ :return_type => 'String')
195
+ if @api_client.config.debugging
196
+ @api_client.config.logger.debug "API called: StationsApi#delete_associateduser\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
197
+ end
198
+ return data, status_code, headers
199
+ end
200
+ end
201
+ end
202
+
203
+
204
+
205
+
@@ -0,0 +1,2407 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class TelephonyProvidersEdgeApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Get the list of edge groups.
12
+ #
13
+ # @param [Hash] opts the optional parameters
14
+ # @option opts [Integer] :page_size Page size
15
+ # @option opts [Integer] :page_number Page number
16
+ # @option opts [String] :name Name
17
+ # @option opts [String] :sort_by Sort by
18
+ # @return [EdgeGroupEntityListing]
19
+ def get_telephony_providers_edge_edgegroups(opts = {})
20
+ data, status_code, headers = get_telephony_providers_edge_edgegroups_with_http_info(opts)
21
+ return data
22
+ end
23
+
24
+ # Get the list of edge groups.
25
+ #
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [Integer] :page_size Page size
28
+ # @option opts [Integer] :page_number Page number
29
+ # @option opts [String] :name Name
30
+ # @option opts [String] :sort_by Sort by
31
+ # @return [Array<(EdgeGroupEntityListing, Fixnum, Hash)>] EdgeGroupEntityListing data, response status code and response headers
32
+ def get_telephony_providers_edge_edgegroups_with_http_info(opts = {})
33
+ if @api_client.config.debugging
34
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_edgegroups ..."
35
+ end
36
+
37
+ # resource path
38
+ path = "/api/v1/telephony/providers/edge/edgegroups".sub('{format}','json')
39
+
40
+ # query parameters
41
+ query_params = {}
42
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
43
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
44
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
45
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
46
+
47
+ # header parameters
48
+ header_params = {}
49
+
50
+ # HTTP header 'Accept' (if needed)
51
+ _header_accept = ['application/json']
52
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
53
+
54
+ # HTTP header 'Content-Type'
55
+ _header_content_type = ['application/json']
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
57
+
58
+ # form parameters
59
+ form_params = {}
60
+
61
+ # http body (model)
62
+ post_body = nil
63
+
64
+
65
+ auth_names = ['PureCloud Auth']
66
+ data, status_code, headers = @api_client.call_api(:GET, path,
67
+ :header_params => header_params,
68
+ :query_params => query_params,
69
+ :form_params => form_params,
70
+ :body => post_body,
71
+ :auth_names => auth_names,
72
+ :return_type => 'EdgeGroupEntityListing')
73
+ if @api_client.config.debugging
74
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_edgegroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
+ end
76
+ return data, status_code, headers
77
+ end
78
+
79
+ # Create an edge group.
80
+ #
81
+ # @param [Hash] opts the optional parameters
82
+ # @option opts [EdgeGroup] :body EdgeGroup
83
+ # @return [EdgeGroup]
84
+ def post_telephony_providers_edge_edgegroups(opts = {})
85
+ data, status_code, headers = post_telephony_providers_edge_edgegroups_with_http_info(opts)
86
+ return data
87
+ end
88
+
89
+ # Create an edge group.
90
+ #
91
+ # @param [Hash] opts the optional parameters
92
+ # @option opts [EdgeGroup] :body EdgeGroup
93
+ # @return [Array<(EdgeGroup, Fixnum, Hash)>] EdgeGroup data, response status code and response headers
94
+ def post_telephony_providers_edge_edgegroups_with_http_info(opts = {})
95
+ if @api_client.config.debugging
96
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_telephony_providers_edge_edgegroups ..."
97
+ end
98
+
99
+ # resource path
100
+ path = "/api/v1/telephony/providers/edge/edgegroups".sub('{format}','json')
101
+
102
+ # query parameters
103
+ query_params = {}
104
+
105
+ # header parameters
106
+ header_params = {}
107
+
108
+ # HTTP header 'Accept' (if needed)
109
+ _header_accept = ['application/json']
110
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
111
+
112
+ # HTTP header 'Content-Type'
113
+ _header_content_type = ['application/json']
114
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
115
+
116
+ # form parameters
117
+ form_params = {}
118
+
119
+ # http body (model)
120
+ post_body = @api_client.object_to_http_body(opts[:'body'])
121
+
122
+
123
+ auth_names = ['PureCloud Auth']
124
+ data, status_code, headers = @api_client.call_api(:POST, path,
125
+ :header_params => header_params,
126
+ :query_params => query_params,
127
+ :form_params => form_params,
128
+ :body => post_body,
129
+ :auth_names => auth_names,
130
+ :return_type => 'EdgeGroup')
131
+ if @api_client.config.debugging
132
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_edgegroups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
133
+ end
134
+ return data, status_code, headers
135
+ end
136
+
137
+ # Get edge group.
138
+ #
139
+ # @param edge_group_id Edge group ID
140
+ # @param [Hash] opts the optional parameters
141
+ # @return [EdgeGroup]
142
+ def get_telephony_providers_edge_edgegroup(edge_group_id, opts = {})
143
+ data, status_code, headers = get_telephony_providers_edge_edgegroup_with_http_info(edge_group_id, opts)
144
+ return data
145
+ end
146
+
147
+ # Get edge group.
148
+ #
149
+ # @param edge_group_id Edge group ID
150
+ # @param [Hash] opts the optional parameters
151
+ # @return [Array<(EdgeGroup, Fixnum, Hash)>] EdgeGroup data, response status code and response headers
152
+ def get_telephony_providers_edge_edgegroup_with_http_info(edge_group_id, opts = {})
153
+ if @api_client.config.debugging
154
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_edgegroup ..."
155
+ end
156
+
157
+ # verify the required parameter 'edge_group_id' is set
158
+ fail "Missing the required parameter 'edge_group_id' when calling get_telephony_providers_edge_edgegroup" if edge_group_id.nil?
159
+
160
+ # resource path
161
+ path = "/api/v1/telephony/providers/edge/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)
162
+
163
+ # query parameters
164
+ query_params = {}
165
+
166
+ # header parameters
167
+ header_params = {}
168
+
169
+ # HTTP header 'Accept' (if needed)
170
+ _header_accept = ['application/json']
171
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
172
+
173
+ # HTTP header 'Content-Type'
174
+ _header_content_type = ['application/json']
175
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
176
+
177
+ # form parameters
178
+ form_params = {}
179
+
180
+ # http body (model)
181
+ post_body = nil
182
+
183
+
184
+ auth_names = ['PureCloud Auth']
185
+ data, status_code, headers = @api_client.call_api(:GET, path,
186
+ :header_params => header_params,
187
+ :query_params => query_params,
188
+ :form_params => form_params,
189
+ :body => post_body,
190
+ :auth_names => auth_names,
191
+ :return_type => 'EdgeGroup')
192
+ if @api_client.config.debugging
193
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_edgegroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
194
+ end
195
+ return data, status_code, headers
196
+ end
197
+
198
+ # Update an edge group.
199
+ #
200
+ # @param edge_group_id Edge group ID
201
+ # @param [Hash] opts the optional parameters
202
+ # @option opts [EdgeGroup] :body EdgeGroup
203
+ # @return [EdgeGroup]
204
+ def put_telephony_providers_edge_edgegroup(edge_group_id, opts = {})
205
+ data, status_code, headers = put_telephony_providers_edge_edgegroup_with_http_info(edge_group_id, opts)
206
+ return data
207
+ end
208
+
209
+ # Update an edge group.
210
+ #
211
+ # @param edge_group_id Edge group ID
212
+ # @param [Hash] opts the optional parameters
213
+ # @option opts [EdgeGroup] :body EdgeGroup
214
+ # @return [Array<(EdgeGroup, Fixnum, Hash)>] EdgeGroup data, response status code and response headers
215
+ def put_telephony_providers_edge_edgegroup_with_http_info(edge_group_id, opts = {})
216
+ if @api_client.config.debugging
217
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_telephony_providers_edge_edgegroup ..."
218
+ end
219
+
220
+ # verify the required parameter 'edge_group_id' is set
221
+ fail "Missing the required parameter 'edge_group_id' when calling put_telephony_providers_edge_edgegroup" if edge_group_id.nil?
222
+
223
+ # resource path
224
+ path = "/api/v1/telephony/providers/edge/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)
225
+
226
+ # query parameters
227
+ query_params = {}
228
+
229
+ # header parameters
230
+ header_params = {}
231
+
232
+ # HTTP header 'Accept' (if needed)
233
+ _header_accept = ['application/json']
234
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
235
+
236
+ # HTTP header 'Content-Type'
237
+ _header_content_type = ['application/json']
238
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
239
+
240
+ # form parameters
241
+ form_params = {}
242
+
243
+ # http body (model)
244
+ post_body = @api_client.object_to_http_body(opts[:'body'])
245
+
246
+
247
+ auth_names = ['PureCloud Auth']
248
+ data, status_code, headers = @api_client.call_api(:PUT, path,
249
+ :header_params => header_params,
250
+ :query_params => query_params,
251
+ :form_params => form_params,
252
+ :body => post_body,
253
+ :auth_names => auth_names,
254
+ :return_type => 'EdgeGroup')
255
+ if @api_client.config.debugging
256
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_telephony_providers_edge_edgegroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
257
+ end
258
+ return data, status_code, headers
259
+ end
260
+
261
+ # Delete an edge group.
262
+ #
263
+ # @param edge_group_id Edge group ID
264
+ # @param [Hash] opts the optional parameters
265
+ # @return [String]
266
+ def delete_telephony_providers_edge_edgegroup(edge_group_id, opts = {})
267
+ data, status_code, headers = delete_telephony_providers_edge_edgegroup_with_http_info(edge_group_id, opts)
268
+ return data
269
+ end
270
+
271
+ # Delete an edge group.
272
+ #
273
+ # @param edge_group_id Edge group ID
274
+ # @param [Hash] opts the optional parameters
275
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
276
+ def delete_telephony_providers_edge_edgegroup_with_http_info(edge_group_id, opts = {})
277
+ if @api_client.config.debugging
278
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_edgegroup ..."
279
+ end
280
+
281
+ # verify the required parameter 'edge_group_id' is set
282
+ fail "Missing the required parameter 'edge_group_id' when calling delete_telephony_providers_edge_edgegroup" if edge_group_id.nil?
283
+
284
+ # resource path
285
+ path = "/api/v1/telephony/providers/edge/edgegroups/{edgeGroupId}".sub('{format}','json').sub('{' + 'edgeGroupId' + '}', edge_group_id.to_s)
286
+
287
+ # query parameters
288
+ query_params = {}
289
+
290
+ # header parameters
291
+ header_params = {}
292
+
293
+ # HTTP header 'Accept' (if needed)
294
+ _header_accept = ['application/json']
295
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
296
+
297
+ # HTTP header 'Content-Type'
298
+ _header_content_type = ['application/json']
299
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
300
+
301
+ # form parameters
302
+ form_params = {}
303
+
304
+ # http body (model)
305
+ post_body = nil
306
+
307
+
308
+ auth_names = ['PureCloud Auth']
309
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
310
+ :header_params => header_params,
311
+ :query_params => query_params,
312
+ :form_params => form_params,
313
+ :body => post_body,
314
+ :auth_names => auth_names,
315
+ :return_type => 'String')
316
+ if @api_client.config.debugging
317
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_edgegroup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
318
+ end
319
+ return data, status_code, headers
320
+ end
321
+
322
+ # Get a listing of line base settings objects
323
+ #
324
+ # @param [Hash] opts the optional parameters
325
+ # @option opts [Integer] :page_number Page number
326
+ # @option opts [Integer] :page_size Page size
327
+ # @option opts [String] :sort_by Value by which to sort
328
+ # @option opts [String] :sort_order Sort order
329
+ # @return [LineBaseEntityListing]
330
+ def get_telephony_providers_edge_linebasesettings(opts = {})
331
+ data, status_code, headers = get_telephony_providers_edge_linebasesettings_with_http_info(opts)
332
+ return data
333
+ end
334
+
335
+ # Get a listing of line base settings objects
336
+ #
337
+ # @param [Hash] opts the optional parameters
338
+ # @option opts [Integer] :page_number Page number
339
+ # @option opts [Integer] :page_size Page size
340
+ # @option opts [String] :sort_by Value by which to sort
341
+ # @option opts [String] :sort_order Sort order
342
+ # @return [Array<(LineBaseEntityListing, Fixnum, Hash)>] LineBaseEntityListing data, response status code and response headers
343
+ def get_telephony_providers_edge_linebasesettings_with_http_info(opts = {})
344
+ if @api_client.config.debugging
345
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_linebasesettings ..."
346
+ end
347
+
348
+ # resource path
349
+ path = "/api/v1/telephony/providers/edge/linebasesettings".sub('{format}','json')
350
+
351
+ # query parameters
352
+ query_params = {}
353
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
354
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
355
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
356
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
357
+
358
+ # header parameters
359
+ header_params = {}
360
+
361
+ # HTTP header 'Accept' (if needed)
362
+ _header_accept = ['application/json']
363
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
364
+
365
+ # HTTP header 'Content-Type'
366
+ _header_content_type = ['application/json']
367
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
368
+
369
+ # form parameters
370
+ form_params = {}
371
+
372
+ # http body (model)
373
+ post_body = nil
374
+
375
+
376
+ auth_names = ['PureCloud Auth']
377
+ data, status_code, headers = @api_client.call_api(:GET, path,
378
+ :header_params => header_params,
379
+ :query_params => query_params,
380
+ :form_params => form_params,
381
+ :body => post_body,
382
+ :auth_names => auth_names,
383
+ :return_type => 'LineBaseEntityListing')
384
+ if @api_client.config.debugging
385
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_linebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
386
+ end
387
+ return data, status_code, headers
388
+ end
389
+
390
+ # Get a line base settings object by ID
391
+ #
392
+ # @param line_base_id Line base ID
393
+ # @param [Hash] opts the optional parameters
394
+ # @return [LineBase]
395
+ def get_telephony_providers_edge_linebasesetting(line_base_id, opts = {})
396
+ data, status_code, headers = get_telephony_providers_edge_linebasesetting_with_http_info(line_base_id, opts)
397
+ return data
398
+ end
399
+
400
+ # Get a line base settings object by ID
401
+ #
402
+ # @param line_base_id Line base ID
403
+ # @param [Hash] opts the optional parameters
404
+ # @return [Array<(LineBase, Fixnum, Hash)>] LineBase data, response status code and response headers
405
+ def get_telephony_providers_edge_linebasesetting_with_http_info(line_base_id, opts = {})
406
+ if @api_client.config.debugging
407
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_linebasesetting ..."
408
+ end
409
+
410
+ # verify the required parameter 'line_base_id' is set
411
+ fail "Missing the required parameter 'line_base_id' when calling get_telephony_providers_edge_linebasesetting" if line_base_id.nil?
412
+
413
+ # resource path
414
+ path = "/api/v1/telephony/providers/edge/linebasesettings/{lineBaseId}".sub('{format}','json').sub('{' + 'lineBaseId' + '}', line_base_id.to_s)
415
+
416
+ # query parameters
417
+ query_params = {}
418
+
419
+ # header parameters
420
+ header_params = {}
421
+
422
+ # HTTP header 'Accept' (if needed)
423
+ _header_accept = ['application/json']
424
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
425
+
426
+ # HTTP header 'Content-Type'
427
+ _header_content_type = ['application/json']
428
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
429
+
430
+ # form parameters
431
+ form_params = {}
432
+
433
+ # http body (model)
434
+ post_body = nil
435
+
436
+
437
+ auth_names = ['PureCloud Auth']
438
+ data, status_code, headers = @api_client.call_api(:GET, path,
439
+ :header_params => header_params,
440
+ :query_params => query_params,
441
+ :form_params => form_params,
442
+ :body => post_body,
443
+ :auth_names => auth_names,
444
+ :return_type => 'LineBase')
445
+ if @api_client.config.debugging
446
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_linebasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
447
+ end
448
+ return data, status_code, headers
449
+ end
450
+
451
+ # Get a list of Lines
452
+ #
453
+ # @param [Hash] opts the optional parameters
454
+ # @option opts [Integer] :page_size Page size
455
+ # @option opts [Integer] :page_number Page number
456
+ # @option opts [String] :name Name
457
+ # @option opts [String] :sort_by Value by which to sort
458
+ # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
459
+ # @return [LineEntityListing]
460
+ def get_telephony_providers_edge_lines(opts = {})
461
+ data, status_code, headers = get_telephony_providers_edge_lines_with_http_info(opts)
462
+ return data
463
+ end
464
+
465
+ # Get a list of Lines
466
+ #
467
+ # @param [Hash] opts the optional parameters
468
+ # @option opts [Integer] :page_size Page size
469
+ # @option opts [Integer] :page_number Page number
470
+ # @option opts [String] :name Name
471
+ # @option opts [String] :sort_by Value by which to sort
472
+ # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
473
+ # @return [Array<(LineEntityListing, Fixnum, Hash)>] LineEntityListing data, response status code and response headers
474
+ def get_telephony_providers_edge_lines_with_http_info(opts = {})
475
+ if @api_client.config.debugging
476
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_lines ..."
477
+ end
478
+
479
+ # resource path
480
+ path = "/api/v1/telephony/providers/edge/lines".sub('{format}','json')
481
+
482
+ # query parameters
483
+ query_params = {}
484
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
485
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
486
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
487
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
488
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
489
+
490
+ # header parameters
491
+ header_params = {}
492
+
493
+ # HTTP header 'Accept' (if needed)
494
+ _header_accept = ['application/json']
495
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
496
+
497
+ # HTTP header 'Content-Type'
498
+ _header_content_type = ['application/json']
499
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
500
+
501
+ # form parameters
502
+ form_params = {}
503
+
504
+ # http body (model)
505
+ post_body = nil
506
+
507
+
508
+ auth_names = ['PureCloud Auth']
509
+ data, status_code, headers = @api_client.call_api(:GET, path,
510
+ :header_params => header_params,
511
+ :query_params => query_params,
512
+ :form_params => form_params,
513
+ :body => post_body,
514
+ :auth_names => auth_names,
515
+ :return_type => 'LineEntityListing')
516
+ if @api_client.config.debugging
517
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_lines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
518
+ end
519
+ return data, status_code, headers
520
+ end
521
+
522
+ # Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance
523
+ #
524
+ # @param line_base_settings_id The id of a Line Base Settings object upon which to base this Line
525
+ # @param [Hash] opts the optional parameters
526
+ # @return [Line]
527
+ def get_telephony_providers_edge_lines_template(line_base_settings_id, opts = {})
528
+ data, status_code, headers = get_telephony_providers_edge_lines_template_with_http_info(line_base_settings_id, opts)
529
+ return data
530
+ end
531
+
532
+ # Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance
533
+ #
534
+ # @param line_base_settings_id The id of a Line Base Settings object upon which to base this Line
535
+ # @param [Hash] opts the optional parameters
536
+ # @return [Array<(Line, Fixnum, Hash)>] Line data, response status code and response headers
537
+ def get_telephony_providers_edge_lines_template_with_http_info(line_base_settings_id, opts = {})
538
+ if @api_client.config.debugging
539
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_lines_template ..."
540
+ end
541
+
542
+ # verify the required parameter 'line_base_settings_id' is set
543
+ fail "Missing the required parameter 'line_base_settings_id' when calling get_telephony_providers_edge_lines_template" if line_base_settings_id.nil?
544
+
545
+ # resource path
546
+ path = "/api/v1/telephony/providers/edge/lines/template".sub('{format}','json')
547
+
548
+ # query parameters
549
+ query_params = {}
550
+ query_params[:'lineBaseSettingsId'] = line_base_settings_id
551
+
552
+ # header parameters
553
+ header_params = {}
554
+
555
+ # HTTP header 'Accept' (if needed)
556
+ _header_accept = ['application/json']
557
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
558
+
559
+ # HTTP header 'Content-Type'
560
+ _header_content_type = ['application/json']
561
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
562
+
563
+ # form parameters
564
+ form_params = {}
565
+
566
+ # http body (model)
567
+ post_body = nil
568
+
569
+
570
+ auth_names = ['PureCloud Auth']
571
+ data, status_code, headers = @api_client.call_api(:GET, path,
572
+ :header_params => header_params,
573
+ :query_params => query_params,
574
+ :form_params => form_params,
575
+ :body => post_body,
576
+ :auth_names => auth_names,
577
+ :return_type => 'Line')
578
+ if @api_client.config.debugging
579
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_lines_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
580
+ end
581
+ return data, status_code, headers
582
+ end
583
+
584
+ # Get a Line by ID
585
+ #
586
+ # @param line_id Line ID
587
+ # @param [Hash] opts the optional parameters
588
+ # @return [Line]
589
+ def get_telephony_providers_edge_line(line_id, opts = {})
590
+ data, status_code, headers = get_telephony_providers_edge_line_with_http_info(line_id, opts)
591
+ return data
592
+ end
593
+
594
+ # Get a Line by ID
595
+ #
596
+ # @param line_id Line ID
597
+ # @param [Hash] opts the optional parameters
598
+ # @return [Array<(Line, Fixnum, Hash)>] Line data, response status code and response headers
599
+ def get_telephony_providers_edge_line_with_http_info(line_id, opts = {})
600
+ if @api_client.config.debugging
601
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_line ..."
602
+ end
603
+
604
+ # verify the required parameter 'line_id' is set
605
+ fail "Missing the required parameter 'line_id' when calling get_telephony_providers_edge_line" if line_id.nil?
606
+
607
+ # resource path
608
+ path = "/api/v1/telephony/providers/edge/lines/{lineId}".sub('{format}','json').sub('{' + 'lineId' + '}', line_id.to_s)
609
+
610
+ # query parameters
611
+ query_params = {}
612
+
613
+ # header parameters
614
+ header_params = {}
615
+
616
+ # HTTP header 'Accept' (if needed)
617
+ _header_accept = ['application/json']
618
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
619
+
620
+ # HTTP header 'Content-Type'
621
+ _header_content_type = ['application/json']
622
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
623
+
624
+ # form parameters
625
+ form_params = {}
626
+
627
+ # http body (model)
628
+ post_body = nil
629
+
630
+
631
+ auth_names = ['PureCloud Auth']
632
+ data, status_code, headers = @api_client.call_api(:GET, path,
633
+ :header_params => header_params,
634
+ :query_params => query_params,
635
+ :form_params => form_params,
636
+ :body => post_body,
637
+ :auth_names => auth_names,
638
+ :return_type => 'Line')
639
+ if @api_client.config.debugging
640
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_line\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
641
+ end
642
+ return data, status_code, headers
643
+ end
644
+
645
+ # Get outbound routes
646
+ #
647
+ # @param [Hash] opts the optional parameters
648
+ # @option opts [Integer] :page_size Page size
649
+ # @option opts [Integer] :page_number Page number
650
+ # @option opts [String] :name Name
651
+ # @option opts [String] :site_id Filter by site.id
652
+ # @option opts [String] :sort_by Sort by
653
+ # @return [OutboundRouteEntityListing]
654
+ def get_telephony_providers_edge_outboundroutes(opts = {})
655
+ data, status_code, headers = get_telephony_providers_edge_outboundroutes_with_http_info(opts)
656
+ return data
657
+ end
658
+
659
+ # Get outbound routes
660
+ #
661
+ # @param [Hash] opts the optional parameters
662
+ # @option opts [Integer] :page_size Page size
663
+ # @option opts [Integer] :page_number Page number
664
+ # @option opts [String] :name Name
665
+ # @option opts [String] :site_id Filter by site.id
666
+ # @option opts [String] :sort_by Sort by
667
+ # @return [Array<(OutboundRouteEntityListing, Fixnum, Hash)>] OutboundRouteEntityListing data, response status code and response headers
668
+ def get_telephony_providers_edge_outboundroutes_with_http_info(opts = {})
669
+ if @api_client.config.debugging
670
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_outboundroutes ..."
671
+ end
672
+
673
+ # resource path
674
+ path = "/api/v1/telephony/providers/edge/outboundroutes".sub('{format}','json')
675
+
676
+ # query parameters
677
+ query_params = {}
678
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
679
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
680
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
681
+ query_params[:'site.id'] = opts[:'site_id'] if opts[:'site_id']
682
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
683
+
684
+ # header parameters
685
+ header_params = {}
686
+
687
+ # HTTP header 'Accept' (if needed)
688
+ _header_accept = ['application/json']
689
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
690
+
691
+ # HTTP header 'Content-Type'
692
+ _header_content_type = ['application/json']
693
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
694
+
695
+ # form parameters
696
+ form_params = {}
697
+
698
+ # http body (model)
699
+ post_body = nil
700
+
701
+
702
+ auth_names = ['PureCloud Auth']
703
+ data, status_code, headers = @api_client.call_api(:GET, path,
704
+ :header_params => header_params,
705
+ :query_params => query_params,
706
+ :form_params => form_params,
707
+ :body => post_body,
708
+ :auth_names => auth_names,
709
+ :return_type => 'OutboundRouteEntityListing')
710
+ if @api_client.config.debugging
711
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_outboundroutes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
712
+ end
713
+ return data, status_code, headers
714
+ end
715
+
716
+ # Create outbound rule
717
+ #
718
+ # @param [Hash] opts the optional parameters
719
+ # @option opts [OutboundRoute] :body OutboundRoute
720
+ # @return [OutboundRoute]
721
+ def post_telephony_providers_edge_outboundroutes(opts = {})
722
+ data, status_code, headers = post_telephony_providers_edge_outboundroutes_with_http_info(opts)
723
+ return data
724
+ end
725
+
726
+ # Create outbound rule
727
+ #
728
+ # @param [Hash] opts the optional parameters
729
+ # @option opts [OutboundRoute] :body OutboundRoute
730
+ # @return [Array<(OutboundRoute, Fixnum, Hash)>] OutboundRoute data, response status code and response headers
731
+ def post_telephony_providers_edge_outboundroutes_with_http_info(opts = {})
732
+ if @api_client.config.debugging
733
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_telephony_providers_edge_outboundroutes ..."
734
+ end
735
+
736
+ # resource path
737
+ path = "/api/v1/telephony/providers/edge/outboundroutes".sub('{format}','json')
738
+
739
+ # query parameters
740
+ query_params = {}
741
+
742
+ # header parameters
743
+ header_params = {}
744
+
745
+ # HTTP header 'Accept' (if needed)
746
+ _header_accept = ['application/json']
747
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
748
+
749
+ # HTTP header 'Content-Type'
750
+ _header_content_type = ['application/json']
751
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
752
+
753
+ # form parameters
754
+ form_params = {}
755
+
756
+ # http body (model)
757
+ post_body = @api_client.object_to_http_body(opts[:'body'])
758
+
759
+
760
+ auth_names = ['PureCloud Auth']
761
+ data, status_code, headers = @api_client.call_api(:POST, path,
762
+ :header_params => header_params,
763
+ :query_params => query_params,
764
+ :form_params => form_params,
765
+ :body => post_body,
766
+ :auth_names => auth_names,
767
+ :return_type => 'OutboundRoute')
768
+ if @api_client.config.debugging
769
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_outboundroutes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
770
+ end
771
+ return data, status_code, headers
772
+ end
773
+
774
+ # Get outbound route
775
+ #
776
+ # @param outbound_route_id Outbound route ID
777
+ # @param [Hash] opts the optional parameters
778
+ # @return [OutboundRoute]
779
+ def get_telephony_providers_edge_outboundroute(outbound_route_id, opts = {})
780
+ data, status_code, headers = get_telephony_providers_edge_outboundroute_with_http_info(outbound_route_id, opts)
781
+ return data
782
+ end
783
+
784
+ # Get outbound route
785
+ #
786
+ # @param outbound_route_id Outbound route ID
787
+ # @param [Hash] opts the optional parameters
788
+ # @return [Array<(OutboundRoute, Fixnum, Hash)>] OutboundRoute data, response status code and response headers
789
+ def get_telephony_providers_edge_outboundroute_with_http_info(outbound_route_id, opts = {})
790
+ if @api_client.config.debugging
791
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_outboundroute ..."
792
+ end
793
+
794
+ # verify the required parameter 'outbound_route_id' is set
795
+ fail "Missing the required parameter 'outbound_route_id' when calling get_telephony_providers_edge_outboundroute" if outbound_route_id.nil?
796
+
797
+ # resource path
798
+ path = "/api/v1/telephony/providers/edge/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)
799
+
800
+ # query parameters
801
+ query_params = {}
802
+
803
+ # header parameters
804
+ header_params = {}
805
+
806
+ # HTTP header 'Accept' (if needed)
807
+ _header_accept = ['application/json']
808
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
809
+
810
+ # HTTP header 'Content-Type'
811
+ _header_content_type = ['application/json']
812
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
813
+
814
+ # form parameters
815
+ form_params = {}
816
+
817
+ # http body (model)
818
+ post_body = nil
819
+
820
+
821
+ auth_names = ['PureCloud Auth']
822
+ data, status_code, headers = @api_client.call_api(:GET, path,
823
+ :header_params => header_params,
824
+ :query_params => query_params,
825
+ :form_params => form_params,
826
+ :body => post_body,
827
+ :auth_names => auth_names,
828
+ :return_type => 'OutboundRoute')
829
+ if @api_client.config.debugging
830
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
831
+ end
832
+ return data, status_code, headers
833
+ end
834
+
835
+ # Update outbound route
836
+ #
837
+ # @param outbound_route_id Outbound route ID
838
+ # @param [Hash] opts the optional parameters
839
+ # @option opts [OutboundRoute] :body OutboundRoute
840
+ # @return [OutboundRoute]
841
+ def put_telephony_providers_edge_outboundroute(outbound_route_id, opts = {})
842
+ data, status_code, headers = put_telephony_providers_edge_outboundroute_with_http_info(outbound_route_id, opts)
843
+ return data
844
+ end
845
+
846
+ # Update outbound route
847
+ #
848
+ # @param outbound_route_id Outbound route ID
849
+ # @param [Hash] opts the optional parameters
850
+ # @option opts [OutboundRoute] :body OutboundRoute
851
+ # @return [Array<(OutboundRoute, Fixnum, Hash)>] OutboundRoute data, response status code and response headers
852
+ def put_telephony_providers_edge_outboundroute_with_http_info(outbound_route_id, opts = {})
853
+ if @api_client.config.debugging
854
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_telephony_providers_edge_outboundroute ..."
855
+ end
856
+
857
+ # verify the required parameter 'outbound_route_id' is set
858
+ fail "Missing the required parameter 'outbound_route_id' when calling put_telephony_providers_edge_outboundroute" if outbound_route_id.nil?
859
+
860
+ # resource path
861
+ path = "/api/v1/telephony/providers/edge/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)
862
+
863
+ # query parameters
864
+ query_params = {}
865
+
866
+ # header parameters
867
+ header_params = {}
868
+
869
+ # HTTP header 'Accept' (if needed)
870
+ _header_accept = ['application/json']
871
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
872
+
873
+ # HTTP header 'Content-Type'
874
+ _header_content_type = ['application/json']
875
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
876
+
877
+ # form parameters
878
+ form_params = {}
879
+
880
+ # http body (model)
881
+ post_body = @api_client.object_to_http_body(opts[:'body'])
882
+
883
+
884
+ auth_names = ['PureCloud Auth']
885
+ data, status_code, headers = @api_client.call_api(:PUT, path,
886
+ :header_params => header_params,
887
+ :query_params => query_params,
888
+ :form_params => form_params,
889
+ :body => post_body,
890
+ :auth_names => auth_names,
891
+ :return_type => 'OutboundRoute')
892
+ if @api_client.config.debugging
893
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_telephony_providers_edge_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
894
+ end
895
+ return data, status_code, headers
896
+ end
897
+
898
+ # Delete Outbound Route
899
+ #
900
+ # @param outbound_route_id Outbound route ID
901
+ # @param [Hash] opts the optional parameters
902
+ # @return [String]
903
+ def delete_telephony_providers_edge_outboundroute(outbound_route_id, opts = {})
904
+ data, status_code, headers = delete_telephony_providers_edge_outboundroute_with_http_info(outbound_route_id, opts)
905
+ return data
906
+ end
907
+
908
+ # Delete Outbound Route
909
+ #
910
+ # @param outbound_route_id Outbound route ID
911
+ # @param [Hash] opts the optional parameters
912
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
913
+ def delete_telephony_providers_edge_outboundroute_with_http_info(outbound_route_id, opts = {})
914
+ if @api_client.config.debugging
915
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_outboundroute ..."
916
+ end
917
+
918
+ # verify the required parameter 'outbound_route_id' is set
919
+ fail "Missing the required parameter 'outbound_route_id' when calling delete_telephony_providers_edge_outboundroute" if outbound_route_id.nil?
920
+
921
+ # resource path
922
+ path = "/api/v1/telephony/providers/edge/outboundroutes/{outboundRouteId}".sub('{format}','json').sub('{' + 'outboundRouteId' + '}', outbound_route_id.to_s)
923
+
924
+ # query parameters
925
+ query_params = {}
926
+
927
+ # header parameters
928
+ header_params = {}
929
+
930
+ # HTTP header 'Accept' (if needed)
931
+ _header_accept = ['application/json']
932
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
933
+
934
+ # HTTP header 'Content-Type'
935
+ _header_content_type = ['application/json']
936
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
937
+
938
+ # form parameters
939
+ form_params = {}
940
+
941
+ # http body (model)
942
+ post_body = nil
943
+
944
+
945
+ auth_names = ['PureCloud Auth']
946
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
947
+ :header_params => header_params,
948
+ :query_params => query_params,
949
+ :form_params => form_params,
950
+ :body => post_body,
951
+ :auth_names => auth_names,
952
+ :return_type => 'String')
953
+ if @api_client.config.debugging
954
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_outboundroute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
955
+ end
956
+ return data, status_code, headers
957
+ end
958
+
959
+ # Get a list of Phone Base Settings objects
960
+ #
961
+ # @param [Hash] opts the optional parameters
962
+ # @option opts [Integer] :page_number Page number
963
+ # @option opts [Integer] :page_size Page size
964
+ # @option opts [String] :sort_by Value by which to sort
965
+ # @option opts [String] :sort_order Sort order
966
+ # @return [PhoneBaseEntityListing]
967
+ def get_telephony_providers_edge_phonebasesettings(opts = {})
968
+ data, status_code, headers = get_telephony_providers_edge_phonebasesettings_with_http_info(opts)
969
+ return data
970
+ end
971
+
972
+ # Get a list of Phone Base Settings objects
973
+ #
974
+ # @param [Hash] opts the optional parameters
975
+ # @option opts [Integer] :page_number Page number
976
+ # @option opts [Integer] :page_size Page size
977
+ # @option opts [String] :sort_by Value by which to sort
978
+ # @option opts [String] :sort_order Sort order
979
+ # @return [Array<(PhoneBaseEntityListing, Fixnum, Hash)>] PhoneBaseEntityListing data, response status code and response headers
980
+ def get_telephony_providers_edge_phonebasesettings_with_http_info(opts = {})
981
+ if @api_client.config.debugging
982
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phonebasesettings ..."
983
+ end
984
+
985
+ # resource path
986
+ path = "/api/v1/telephony/providers/edge/phonebasesettings".sub('{format}','json')
987
+
988
+ # query parameters
989
+ query_params = {}
990
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
991
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
992
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
993
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
994
+
995
+ # header parameters
996
+ header_params = {}
997
+
998
+ # HTTP header 'Accept' (if needed)
999
+ _header_accept = ['application/json']
1000
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1001
+
1002
+ # HTTP header 'Content-Type'
1003
+ _header_content_type = ['application/json']
1004
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1005
+
1006
+ # form parameters
1007
+ form_params = {}
1008
+
1009
+ # http body (model)
1010
+ post_body = nil
1011
+
1012
+
1013
+ auth_names = ['PureCloud Auth']
1014
+ data, status_code, headers = @api_client.call_api(:GET, path,
1015
+ :header_params => header_params,
1016
+ :query_params => query_params,
1017
+ :form_params => form_params,
1018
+ :body => post_body,
1019
+ :auth_names => auth_names,
1020
+ :return_type => 'PhoneBaseEntityListing')
1021
+ if @api_client.config.debugging
1022
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phonebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1023
+ end
1024
+ return data, status_code, headers
1025
+ end
1026
+
1027
+ # Create a new Phone Base Settings object
1028
+ #
1029
+ # @param [Hash] opts the optional parameters
1030
+ # @option opts [PhoneBase] :body
1031
+ # @return [PhoneBase]
1032
+ def post_telephony_providers_edge_phonebasesettings(opts = {})
1033
+ data, status_code, headers = post_telephony_providers_edge_phonebasesettings_with_http_info(opts)
1034
+ return data
1035
+ end
1036
+
1037
+ # Create a new Phone Base Settings object
1038
+ #
1039
+ # @param [Hash] opts the optional parameters
1040
+ # @option opts [PhoneBase] :body
1041
+ # @return [Array<(PhoneBase, Fixnum, Hash)>] PhoneBase data, response status code and response headers
1042
+ def post_telephony_providers_edge_phonebasesettings_with_http_info(opts = {})
1043
+ if @api_client.config.debugging
1044
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_telephony_providers_edge_phonebasesettings ..."
1045
+ end
1046
+
1047
+ # resource path
1048
+ path = "/api/v1/telephony/providers/edge/phonebasesettings".sub('{format}','json')
1049
+
1050
+ # query parameters
1051
+ query_params = {}
1052
+
1053
+ # header parameters
1054
+ header_params = {}
1055
+
1056
+ # HTTP header 'Accept' (if needed)
1057
+ _header_accept = ['application/json']
1058
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1059
+
1060
+ # HTTP header 'Content-Type'
1061
+ _header_content_type = ['application/json']
1062
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1063
+
1064
+ # form parameters
1065
+ form_params = {}
1066
+
1067
+ # http body (model)
1068
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1069
+
1070
+
1071
+ auth_names = ['PureCloud Auth']
1072
+ data, status_code, headers = @api_client.call_api(:POST, path,
1073
+ :header_params => header_params,
1074
+ :query_params => query_params,
1075
+ :form_params => form_params,
1076
+ :body => post_body,
1077
+ :auth_names => auth_names,
1078
+ :return_type => 'PhoneBase')
1079
+ if @api_client.config.debugging
1080
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_phonebasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1081
+ end
1082
+ return data, status_code, headers
1083
+ end
1084
+
1085
+ # Get a list of available makes and models to create a new Phone Base Settings
1086
+ #
1087
+ # @param [Hash] opts the optional parameters
1088
+ # @option opts [Integer] :page_size Page size
1089
+ # @option opts [Integer] :page_number Page number
1090
+ # @return [PhoneMetaBaseEntityListing]
1091
+ def get_telephony_providers_edge_phonebasesettings_availablemetabases(opts = {})
1092
+ data, status_code, headers = get_telephony_providers_edge_phonebasesettings_availablemetabases_with_http_info(opts)
1093
+ return data
1094
+ end
1095
+
1096
+ # Get a list of available makes and models to create a new Phone Base Settings
1097
+ #
1098
+ # @param [Hash] opts the optional parameters
1099
+ # @option opts [Integer] :page_size Page size
1100
+ # @option opts [Integer] :page_number Page number
1101
+ # @return [Array<(PhoneMetaBaseEntityListing, Fixnum, Hash)>] PhoneMetaBaseEntityListing data, response status code and response headers
1102
+ def get_telephony_providers_edge_phonebasesettings_availablemetabases_with_http_info(opts = {})
1103
+ if @api_client.config.debugging
1104
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phonebasesettings_availablemetabases ..."
1105
+ end
1106
+
1107
+ # resource path
1108
+ path = "/api/v1/telephony/providers/edge/phonebasesettings/availablemetabases".sub('{format}','json')
1109
+
1110
+ # query parameters
1111
+ query_params = {}
1112
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1113
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1114
+
1115
+ # header parameters
1116
+ header_params = {}
1117
+
1118
+ # HTTP header 'Accept' (if needed)
1119
+ _header_accept = ['application/json']
1120
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1121
+
1122
+ # HTTP header 'Content-Type'
1123
+ _header_content_type = ['application/json']
1124
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1125
+
1126
+ # form parameters
1127
+ form_params = {}
1128
+
1129
+ # http body (model)
1130
+ post_body = nil
1131
+
1132
+
1133
+ auth_names = ['PureCloud Auth']
1134
+ data, status_code, headers = @api_client.call_api(:GET, path,
1135
+ :header_params => header_params,
1136
+ :query_params => query_params,
1137
+ :form_params => form_params,
1138
+ :body => post_body,
1139
+ :auth_names => auth_names,
1140
+ :return_type => 'PhoneMetaBaseEntityListing')
1141
+ if @api_client.config.debugging
1142
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phonebasesettings_availablemetabases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1143
+ end
1144
+ return data, status_code, headers
1145
+ end
1146
+
1147
+ # Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance
1148
+ #
1149
+ # @param phone_metabase_id The id of a metabase object upon which to base this Phone Base Settings
1150
+ # @param [Hash] opts the optional parameters
1151
+ # @return [PhoneBase]
1152
+ def get_telephony_providers_edge_phonebasesettings_template(phone_metabase_id, opts = {})
1153
+ data, status_code, headers = get_telephony_providers_edge_phonebasesettings_template_with_http_info(phone_metabase_id, opts)
1154
+ return data
1155
+ end
1156
+
1157
+ # Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance
1158
+ #
1159
+ # @param phone_metabase_id The id of a metabase object upon which to base this Phone Base Settings
1160
+ # @param [Hash] opts the optional parameters
1161
+ # @return [Array<(PhoneBase, Fixnum, Hash)>] PhoneBase data, response status code and response headers
1162
+ def get_telephony_providers_edge_phonebasesettings_template_with_http_info(phone_metabase_id, opts = {})
1163
+ if @api_client.config.debugging
1164
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phonebasesettings_template ..."
1165
+ end
1166
+
1167
+ # verify the required parameter 'phone_metabase_id' is set
1168
+ fail "Missing the required parameter 'phone_metabase_id' when calling get_telephony_providers_edge_phonebasesettings_template" if phone_metabase_id.nil?
1169
+
1170
+ # resource path
1171
+ path = "/api/v1/telephony/providers/edge/phonebasesettings/template".sub('{format}','json')
1172
+
1173
+ # query parameters
1174
+ query_params = {}
1175
+ query_params[:'phoneMetabaseId'] = phone_metabase_id
1176
+
1177
+ # header parameters
1178
+ header_params = {}
1179
+
1180
+ # HTTP header 'Accept' (if needed)
1181
+ _header_accept = ['application/json']
1182
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1183
+
1184
+ # HTTP header 'Content-Type'
1185
+ _header_content_type = ['application/json']
1186
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1187
+
1188
+ # form parameters
1189
+ form_params = {}
1190
+
1191
+ # http body (model)
1192
+ post_body = nil
1193
+
1194
+
1195
+ auth_names = ['PureCloud Auth']
1196
+ data, status_code, headers = @api_client.call_api(:GET, path,
1197
+ :header_params => header_params,
1198
+ :query_params => query_params,
1199
+ :form_params => form_params,
1200
+ :body => post_body,
1201
+ :auth_names => auth_names,
1202
+ :return_type => 'PhoneBase')
1203
+ if @api_client.config.debugging
1204
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phonebasesettings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1205
+ end
1206
+ return data, status_code, headers
1207
+ end
1208
+
1209
+ # Get a Phone Base Settings object by ID
1210
+ #
1211
+ # @param phone_base_id Phone base ID
1212
+ # @param [Hash] opts the optional parameters
1213
+ # @return [PhoneBase]
1214
+ def get_telephony_providers_edge_phonebasesetting(phone_base_id, opts = {})
1215
+ data, status_code, headers = get_telephony_providers_edge_phonebasesetting_with_http_info(phone_base_id, opts)
1216
+ return data
1217
+ end
1218
+
1219
+ # Get a Phone Base Settings object by ID
1220
+ #
1221
+ # @param phone_base_id Phone base ID
1222
+ # @param [Hash] opts the optional parameters
1223
+ # @return [Array<(PhoneBase, Fixnum, Hash)>] PhoneBase data, response status code and response headers
1224
+ def get_telephony_providers_edge_phonebasesetting_with_http_info(phone_base_id, opts = {})
1225
+ if @api_client.config.debugging
1226
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phonebasesetting ..."
1227
+ end
1228
+
1229
+ # verify the required parameter 'phone_base_id' is set
1230
+ fail "Missing the required parameter 'phone_base_id' when calling get_telephony_providers_edge_phonebasesetting" if phone_base_id.nil?
1231
+
1232
+ # resource path
1233
+ path = "/api/v1/telephony/providers/edge/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)
1234
+
1235
+ # query parameters
1236
+ query_params = {}
1237
+
1238
+ # header parameters
1239
+ header_params = {}
1240
+
1241
+ # HTTP header 'Accept' (if needed)
1242
+ _header_accept = ['application/json']
1243
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1244
+
1245
+ # HTTP header 'Content-Type'
1246
+ _header_content_type = ['application/json']
1247
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1248
+
1249
+ # form parameters
1250
+ form_params = {}
1251
+
1252
+ # http body (model)
1253
+ post_body = nil
1254
+
1255
+
1256
+ auth_names = ['PureCloud Auth']
1257
+ data, status_code, headers = @api_client.call_api(:GET, path,
1258
+ :header_params => header_params,
1259
+ :query_params => query_params,
1260
+ :form_params => form_params,
1261
+ :body => post_body,
1262
+ :auth_names => auth_names,
1263
+ :return_type => 'PhoneBase')
1264
+ if @api_client.config.debugging
1265
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phonebasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1266
+ end
1267
+ return data, status_code, headers
1268
+ end
1269
+
1270
+ # Update a Phone Base Settings by ID
1271
+ #
1272
+ # @param phone_base_id Phone base ID
1273
+ # @param [Hash] opts the optional parameters
1274
+ # @option opts [PhoneBase] :body
1275
+ # @return [PhoneBase]
1276
+ def put_telephony_providers_edge_phonebasesetting(phone_base_id, opts = {})
1277
+ data, status_code, headers = put_telephony_providers_edge_phonebasesetting_with_http_info(phone_base_id, opts)
1278
+ return data
1279
+ end
1280
+
1281
+ # Update a Phone Base Settings by ID
1282
+ #
1283
+ # @param phone_base_id Phone base ID
1284
+ # @param [Hash] opts the optional parameters
1285
+ # @option opts [PhoneBase] :body
1286
+ # @return [Array<(PhoneBase, Fixnum, Hash)>] PhoneBase data, response status code and response headers
1287
+ def put_telephony_providers_edge_phonebasesetting_with_http_info(phone_base_id, opts = {})
1288
+ if @api_client.config.debugging
1289
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_telephony_providers_edge_phonebasesetting ..."
1290
+ end
1291
+
1292
+ # verify the required parameter 'phone_base_id' is set
1293
+ fail "Missing the required parameter 'phone_base_id' when calling put_telephony_providers_edge_phonebasesetting" if phone_base_id.nil?
1294
+
1295
+ # resource path
1296
+ path = "/api/v1/telephony/providers/edge/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)
1297
+
1298
+ # query parameters
1299
+ query_params = {}
1300
+
1301
+ # header parameters
1302
+ header_params = {}
1303
+
1304
+ # HTTP header 'Accept' (if needed)
1305
+ _header_accept = ['application/json']
1306
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1307
+
1308
+ # HTTP header 'Content-Type'
1309
+ _header_content_type = ['application/json']
1310
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1311
+
1312
+ # form parameters
1313
+ form_params = {}
1314
+
1315
+ # http body (model)
1316
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1317
+
1318
+
1319
+ auth_names = ['PureCloud Auth']
1320
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1321
+ :header_params => header_params,
1322
+ :query_params => query_params,
1323
+ :form_params => form_params,
1324
+ :body => post_body,
1325
+ :auth_names => auth_names,
1326
+ :return_type => 'PhoneBase')
1327
+ if @api_client.config.debugging
1328
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_telephony_providers_edge_phonebasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1329
+ end
1330
+ return data, status_code, headers
1331
+ end
1332
+
1333
+ # Delete a Phone Base Settings by ID
1334
+ #
1335
+ # @param phone_base_id Phone base ID
1336
+ # @param [Hash] opts the optional parameters
1337
+ # @return [String]
1338
+ def delete_telephony_providers_edge_phonebasesetting(phone_base_id, opts = {})
1339
+ data, status_code, headers = delete_telephony_providers_edge_phonebasesetting_with_http_info(phone_base_id, opts)
1340
+ return data
1341
+ end
1342
+
1343
+ # Delete a Phone Base Settings by ID
1344
+ #
1345
+ # @param phone_base_id Phone base ID
1346
+ # @param [Hash] opts the optional parameters
1347
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1348
+ def delete_telephony_providers_edge_phonebasesetting_with_http_info(phone_base_id, opts = {})
1349
+ if @api_client.config.debugging
1350
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_phonebasesetting ..."
1351
+ end
1352
+
1353
+ # verify the required parameter 'phone_base_id' is set
1354
+ fail "Missing the required parameter 'phone_base_id' when calling delete_telephony_providers_edge_phonebasesetting" if phone_base_id.nil?
1355
+
1356
+ # resource path
1357
+ path = "/api/v1/telephony/providers/edge/phonebasesettings/{phoneBaseId}".sub('{format}','json').sub('{' + 'phoneBaseId' + '}', phone_base_id.to_s)
1358
+
1359
+ # query parameters
1360
+ query_params = {}
1361
+
1362
+ # header parameters
1363
+ header_params = {}
1364
+
1365
+ # HTTP header 'Accept' (if needed)
1366
+ _header_accept = ['application/json']
1367
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1368
+
1369
+ # HTTP header 'Content-Type'
1370
+ _header_content_type = ['application/json']
1371
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1372
+
1373
+ # form parameters
1374
+ form_params = {}
1375
+
1376
+ # http body (model)
1377
+ post_body = nil
1378
+
1379
+
1380
+ auth_names = ['PureCloud Auth']
1381
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1382
+ :header_params => header_params,
1383
+ :query_params => query_params,
1384
+ :form_params => form_params,
1385
+ :body => post_body,
1386
+ :auth_names => auth_names,
1387
+ :return_type => 'String')
1388
+ if @api_client.config.debugging
1389
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_phonebasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1390
+ end
1391
+ return data, status_code, headers
1392
+ end
1393
+
1394
+ # Get a list of Phone Instances
1395
+ #
1396
+ # @param [Hash] opts the optional parameters
1397
+ # @option opts [Integer] :page_number Page number
1398
+ # @option opts [Integer] :page_size Page size
1399
+ # @option opts [String] :sort_by Value by which to sort
1400
+ # @option opts [String] :sort_order Sort order
1401
+ # @option opts [String] :site_id Filter by site.id
1402
+ # @option opts [String] :phone_base_settings_id Filter by phoneBaseSettings.id
1403
+ # @option opts [String] :phone_hardware_id Filter by phone_hardwareId
1404
+ # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
1405
+ # @option opts [Array<String>] :fields Fields under properties to get, comma-separated
1406
+ # @return [PhoneEntityListing]
1407
+ def get_telephony_providers_edge_phones(opts = {})
1408
+ data, status_code, headers = get_telephony_providers_edge_phones_with_http_info(opts)
1409
+ return data
1410
+ end
1411
+
1412
+ # Get a list of Phone Instances
1413
+ #
1414
+ # @param [Hash] opts the optional parameters
1415
+ # @option opts [Integer] :page_number Page number
1416
+ # @option opts [Integer] :page_size Page size
1417
+ # @option opts [String] :sort_by Value by which to sort
1418
+ # @option opts [String] :sort_order Sort order
1419
+ # @option opts [String] :site_id Filter by site.id
1420
+ # @option opts [String] :phone_base_settings_id Filter by phoneBaseSettings.id
1421
+ # @option opts [String] :phone_hardware_id Filter by phone_hardwareId
1422
+ # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
1423
+ # @option opts [Array<String>] :fields Fields under properties to get, comma-separated
1424
+ # @return [Array<(PhoneEntityListing, Fixnum, Hash)>] PhoneEntityListing data, response status code and response headers
1425
+ def get_telephony_providers_edge_phones_with_http_info(opts = {})
1426
+ if @api_client.config.debugging
1427
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phones ..."
1428
+ end
1429
+
1430
+ # resource path
1431
+ path = "/api/v1/telephony/providers/edge/phones".sub('{format}','json')
1432
+
1433
+ # query parameters
1434
+ query_params = {}
1435
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1436
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1437
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1438
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1439
+ query_params[:'site.id'] = opts[:'site_id'] if opts[:'site_id']
1440
+ query_params[:'phoneBaseSettings.id'] = opts[:'phone_base_settings_id'] if opts[:'phone_base_settings_id']
1441
+ query_params[:'phone_hardwareId'] = opts[:'phone_hardware_id'] if opts[:'phone_hardware_id']
1442
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
1443
+ query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if opts[:'fields']
1444
+
1445
+ # header parameters
1446
+ header_params = {}
1447
+
1448
+ # HTTP header 'Accept' (if needed)
1449
+ _header_accept = ['application/json']
1450
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1451
+
1452
+ # HTTP header 'Content-Type'
1453
+ _header_content_type = ['application/json']
1454
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1455
+
1456
+ # form parameters
1457
+ form_params = {}
1458
+
1459
+ # http body (model)
1460
+ post_body = nil
1461
+
1462
+
1463
+ auth_names = ['PureCloud Auth']
1464
+ data, status_code, headers = @api_client.call_api(:GET, path,
1465
+ :header_params => header_params,
1466
+ :query_params => query_params,
1467
+ :form_params => form_params,
1468
+ :body => post_body,
1469
+ :auth_names => auth_names,
1470
+ :return_type => 'PhoneEntityListing')
1471
+ if @api_client.config.debugging
1472
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1473
+ end
1474
+ return data, status_code, headers
1475
+ end
1476
+
1477
+ # Create a new Phone
1478
+ #
1479
+ # @param [Hash] opts the optional parameters
1480
+ # @option opts [Phone] :body
1481
+ # @return [Phone]
1482
+ def post_telephony_providers_edge_phones(opts = {})
1483
+ data, status_code, headers = post_telephony_providers_edge_phones_with_http_info(opts)
1484
+ return data
1485
+ end
1486
+
1487
+ # Create a new Phone
1488
+ #
1489
+ # @param [Hash] opts the optional parameters
1490
+ # @option opts [Phone] :body
1491
+ # @return [Array<(Phone, Fixnum, Hash)>] Phone data, response status code and response headers
1492
+ def post_telephony_providers_edge_phones_with_http_info(opts = {})
1493
+ if @api_client.config.debugging
1494
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_telephony_providers_edge_phones ..."
1495
+ end
1496
+
1497
+ # resource path
1498
+ path = "/api/v1/telephony/providers/edge/phones".sub('{format}','json')
1499
+
1500
+ # query parameters
1501
+ query_params = {}
1502
+
1503
+ # header parameters
1504
+ header_params = {}
1505
+
1506
+ # HTTP header 'Accept' (if needed)
1507
+ _header_accept = ['application/json']
1508
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1509
+
1510
+ # HTTP header 'Content-Type'
1511
+ _header_content_type = ['application/json']
1512
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1513
+
1514
+ # form parameters
1515
+ form_params = {}
1516
+
1517
+ # http body (model)
1518
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1519
+
1520
+
1521
+ auth_names = ['PureCloud Auth']
1522
+ data, status_code, headers = @api_client.call_api(:POST, path,
1523
+ :header_params => header_params,
1524
+ :query_params => query_params,
1525
+ :form_params => form_params,
1526
+ :body => post_body,
1527
+ :auth_names => auth_names,
1528
+ :return_type => 'Phone')
1529
+ if @api_client.config.debugging
1530
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_phones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1531
+ end
1532
+ return data, status_code, headers
1533
+ end
1534
+
1535
+ # Reboot Multiple Phones
1536
+ #
1537
+ # @param [Hash] opts the optional parameters
1538
+ # @option opts [PhonesReboot] :body body
1539
+ # @return [nil]
1540
+ def post_telephony_providers_edge_phones_reboot(opts = {})
1541
+ post_telephony_providers_edge_phones_reboot_with_http_info(opts)
1542
+ return nil
1543
+ end
1544
+
1545
+ # Reboot Multiple Phones
1546
+ #
1547
+ # @param [Hash] opts the optional parameters
1548
+ # @option opts [PhonesReboot] :body body
1549
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1550
+ def post_telephony_providers_edge_phones_reboot_with_http_info(opts = {})
1551
+ if @api_client.config.debugging
1552
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_telephony_providers_edge_phones_reboot ..."
1553
+ end
1554
+
1555
+ # resource path
1556
+ path = "/api/v1/telephony/providers/edge/phones/reboot".sub('{format}','json')
1557
+
1558
+ # query parameters
1559
+ query_params = {}
1560
+
1561
+ # header parameters
1562
+ header_params = {}
1563
+
1564
+ # HTTP header 'Accept' (if needed)
1565
+ _header_accept = ['application/json']
1566
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1567
+
1568
+ # HTTP header 'Content-Type'
1569
+ _header_content_type = ['application/json']
1570
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1571
+
1572
+ # form parameters
1573
+ form_params = {}
1574
+
1575
+ # http body (model)
1576
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1577
+
1578
+
1579
+ auth_names = ['PureCloud Auth']
1580
+ data, status_code, headers = @api_client.call_api(:POST, path,
1581
+ :header_params => header_params,
1582
+ :query_params => query_params,
1583
+ :form_params => form_params,
1584
+ :body => post_body,
1585
+ :auth_names => auth_names)
1586
+ if @api_client.config.debugging
1587
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_phones_reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1588
+ end
1589
+ return data, status_code, headers
1590
+ end
1591
+
1592
+ # Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance
1593
+ #
1594
+ # @param phone_base_settings_id The id of a Phone Base Settings object upon which to base this Phone
1595
+ # @param [Hash] opts the optional parameters
1596
+ # @return [Phone]
1597
+ def get_telephony_providers_edge_phones_template(phone_base_settings_id, opts = {})
1598
+ data, status_code, headers = get_telephony_providers_edge_phones_template_with_http_info(phone_base_settings_id, opts)
1599
+ return data
1600
+ end
1601
+
1602
+ # Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance
1603
+ #
1604
+ # @param phone_base_settings_id The id of a Phone Base Settings object upon which to base this Phone
1605
+ # @param [Hash] opts the optional parameters
1606
+ # @return [Array<(Phone, Fixnum, Hash)>] Phone data, response status code and response headers
1607
+ def get_telephony_providers_edge_phones_template_with_http_info(phone_base_settings_id, opts = {})
1608
+ if @api_client.config.debugging
1609
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phones_template ..."
1610
+ end
1611
+
1612
+ # verify the required parameter 'phone_base_settings_id' is set
1613
+ fail "Missing the required parameter 'phone_base_settings_id' when calling get_telephony_providers_edge_phones_template" if phone_base_settings_id.nil?
1614
+
1615
+ # resource path
1616
+ path = "/api/v1/telephony/providers/edge/phones/template".sub('{format}','json')
1617
+
1618
+ # query parameters
1619
+ query_params = {}
1620
+ query_params[:'phoneBaseSettingsId'] = phone_base_settings_id
1621
+
1622
+ # header parameters
1623
+ header_params = {}
1624
+
1625
+ # HTTP header 'Accept' (if needed)
1626
+ _header_accept = ['application/json']
1627
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1628
+
1629
+ # HTTP header 'Content-Type'
1630
+ _header_content_type = ['application/json']
1631
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1632
+
1633
+ # form parameters
1634
+ form_params = {}
1635
+
1636
+ # http body (model)
1637
+ post_body = nil
1638
+
1639
+
1640
+ auth_names = ['PureCloud Auth']
1641
+ data, status_code, headers = @api_client.call_api(:GET, path,
1642
+ :header_params => header_params,
1643
+ :query_params => query_params,
1644
+ :form_params => form_params,
1645
+ :body => post_body,
1646
+ :auth_names => auth_names,
1647
+ :return_type => 'Phone')
1648
+ if @api_client.config.debugging
1649
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phones_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1650
+ end
1651
+ return data, status_code, headers
1652
+ end
1653
+
1654
+ # Get a Phone by ID
1655
+ #
1656
+ # @param phone_id Phone ID
1657
+ # @param [Hash] opts the optional parameters
1658
+ # @return [Phone]
1659
+ def get_telephony_providers_edge_phone(phone_id, opts = {})
1660
+ data, status_code, headers = get_telephony_providers_edge_phone_with_http_info(phone_id, opts)
1661
+ return data
1662
+ end
1663
+
1664
+ # Get a Phone by ID
1665
+ #
1666
+ # @param phone_id Phone ID
1667
+ # @param [Hash] opts the optional parameters
1668
+ # @return [Array<(Phone, Fixnum, Hash)>] Phone data, response status code and response headers
1669
+ def get_telephony_providers_edge_phone_with_http_info(phone_id, opts = {})
1670
+ if @api_client.config.debugging
1671
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phone ..."
1672
+ end
1673
+
1674
+ # verify the required parameter 'phone_id' is set
1675
+ fail "Missing the required parameter 'phone_id' when calling get_telephony_providers_edge_phone" if phone_id.nil?
1676
+
1677
+ # resource path
1678
+ path = "/api/v1/telephony/providers/edge/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)
1679
+
1680
+ # query parameters
1681
+ query_params = {}
1682
+
1683
+ # header parameters
1684
+ header_params = {}
1685
+
1686
+ # HTTP header 'Accept' (if needed)
1687
+ _header_accept = ['application/json']
1688
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1689
+
1690
+ # HTTP header 'Content-Type'
1691
+ _header_content_type = ['application/json']
1692
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1693
+
1694
+ # form parameters
1695
+ form_params = {}
1696
+
1697
+ # http body (model)
1698
+ post_body = nil
1699
+
1700
+
1701
+ auth_names = ['PureCloud Auth']
1702
+ data, status_code, headers = @api_client.call_api(:GET, path,
1703
+ :header_params => header_params,
1704
+ :query_params => query_params,
1705
+ :form_params => form_params,
1706
+ :body => post_body,
1707
+ :auth_names => auth_names,
1708
+ :return_type => 'Phone')
1709
+ if @api_client.config.debugging
1710
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1711
+ end
1712
+ return data, status_code, headers
1713
+ end
1714
+
1715
+ # Update a Phone by ID
1716
+ #
1717
+ # @param phone_id Phone ID
1718
+ # @param [Hash] opts the optional parameters
1719
+ # @option opts [Phone] :body
1720
+ # @return [Phone]
1721
+ def put_telephony_providers_edge_phone(phone_id, opts = {})
1722
+ data, status_code, headers = put_telephony_providers_edge_phone_with_http_info(phone_id, opts)
1723
+ return data
1724
+ end
1725
+
1726
+ # Update a Phone by ID
1727
+ #
1728
+ # @param phone_id Phone ID
1729
+ # @param [Hash] opts the optional parameters
1730
+ # @option opts [Phone] :body
1731
+ # @return [Array<(Phone, Fixnum, Hash)>] Phone data, response status code and response headers
1732
+ def put_telephony_providers_edge_phone_with_http_info(phone_id, opts = {})
1733
+ if @api_client.config.debugging
1734
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_telephony_providers_edge_phone ..."
1735
+ end
1736
+
1737
+ # verify the required parameter 'phone_id' is set
1738
+ fail "Missing the required parameter 'phone_id' when calling put_telephony_providers_edge_phone" if phone_id.nil?
1739
+
1740
+ # resource path
1741
+ path = "/api/v1/telephony/providers/edge/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)
1742
+
1743
+ # query parameters
1744
+ query_params = {}
1745
+
1746
+ # header parameters
1747
+ header_params = {}
1748
+
1749
+ # HTTP header 'Accept' (if needed)
1750
+ _header_accept = ['application/json']
1751
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1752
+
1753
+ # HTTP header 'Content-Type'
1754
+ _header_content_type = ['application/json']
1755
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1756
+
1757
+ # form parameters
1758
+ form_params = {}
1759
+
1760
+ # http body (model)
1761
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1762
+
1763
+
1764
+ auth_names = ['PureCloud Auth']
1765
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1766
+ :header_params => header_params,
1767
+ :query_params => query_params,
1768
+ :form_params => form_params,
1769
+ :body => post_body,
1770
+ :auth_names => auth_names,
1771
+ :return_type => 'Phone')
1772
+ if @api_client.config.debugging
1773
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_telephony_providers_edge_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1774
+ end
1775
+ return data, status_code, headers
1776
+ end
1777
+
1778
+ # Delete a Phone by ID
1779
+ #
1780
+ # @param phone_id Phone ID
1781
+ # @param [Hash] opts the optional parameters
1782
+ # @return [String]
1783
+ def delete_telephony_providers_edge_phone(phone_id, opts = {})
1784
+ data, status_code, headers = delete_telephony_providers_edge_phone_with_http_info(phone_id, opts)
1785
+ return data
1786
+ end
1787
+
1788
+ # Delete a Phone by ID
1789
+ #
1790
+ # @param phone_id Phone ID
1791
+ # @param [Hash] opts the optional parameters
1792
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1793
+ def delete_telephony_providers_edge_phone_with_http_info(phone_id, opts = {})
1794
+ if @api_client.config.debugging
1795
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_phone ..."
1796
+ end
1797
+
1798
+ # verify the required parameter 'phone_id' is set
1799
+ fail "Missing the required parameter 'phone_id' when calling delete_telephony_providers_edge_phone" if phone_id.nil?
1800
+
1801
+ # resource path
1802
+ path = "/api/v1/telephony/providers/edge/phones/{phoneId}".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)
1803
+
1804
+ # query parameters
1805
+ query_params = {}
1806
+
1807
+ # header parameters
1808
+ header_params = {}
1809
+
1810
+ # HTTP header 'Accept' (if needed)
1811
+ _header_accept = ['application/json']
1812
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1813
+
1814
+ # HTTP header 'Content-Type'
1815
+ _header_content_type = ['application/json']
1816
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1817
+
1818
+ # form parameters
1819
+ form_params = {}
1820
+
1821
+ # http body (model)
1822
+ post_body = nil
1823
+
1824
+
1825
+ auth_names = ['PureCloud Auth']
1826
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1827
+ :header_params => header_params,
1828
+ :query_params => query_params,
1829
+ :form_params => form_params,
1830
+ :body => post_body,
1831
+ :auth_names => auth_names,
1832
+ :return_type => 'String')
1833
+ if @api_client.config.debugging
1834
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_phone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1835
+ end
1836
+ return data, status_code, headers
1837
+ end
1838
+
1839
+ # Reboot a Phone
1840
+ #
1841
+ # @param phone_id Phone Id
1842
+ # @param [Hash] opts the optional parameters
1843
+ # @return [nil]
1844
+ def post_telephony_providers_edge_phone_reboot(phone_id, opts = {})
1845
+ post_telephony_providers_edge_phone_reboot_with_http_info(phone_id, opts)
1846
+ return nil
1847
+ end
1848
+
1849
+ # Reboot a Phone
1850
+ #
1851
+ # @param phone_id Phone Id
1852
+ # @param [Hash] opts the optional parameters
1853
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1854
+ def post_telephony_providers_edge_phone_reboot_with_http_info(phone_id, opts = {})
1855
+ if @api_client.config.debugging
1856
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_telephony_providers_edge_phone_reboot ..."
1857
+ end
1858
+
1859
+ # verify the required parameter 'phone_id' is set
1860
+ fail "Missing the required parameter 'phone_id' when calling post_telephony_providers_edge_phone_reboot" if phone_id.nil?
1861
+
1862
+ # resource path
1863
+ path = "/api/v1/telephony/providers/edge/phones/{phoneId}/reboot".sub('{format}','json').sub('{' + 'phoneId' + '}', phone_id.to_s)
1864
+
1865
+ # query parameters
1866
+ query_params = {}
1867
+
1868
+ # header parameters
1869
+ header_params = {}
1870
+
1871
+ # HTTP header 'Accept' (if needed)
1872
+ _header_accept = ['application/json']
1873
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1874
+
1875
+ # HTTP header 'Content-Type'
1876
+ _header_content_type = ['application/json']
1877
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1878
+
1879
+ # form parameters
1880
+ form_params = {}
1881
+
1882
+ # http body (model)
1883
+ post_body = nil
1884
+
1885
+
1886
+ auth_names = ['PureCloud Auth']
1887
+ data, status_code, headers = @api_client.call_api(:POST, path,
1888
+ :header_params => header_params,
1889
+ :query_params => query_params,
1890
+ :form_params => form_params,
1891
+ :body => post_body,
1892
+ :auth_names => auth_names)
1893
+ if @api_client.config.debugging
1894
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_phone_reboot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1895
+ end
1896
+ return data, status_code, headers
1897
+ end
1898
+
1899
+ # Get a list of Edge-compatible time zones
1900
+ #
1901
+ # @param [Hash] opts the optional parameters
1902
+ # @option opts [Integer] :page_size Page size
1903
+ # @option opts [Integer] :page_number Page number
1904
+ # @return [TimeZoneEntityListing]
1905
+ def get_telephony_providers_edge_timezones(opts = {})
1906
+ data, status_code, headers = get_telephony_providers_edge_timezones_with_http_info(opts)
1907
+ return data
1908
+ end
1909
+
1910
+ # Get a list of Edge-compatible time zones
1911
+ #
1912
+ # @param [Hash] opts the optional parameters
1913
+ # @option opts [Integer] :page_size Page size
1914
+ # @option opts [Integer] :page_number Page number
1915
+ # @return [Array<(TimeZoneEntityListing, Fixnum, Hash)>] TimeZoneEntityListing data, response status code and response headers
1916
+ def get_telephony_providers_edge_timezones_with_http_info(opts = {})
1917
+ if @api_client.config.debugging
1918
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_timezones ..."
1919
+ end
1920
+
1921
+ # resource path
1922
+ path = "/api/v1/telephony/providers/edge/timezones".sub('{format}','json')
1923
+
1924
+ # query parameters
1925
+ query_params = {}
1926
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1927
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1928
+
1929
+ # header parameters
1930
+ header_params = {}
1931
+
1932
+ # HTTP header 'Accept' (if needed)
1933
+ _header_accept = ['application/json']
1934
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1935
+
1936
+ # HTTP header 'Content-Type'
1937
+ _header_content_type = ['application/json']
1938
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1939
+
1940
+ # form parameters
1941
+ form_params = {}
1942
+
1943
+ # http body (model)
1944
+ post_body = nil
1945
+
1946
+
1947
+ auth_names = ['PureCloud Auth']
1948
+ data, status_code, headers = @api_client.call_api(:GET, path,
1949
+ :header_params => header_params,
1950
+ :query_params => query_params,
1951
+ :form_params => form_params,
1952
+ :body => post_body,
1953
+ :auth_names => auth_names,
1954
+ :return_type => 'TimeZoneEntityListing')
1955
+ if @api_client.config.debugging
1956
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_timezones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1957
+ end
1958
+ return data, status_code, headers
1959
+ end
1960
+
1961
+ # Get Trunk Base Settings listing
1962
+ #
1963
+ # @param [Hash] opts the optional parameters
1964
+ # @option opts [Integer] :page_number Page number
1965
+ # @option opts [Integer] :page_size Page size
1966
+ # @option opts [String] :sort_by Value by which to sort
1967
+ # @option opts [String] :sort_order Sort order
1968
+ # @return [TrunkBase]
1969
+ def get_telephony_providers_edge_trunkbasesettings(opts = {})
1970
+ data, status_code, headers = get_telephony_providers_edge_trunkbasesettings_with_http_info(opts)
1971
+ return data
1972
+ end
1973
+
1974
+ # Get Trunk Base Settings listing
1975
+ #
1976
+ # @param [Hash] opts the optional parameters
1977
+ # @option opts [Integer] :page_number Page number
1978
+ # @option opts [Integer] :page_size Page size
1979
+ # @option opts [String] :sort_by Value by which to sort
1980
+ # @option opts [String] :sort_order Sort order
1981
+ # @return [Array<(TrunkBase, Fixnum, Hash)>] TrunkBase data, response status code and response headers
1982
+ def get_telephony_providers_edge_trunkbasesettings_with_http_info(opts = {})
1983
+ if @api_client.config.debugging
1984
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunkbasesettings ..."
1985
+ end
1986
+
1987
+ # resource path
1988
+ path = "/api/v1/telephony/providers/edge/trunkbasesettings".sub('{format}','json')
1989
+
1990
+ # query parameters
1991
+ query_params = {}
1992
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
1993
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
1994
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
1995
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
1996
+
1997
+ # header parameters
1998
+ header_params = {}
1999
+
2000
+ # HTTP header 'Accept' (if needed)
2001
+ _header_accept = ['application/json']
2002
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2003
+
2004
+ # HTTP header 'Content-Type'
2005
+ _header_content_type = ['application/json']
2006
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2007
+
2008
+ # form parameters
2009
+ form_params = {}
2010
+
2011
+ # http body (model)
2012
+ post_body = nil
2013
+
2014
+
2015
+ auth_names = ['PureCloud Auth']
2016
+ data, status_code, headers = @api_client.call_api(:GET, path,
2017
+ :header_params => header_params,
2018
+ :query_params => query_params,
2019
+ :form_params => form_params,
2020
+ :body => post_body,
2021
+ :auth_names => auth_names,
2022
+ :return_type => 'TrunkBase')
2023
+ if @api_client.config.debugging
2024
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunkbasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2025
+ end
2026
+ return data, status_code, headers
2027
+ end
2028
+
2029
+ # Create a Trunk Base Settings object
2030
+ #
2031
+ # @param [Hash] opts the optional parameters
2032
+ # @option opts [TrunkBase] :body
2033
+ # @return [TrunkBase]
2034
+ def post_telephony_providers_edge_trunkbasesettings(opts = {})
2035
+ data, status_code, headers = post_telephony_providers_edge_trunkbasesettings_with_http_info(opts)
2036
+ return data
2037
+ end
2038
+
2039
+ # Create a Trunk Base Settings object
2040
+ #
2041
+ # @param [Hash] opts the optional parameters
2042
+ # @option opts [TrunkBase] :body
2043
+ # @return [Array<(TrunkBase, Fixnum, Hash)>] TrunkBase data, response status code and response headers
2044
+ def post_telephony_providers_edge_trunkbasesettings_with_http_info(opts = {})
2045
+ if @api_client.config.debugging
2046
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#post_telephony_providers_edge_trunkbasesettings ..."
2047
+ end
2048
+
2049
+ # resource path
2050
+ path = "/api/v1/telephony/providers/edge/trunkbasesettings".sub('{format}','json')
2051
+
2052
+ # query parameters
2053
+ query_params = {}
2054
+
2055
+ # header parameters
2056
+ header_params = {}
2057
+
2058
+ # HTTP header 'Accept' (if needed)
2059
+ _header_accept = ['application/json']
2060
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2061
+
2062
+ # HTTP header 'Content-Type'
2063
+ _header_content_type = ['application/json']
2064
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2065
+
2066
+ # form parameters
2067
+ form_params = {}
2068
+
2069
+ # http body (model)
2070
+ post_body = @api_client.object_to_http_body(opts[:'body'])
2071
+
2072
+
2073
+ auth_names = ['PureCloud Auth']
2074
+ data, status_code, headers = @api_client.call_api(:POST, path,
2075
+ :header_params => header_params,
2076
+ :query_params => query_params,
2077
+ :form_params => form_params,
2078
+ :body => post_body,
2079
+ :auth_names => auth_names,
2080
+ :return_type => 'TrunkBase')
2081
+ if @api_client.config.debugging
2082
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#post_telephony_providers_edge_trunkbasesettings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2083
+ end
2084
+ return data, status_code, headers
2085
+ end
2086
+
2087
+ # Get a list of available makes and models to create a new Trunk Base Settings
2088
+ #
2089
+ # @param [Hash] opts the optional parameters
2090
+ # @option opts [String] :type
2091
+ # @option opts [Integer] :page_size
2092
+ # @option opts [Integer] :page_number
2093
+ # @return [TrunkMetabaseEntityListing]
2094
+ def get_telephony_providers_edge_trunkbasesettings_availablemetabases(opts = {})
2095
+ data, status_code, headers = get_telephony_providers_edge_trunkbasesettings_availablemetabases_with_http_info(opts)
2096
+ return data
2097
+ end
2098
+
2099
+ # Get a list of available makes and models to create a new Trunk Base Settings
2100
+ #
2101
+ # @param [Hash] opts the optional parameters
2102
+ # @option opts [String] :type
2103
+ # @option opts [Integer] :page_size
2104
+ # @option opts [Integer] :page_number
2105
+ # @return [Array<(TrunkMetabaseEntityListing, Fixnum, Hash)>] TrunkMetabaseEntityListing data, response status code and response headers
2106
+ def get_telephony_providers_edge_trunkbasesettings_availablemetabases_with_http_info(opts = {})
2107
+ if @api_client.config.debugging
2108
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunkbasesettings_availablemetabases ..."
2109
+ end
2110
+
2111
+ if opts[:'type'] && !['EXTERNAL', 'PHONE', 'EDGE'].include?(opts[:'type'])
2112
+ fail 'invalid value for "type", must be one of EXTERNAL, PHONE, EDGE'
2113
+ end
2114
+
2115
+ # resource path
2116
+ path = "/api/v1/telephony/providers/edge/trunkbasesettings/availablemetabases".sub('{format}','json')
2117
+
2118
+ # query parameters
2119
+ query_params = {}
2120
+ query_params[:'type'] = opts[:'type'] if opts[:'type']
2121
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
2122
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
2123
+
2124
+ # header parameters
2125
+ header_params = {}
2126
+
2127
+ # HTTP header 'Accept' (if needed)
2128
+ _header_accept = ['application/json']
2129
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2130
+
2131
+ # HTTP header 'Content-Type'
2132
+ _header_content_type = ['application/json']
2133
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2134
+
2135
+ # form parameters
2136
+ form_params = {}
2137
+
2138
+ # http body (model)
2139
+ post_body = nil
2140
+
2141
+
2142
+ auth_names = ['PureCloud Auth']
2143
+ data, status_code, headers = @api_client.call_api(:GET, path,
2144
+ :header_params => header_params,
2145
+ :query_params => query_params,
2146
+ :form_params => form_params,
2147
+ :body => post_body,
2148
+ :auth_names => auth_names,
2149
+ :return_type => 'TrunkMetabaseEntityListing')
2150
+ if @api_client.config.debugging
2151
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunkbasesettings_availablemetabases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2152
+ end
2153
+ return data, status_code, headers
2154
+ end
2155
+
2156
+ # Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance
2157
+ #
2158
+ # @param trunk_metabase_id The id of a metabase object upon which to base this Trunk Base Settings
2159
+ # @param [Hash] opts the optional parameters
2160
+ # @return [TrunkBase]
2161
+ def get_telephony_providers_edge_trunkbasesettings_template(trunk_metabase_id, opts = {})
2162
+ data, status_code, headers = get_telephony_providers_edge_trunkbasesettings_template_with_http_info(trunk_metabase_id, opts)
2163
+ return data
2164
+ end
2165
+
2166
+ # Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance
2167
+ #
2168
+ # @param trunk_metabase_id The id of a metabase object upon which to base this Trunk Base Settings
2169
+ # @param [Hash] opts the optional parameters
2170
+ # @return [Array<(TrunkBase, Fixnum, Hash)>] TrunkBase data, response status code and response headers
2171
+ def get_telephony_providers_edge_trunkbasesettings_template_with_http_info(trunk_metabase_id, opts = {})
2172
+ if @api_client.config.debugging
2173
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunkbasesettings_template ..."
2174
+ end
2175
+
2176
+ # verify the required parameter 'trunk_metabase_id' is set
2177
+ fail "Missing the required parameter 'trunk_metabase_id' when calling get_telephony_providers_edge_trunkbasesettings_template" if trunk_metabase_id.nil?
2178
+
2179
+ # resource path
2180
+ path = "/api/v1/telephony/providers/edge/trunkbasesettings/template".sub('{format}','json')
2181
+
2182
+ # query parameters
2183
+ query_params = {}
2184
+ query_params[:'trunkMetabaseId'] = trunk_metabase_id
2185
+
2186
+ # header parameters
2187
+ header_params = {}
2188
+
2189
+ # HTTP header 'Accept' (if needed)
2190
+ _header_accept = ['application/json']
2191
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2192
+
2193
+ # HTTP header 'Content-Type'
2194
+ _header_content_type = ['application/json']
2195
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2196
+
2197
+ # form parameters
2198
+ form_params = {}
2199
+
2200
+ # http body (model)
2201
+ post_body = nil
2202
+
2203
+
2204
+ auth_names = ['PureCloud Auth']
2205
+ data, status_code, headers = @api_client.call_api(:GET, path,
2206
+ :header_params => header_params,
2207
+ :query_params => query_params,
2208
+ :form_params => form_params,
2209
+ :body => post_body,
2210
+ :auth_names => auth_names,
2211
+ :return_type => 'TrunkBase')
2212
+ if @api_client.config.debugging
2213
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunkbasesettings_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2214
+ end
2215
+ return data, status_code, headers
2216
+ end
2217
+
2218
+ # Get a Trunk Base Settings object by ID
2219
+ #
2220
+ # @param trunk_base_settings_id Trunk Base ID
2221
+ # @param [Hash] opts the optional parameters
2222
+ # @return [TrunkBase]
2223
+ def get_telephony_providers_edge_trunkbasesetting(trunk_base_settings_id, opts = {})
2224
+ data, status_code, headers = get_telephony_providers_edge_trunkbasesetting_with_http_info(trunk_base_settings_id, opts)
2225
+ return data
2226
+ end
2227
+
2228
+ # Get a Trunk Base Settings object by ID
2229
+ #
2230
+ # @param trunk_base_settings_id Trunk Base ID
2231
+ # @param [Hash] opts the optional parameters
2232
+ # @return [Array<(TrunkBase, Fixnum, Hash)>] TrunkBase data, response status code and response headers
2233
+ def get_telephony_providers_edge_trunkbasesetting_with_http_info(trunk_base_settings_id, opts = {})
2234
+ if @api_client.config.debugging
2235
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunkbasesetting ..."
2236
+ end
2237
+
2238
+ # verify the required parameter 'trunk_base_settings_id' is set
2239
+ fail "Missing the required parameter 'trunk_base_settings_id' when calling get_telephony_providers_edge_trunkbasesetting" if trunk_base_settings_id.nil?
2240
+
2241
+ # resource path
2242
+ path = "/api/v1/telephony/providers/edge/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)
2243
+
2244
+ # query parameters
2245
+ query_params = {}
2246
+
2247
+ # header parameters
2248
+ header_params = {}
2249
+
2250
+ # HTTP header 'Accept' (if needed)
2251
+ _header_accept = ['application/json']
2252
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2253
+
2254
+ # HTTP header 'Content-Type'
2255
+ _header_content_type = ['application/json']
2256
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2257
+
2258
+ # form parameters
2259
+ form_params = {}
2260
+
2261
+ # http body (model)
2262
+ post_body = nil
2263
+
2264
+
2265
+ auth_names = ['PureCloud Auth']
2266
+ data, status_code, headers = @api_client.call_api(:GET, path,
2267
+ :header_params => header_params,
2268
+ :query_params => query_params,
2269
+ :form_params => form_params,
2270
+ :body => post_body,
2271
+ :auth_names => auth_names,
2272
+ :return_type => 'TrunkBase')
2273
+ if @api_client.config.debugging
2274
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunkbasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2275
+ end
2276
+ return data, status_code, headers
2277
+ end
2278
+
2279
+ # Update a Trunk Base Settings object by ID
2280
+ #
2281
+ # @param trunk_base_settings_id Trunk Base ID
2282
+ # @param [Hash] opts the optional parameters
2283
+ # @option opts [TrunkBase] :body
2284
+ # @return [TrunkBase]
2285
+ def put_telephony_providers_edge_trunkbasesetting(trunk_base_settings_id, opts = {})
2286
+ data, status_code, headers = put_telephony_providers_edge_trunkbasesetting_with_http_info(trunk_base_settings_id, opts)
2287
+ return data
2288
+ end
2289
+
2290
+ # Update a Trunk Base Settings object by ID
2291
+ #
2292
+ # @param trunk_base_settings_id Trunk Base ID
2293
+ # @param [Hash] opts the optional parameters
2294
+ # @option opts [TrunkBase] :body
2295
+ # @return [Array<(TrunkBase, Fixnum, Hash)>] TrunkBase data, response status code and response headers
2296
+ def put_telephony_providers_edge_trunkbasesetting_with_http_info(trunk_base_settings_id, opts = {})
2297
+ if @api_client.config.debugging
2298
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#put_telephony_providers_edge_trunkbasesetting ..."
2299
+ end
2300
+
2301
+ # verify the required parameter 'trunk_base_settings_id' is set
2302
+ fail "Missing the required parameter 'trunk_base_settings_id' when calling put_telephony_providers_edge_trunkbasesetting" if trunk_base_settings_id.nil?
2303
+
2304
+ # resource path
2305
+ path = "/api/v1/telephony/providers/edge/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)
2306
+
2307
+ # query parameters
2308
+ query_params = {}
2309
+
2310
+ # header parameters
2311
+ header_params = {}
2312
+
2313
+ # HTTP header 'Accept' (if needed)
2314
+ _header_accept = ['application/json']
2315
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2316
+
2317
+ # HTTP header 'Content-Type'
2318
+ _header_content_type = ['application/json']
2319
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2320
+
2321
+ # form parameters
2322
+ form_params = {}
2323
+
2324
+ # http body (model)
2325
+ post_body = @api_client.object_to_http_body(opts[:'body'])
2326
+
2327
+
2328
+ auth_names = ['PureCloud Auth']
2329
+ data, status_code, headers = @api_client.call_api(:PUT, path,
2330
+ :header_params => header_params,
2331
+ :query_params => query_params,
2332
+ :form_params => form_params,
2333
+ :body => post_body,
2334
+ :auth_names => auth_names,
2335
+ :return_type => 'TrunkBase')
2336
+ if @api_client.config.debugging
2337
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#put_telephony_providers_edge_trunkbasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2338
+ end
2339
+ return data, status_code, headers
2340
+ end
2341
+
2342
+ # Delete a Trunk Base Settings object by ID
2343
+ #
2344
+ # @param trunk_base_settings_id Trunk Base ID
2345
+ # @param [Hash] opts the optional parameters
2346
+ # @return [String]
2347
+ def delete_telephony_providers_edge_trunkbasesetting(trunk_base_settings_id, opts = {})
2348
+ data, status_code, headers = delete_telephony_providers_edge_trunkbasesetting_with_http_info(trunk_base_settings_id, opts)
2349
+ return data
2350
+ end
2351
+
2352
+ # Delete a Trunk Base Settings object by ID
2353
+ #
2354
+ # @param trunk_base_settings_id Trunk Base ID
2355
+ # @param [Hash] opts the optional parameters
2356
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
2357
+ def delete_telephony_providers_edge_trunkbasesetting_with_http_info(trunk_base_settings_id, opts = {})
2358
+ if @api_client.config.debugging
2359
+ @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_trunkbasesetting ..."
2360
+ end
2361
+
2362
+ # verify the required parameter 'trunk_base_settings_id' is set
2363
+ fail "Missing the required parameter 'trunk_base_settings_id' when calling delete_telephony_providers_edge_trunkbasesetting" if trunk_base_settings_id.nil?
2364
+
2365
+ # resource path
2366
+ path = "/api/v1/telephony/providers/edge/trunkbasesettings/{trunkBaseSettingsId}".sub('{format}','json').sub('{' + 'trunkBaseSettingsId' + '}', trunk_base_settings_id.to_s)
2367
+
2368
+ # query parameters
2369
+ query_params = {}
2370
+
2371
+ # header parameters
2372
+ header_params = {}
2373
+
2374
+ # HTTP header 'Accept' (if needed)
2375
+ _header_accept = ['application/json']
2376
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
2377
+
2378
+ # HTTP header 'Content-Type'
2379
+ _header_content_type = ['application/json']
2380
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
2381
+
2382
+ # form parameters
2383
+ form_params = {}
2384
+
2385
+ # http body (model)
2386
+ post_body = nil
2387
+
2388
+
2389
+ auth_names = ['PureCloud Auth']
2390
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
2391
+ :header_params => header_params,
2392
+ :query_params => query_params,
2393
+ :form_params => form_params,
2394
+ :body => post_body,
2395
+ :auth_names => auth_names,
2396
+ :return_type => 'String')
2397
+ if @api_client.config.debugging
2398
+ @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#delete_telephony_providers_edge_trunkbasesetting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2399
+ end
2400
+ return data, status_code, headers
2401
+ end
2402
+ end
2403
+ end
2404
+
2405
+
2406
+
2407
+