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