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,205 @@
|
|
|
1
|
+
require "uri"
|
|
2
|
+
|
|
3
|
+
module PureCloud
|
|
4
|
+
class OrphanedRecordingsApi
|
|
5
|
+
attr_accessor :api_client
|
|
6
|
+
|
|
7
|
+
def initialize(api_client = ApiClient.default)
|
|
8
|
+
@api_client = api_client
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# Gets all orphan recordings
|
|
12
|
+
#
|
|
13
|
+
# @param [Hash] opts the optional parameters
|
|
14
|
+
# @option opts [Integer] :page_size The total page size requested
|
|
15
|
+
# @option opts [Integer] :page_number The page number requested
|
|
16
|
+
# @option opts [String] :sort_by variable name requested to sort by
|
|
17
|
+
# @option opts [Array<String>] :expand variable name requested by expand list
|
|
18
|
+
# @return [OrphanRecordingListing]
|
|
19
|
+
def get_orphanrecordings(opts = {})
|
|
20
|
+
data, status_code, headers = get_orphanrecordings_with_http_info(opts)
|
|
21
|
+
return data
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
# Gets all orphan recordings
|
|
25
|
+
#
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @option opts [Integer] :page_size The total page size requested
|
|
28
|
+
# @option opts [Integer] :page_number The page number requested
|
|
29
|
+
# @option opts [String] :sort_by variable name requested to sort by
|
|
30
|
+
# @option opts [Array<String>] :expand variable name requested by expand list
|
|
31
|
+
# @return [Array<(OrphanRecordingListing, Fixnum, Hash)>] OrphanRecordingListing data, response status code and response headers
|
|
32
|
+
def get_orphanrecordings_with_http_info(opts = {})
|
|
33
|
+
if @api_client.config.debugging
|
|
34
|
+
@api_client.config.logger.debug "Calling API: OrphanedRecordingsApi#get_orphanrecordings ..."
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# resource path
|
|
38
|
+
path = "/api/v1/orphanrecordings".sub('{format}','json')
|
|
39
|
+
|
|
40
|
+
# query parameters
|
|
41
|
+
query_params = {}
|
|
42
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
43
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
44
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
45
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
|
46
|
+
|
|
47
|
+
# header parameters
|
|
48
|
+
header_params = {}
|
|
49
|
+
|
|
50
|
+
# HTTP header 'Accept' (if needed)
|
|
51
|
+
_header_accept = ['application/json']
|
|
52
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
53
|
+
|
|
54
|
+
# HTTP header 'Content-Type'
|
|
55
|
+
_header_content_type = ['application/json']
|
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
57
|
+
|
|
58
|
+
# form parameters
|
|
59
|
+
form_params = {}
|
|
60
|
+
|
|
61
|
+
# http body (model)
|
|
62
|
+
post_body = nil
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
auth_names = ['PureCloud Auth']
|
|
66
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
67
|
+
:header_params => header_params,
|
|
68
|
+
:query_params => query_params,
|
|
69
|
+
:form_params => form_params,
|
|
70
|
+
:body => post_body,
|
|
71
|
+
:auth_names => auth_names,
|
|
72
|
+
:return_type => 'OrphanRecordingListing')
|
|
73
|
+
if @api_client.config.debugging
|
|
74
|
+
@api_client.config.logger.debug "API called: OrphanedRecordingsApi#get_orphanrecordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
75
|
+
end
|
|
76
|
+
return data, status_code, headers
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Gets a single orphan recording
|
|
80
|
+
#
|
|
81
|
+
# @param orphan_id Orphan ID
|
|
82
|
+
# @param [Hash] opts the optional parameters
|
|
83
|
+
# @return [OrphanRecording]
|
|
84
|
+
def get_orphanrecording(orphan_id, opts = {})
|
|
85
|
+
data, status_code, headers = get_orphanrecording_with_http_info(orphan_id, opts)
|
|
86
|
+
return data
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# Gets a single orphan recording
|
|
90
|
+
#
|
|
91
|
+
# @param orphan_id Orphan ID
|
|
92
|
+
# @param [Hash] opts the optional parameters
|
|
93
|
+
# @return [Array<(OrphanRecording, Fixnum, Hash)>] OrphanRecording data, response status code and response headers
|
|
94
|
+
def get_orphanrecording_with_http_info(orphan_id, opts = {})
|
|
95
|
+
if @api_client.config.debugging
|
|
96
|
+
@api_client.config.logger.debug "Calling API: OrphanedRecordingsApi#get_orphanrecording ..."
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# verify the required parameter 'orphan_id' is set
|
|
100
|
+
fail "Missing the required parameter 'orphan_id' when calling get_orphanrecording" if orphan_id.nil?
|
|
101
|
+
|
|
102
|
+
# resource path
|
|
103
|
+
path = "/api/v1/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
|
|
104
|
+
|
|
105
|
+
# query parameters
|
|
106
|
+
query_params = {}
|
|
107
|
+
|
|
108
|
+
# header parameters
|
|
109
|
+
header_params = {}
|
|
110
|
+
|
|
111
|
+
# HTTP header 'Accept' (if needed)
|
|
112
|
+
_header_accept = ['application/json']
|
|
113
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
114
|
+
|
|
115
|
+
# HTTP header 'Content-Type'
|
|
116
|
+
_header_content_type = ['application/json']
|
|
117
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
118
|
+
|
|
119
|
+
# form parameters
|
|
120
|
+
form_params = {}
|
|
121
|
+
|
|
122
|
+
# http body (model)
|
|
123
|
+
post_body = nil
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
auth_names = ['PureCloud Auth']
|
|
127
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
128
|
+
:header_params => header_params,
|
|
129
|
+
:query_params => query_params,
|
|
130
|
+
:form_params => form_params,
|
|
131
|
+
:body => post_body,
|
|
132
|
+
:auth_names => auth_names,
|
|
133
|
+
:return_type => 'OrphanRecording')
|
|
134
|
+
if @api_client.config.debugging
|
|
135
|
+
@api_client.config.logger.debug "API called: OrphanedRecordingsApi#get_orphanrecording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
136
|
+
end
|
|
137
|
+
return data, status_code, headers
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# deletes a single orphan recording
|
|
141
|
+
#
|
|
142
|
+
# @param orphan_id Orphan ID
|
|
143
|
+
# @param [Hash] opts the optional parameters
|
|
144
|
+
# @return [OrphanRecording]
|
|
145
|
+
def delete_orphanrecording(orphan_id, opts = {})
|
|
146
|
+
data, status_code, headers = delete_orphanrecording_with_http_info(orphan_id, opts)
|
|
147
|
+
return data
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
# deletes a single orphan recording
|
|
151
|
+
#
|
|
152
|
+
# @param orphan_id Orphan ID
|
|
153
|
+
# @param [Hash] opts the optional parameters
|
|
154
|
+
# @return [Array<(OrphanRecording, Fixnum, Hash)>] OrphanRecording data, response status code and response headers
|
|
155
|
+
def delete_orphanrecording_with_http_info(orphan_id, opts = {})
|
|
156
|
+
if @api_client.config.debugging
|
|
157
|
+
@api_client.config.logger.debug "Calling API: OrphanedRecordingsApi#delete_orphanrecording ..."
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# verify the required parameter 'orphan_id' is set
|
|
161
|
+
fail "Missing the required parameter 'orphan_id' when calling delete_orphanrecording" if orphan_id.nil?
|
|
162
|
+
|
|
163
|
+
# resource path
|
|
164
|
+
path = "/api/v1/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
|
|
165
|
+
|
|
166
|
+
# query parameters
|
|
167
|
+
query_params = {}
|
|
168
|
+
|
|
169
|
+
# header parameters
|
|
170
|
+
header_params = {}
|
|
171
|
+
|
|
172
|
+
# HTTP header 'Accept' (if needed)
|
|
173
|
+
_header_accept = ['application/json']
|
|
174
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
175
|
+
|
|
176
|
+
# HTTP header 'Content-Type'
|
|
177
|
+
_header_content_type = ['application/json']
|
|
178
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
179
|
+
|
|
180
|
+
# form parameters
|
|
181
|
+
form_params = {}
|
|
182
|
+
|
|
183
|
+
# http body (model)
|
|
184
|
+
post_body = nil
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
auth_names = ['PureCloud Auth']
|
|
188
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
189
|
+
:header_params => header_params,
|
|
190
|
+
:query_params => query_params,
|
|
191
|
+
:form_params => form_params,
|
|
192
|
+
:body => post_body,
|
|
193
|
+
:auth_names => auth_names,
|
|
194
|
+
:return_type => 'OrphanRecording')
|
|
195
|
+
if @api_client.config.debugging
|
|
196
|
+
@api_client.config.logger.debug "API called: OrphanedRecordingsApi#delete_orphanrecording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
197
|
+
end
|
|
198
|
+
return data, status_code, headers
|
|
199
|
+
end
|
|
200
|
+
end
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
@@ -0,0 +1,4262 @@
|
|
|
1
|
+
require "uri"
|
|
2
|
+
|
|
3
|
+
module PureCloud
|
|
4
|
+
class OutboundApi
|
|
5
|
+
attr_accessor :api_client
|
|
6
|
+
|
|
7
|
+
def initialize(api_client = ApiClient.default)
|
|
8
|
+
@api_client = api_client
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# Retrieves audits for dialer.
|
|
12
|
+
#
|
|
13
|
+
# @param [Hash] opts the optional parameters
|
|
14
|
+
# @option opts [DialerAuditRequest] :body AuditSearch
|
|
15
|
+
# @option opts [Integer] :page_size Page size
|
|
16
|
+
# @option opts [Integer] :page_number Page number
|
|
17
|
+
# @option opts [String] :sort_by Sort by
|
|
18
|
+
# @option opts [String] :sort_order Sort order
|
|
19
|
+
# @option opts [BOOLEAN] :facets_only Facets only
|
|
20
|
+
# @return [AuditSearchResult]
|
|
21
|
+
def post_audits(opts = {})
|
|
22
|
+
data, status_code, headers = post_audits_with_http_info(opts)
|
|
23
|
+
return data
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
# Retrieves audits for dialer.
|
|
27
|
+
#
|
|
28
|
+
# @param [Hash] opts the optional parameters
|
|
29
|
+
# @option opts [DialerAuditRequest] :body AuditSearch
|
|
30
|
+
# @option opts [Integer] :page_size Page size
|
|
31
|
+
# @option opts [Integer] :page_number Page number
|
|
32
|
+
# @option opts [String] :sort_by Sort by
|
|
33
|
+
# @option opts [String] :sort_order Sort order
|
|
34
|
+
# @option opts [BOOLEAN] :facets_only Facets only
|
|
35
|
+
# @return [Array<(AuditSearchResult, Fixnum, Hash)>] AuditSearchResult data, response status code and response headers
|
|
36
|
+
def post_audits_with_http_info(opts = {})
|
|
37
|
+
if @api_client.config.debugging
|
|
38
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_audits ..."
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# resource path
|
|
42
|
+
path = "/api/v1/outbound/audits".sub('{format}','json')
|
|
43
|
+
|
|
44
|
+
# query parameters
|
|
45
|
+
query_params = {}
|
|
46
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
47
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
48
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
49
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
50
|
+
query_params[:'facetsOnly'] = opts[:'facets_only'] if opts[:'facets_only']
|
|
51
|
+
|
|
52
|
+
# header parameters
|
|
53
|
+
header_params = {}
|
|
54
|
+
|
|
55
|
+
# HTTP header 'Accept' (if needed)
|
|
56
|
+
_header_accept = ['application/json']
|
|
57
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
58
|
+
|
|
59
|
+
# HTTP header 'Content-Type'
|
|
60
|
+
_header_content_type = ['application/json']
|
|
61
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
62
|
+
|
|
63
|
+
# form parameters
|
|
64
|
+
form_params = {}
|
|
65
|
+
|
|
66
|
+
# http body (model)
|
|
67
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
auth_names = ['PureCloud Auth']
|
|
71
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
72
|
+
:header_params => header_params,
|
|
73
|
+
:query_params => query_params,
|
|
74
|
+
:form_params => form_params,
|
|
75
|
+
:body => post_body,
|
|
76
|
+
:auth_names => auth_names,
|
|
77
|
+
:return_type => 'AuditSearchResult')
|
|
78
|
+
if @api_client.config.debugging
|
|
79
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
80
|
+
end
|
|
81
|
+
return data, status_code, headers
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Query callable time set list
|
|
85
|
+
#
|
|
86
|
+
# @param [Hash] opts the optional parameters
|
|
87
|
+
# @option opts [Integer] :page_size Page size
|
|
88
|
+
# @option opts [Integer] :page_number Page number
|
|
89
|
+
# @option opts [String] :filter_type Filter type
|
|
90
|
+
# @option opts [String] :name Name
|
|
91
|
+
# @option opts [String] :sort_by Sort by
|
|
92
|
+
# @option opts [String] :sort_order Sort order
|
|
93
|
+
# @return [CallableTimeSetEntityListing]
|
|
94
|
+
def get_callabletimesets(opts = {})
|
|
95
|
+
data, status_code, headers = get_callabletimesets_with_http_info(opts)
|
|
96
|
+
return data
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# Query callable time set list
|
|
100
|
+
#
|
|
101
|
+
# @param [Hash] opts the optional parameters
|
|
102
|
+
# @option opts [Integer] :page_size Page size
|
|
103
|
+
# @option opts [Integer] :page_number Page number
|
|
104
|
+
# @option opts [String] :filter_type Filter type
|
|
105
|
+
# @option opts [String] :name Name
|
|
106
|
+
# @option opts [String] :sort_by Sort by
|
|
107
|
+
# @option opts [String] :sort_order Sort order
|
|
108
|
+
# @return [Array<(CallableTimeSetEntityListing, Fixnum, Hash)>] CallableTimeSetEntityListing data, response status code and response headers
|
|
109
|
+
def get_callabletimesets_with_http_info(opts = {})
|
|
110
|
+
if @api_client.config.debugging
|
|
111
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_callabletimesets ..."
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
|
|
115
|
+
fail 'invalid value for "filter_type", must be one of EQUALS, REGEX, CONTAINS, PREFIX, LESSTHAN, LESSTHANEQUALTO, GREATERTHAN, GREATERTHANEQUALTO, BEGINSWITH, ENDSWITH'
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
119
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
# resource path
|
|
123
|
+
path = "/api/v1/outbound/callabletimesets".sub('{format}','json')
|
|
124
|
+
|
|
125
|
+
# query parameters
|
|
126
|
+
query_params = {}
|
|
127
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
128
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
129
|
+
query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
|
|
130
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
131
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
132
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
133
|
+
|
|
134
|
+
# header parameters
|
|
135
|
+
header_params = {}
|
|
136
|
+
|
|
137
|
+
# HTTP header 'Accept' (if needed)
|
|
138
|
+
_header_accept = ['application/json']
|
|
139
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
140
|
+
|
|
141
|
+
# HTTP header 'Content-Type'
|
|
142
|
+
_header_content_type = ['application/json']
|
|
143
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
144
|
+
|
|
145
|
+
# form parameters
|
|
146
|
+
form_params = {}
|
|
147
|
+
|
|
148
|
+
# http body (model)
|
|
149
|
+
post_body = nil
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
auth_names = ['PureCloud Auth']
|
|
153
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
154
|
+
:header_params => header_params,
|
|
155
|
+
:query_params => query_params,
|
|
156
|
+
:form_params => form_params,
|
|
157
|
+
:body => post_body,
|
|
158
|
+
:auth_names => auth_names,
|
|
159
|
+
:return_type => 'CallableTimeSetEntityListing')
|
|
160
|
+
if @api_client.config.debugging
|
|
161
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
162
|
+
end
|
|
163
|
+
return data, status_code, headers
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
# Create callable time set
|
|
167
|
+
#
|
|
168
|
+
# @param [Hash] opts the optional parameters
|
|
169
|
+
# @option opts [CallableTimeSet] :body DialerCallableTimeSet
|
|
170
|
+
# @return [CallableTimeSet]
|
|
171
|
+
def post_callabletimesets(opts = {})
|
|
172
|
+
data, status_code, headers = post_callabletimesets_with_http_info(opts)
|
|
173
|
+
return data
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
# Create callable time set
|
|
177
|
+
#
|
|
178
|
+
# @param [Hash] opts the optional parameters
|
|
179
|
+
# @option opts [CallableTimeSet] :body DialerCallableTimeSet
|
|
180
|
+
# @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers
|
|
181
|
+
def post_callabletimesets_with_http_info(opts = {})
|
|
182
|
+
if @api_client.config.debugging
|
|
183
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_callabletimesets ..."
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# resource path
|
|
187
|
+
path = "/api/v1/outbound/callabletimesets".sub('{format}','json')
|
|
188
|
+
|
|
189
|
+
# query parameters
|
|
190
|
+
query_params = {}
|
|
191
|
+
|
|
192
|
+
# header parameters
|
|
193
|
+
header_params = {}
|
|
194
|
+
|
|
195
|
+
# HTTP header 'Accept' (if needed)
|
|
196
|
+
_header_accept = ['application/json']
|
|
197
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
198
|
+
|
|
199
|
+
# HTTP header 'Content-Type'
|
|
200
|
+
_header_content_type = ['application/json']
|
|
201
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
202
|
+
|
|
203
|
+
# form parameters
|
|
204
|
+
form_params = {}
|
|
205
|
+
|
|
206
|
+
# http body (model)
|
|
207
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
auth_names = ['PureCloud Auth']
|
|
211
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
212
|
+
:header_params => header_params,
|
|
213
|
+
:query_params => query_params,
|
|
214
|
+
:form_params => form_params,
|
|
215
|
+
:body => post_body,
|
|
216
|
+
:auth_names => auth_names,
|
|
217
|
+
:return_type => 'CallableTimeSet')
|
|
218
|
+
if @api_client.config.debugging
|
|
219
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
220
|
+
end
|
|
221
|
+
return data, status_code, headers
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
# Get callable time set
|
|
225
|
+
#
|
|
226
|
+
# @param callable_time_set_id Callable Time Set ID
|
|
227
|
+
# @param [Hash] opts the optional parameters
|
|
228
|
+
# @return [CallableTimeSet]
|
|
229
|
+
def get_callabletimeset(callable_time_set_id, opts = {})
|
|
230
|
+
data, status_code, headers = get_callabletimeset_with_http_info(callable_time_set_id, opts)
|
|
231
|
+
return data
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
# Get callable time set
|
|
235
|
+
#
|
|
236
|
+
# @param callable_time_set_id Callable Time Set ID
|
|
237
|
+
# @param [Hash] opts the optional parameters
|
|
238
|
+
# @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers
|
|
239
|
+
def get_callabletimeset_with_http_info(callable_time_set_id, opts = {})
|
|
240
|
+
if @api_client.config.debugging
|
|
241
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_callabletimeset ..."
|
|
242
|
+
end
|
|
243
|
+
|
|
244
|
+
# verify the required parameter 'callable_time_set_id' is set
|
|
245
|
+
fail "Missing the required parameter 'callable_time_set_id' when calling get_callabletimeset" if callable_time_set_id.nil?
|
|
246
|
+
|
|
247
|
+
# resource path
|
|
248
|
+
path = "/api/v1/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)
|
|
249
|
+
|
|
250
|
+
# query parameters
|
|
251
|
+
query_params = {}
|
|
252
|
+
|
|
253
|
+
# header parameters
|
|
254
|
+
header_params = {}
|
|
255
|
+
|
|
256
|
+
# HTTP header 'Accept' (if needed)
|
|
257
|
+
_header_accept = ['application/json']
|
|
258
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
259
|
+
|
|
260
|
+
# HTTP header 'Content-Type'
|
|
261
|
+
_header_content_type = ['application/json']
|
|
262
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
263
|
+
|
|
264
|
+
# form parameters
|
|
265
|
+
form_params = {}
|
|
266
|
+
|
|
267
|
+
# http body (model)
|
|
268
|
+
post_body = nil
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
auth_names = ['PureCloud Auth']
|
|
272
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
273
|
+
:header_params => header_params,
|
|
274
|
+
:query_params => query_params,
|
|
275
|
+
:form_params => form_params,
|
|
276
|
+
:body => post_body,
|
|
277
|
+
:auth_names => auth_names,
|
|
278
|
+
:return_type => 'CallableTimeSet')
|
|
279
|
+
if @api_client.config.debugging
|
|
280
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
281
|
+
end
|
|
282
|
+
return data, status_code, headers
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# Update callable time set
|
|
286
|
+
#
|
|
287
|
+
# @param callable_time_set_id Callable Time Set ID
|
|
288
|
+
# @param [Hash] opts the optional parameters
|
|
289
|
+
# @option opts [CallableTimeSet] :body DialerCallableTimeSet
|
|
290
|
+
# @return [CallableTimeSet]
|
|
291
|
+
def put_callabletimeset(callable_time_set_id, opts = {})
|
|
292
|
+
data, status_code, headers = put_callabletimeset_with_http_info(callable_time_set_id, opts)
|
|
293
|
+
return data
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
# Update callable time set
|
|
297
|
+
#
|
|
298
|
+
# @param callable_time_set_id Callable Time Set ID
|
|
299
|
+
# @param [Hash] opts the optional parameters
|
|
300
|
+
# @option opts [CallableTimeSet] :body DialerCallableTimeSet
|
|
301
|
+
# @return [Array<(CallableTimeSet, Fixnum, Hash)>] CallableTimeSet data, response status code and response headers
|
|
302
|
+
def put_callabletimeset_with_http_info(callable_time_set_id, opts = {})
|
|
303
|
+
if @api_client.config.debugging
|
|
304
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_callabletimeset ..."
|
|
305
|
+
end
|
|
306
|
+
|
|
307
|
+
# verify the required parameter 'callable_time_set_id' is set
|
|
308
|
+
fail "Missing the required parameter 'callable_time_set_id' when calling put_callabletimeset" if callable_time_set_id.nil?
|
|
309
|
+
|
|
310
|
+
# resource path
|
|
311
|
+
path = "/api/v1/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)
|
|
312
|
+
|
|
313
|
+
# query parameters
|
|
314
|
+
query_params = {}
|
|
315
|
+
|
|
316
|
+
# header parameters
|
|
317
|
+
header_params = {}
|
|
318
|
+
|
|
319
|
+
# HTTP header 'Accept' (if needed)
|
|
320
|
+
_header_accept = ['application/json']
|
|
321
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
322
|
+
|
|
323
|
+
# HTTP header 'Content-Type'
|
|
324
|
+
_header_content_type = ['application/json']
|
|
325
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
326
|
+
|
|
327
|
+
# form parameters
|
|
328
|
+
form_params = {}
|
|
329
|
+
|
|
330
|
+
# http body (model)
|
|
331
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
auth_names = ['PureCloud Auth']
|
|
335
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
336
|
+
:header_params => header_params,
|
|
337
|
+
:query_params => query_params,
|
|
338
|
+
:form_params => form_params,
|
|
339
|
+
:body => post_body,
|
|
340
|
+
:auth_names => auth_names,
|
|
341
|
+
:return_type => 'CallableTimeSet')
|
|
342
|
+
if @api_client.config.debugging
|
|
343
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
344
|
+
end
|
|
345
|
+
return data, status_code, headers
|
|
346
|
+
end
|
|
347
|
+
|
|
348
|
+
# Delete callable time set
|
|
349
|
+
#
|
|
350
|
+
# @param callable_time_set_id Callable Time Set ID
|
|
351
|
+
# @param [Hash] opts the optional parameters
|
|
352
|
+
# @return [String]
|
|
353
|
+
def delete_callabletimeset(callable_time_set_id, opts = {})
|
|
354
|
+
data, status_code, headers = delete_callabletimeset_with_http_info(callable_time_set_id, opts)
|
|
355
|
+
return data
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
# Delete callable time set
|
|
359
|
+
#
|
|
360
|
+
# @param callable_time_set_id Callable Time Set ID
|
|
361
|
+
# @param [Hash] opts the optional parameters
|
|
362
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
363
|
+
def delete_callabletimeset_with_http_info(callable_time_set_id, opts = {})
|
|
364
|
+
if @api_client.config.debugging
|
|
365
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_callabletimeset ..."
|
|
366
|
+
end
|
|
367
|
+
|
|
368
|
+
# verify the required parameter 'callable_time_set_id' is set
|
|
369
|
+
fail "Missing the required parameter 'callable_time_set_id' when calling delete_callabletimeset" if callable_time_set_id.nil?
|
|
370
|
+
|
|
371
|
+
# resource path
|
|
372
|
+
path = "/api/v1/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)
|
|
373
|
+
|
|
374
|
+
# query parameters
|
|
375
|
+
query_params = {}
|
|
376
|
+
|
|
377
|
+
# header parameters
|
|
378
|
+
header_params = {}
|
|
379
|
+
|
|
380
|
+
# HTTP header 'Accept' (if needed)
|
|
381
|
+
_header_accept = ['application/json']
|
|
382
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
383
|
+
|
|
384
|
+
# HTTP header 'Content-Type'
|
|
385
|
+
_header_content_type = ['application/json']
|
|
386
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
387
|
+
|
|
388
|
+
# form parameters
|
|
389
|
+
form_params = {}
|
|
390
|
+
|
|
391
|
+
# http body (model)
|
|
392
|
+
post_body = nil
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
auth_names = ['PureCloud Auth']
|
|
396
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
397
|
+
:header_params => header_params,
|
|
398
|
+
:query_params => query_params,
|
|
399
|
+
:form_params => form_params,
|
|
400
|
+
:body => post_body,
|
|
401
|
+
:auth_names => auth_names,
|
|
402
|
+
:return_type => 'String')
|
|
403
|
+
if @api_client.config.debugging
|
|
404
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
405
|
+
end
|
|
406
|
+
return data, status_code, headers
|
|
407
|
+
end
|
|
408
|
+
|
|
409
|
+
# Query a list of dialer call analysis response sets.
|
|
410
|
+
#
|
|
411
|
+
# @param [Hash] opts the optional parameters
|
|
412
|
+
# @option opts [Integer] :page_size Page size
|
|
413
|
+
# @option opts [Integer] :page_number Page number
|
|
414
|
+
# @option opts [String] :filter_type Filter type
|
|
415
|
+
# @option opts [String] :name Name
|
|
416
|
+
# @option opts [String] :sort_by Sort by
|
|
417
|
+
# @option opts [String] :sort_order Sort order
|
|
418
|
+
# @return [ResponseSetEntityListing]
|
|
419
|
+
def get_callanalysisresponsesets(opts = {})
|
|
420
|
+
data, status_code, headers = get_callanalysisresponsesets_with_http_info(opts)
|
|
421
|
+
return data
|
|
422
|
+
end
|
|
423
|
+
|
|
424
|
+
# Query a list of dialer call analysis response sets.
|
|
425
|
+
#
|
|
426
|
+
# @param [Hash] opts the optional parameters
|
|
427
|
+
# @option opts [Integer] :page_size Page size
|
|
428
|
+
# @option opts [Integer] :page_number Page number
|
|
429
|
+
# @option opts [String] :filter_type Filter type
|
|
430
|
+
# @option opts [String] :name Name
|
|
431
|
+
# @option opts [String] :sort_by Sort by
|
|
432
|
+
# @option opts [String] :sort_order Sort order
|
|
433
|
+
# @return [Array<(ResponseSetEntityListing, Fixnum, Hash)>] ResponseSetEntityListing data, response status code and response headers
|
|
434
|
+
def get_callanalysisresponsesets_with_http_info(opts = {})
|
|
435
|
+
if @api_client.config.debugging
|
|
436
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_callanalysisresponsesets ..."
|
|
437
|
+
end
|
|
438
|
+
|
|
439
|
+
if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
|
|
440
|
+
fail 'invalid value for "filter_type", must be one of EQUALS, REGEX, CONTAINS, PREFIX, LESSTHAN, LESSTHANEQUALTO, GREATERTHAN, GREATERTHANEQUALTO, BEGINSWITH, ENDSWITH'
|
|
441
|
+
end
|
|
442
|
+
|
|
443
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
444
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
445
|
+
end
|
|
446
|
+
|
|
447
|
+
# resource path
|
|
448
|
+
path = "/api/v1/outbound/callanalysisresponsesets".sub('{format}','json')
|
|
449
|
+
|
|
450
|
+
# query parameters
|
|
451
|
+
query_params = {}
|
|
452
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
453
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
454
|
+
query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
|
|
455
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
456
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
457
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
458
|
+
|
|
459
|
+
# header parameters
|
|
460
|
+
header_params = {}
|
|
461
|
+
|
|
462
|
+
# HTTP header 'Accept' (if needed)
|
|
463
|
+
_header_accept = ['application/json']
|
|
464
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
465
|
+
|
|
466
|
+
# HTTP header 'Content-Type'
|
|
467
|
+
_header_content_type = ['application/json']
|
|
468
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
469
|
+
|
|
470
|
+
# form parameters
|
|
471
|
+
form_params = {}
|
|
472
|
+
|
|
473
|
+
# http body (model)
|
|
474
|
+
post_body = nil
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
auth_names = ['PureCloud Auth']
|
|
478
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
479
|
+
:header_params => header_params,
|
|
480
|
+
:query_params => query_params,
|
|
481
|
+
:form_params => form_params,
|
|
482
|
+
:body => post_body,
|
|
483
|
+
:auth_names => auth_names,
|
|
484
|
+
:return_type => 'ResponseSetEntityListing')
|
|
485
|
+
if @api_client.config.debugging
|
|
486
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
487
|
+
end
|
|
488
|
+
return data, status_code, headers
|
|
489
|
+
end
|
|
490
|
+
|
|
491
|
+
# Create a dialer call analysis response set.
|
|
492
|
+
#
|
|
493
|
+
# @param [Hash] opts the optional parameters
|
|
494
|
+
# @option opts [ResponseSet] :body ResponseSet
|
|
495
|
+
# @return [ResponseSet]
|
|
496
|
+
def post_callanalysisresponsesets(opts = {})
|
|
497
|
+
data, status_code, headers = post_callanalysisresponsesets_with_http_info(opts)
|
|
498
|
+
return data
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
# Create a dialer call analysis response set.
|
|
502
|
+
#
|
|
503
|
+
# @param [Hash] opts the optional parameters
|
|
504
|
+
# @option opts [ResponseSet] :body ResponseSet
|
|
505
|
+
# @return [Array<(ResponseSet, Fixnum, Hash)>] ResponseSet data, response status code and response headers
|
|
506
|
+
def post_callanalysisresponsesets_with_http_info(opts = {})
|
|
507
|
+
if @api_client.config.debugging
|
|
508
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_callanalysisresponsesets ..."
|
|
509
|
+
end
|
|
510
|
+
|
|
511
|
+
# resource path
|
|
512
|
+
path = "/api/v1/outbound/callanalysisresponsesets".sub('{format}','json')
|
|
513
|
+
|
|
514
|
+
# query parameters
|
|
515
|
+
query_params = {}
|
|
516
|
+
|
|
517
|
+
# header parameters
|
|
518
|
+
header_params = {}
|
|
519
|
+
|
|
520
|
+
# HTTP header 'Accept' (if needed)
|
|
521
|
+
_header_accept = ['application/json']
|
|
522
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
523
|
+
|
|
524
|
+
# HTTP header 'Content-Type'
|
|
525
|
+
_header_content_type = ['application/json']
|
|
526
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
527
|
+
|
|
528
|
+
# form parameters
|
|
529
|
+
form_params = {}
|
|
530
|
+
|
|
531
|
+
# http body (model)
|
|
532
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
auth_names = ['PureCloud Auth']
|
|
536
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
537
|
+
:header_params => header_params,
|
|
538
|
+
:query_params => query_params,
|
|
539
|
+
:form_params => form_params,
|
|
540
|
+
:body => post_body,
|
|
541
|
+
:auth_names => auth_names,
|
|
542
|
+
:return_type => 'ResponseSet')
|
|
543
|
+
if @api_client.config.debugging
|
|
544
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
545
|
+
end
|
|
546
|
+
return data, status_code, headers
|
|
547
|
+
end
|
|
548
|
+
|
|
549
|
+
# Get a dialer call analysis response set.
|
|
550
|
+
#
|
|
551
|
+
# @param call_analysis_set_id Call Analysis Response Set ID
|
|
552
|
+
# @param [Hash] opts the optional parameters
|
|
553
|
+
# @return [ResponseSet]
|
|
554
|
+
def get_callanalysisresponseset(call_analysis_set_id, opts = {})
|
|
555
|
+
data, status_code, headers = get_callanalysisresponseset_with_http_info(call_analysis_set_id, opts)
|
|
556
|
+
return data
|
|
557
|
+
end
|
|
558
|
+
|
|
559
|
+
# Get a dialer call analysis response set.
|
|
560
|
+
#
|
|
561
|
+
# @param call_analysis_set_id Call Analysis Response Set ID
|
|
562
|
+
# @param [Hash] opts the optional parameters
|
|
563
|
+
# @return [Array<(ResponseSet, Fixnum, Hash)>] ResponseSet data, response status code and response headers
|
|
564
|
+
def get_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {})
|
|
565
|
+
if @api_client.config.debugging
|
|
566
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_callanalysisresponseset ..."
|
|
567
|
+
end
|
|
568
|
+
|
|
569
|
+
# verify the required parameter 'call_analysis_set_id' is set
|
|
570
|
+
fail "Missing the required parameter 'call_analysis_set_id' when calling get_callanalysisresponseset" if call_analysis_set_id.nil?
|
|
571
|
+
|
|
572
|
+
# resource path
|
|
573
|
+
path = "/api/v1/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)
|
|
574
|
+
|
|
575
|
+
# query parameters
|
|
576
|
+
query_params = {}
|
|
577
|
+
|
|
578
|
+
# header parameters
|
|
579
|
+
header_params = {}
|
|
580
|
+
|
|
581
|
+
# HTTP header 'Accept' (if needed)
|
|
582
|
+
_header_accept = ['application/json']
|
|
583
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
584
|
+
|
|
585
|
+
# HTTP header 'Content-Type'
|
|
586
|
+
_header_content_type = ['application/json']
|
|
587
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
588
|
+
|
|
589
|
+
# form parameters
|
|
590
|
+
form_params = {}
|
|
591
|
+
|
|
592
|
+
# http body (model)
|
|
593
|
+
post_body = nil
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
auth_names = ['PureCloud Auth']
|
|
597
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
598
|
+
:header_params => header_params,
|
|
599
|
+
:query_params => query_params,
|
|
600
|
+
:form_params => form_params,
|
|
601
|
+
:body => post_body,
|
|
602
|
+
:auth_names => auth_names,
|
|
603
|
+
:return_type => 'ResponseSet')
|
|
604
|
+
if @api_client.config.debugging
|
|
605
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
606
|
+
end
|
|
607
|
+
return data, status_code, headers
|
|
608
|
+
end
|
|
609
|
+
|
|
610
|
+
# Update a dialer call analysis response set.
|
|
611
|
+
#
|
|
612
|
+
# @param call_analysis_set_id Call Analysis Response Set ID
|
|
613
|
+
# @param [Hash] opts the optional parameters
|
|
614
|
+
# @option opts [ResponseSet] :body ResponseSet
|
|
615
|
+
# @return [ResponseSet]
|
|
616
|
+
def put_callanalysisresponseset(call_analysis_set_id, opts = {})
|
|
617
|
+
data, status_code, headers = put_callanalysisresponseset_with_http_info(call_analysis_set_id, opts)
|
|
618
|
+
return data
|
|
619
|
+
end
|
|
620
|
+
|
|
621
|
+
# Update a dialer call analysis response set.
|
|
622
|
+
#
|
|
623
|
+
# @param call_analysis_set_id Call Analysis Response Set ID
|
|
624
|
+
# @param [Hash] opts the optional parameters
|
|
625
|
+
# @option opts [ResponseSet] :body ResponseSet
|
|
626
|
+
# @return [Array<(ResponseSet, Fixnum, Hash)>] ResponseSet data, response status code and response headers
|
|
627
|
+
def put_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {})
|
|
628
|
+
if @api_client.config.debugging
|
|
629
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_callanalysisresponseset ..."
|
|
630
|
+
end
|
|
631
|
+
|
|
632
|
+
# verify the required parameter 'call_analysis_set_id' is set
|
|
633
|
+
fail "Missing the required parameter 'call_analysis_set_id' when calling put_callanalysisresponseset" if call_analysis_set_id.nil?
|
|
634
|
+
|
|
635
|
+
# resource path
|
|
636
|
+
path = "/api/v1/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)
|
|
637
|
+
|
|
638
|
+
# query parameters
|
|
639
|
+
query_params = {}
|
|
640
|
+
|
|
641
|
+
# header parameters
|
|
642
|
+
header_params = {}
|
|
643
|
+
|
|
644
|
+
# HTTP header 'Accept' (if needed)
|
|
645
|
+
_header_accept = ['application/json']
|
|
646
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
647
|
+
|
|
648
|
+
# HTTP header 'Content-Type'
|
|
649
|
+
_header_content_type = ['application/json']
|
|
650
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
651
|
+
|
|
652
|
+
# form parameters
|
|
653
|
+
form_params = {}
|
|
654
|
+
|
|
655
|
+
# http body (model)
|
|
656
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
auth_names = ['PureCloud Auth']
|
|
660
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
661
|
+
:header_params => header_params,
|
|
662
|
+
:query_params => query_params,
|
|
663
|
+
:form_params => form_params,
|
|
664
|
+
:body => post_body,
|
|
665
|
+
:auth_names => auth_names,
|
|
666
|
+
:return_type => 'ResponseSet')
|
|
667
|
+
if @api_client.config.debugging
|
|
668
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
669
|
+
end
|
|
670
|
+
return data, status_code, headers
|
|
671
|
+
end
|
|
672
|
+
|
|
673
|
+
# Delete a dialer call analysis response set.
|
|
674
|
+
#
|
|
675
|
+
# @param call_analysis_set_id Call Analysis Response Set ID
|
|
676
|
+
# @param [Hash] opts the optional parameters
|
|
677
|
+
# @return [String]
|
|
678
|
+
def delete_callanalysisresponseset(call_analysis_set_id, opts = {})
|
|
679
|
+
data, status_code, headers = delete_callanalysisresponseset_with_http_info(call_analysis_set_id, opts)
|
|
680
|
+
return data
|
|
681
|
+
end
|
|
682
|
+
|
|
683
|
+
# Delete a dialer call analysis response set.
|
|
684
|
+
#
|
|
685
|
+
# @param call_analysis_set_id Call Analysis Response Set ID
|
|
686
|
+
# @param [Hash] opts the optional parameters
|
|
687
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
688
|
+
def delete_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {})
|
|
689
|
+
if @api_client.config.debugging
|
|
690
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_callanalysisresponseset ..."
|
|
691
|
+
end
|
|
692
|
+
|
|
693
|
+
# verify the required parameter 'call_analysis_set_id' is set
|
|
694
|
+
fail "Missing the required parameter 'call_analysis_set_id' when calling delete_callanalysisresponseset" if call_analysis_set_id.nil?
|
|
695
|
+
|
|
696
|
+
# resource path
|
|
697
|
+
path = "/api/v1/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)
|
|
698
|
+
|
|
699
|
+
# query parameters
|
|
700
|
+
query_params = {}
|
|
701
|
+
|
|
702
|
+
# header parameters
|
|
703
|
+
header_params = {}
|
|
704
|
+
|
|
705
|
+
# HTTP header 'Accept' (if needed)
|
|
706
|
+
_header_accept = ['application/json']
|
|
707
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
708
|
+
|
|
709
|
+
# HTTP header 'Content-Type'
|
|
710
|
+
_header_content_type = ['application/json']
|
|
711
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
712
|
+
|
|
713
|
+
# form parameters
|
|
714
|
+
form_params = {}
|
|
715
|
+
|
|
716
|
+
# http body (model)
|
|
717
|
+
post_body = nil
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
auth_names = ['PureCloud Auth']
|
|
721
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
722
|
+
:header_params => header_params,
|
|
723
|
+
:query_params => query_params,
|
|
724
|
+
:form_params => form_params,
|
|
725
|
+
:body => post_body,
|
|
726
|
+
:auth_names => auth_names,
|
|
727
|
+
:return_type => 'String')
|
|
728
|
+
if @api_client.config.debugging
|
|
729
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
730
|
+
end
|
|
731
|
+
return data, status_code, headers
|
|
732
|
+
end
|
|
733
|
+
|
|
734
|
+
# Query a list of dialer campaigns.
|
|
735
|
+
#
|
|
736
|
+
# @param [Hash] opts the optional parameters
|
|
737
|
+
# @option opts [Integer] :page_size Page size
|
|
738
|
+
# @option opts [Integer] :page_number Page number
|
|
739
|
+
# @option opts [String] :filter_type Filter type
|
|
740
|
+
# @option opts [String] :name Name
|
|
741
|
+
# @option opts [String] :contact_list_id Contact List ID
|
|
742
|
+
# @option opts [String] :dnc_list_id DNC list ID
|
|
743
|
+
# @option opts [String] :distribution_queue_id Distribution queue ID
|
|
744
|
+
# @option opts [String] :edge_group_id Edge group ID
|
|
745
|
+
# @option opts [String] :call_analysis_response_set_id Call analysis response set ID
|
|
746
|
+
# @option opts [String] :sort_by Sort by
|
|
747
|
+
# @option opts [String] :sort_order Sort order
|
|
748
|
+
# @return [CampaignEntityListing]
|
|
749
|
+
def get_campaigns(opts = {})
|
|
750
|
+
data, status_code, headers = get_campaigns_with_http_info(opts)
|
|
751
|
+
return data
|
|
752
|
+
end
|
|
753
|
+
|
|
754
|
+
# Query a list of dialer campaigns.
|
|
755
|
+
#
|
|
756
|
+
# @param [Hash] opts the optional parameters
|
|
757
|
+
# @option opts [Integer] :page_size Page size
|
|
758
|
+
# @option opts [Integer] :page_number Page number
|
|
759
|
+
# @option opts [String] :filter_type Filter type
|
|
760
|
+
# @option opts [String] :name Name
|
|
761
|
+
# @option opts [String] :contact_list_id Contact List ID
|
|
762
|
+
# @option opts [String] :dnc_list_id DNC list ID
|
|
763
|
+
# @option opts [String] :distribution_queue_id Distribution queue ID
|
|
764
|
+
# @option opts [String] :edge_group_id Edge group ID
|
|
765
|
+
# @option opts [String] :call_analysis_response_set_id Call analysis response set ID
|
|
766
|
+
# @option opts [String] :sort_by Sort by
|
|
767
|
+
# @option opts [String] :sort_order Sort order
|
|
768
|
+
# @return [Array<(CampaignEntityListing, Fixnum, Hash)>] CampaignEntityListing data, response status code and response headers
|
|
769
|
+
def get_campaigns_with_http_info(opts = {})
|
|
770
|
+
if @api_client.config.debugging
|
|
771
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns ..."
|
|
772
|
+
end
|
|
773
|
+
|
|
774
|
+
if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
|
|
775
|
+
fail 'invalid value for "filter_type", must be one of EQUALS, REGEX, CONTAINS, PREFIX, LESSTHAN, LESSTHANEQUALTO, GREATERTHAN, GREATERTHANEQUALTO, BEGINSWITH, ENDSWITH'
|
|
776
|
+
end
|
|
777
|
+
|
|
778
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
779
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
780
|
+
end
|
|
781
|
+
|
|
782
|
+
# resource path
|
|
783
|
+
path = "/api/v1/outbound/campaigns".sub('{format}','json')
|
|
784
|
+
|
|
785
|
+
# query parameters
|
|
786
|
+
query_params = {}
|
|
787
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
788
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
789
|
+
query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
|
|
790
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
791
|
+
query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
|
|
792
|
+
query_params[:'dncListId'] = opts[:'dnc_list_id'] if opts[:'dnc_list_id']
|
|
793
|
+
query_params[:'distributionQueueId'] = opts[:'distribution_queue_id'] if opts[:'distribution_queue_id']
|
|
794
|
+
query_params[:'edgeGroupId'] = opts[:'edge_group_id'] if opts[:'edge_group_id']
|
|
795
|
+
query_params[:'callAnalysisResponseSetId'] = opts[:'call_analysis_response_set_id'] if opts[:'call_analysis_response_set_id']
|
|
796
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
797
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
798
|
+
|
|
799
|
+
# header parameters
|
|
800
|
+
header_params = {}
|
|
801
|
+
|
|
802
|
+
# HTTP header 'Accept' (if needed)
|
|
803
|
+
_header_accept = ['application/json']
|
|
804
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
805
|
+
|
|
806
|
+
# HTTP header 'Content-Type'
|
|
807
|
+
_header_content_type = ['application/json']
|
|
808
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
809
|
+
|
|
810
|
+
# form parameters
|
|
811
|
+
form_params = {}
|
|
812
|
+
|
|
813
|
+
# http body (model)
|
|
814
|
+
post_body = nil
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
auth_names = ['PureCloud Auth']
|
|
818
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
819
|
+
:header_params => header_params,
|
|
820
|
+
:query_params => query_params,
|
|
821
|
+
:form_params => form_params,
|
|
822
|
+
:body => post_body,
|
|
823
|
+
:auth_names => auth_names,
|
|
824
|
+
:return_type => 'CampaignEntityListing')
|
|
825
|
+
if @api_client.config.debugging
|
|
826
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
827
|
+
end
|
|
828
|
+
return data, status_code, headers
|
|
829
|
+
end
|
|
830
|
+
|
|
831
|
+
# Create a campaign.
|
|
832
|
+
#
|
|
833
|
+
# @param [Hash] opts the optional parameters
|
|
834
|
+
# @option opts [Campaign] :body Campaign
|
|
835
|
+
# @return [Campaign]
|
|
836
|
+
def post_campaigns(opts = {})
|
|
837
|
+
data, status_code, headers = post_campaigns_with_http_info(opts)
|
|
838
|
+
return data
|
|
839
|
+
end
|
|
840
|
+
|
|
841
|
+
# Create a campaign.
|
|
842
|
+
#
|
|
843
|
+
# @param [Hash] opts the optional parameters
|
|
844
|
+
# @option opts [Campaign] :body Campaign
|
|
845
|
+
# @return [Array<(Campaign, Fixnum, Hash)>] Campaign data, response status code and response headers
|
|
846
|
+
def post_campaigns_with_http_info(opts = {})
|
|
847
|
+
if @api_client.config.debugging
|
|
848
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_campaigns ..."
|
|
849
|
+
end
|
|
850
|
+
|
|
851
|
+
# resource path
|
|
852
|
+
path = "/api/v1/outbound/campaigns".sub('{format}','json')
|
|
853
|
+
|
|
854
|
+
# query parameters
|
|
855
|
+
query_params = {}
|
|
856
|
+
|
|
857
|
+
# header parameters
|
|
858
|
+
header_params = {}
|
|
859
|
+
|
|
860
|
+
# HTTP header 'Accept' (if needed)
|
|
861
|
+
_header_accept = ['application/json']
|
|
862
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
863
|
+
|
|
864
|
+
# HTTP header 'Content-Type'
|
|
865
|
+
_header_content_type = ['application/json']
|
|
866
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
867
|
+
|
|
868
|
+
# form parameters
|
|
869
|
+
form_params = {}
|
|
870
|
+
|
|
871
|
+
# http body (model)
|
|
872
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
auth_names = ['PureCloud Auth']
|
|
876
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
877
|
+
:header_params => header_params,
|
|
878
|
+
:query_params => query_params,
|
|
879
|
+
:form_params => form_params,
|
|
880
|
+
:body => post_body,
|
|
881
|
+
:auth_names => auth_names,
|
|
882
|
+
:return_type => 'Campaign')
|
|
883
|
+
if @api_client.config.debugging
|
|
884
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
885
|
+
end
|
|
886
|
+
return data, status_code, headers
|
|
887
|
+
end
|
|
888
|
+
|
|
889
|
+
# Get dialer campaign.
|
|
890
|
+
#
|
|
891
|
+
# @param campaign_id Campaign ID
|
|
892
|
+
# @param [Hash] opts the optional parameters
|
|
893
|
+
# @return [Campaign]
|
|
894
|
+
def get_campaign(campaign_id, opts = {})
|
|
895
|
+
data, status_code, headers = get_campaign_with_http_info(campaign_id, opts)
|
|
896
|
+
return data
|
|
897
|
+
end
|
|
898
|
+
|
|
899
|
+
# Get dialer campaign.
|
|
900
|
+
#
|
|
901
|
+
# @param campaign_id Campaign ID
|
|
902
|
+
# @param [Hash] opts the optional parameters
|
|
903
|
+
# @return [Array<(Campaign, Fixnum, Hash)>] Campaign data, response status code and response headers
|
|
904
|
+
def get_campaign_with_http_info(campaign_id, opts = {})
|
|
905
|
+
if @api_client.config.debugging
|
|
906
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_campaign ..."
|
|
907
|
+
end
|
|
908
|
+
|
|
909
|
+
# verify the required parameter 'campaign_id' is set
|
|
910
|
+
fail "Missing the required parameter 'campaign_id' when calling get_campaign" if campaign_id.nil?
|
|
911
|
+
|
|
912
|
+
# resource path
|
|
913
|
+
path = "/api/v1/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
914
|
+
|
|
915
|
+
# query parameters
|
|
916
|
+
query_params = {}
|
|
917
|
+
|
|
918
|
+
# header parameters
|
|
919
|
+
header_params = {}
|
|
920
|
+
|
|
921
|
+
# HTTP header 'Accept' (if needed)
|
|
922
|
+
_header_accept = ['application/json']
|
|
923
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
924
|
+
|
|
925
|
+
# HTTP header 'Content-Type'
|
|
926
|
+
_header_content_type = ['application/json']
|
|
927
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
928
|
+
|
|
929
|
+
# form parameters
|
|
930
|
+
form_params = {}
|
|
931
|
+
|
|
932
|
+
# http body (model)
|
|
933
|
+
post_body = nil
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
auth_names = ['PureCloud Auth']
|
|
937
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
938
|
+
:header_params => header_params,
|
|
939
|
+
:query_params => query_params,
|
|
940
|
+
:form_params => form_params,
|
|
941
|
+
:body => post_body,
|
|
942
|
+
:auth_names => auth_names,
|
|
943
|
+
:return_type => 'Campaign')
|
|
944
|
+
if @api_client.config.debugging
|
|
945
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
946
|
+
end
|
|
947
|
+
return data, status_code, headers
|
|
948
|
+
end
|
|
949
|
+
|
|
950
|
+
# Update a campaign.
|
|
951
|
+
#
|
|
952
|
+
# @param campaign_id Campaign ID
|
|
953
|
+
# @param [Hash] opts the optional parameters
|
|
954
|
+
# @option opts [Campaign] :body Campaign
|
|
955
|
+
# @return [Campaign]
|
|
956
|
+
def put_campaign(campaign_id, opts = {})
|
|
957
|
+
data, status_code, headers = put_campaign_with_http_info(campaign_id, opts)
|
|
958
|
+
return data
|
|
959
|
+
end
|
|
960
|
+
|
|
961
|
+
# Update a campaign.
|
|
962
|
+
#
|
|
963
|
+
# @param campaign_id Campaign ID
|
|
964
|
+
# @param [Hash] opts the optional parameters
|
|
965
|
+
# @option opts [Campaign] :body Campaign
|
|
966
|
+
# @return [Array<(Campaign, Fixnum, Hash)>] Campaign data, response status code and response headers
|
|
967
|
+
def put_campaign_with_http_info(campaign_id, opts = {})
|
|
968
|
+
if @api_client.config.debugging
|
|
969
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_campaign ..."
|
|
970
|
+
end
|
|
971
|
+
|
|
972
|
+
# verify the required parameter 'campaign_id' is set
|
|
973
|
+
fail "Missing the required parameter 'campaign_id' when calling put_campaign" if campaign_id.nil?
|
|
974
|
+
|
|
975
|
+
# resource path
|
|
976
|
+
path = "/api/v1/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
977
|
+
|
|
978
|
+
# query parameters
|
|
979
|
+
query_params = {}
|
|
980
|
+
|
|
981
|
+
# header parameters
|
|
982
|
+
header_params = {}
|
|
983
|
+
|
|
984
|
+
# HTTP header 'Accept' (if needed)
|
|
985
|
+
_header_accept = ['application/json']
|
|
986
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
987
|
+
|
|
988
|
+
# HTTP header 'Content-Type'
|
|
989
|
+
_header_content_type = ['application/json']
|
|
990
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
991
|
+
|
|
992
|
+
# form parameters
|
|
993
|
+
form_params = {}
|
|
994
|
+
|
|
995
|
+
# http body (model)
|
|
996
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
auth_names = ['PureCloud Auth']
|
|
1000
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
1001
|
+
:header_params => header_params,
|
|
1002
|
+
:query_params => query_params,
|
|
1003
|
+
:form_params => form_params,
|
|
1004
|
+
:body => post_body,
|
|
1005
|
+
:auth_names => auth_names,
|
|
1006
|
+
:return_type => 'Campaign')
|
|
1007
|
+
if @api_client.config.debugging
|
|
1008
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1009
|
+
end
|
|
1010
|
+
return data, status_code, headers
|
|
1011
|
+
end
|
|
1012
|
+
|
|
1013
|
+
# Delete a campaign.
|
|
1014
|
+
#
|
|
1015
|
+
# @param campaign_id Campaign ID
|
|
1016
|
+
# @param [Hash] opts the optional parameters
|
|
1017
|
+
# @return [String]
|
|
1018
|
+
def delete_campaign(campaign_id, opts = {})
|
|
1019
|
+
data, status_code, headers = delete_campaign_with_http_info(campaign_id, opts)
|
|
1020
|
+
return data
|
|
1021
|
+
end
|
|
1022
|
+
|
|
1023
|
+
# Delete a campaign.
|
|
1024
|
+
#
|
|
1025
|
+
# @param campaign_id Campaign ID
|
|
1026
|
+
# @param [Hash] opts the optional parameters
|
|
1027
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
1028
|
+
def delete_campaign_with_http_info(campaign_id, opts = {})
|
|
1029
|
+
if @api_client.config.debugging
|
|
1030
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_campaign ..."
|
|
1031
|
+
end
|
|
1032
|
+
|
|
1033
|
+
# verify the required parameter 'campaign_id' is set
|
|
1034
|
+
fail "Missing the required parameter 'campaign_id' when calling delete_campaign" if campaign_id.nil?
|
|
1035
|
+
|
|
1036
|
+
# resource path
|
|
1037
|
+
path = "/api/v1/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
1038
|
+
|
|
1039
|
+
# query parameters
|
|
1040
|
+
query_params = {}
|
|
1041
|
+
|
|
1042
|
+
# header parameters
|
|
1043
|
+
header_params = {}
|
|
1044
|
+
|
|
1045
|
+
# HTTP header 'Accept' (if needed)
|
|
1046
|
+
_header_accept = ['application/json']
|
|
1047
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1048
|
+
|
|
1049
|
+
# HTTP header 'Content-Type'
|
|
1050
|
+
_header_content_type = ['application/json']
|
|
1051
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1052
|
+
|
|
1053
|
+
# form parameters
|
|
1054
|
+
form_params = {}
|
|
1055
|
+
|
|
1056
|
+
# http body (model)
|
|
1057
|
+
post_body = nil
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
auth_names = ['PureCloud Auth']
|
|
1061
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
1062
|
+
:header_params => header_params,
|
|
1063
|
+
:query_params => query_params,
|
|
1064
|
+
:form_params => form_params,
|
|
1065
|
+
:body => post_body,
|
|
1066
|
+
:auth_names => auth_names,
|
|
1067
|
+
:return_type => 'String')
|
|
1068
|
+
if @api_client.config.debugging
|
|
1069
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1070
|
+
end
|
|
1071
|
+
return data, status_code, headers
|
|
1072
|
+
end
|
|
1073
|
+
|
|
1074
|
+
# Send notification that an agent's state changed
|
|
1075
|
+
# New agent state.
|
|
1076
|
+
# @param campaign_id Campaign ID
|
|
1077
|
+
# @param user_id Agent's user ID
|
|
1078
|
+
# @param [Hash] opts the optional parameters
|
|
1079
|
+
# @option opts [Agent] :body agent
|
|
1080
|
+
# @return [String]
|
|
1081
|
+
def put_campaign_agent(campaign_id, user_id, opts = {})
|
|
1082
|
+
data, status_code, headers = put_campaign_agent_with_http_info(campaign_id, user_id, opts)
|
|
1083
|
+
return data
|
|
1084
|
+
end
|
|
1085
|
+
|
|
1086
|
+
# Send notification that an agent's state changed
|
|
1087
|
+
# New agent state.
|
|
1088
|
+
# @param campaign_id Campaign ID
|
|
1089
|
+
# @param user_id Agent's user ID
|
|
1090
|
+
# @param [Hash] opts the optional parameters
|
|
1091
|
+
# @option opts [Agent] :body agent
|
|
1092
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
1093
|
+
def put_campaign_agent_with_http_info(campaign_id, user_id, opts = {})
|
|
1094
|
+
if @api_client.config.debugging
|
|
1095
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_campaign_agent ..."
|
|
1096
|
+
end
|
|
1097
|
+
|
|
1098
|
+
# verify the required parameter 'campaign_id' is set
|
|
1099
|
+
fail "Missing the required parameter 'campaign_id' when calling put_campaign_agent" if campaign_id.nil?
|
|
1100
|
+
|
|
1101
|
+
# verify the required parameter 'user_id' is set
|
|
1102
|
+
fail "Missing the required parameter 'user_id' when calling put_campaign_agent" if user_id.nil?
|
|
1103
|
+
|
|
1104
|
+
# resource path
|
|
1105
|
+
path = "/api/v1/outbound/campaigns/{campaignId}/agents/{userId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
|
1106
|
+
|
|
1107
|
+
# query parameters
|
|
1108
|
+
query_params = {}
|
|
1109
|
+
|
|
1110
|
+
# header parameters
|
|
1111
|
+
header_params = {}
|
|
1112
|
+
|
|
1113
|
+
# HTTP header 'Accept' (if needed)
|
|
1114
|
+
_header_accept = ['application/json']
|
|
1115
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1116
|
+
|
|
1117
|
+
# HTTP header 'Content-Type'
|
|
1118
|
+
_header_content_type = ['application/json']
|
|
1119
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1120
|
+
|
|
1121
|
+
# form parameters
|
|
1122
|
+
form_params = {}
|
|
1123
|
+
|
|
1124
|
+
# http body (model)
|
|
1125
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
auth_names = ['PureCloud Auth']
|
|
1129
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
1130
|
+
:header_params => header_params,
|
|
1131
|
+
:query_params => query_params,
|
|
1132
|
+
:form_params => form_params,
|
|
1133
|
+
:body => post_body,
|
|
1134
|
+
:auth_names => auth_names,
|
|
1135
|
+
:return_type => 'String')
|
|
1136
|
+
if @api_client.config.debugging
|
|
1137
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_campaign_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1138
|
+
end
|
|
1139
|
+
return data, status_code, headers
|
|
1140
|
+
end
|
|
1141
|
+
|
|
1142
|
+
# Schedule a Callback for a Dialer Campaign
|
|
1143
|
+
#
|
|
1144
|
+
# @param campaign_id Campaign ID
|
|
1145
|
+
# @param [Hash] opts the optional parameters
|
|
1146
|
+
# @option opts [ContactCallbackRequest] :body ContactCallbackRequest
|
|
1147
|
+
# @return [ContactCallbackRequest]
|
|
1148
|
+
def post_campaign_callback_schedule(campaign_id, opts = {})
|
|
1149
|
+
data, status_code, headers = post_campaign_callback_schedule_with_http_info(campaign_id, opts)
|
|
1150
|
+
return data
|
|
1151
|
+
end
|
|
1152
|
+
|
|
1153
|
+
# Schedule a Callback for a Dialer Campaign
|
|
1154
|
+
#
|
|
1155
|
+
# @param campaign_id Campaign ID
|
|
1156
|
+
# @param [Hash] opts the optional parameters
|
|
1157
|
+
# @option opts [ContactCallbackRequest] :body ContactCallbackRequest
|
|
1158
|
+
# @return [Array<(ContactCallbackRequest, Fixnum, Hash)>] ContactCallbackRequest data, response status code and response headers
|
|
1159
|
+
def post_campaign_callback_schedule_with_http_info(campaign_id, opts = {})
|
|
1160
|
+
if @api_client.config.debugging
|
|
1161
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_campaign_callback_schedule ..."
|
|
1162
|
+
end
|
|
1163
|
+
|
|
1164
|
+
# verify the required parameter 'campaign_id' is set
|
|
1165
|
+
fail "Missing the required parameter 'campaign_id' when calling post_campaign_callback_schedule" if campaign_id.nil?
|
|
1166
|
+
|
|
1167
|
+
# resource path
|
|
1168
|
+
path = "/api/v1/outbound/campaigns/{campaignId}/callback/schedule".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
1169
|
+
|
|
1170
|
+
# query parameters
|
|
1171
|
+
query_params = {}
|
|
1172
|
+
|
|
1173
|
+
# header parameters
|
|
1174
|
+
header_params = {}
|
|
1175
|
+
|
|
1176
|
+
# HTTP header 'Accept' (if needed)
|
|
1177
|
+
_header_accept = ['application/json']
|
|
1178
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1179
|
+
|
|
1180
|
+
# HTTP header 'Content-Type'
|
|
1181
|
+
_header_content_type = ['application/json']
|
|
1182
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1183
|
+
|
|
1184
|
+
# form parameters
|
|
1185
|
+
form_params = {}
|
|
1186
|
+
|
|
1187
|
+
# http body (model)
|
|
1188
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
auth_names = ['PureCloud Auth']
|
|
1192
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
1193
|
+
:header_params => header_params,
|
|
1194
|
+
:query_params => query_params,
|
|
1195
|
+
:form_params => form_params,
|
|
1196
|
+
:body => post_body,
|
|
1197
|
+
:auth_names => auth_names,
|
|
1198
|
+
:return_type => 'ContactCallbackRequest')
|
|
1199
|
+
if @api_client.config.debugging
|
|
1200
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_campaign_callback_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1201
|
+
end
|
|
1202
|
+
return data, status_code, headers
|
|
1203
|
+
end
|
|
1204
|
+
|
|
1205
|
+
# Get campaign diagnostics
|
|
1206
|
+
#
|
|
1207
|
+
# @param campaign_id Campaign ID
|
|
1208
|
+
# @param [Hash] opts the optional parameters
|
|
1209
|
+
# @return [CampaignDiagnostics]
|
|
1210
|
+
def get_campaign_diagnostics(campaign_id, opts = {})
|
|
1211
|
+
data, status_code, headers = get_campaign_diagnostics_with_http_info(campaign_id, opts)
|
|
1212
|
+
return data
|
|
1213
|
+
end
|
|
1214
|
+
|
|
1215
|
+
# Get campaign diagnostics
|
|
1216
|
+
#
|
|
1217
|
+
# @param campaign_id Campaign ID
|
|
1218
|
+
# @param [Hash] opts the optional parameters
|
|
1219
|
+
# @return [Array<(CampaignDiagnostics, Fixnum, Hash)>] CampaignDiagnostics data, response status code and response headers
|
|
1220
|
+
def get_campaign_diagnostics_with_http_info(campaign_id, opts = {})
|
|
1221
|
+
if @api_client.config.debugging
|
|
1222
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_campaign_diagnostics ..."
|
|
1223
|
+
end
|
|
1224
|
+
|
|
1225
|
+
# verify the required parameter 'campaign_id' is set
|
|
1226
|
+
fail "Missing the required parameter 'campaign_id' when calling get_campaign_diagnostics" if campaign_id.nil?
|
|
1227
|
+
|
|
1228
|
+
# resource path
|
|
1229
|
+
path = "/api/v1/outbound/campaigns/{campaignId}/diagnostics".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
1230
|
+
|
|
1231
|
+
# query parameters
|
|
1232
|
+
query_params = {}
|
|
1233
|
+
|
|
1234
|
+
# header parameters
|
|
1235
|
+
header_params = {}
|
|
1236
|
+
|
|
1237
|
+
# HTTP header 'Accept' (if needed)
|
|
1238
|
+
_header_accept = ['application/json']
|
|
1239
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1240
|
+
|
|
1241
|
+
# HTTP header 'Content-Type'
|
|
1242
|
+
_header_content_type = ['application/json']
|
|
1243
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1244
|
+
|
|
1245
|
+
# form parameters
|
|
1246
|
+
form_params = {}
|
|
1247
|
+
|
|
1248
|
+
# http body (model)
|
|
1249
|
+
post_body = nil
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
auth_names = ['PureCloud Auth']
|
|
1253
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1254
|
+
:header_params => header_params,
|
|
1255
|
+
:query_params => query_params,
|
|
1256
|
+
:form_params => form_params,
|
|
1257
|
+
:body => post_body,
|
|
1258
|
+
:auth_names => auth_names,
|
|
1259
|
+
:return_type => 'CampaignDiagnostics')
|
|
1260
|
+
if @api_client.config.debugging
|
|
1261
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_campaign_diagnostics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1262
|
+
end
|
|
1263
|
+
return data, status_code, headers
|
|
1264
|
+
end
|
|
1265
|
+
|
|
1266
|
+
# Get statistics about a Dialer Campaign
|
|
1267
|
+
#
|
|
1268
|
+
# @param campaign_id Campaign ID
|
|
1269
|
+
# @param [Hash] opts the optional parameters
|
|
1270
|
+
# @return [CampaignStats]
|
|
1271
|
+
def get_campaign_stats(campaign_id, opts = {})
|
|
1272
|
+
data, status_code, headers = get_campaign_stats_with_http_info(campaign_id, opts)
|
|
1273
|
+
return data
|
|
1274
|
+
end
|
|
1275
|
+
|
|
1276
|
+
# Get statistics about a Dialer Campaign
|
|
1277
|
+
#
|
|
1278
|
+
# @param campaign_id Campaign ID
|
|
1279
|
+
# @param [Hash] opts the optional parameters
|
|
1280
|
+
# @return [Array<(CampaignStats, Fixnum, Hash)>] CampaignStats data, response status code and response headers
|
|
1281
|
+
def get_campaign_stats_with_http_info(campaign_id, opts = {})
|
|
1282
|
+
if @api_client.config.debugging
|
|
1283
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_campaign_stats ..."
|
|
1284
|
+
end
|
|
1285
|
+
|
|
1286
|
+
# verify the required parameter 'campaign_id' is set
|
|
1287
|
+
fail "Missing the required parameter 'campaign_id' when calling get_campaign_stats" if campaign_id.nil?
|
|
1288
|
+
|
|
1289
|
+
# resource path
|
|
1290
|
+
path = "/api/v1/outbound/campaigns/{campaignId}/stats".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
1291
|
+
|
|
1292
|
+
# query parameters
|
|
1293
|
+
query_params = {}
|
|
1294
|
+
|
|
1295
|
+
# header parameters
|
|
1296
|
+
header_params = {}
|
|
1297
|
+
|
|
1298
|
+
# HTTP header 'Accept' (if needed)
|
|
1299
|
+
_header_accept = ['application/json']
|
|
1300
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1301
|
+
|
|
1302
|
+
# HTTP header 'Content-Type'
|
|
1303
|
+
_header_content_type = ['application/json']
|
|
1304
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1305
|
+
|
|
1306
|
+
# form parameters
|
|
1307
|
+
form_params = {}
|
|
1308
|
+
|
|
1309
|
+
# http body (model)
|
|
1310
|
+
post_body = nil
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
auth_names = ['PureCloud Auth']
|
|
1314
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1315
|
+
:header_params => header_params,
|
|
1316
|
+
:query_params => query_params,
|
|
1317
|
+
:form_params => form_params,
|
|
1318
|
+
:body => post_body,
|
|
1319
|
+
:auth_names => auth_names,
|
|
1320
|
+
:return_type => 'CampaignStats')
|
|
1321
|
+
if @api_client.config.debugging
|
|
1322
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_campaign_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1323
|
+
end
|
|
1324
|
+
return data, status_code, headers
|
|
1325
|
+
end
|
|
1326
|
+
|
|
1327
|
+
# Query a list of contact lists.
|
|
1328
|
+
#
|
|
1329
|
+
# @param [Hash] opts the optional parameters
|
|
1330
|
+
# @option opts [BOOLEAN] :include_import_status Include import status
|
|
1331
|
+
# @option opts [BOOLEAN] :import_status Import status
|
|
1332
|
+
# @option opts [BOOLEAN] :include_size Include size
|
|
1333
|
+
# @option opts [Integer] :page_size Page size
|
|
1334
|
+
# @option opts [Integer] :page_number Page number
|
|
1335
|
+
# @option opts [String] :filter_type Filter type
|
|
1336
|
+
# @option opts [String] :name Name
|
|
1337
|
+
# @option opts [String] :sort_by Sort by
|
|
1338
|
+
# @option opts [String] :sort_order Sort order
|
|
1339
|
+
# @return [ContactListEntityListing]
|
|
1340
|
+
def get_contactlists(opts = {})
|
|
1341
|
+
data, status_code, headers = get_contactlists_with_http_info(opts)
|
|
1342
|
+
return data
|
|
1343
|
+
end
|
|
1344
|
+
|
|
1345
|
+
# Query a list of contact lists.
|
|
1346
|
+
#
|
|
1347
|
+
# @param [Hash] opts the optional parameters
|
|
1348
|
+
# @option opts [BOOLEAN] :include_import_status Include import status
|
|
1349
|
+
# @option opts [BOOLEAN] :import_status Import status
|
|
1350
|
+
# @option opts [BOOLEAN] :include_size Include size
|
|
1351
|
+
# @option opts [Integer] :page_size Page size
|
|
1352
|
+
# @option opts [Integer] :page_number Page number
|
|
1353
|
+
# @option opts [String] :filter_type Filter type
|
|
1354
|
+
# @option opts [String] :name Name
|
|
1355
|
+
# @option opts [String] :sort_by Sort by
|
|
1356
|
+
# @option opts [String] :sort_order Sort order
|
|
1357
|
+
# @return [Array<(ContactListEntityListing, Fixnum, Hash)>] ContactListEntityListing data, response status code and response headers
|
|
1358
|
+
def get_contactlists_with_http_info(opts = {})
|
|
1359
|
+
if @api_client.config.debugging
|
|
1360
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists ..."
|
|
1361
|
+
end
|
|
1362
|
+
|
|
1363
|
+
if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
|
|
1364
|
+
fail 'invalid value for "filter_type", must be one of EQUALS, REGEX, CONTAINS, PREFIX, LESSTHAN, LESSTHANEQUALTO, GREATERTHAN, GREATERTHANEQUALTO, BEGINSWITH, ENDSWITH'
|
|
1365
|
+
end
|
|
1366
|
+
|
|
1367
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
1368
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
1369
|
+
end
|
|
1370
|
+
|
|
1371
|
+
# resource path
|
|
1372
|
+
path = "/api/v1/outbound/contactlists".sub('{format}','json')
|
|
1373
|
+
|
|
1374
|
+
# query parameters
|
|
1375
|
+
query_params = {}
|
|
1376
|
+
query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
|
|
1377
|
+
query_params[:'importStatus'] = opts[:'import_status'] if opts[:'import_status']
|
|
1378
|
+
query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
|
|
1379
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
1380
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
1381
|
+
query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
|
|
1382
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
1383
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
1384
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
1385
|
+
|
|
1386
|
+
# header parameters
|
|
1387
|
+
header_params = {}
|
|
1388
|
+
|
|
1389
|
+
# HTTP header 'Accept' (if needed)
|
|
1390
|
+
_header_accept = ['application/json']
|
|
1391
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1392
|
+
|
|
1393
|
+
# HTTP header 'Content-Type'
|
|
1394
|
+
_header_content_type = ['application/json']
|
|
1395
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1396
|
+
|
|
1397
|
+
# form parameters
|
|
1398
|
+
form_params = {}
|
|
1399
|
+
|
|
1400
|
+
# http body (model)
|
|
1401
|
+
post_body = nil
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
auth_names = ['PureCloud Auth']
|
|
1405
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1406
|
+
:header_params => header_params,
|
|
1407
|
+
:query_params => query_params,
|
|
1408
|
+
:form_params => form_params,
|
|
1409
|
+
:body => post_body,
|
|
1410
|
+
:auth_names => auth_names,
|
|
1411
|
+
:return_type => 'ContactListEntityListing')
|
|
1412
|
+
if @api_client.config.debugging
|
|
1413
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1414
|
+
end
|
|
1415
|
+
return data, status_code, headers
|
|
1416
|
+
end
|
|
1417
|
+
|
|
1418
|
+
# Create a contact List.
|
|
1419
|
+
#
|
|
1420
|
+
# @param [Hash] opts the optional parameters
|
|
1421
|
+
# @option opts [ContactList] :body ContactList
|
|
1422
|
+
# @return [ContactList]
|
|
1423
|
+
def post_contactlists(opts = {})
|
|
1424
|
+
data, status_code, headers = post_contactlists_with_http_info(opts)
|
|
1425
|
+
return data
|
|
1426
|
+
end
|
|
1427
|
+
|
|
1428
|
+
# Create a contact List.
|
|
1429
|
+
#
|
|
1430
|
+
# @param [Hash] opts the optional parameters
|
|
1431
|
+
# @option opts [ContactList] :body ContactList
|
|
1432
|
+
# @return [Array<(ContactList, Fixnum, Hash)>] ContactList data, response status code and response headers
|
|
1433
|
+
def post_contactlists_with_http_info(opts = {})
|
|
1434
|
+
if @api_client.config.debugging
|
|
1435
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_contactlists ..."
|
|
1436
|
+
end
|
|
1437
|
+
|
|
1438
|
+
# resource path
|
|
1439
|
+
path = "/api/v1/outbound/contactlists".sub('{format}','json')
|
|
1440
|
+
|
|
1441
|
+
# query parameters
|
|
1442
|
+
query_params = {}
|
|
1443
|
+
|
|
1444
|
+
# header parameters
|
|
1445
|
+
header_params = {}
|
|
1446
|
+
|
|
1447
|
+
# HTTP header 'Accept' (if needed)
|
|
1448
|
+
_header_accept = ['application/json']
|
|
1449
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1450
|
+
|
|
1451
|
+
# HTTP header 'Content-Type'
|
|
1452
|
+
_header_content_type = ['application/json']
|
|
1453
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1454
|
+
|
|
1455
|
+
# form parameters
|
|
1456
|
+
form_params = {}
|
|
1457
|
+
|
|
1458
|
+
# http body (model)
|
|
1459
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
auth_names = ['PureCloud Auth']
|
|
1463
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
1464
|
+
:header_params => header_params,
|
|
1465
|
+
:query_params => query_params,
|
|
1466
|
+
:form_params => form_params,
|
|
1467
|
+
:body => post_body,
|
|
1468
|
+
:auth_names => auth_names,
|
|
1469
|
+
:return_type => 'ContactList')
|
|
1470
|
+
if @api_client.config.debugging
|
|
1471
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1472
|
+
end
|
|
1473
|
+
return data, status_code, headers
|
|
1474
|
+
end
|
|
1475
|
+
|
|
1476
|
+
# Get penetration rates for a list of penetration rate identifiers (contact list id and qualifier id)
|
|
1477
|
+
#
|
|
1478
|
+
# @param [Hash] opts the optional parameters
|
|
1479
|
+
# @option opts [Array<PenetrationRateId>] :body PenetrationRateIdentifierList
|
|
1480
|
+
# @return [Array<PenetrationRate>]
|
|
1481
|
+
def post_contactlists_penetrationrates(opts = {})
|
|
1482
|
+
data, status_code, headers = post_contactlists_penetrationrates_with_http_info(opts)
|
|
1483
|
+
return data
|
|
1484
|
+
end
|
|
1485
|
+
|
|
1486
|
+
# Get penetration rates for a list of penetration rate identifiers (contact list id and qualifier id)
|
|
1487
|
+
#
|
|
1488
|
+
# @param [Hash] opts the optional parameters
|
|
1489
|
+
# @option opts [Array<PenetrationRateId>] :body PenetrationRateIdentifierList
|
|
1490
|
+
# @return [Array<(Array<PenetrationRate>, Fixnum, Hash)>] Array<PenetrationRate> data, response status code and response headers
|
|
1491
|
+
def post_contactlists_penetrationrates_with_http_info(opts = {})
|
|
1492
|
+
if @api_client.config.debugging
|
|
1493
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_contactlists_penetrationrates ..."
|
|
1494
|
+
end
|
|
1495
|
+
|
|
1496
|
+
# resource path
|
|
1497
|
+
path = "/api/v1/outbound/contactlists/penetrationrates".sub('{format}','json')
|
|
1498
|
+
|
|
1499
|
+
# query parameters
|
|
1500
|
+
query_params = {}
|
|
1501
|
+
|
|
1502
|
+
# header parameters
|
|
1503
|
+
header_params = {}
|
|
1504
|
+
|
|
1505
|
+
# HTTP header 'Accept' (if needed)
|
|
1506
|
+
_header_accept = ['application/json']
|
|
1507
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1508
|
+
|
|
1509
|
+
# HTTP header 'Content-Type'
|
|
1510
|
+
_header_content_type = ['application/json']
|
|
1511
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1512
|
+
|
|
1513
|
+
# form parameters
|
|
1514
|
+
form_params = {}
|
|
1515
|
+
|
|
1516
|
+
# http body (model)
|
|
1517
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
auth_names = ['PureCloud Auth']
|
|
1521
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
1522
|
+
:header_params => header_params,
|
|
1523
|
+
:query_params => query_params,
|
|
1524
|
+
:form_params => form_params,
|
|
1525
|
+
:body => post_body,
|
|
1526
|
+
:auth_names => auth_names,
|
|
1527
|
+
:return_type => 'Array<PenetrationRate>')
|
|
1528
|
+
if @api_client.config.debugging
|
|
1529
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_contactlists_penetrationrates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1530
|
+
end
|
|
1531
|
+
return data, status_code, headers
|
|
1532
|
+
end
|
|
1533
|
+
|
|
1534
|
+
# Get dialer contactList.
|
|
1535
|
+
#
|
|
1536
|
+
# @param contact_list_id ContactList ID
|
|
1537
|
+
# @param [Hash] opts the optional parameters
|
|
1538
|
+
# @option opts [BOOLEAN] :include_import_status Import status
|
|
1539
|
+
# @option opts [BOOLEAN] :import_status Import status
|
|
1540
|
+
# @option opts [BOOLEAN] :include_size Include size
|
|
1541
|
+
# @return [ContactList]
|
|
1542
|
+
def get_contactlist(contact_list_id, opts = {})
|
|
1543
|
+
data, status_code, headers = get_contactlist_with_http_info(contact_list_id, opts)
|
|
1544
|
+
return data
|
|
1545
|
+
end
|
|
1546
|
+
|
|
1547
|
+
# Get dialer contactList.
|
|
1548
|
+
#
|
|
1549
|
+
# @param contact_list_id ContactList ID
|
|
1550
|
+
# @param [Hash] opts the optional parameters
|
|
1551
|
+
# @option opts [BOOLEAN] :include_import_status Import status
|
|
1552
|
+
# @option opts [BOOLEAN] :import_status Import status
|
|
1553
|
+
# @option opts [BOOLEAN] :include_size Include size
|
|
1554
|
+
# @return [Array<(ContactList, Fixnum, Hash)>] ContactList data, response status code and response headers
|
|
1555
|
+
def get_contactlist_with_http_info(contact_list_id, opts = {})
|
|
1556
|
+
if @api_client.config.debugging
|
|
1557
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_contactlist ..."
|
|
1558
|
+
end
|
|
1559
|
+
|
|
1560
|
+
# verify the required parameter 'contact_list_id' is set
|
|
1561
|
+
fail "Missing the required parameter 'contact_list_id' when calling get_contactlist" if contact_list_id.nil?
|
|
1562
|
+
|
|
1563
|
+
# resource path
|
|
1564
|
+
path = "/api/v1/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
|
|
1565
|
+
|
|
1566
|
+
# query parameters
|
|
1567
|
+
query_params = {}
|
|
1568
|
+
query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
|
|
1569
|
+
query_params[:'importStatus'] = opts[:'import_status'] if opts[:'import_status']
|
|
1570
|
+
query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
|
|
1571
|
+
|
|
1572
|
+
# header parameters
|
|
1573
|
+
header_params = {}
|
|
1574
|
+
|
|
1575
|
+
# HTTP header 'Accept' (if needed)
|
|
1576
|
+
_header_accept = ['application/json']
|
|
1577
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1578
|
+
|
|
1579
|
+
# HTTP header 'Content-Type'
|
|
1580
|
+
_header_content_type = ['application/json']
|
|
1581
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1582
|
+
|
|
1583
|
+
# form parameters
|
|
1584
|
+
form_params = {}
|
|
1585
|
+
|
|
1586
|
+
# http body (model)
|
|
1587
|
+
post_body = nil
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
auth_names = ['PureCloud Auth']
|
|
1591
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1592
|
+
:header_params => header_params,
|
|
1593
|
+
:query_params => query_params,
|
|
1594
|
+
:form_params => form_params,
|
|
1595
|
+
:body => post_body,
|
|
1596
|
+
:auth_names => auth_names,
|
|
1597
|
+
:return_type => 'ContactList')
|
|
1598
|
+
if @api_client.config.debugging
|
|
1599
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1600
|
+
end
|
|
1601
|
+
return data, status_code, headers
|
|
1602
|
+
end
|
|
1603
|
+
|
|
1604
|
+
# Update a contact list.
|
|
1605
|
+
#
|
|
1606
|
+
# @param contact_list_id ContactList ID
|
|
1607
|
+
# @param [Hash] opts the optional parameters
|
|
1608
|
+
# @option opts [ContactList] :body ContactList
|
|
1609
|
+
# @return [ContactList]
|
|
1610
|
+
def put_contactlist(contact_list_id, opts = {})
|
|
1611
|
+
data, status_code, headers = put_contactlist_with_http_info(contact_list_id, opts)
|
|
1612
|
+
return data
|
|
1613
|
+
end
|
|
1614
|
+
|
|
1615
|
+
# Update a contact list.
|
|
1616
|
+
#
|
|
1617
|
+
# @param contact_list_id ContactList ID
|
|
1618
|
+
# @param [Hash] opts the optional parameters
|
|
1619
|
+
# @option opts [ContactList] :body ContactList
|
|
1620
|
+
# @return [Array<(ContactList, Fixnum, Hash)>] ContactList data, response status code and response headers
|
|
1621
|
+
def put_contactlist_with_http_info(contact_list_id, opts = {})
|
|
1622
|
+
if @api_client.config.debugging
|
|
1623
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_contactlist ..."
|
|
1624
|
+
end
|
|
1625
|
+
|
|
1626
|
+
# verify the required parameter 'contact_list_id' is set
|
|
1627
|
+
fail "Missing the required parameter 'contact_list_id' when calling put_contactlist" if contact_list_id.nil?
|
|
1628
|
+
|
|
1629
|
+
# resource path
|
|
1630
|
+
path = "/api/v1/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
|
|
1631
|
+
|
|
1632
|
+
# query parameters
|
|
1633
|
+
query_params = {}
|
|
1634
|
+
|
|
1635
|
+
# header parameters
|
|
1636
|
+
header_params = {}
|
|
1637
|
+
|
|
1638
|
+
# HTTP header 'Accept' (if needed)
|
|
1639
|
+
_header_accept = ['application/json']
|
|
1640
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1641
|
+
|
|
1642
|
+
# HTTP header 'Content-Type'
|
|
1643
|
+
_header_content_type = ['application/json']
|
|
1644
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1645
|
+
|
|
1646
|
+
# form parameters
|
|
1647
|
+
form_params = {}
|
|
1648
|
+
|
|
1649
|
+
# http body (model)
|
|
1650
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
auth_names = ['PureCloud Auth']
|
|
1654
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
1655
|
+
:header_params => header_params,
|
|
1656
|
+
:query_params => query_params,
|
|
1657
|
+
:form_params => form_params,
|
|
1658
|
+
:body => post_body,
|
|
1659
|
+
:auth_names => auth_names,
|
|
1660
|
+
:return_type => 'ContactList')
|
|
1661
|
+
if @api_client.config.debugging
|
|
1662
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1663
|
+
end
|
|
1664
|
+
return data, status_code, headers
|
|
1665
|
+
end
|
|
1666
|
+
|
|
1667
|
+
# Delete a contact list.
|
|
1668
|
+
#
|
|
1669
|
+
# @param contact_list_id ContactList ID
|
|
1670
|
+
# @param [Hash] opts the optional parameters
|
|
1671
|
+
# @return [String]
|
|
1672
|
+
def delete_contactlist(contact_list_id, opts = {})
|
|
1673
|
+
data, status_code, headers = delete_contactlist_with_http_info(contact_list_id, opts)
|
|
1674
|
+
return data
|
|
1675
|
+
end
|
|
1676
|
+
|
|
1677
|
+
# Delete a contact list.
|
|
1678
|
+
#
|
|
1679
|
+
# @param contact_list_id ContactList ID
|
|
1680
|
+
# @param [Hash] opts the optional parameters
|
|
1681
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
1682
|
+
def delete_contactlist_with_http_info(contact_list_id, opts = {})
|
|
1683
|
+
if @api_client.config.debugging
|
|
1684
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_contactlist ..."
|
|
1685
|
+
end
|
|
1686
|
+
|
|
1687
|
+
# verify the required parameter 'contact_list_id' is set
|
|
1688
|
+
fail "Missing the required parameter 'contact_list_id' when calling delete_contactlist" if contact_list_id.nil?
|
|
1689
|
+
|
|
1690
|
+
# resource path
|
|
1691
|
+
path = "/api/v1/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
|
|
1692
|
+
|
|
1693
|
+
# query parameters
|
|
1694
|
+
query_params = {}
|
|
1695
|
+
|
|
1696
|
+
# header parameters
|
|
1697
|
+
header_params = {}
|
|
1698
|
+
|
|
1699
|
+
# HTTP header 'Accept' (if needed)
|
|
1700
|
+
_header_accept = ['application/json']
|
|
1701
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1702
|
+
|
|
1703
|
+
# HTTP header 'Content-Type'
|
|
1704
|
+
_header_content_type = ['application/json']
|
|
1705
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1706
|
+
|
|
1707
|
+
# form parameters
|
|
1708
|
+
form_params = {}
|
|
1709
|
+
|
|
1710
|
+
# http body (model)
|
|
1711
|
+
post_body = nil
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
auth_names = ['PureCloud Auth']
|
|
1715
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
1716
|
+
:header_params => header_params,
|
|
1717
|
+
:query_params => query_params,
|
|
1718
|
+
:form_params => form_params,
|
|
1719
|
+
:body => post_body,
|
|
1720
|
+
:auth_names => auth_names,
|
|
1721
|
+
:return_type => 'String')
|
|
1722
|
+
if @api_client.config.debugging
|
|
1723
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1724
|
+
end
|
|
1725
|
+
return data, status_code, headers
|
|
1726
|
+
end
|
|
1727
|
+
|
|
1728
|
+
# Add contacts to a contact list.
|
|
1729
|
+
#
|
|
1730
|
+
# @param contact_list_id Contact List ID
|
|
1731
|
+
# @param [Hash] opts the optional parameters
|
|
1732
|
+
# @option opts [Array<Contact>] :body Contact
|
|
1733
|
+
# @option opts [BOOLEAN] :priority
|
|
1734
|
+
# @return [Contact]
|
|
1735
|
+
def post_contactlist_contacts(contact_list_id, opts = {})
|
|
1736
|
+
data, status_code, headers = post_contactlist_contacts_with_http_info(contact_list_id, opts)
|
|
1737
|
+
return data
|
|
1738
|
+
end
|
|
1739
|
+
|
|
1740
|
+
# Add contacts to a contact list.
|
|
1741
|
+
#
|
|
1742
|
+
# @param contact_list_id Contact List ID
|
|
1743
|
+
# @param [Hash] opts the optional parameters
|
|
1744
|
+
# @option opts [Array<Contact>] :body Contact
|
|
1745
|
+
# @option opts [BOOLEAN] :priority
|
|
1746
|
+
# @return [Array<(Contact, Fixnum, Hash)>] Contact data, response status code and response headers
|
|
1747
|
+
def post_contactlist_contacts_with_http_info(contact_list_id, opts = {})
|
|
1748
|
+
if @api_client.config.debugging
|
|
1749
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_contactlist_contacts ..."
|
|
1750
|
+
end
|
|
1751
|
+
|
|
1752
|
+
# verify the required parameter 'contact_list_id' is set
|
|
1753
|
+
fail "Missing the required parameter 'contact_list_id' when calling post_contactlist_contacts" if contact_list_id.nil?
|
|
1754
|
+
|
|
1755
|
+
# resource path
|
|
1756
|
+
path = "/api/v1/outbound/contactlists/{contactListId}/contacts".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
|
|
1757
|
+
|
|
1758
|
+
# query parameters
|
|
1759
|
+
query_params = {}
|
|
1760
|
+
query_params[:'priority'] = opts[:'priority'] if opts[:'priority']
|
|
1761
|
+
|
|
1762
|
+
# header parameters
|
|
1763
|
+
header_params = {}
|
|
1764
|
+
|
|
1765
|
+
# HTTP header 'Accept' (if needed)
|
|
1766
|
+
_header_accept = ['application/json']
|
|
1767
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1768
|
+
|
|
1769
|
+
# HTTP header 'Content-Type'
|
|
1770
|
+
_header_content_type = ['application/json']
|
|
1771
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1772
|
+
|
|
1773
|
+
# form parameters
|
|
1774
|
+
form_params = {}
|
|
1775
|
+
|
|
1776
|
+
# http body (model)
|
|
1777
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
auth_names = ['PureCloud Auth']
|
|
1781
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
1782
|
+
:header_params => header_params,
|
|
1783
|
+
:query_params => query_params,
|
|
1784
|
+
:form_params => form_params,
|
|
1785
|
+
:body => post_body,
|
|
1786
|
+
:auth_names => auth_names,
|
|
1787
|
+
:return_type => 'Contact')
|
|
1788
|
+
if @api_client.config.debugging
|
|
1789
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_contactlist_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1790
|
+
end
|
|
1791
|
+
return data, status_code, headers
|
|
1792
|
+
end
|
|
1793
|
+
|
|
1794
|
+
# Get dialer contactList.
|
|
1795
|
+
#
|
|
1796
|
+
# @param contact_list_id Contact List ID
|
|
1797
|
+
# @param contact_id Contact ID
|
|
1798
|
+
# @param [Hash] opts the optional parameters
|
|
1799
|
+
# @return [Contact]
|
|
1800
|
+
def get_contactlist_contact(contact_list_id, contact_id, opts = {})
|
|
1801
|
+
data, status_code, headers = get_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
|
|
1802
|
+
return data
|
|
1803
|
+
end
|
|
1804
|
+
|
|
1805
|
+
# Get dialer contactList.
|
|
1806
|
+
#
|
|
1807
|
+
# @param contact_list_id Contact List ID
|
|
1808
|
+
# @param contact_id Contact ID
|
|
1809
|
+
# @param [Hash] opts the optional parameters
|
|
1810
|
+
# @return [Array<(Contact, Fixnum, Hash)>] Contact data, response status code and response headers
|
|
1811
|
+
def get_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {})
|
|
1812
|
+
if @api_client.config.debugging
|
|
1813
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_contactlist_contact ..."
|
|
1814
|
+
end
|
|
1815
|
+
|
|
1816
|
+
# verify the required parameter 'contact_list_id' is set
|
|
1817
|
+
fail "Missing the required parameter 'contact_list_id' when calling get_contactlist_contact" if contact_list_id.nil?
|
|
1818
|
+
|
|
1819
|
+
# verify the required parameter 'contact_id' is set
|
|
1820
|
+
fail "Missing the required parameter 'contact_id' when calling get_contactlist_contact" if contact_id.nil?
|
|
1821
|
+
|
|
1822
|
+
# resource path
|
|
1823
|
+
path = "/api/v1/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)
|
|
1824
|
+
|
|
1825
|
+
# query parameters
|
|
1826
|
+
query_params = {}
|
|
1827
|
+
|
|
1828
|
+
# header parameters
|
|
1829
|
+
header_params = {}
|
|
1830
|
+
|
|
1831
|
+
# HTTP header 'Accept' (if needed)
|
|
1832
|
+
_header_accept = ['application/json']
|
|
1833
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1834
|
+
|
|
1835
|
+
# HTTP header 'Content-Type'
|
|
1836
|
+
_header_content_type = ['application/json']
|
|
1837
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1838
|
+
|
|
1839
|
+
# form parameters
|
|
1840
|
+
form_params = {}
|
|
1841
|
+
|
|
1842
|
+
# http body (model)
|
|
1843
|
+
post_body = nil
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
auth_names = ['PureCloud Auth']
|
|
1847
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1848
|
+
:header_params => header_params,
|
|
1849
|
+
:query_params => query_params,
|
|
1850
|
+
:form_params => form_params,
|
|
1851
|
+
:body => post_body,
|
|
1852
|
+
:auth_names => auth_names,
|
|
1853
|
+
:return_type => 'Contact')
|
|
1854
|
+
if @api_client.config.debugging
|
|
1855
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1856
|
+
end
|
|
1857
|
+
return data, status_code, headers
|
|
1858
|
+
end
|
|
1859
|
+
|
|
1860
|
+
# Update a contact.
|
|
1861
|
+
#
|
|
1862
|
+
# @param contact_list_id Contact List ID
|
|
1863
|
+
# @param contact_id Contact ID
|
|
1864
|
+
# @param [Hash] opts the optional parameters
|
|
1865
|
+
# @option opts [Contact] :body Contact
|
|
1866
|
+
# @return [Contact]
|
|
1867
|
+
def put_contactlist_contact(contact_list_id, contact_id, opts = {})
|
|
1868
|
+
data, status_code, headers = put_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
|
|
1869
|
+
return data
|
|
1870
|
+
end
|
|
1871
|
+
|
|
1872
|
+
# Update a contact.
|
|
1873
|
+
#
|
|
1874
|
+
# @param contact_list_id Contact List ID
|
|
1875
|
+
# @param contact_id Contact ID
|
|
1876
|
+
# @param [Hash] opts the optional parameters
|
|
1877
|
+
# @option opts [Contact] :body Contact
|
|
1878
|
+
# @return [Array<(Contact, Fixnum, Hash)>] Contact data, response status code and response headers
|
|
1879
|
+
def put_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {})
|
|
1880
|
+
if @api_client.config.debugging
|
|
1881
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_contactlist_contact ..."
|
|
1882
|
+
end
|
|
1883
|
+
|
|
1884
|
+
# verify the required parameter 'contact_list_id' is set
|
|
1885
|
+
fail "Missing the required parameter 'contact_list_id' when calling put_contactlist_contact" if contact_list_id.nil?
|
|
1886
|
+
|
|
1887
|
+
# verify the required parameter 'contact_id' is set
|
|
1888
|
+
fail "Missing the required parameter 'contact_id' when calling put_contactlist_contact" if contact_id.nil?
|
|
1889
|
+
|
|
1890
|
+
# resource path
|
|
1891
|
+
path = "/api/v1/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)
|
|
1892
|
+
|
|
1893
|
+
# query parameters
|
|
1894
|
+
query_params = {}
|
|
1895
|
+
|
|
1896
|
+
# header parameters
|
|
1897
|
+
header_params = {}
|
|
1898
|
+
|
|
1899
|
+
# HTTP header 'Accept' (if needed)
|
|
1900
|
+
_header_accept = ['application/json']
|
|
1901
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1902
|
+
|
|
1903
|
+
# HTTP header 'Content-Type'
|
|
1904
|
+
_header_content_type = ['application/json']
|
|
1905
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1906
|
+
|
|
1907
|
+
# form parameters
|
|
1908
|
+
form_params = {}
|
|
1909
|
+
|
|
1910
|
+
# http body (model)
|
|
1911
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
auth_names = ['PureCloud Auth']
|
|
1915
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
1916
|
+
:header_params => header_params,
|
|
1917
|
+
:query_params => query_params,
|
|
1918
|
+
:form_params => form_params,
|
|
1919
|
+
:body => post_body,
|
|
1920
|
+
:auth_names => auth_names,
|
|
1921
|
+
:return_type => 'Contact')
|
|
1922
|
+
if @api_client.config.debugging
|
|
1923
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1924
|
+
end
|
|
1925
|
+
return data, status_code, headers
|
|
1926
|
+
end
|
|
1927
|
+
|
|
1928
|
+
# Delete a contact.
|
|
1929
|
+
#
|
|
1930
|
+
# @param contact_list_id Contact List ID
|
|
1931
|
+
# @param contact_id Contact ID
|
|
1932
|
+
# @param [Hash] opts the optional parameters
|
|
1933
|
+
# @return [String]
|
|
1934
|
+
def delete_contactlist_contact(contact_list_id, contact_id, opts = {})
|
|
1935
|
+
data, status_code, headers = delete_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
|
|
1936
|
+
return data
|
|
1937
|
+
end
|
|
1938
|
+
|
|
1939
|
+
# Delete a contact.
|
|
1940
|
+
#
|
|
1941
|
+
# @param contact_list_id Contact List ID
|
|
1942
|
+
# @param contact_id Contact ID
|
|
1943
|
+
# @param [Hash] opts the optional parameters
|
|
1944
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
1945
|
+
def delete_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {})
|
|
1946
|
+
if @api_client.config.debugging
|
|
1947
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_contactlist_contact ..."
|
|
1948
|
+
end
|
|
1949
|
+
|
|
1950
|
+
# verify the required parameter 'contact_list_id' is set
|
|
1951
|
+
fail "Missing the required parameter 'contact_list_id' when calling delete_contactlist_contact" if contact_list_id.nil?
|
|
1952
|
+
|
|
1953
|
+
# verify the required parameter 'contact_id' is set
|
|
1954
|
+
fail "Missing the required parameter 'contact_id' when calling delete_contactlist_contact" if contact_id.nil?
|
|
1955
|
+
|
|
1956
|
+
# resource path
|
|
1957
|
+
path = "/api/v1/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)
|
|
1958
|
+
|
|
1959
|
+
# query parameters
|
|
1960
|
+
query_params = {}
|
|
1961
|
+
|
|
1962
|
+
# header parameters
|
|
1963
|
+
header_params = {}
|
|
1964
|
+
|
|
1965
|
+
# HTTP header 'Accept' (if needed)
|
|
1966
|
+
_header_accept = ['application/json']
|
|
1967
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1968
|
+
|
|
1969
|
+
# HTTP header 'Content-Type'
|
|
1970
|
+
_header_content_type = ['application/json']
|
|
1971
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1972
|
+
|
|
1973
|
+
# form parameters
|
|
1974
|
+
form_params = {}
|
|
1975
|
+
|
|
1976
|
+
# http body (model)
|
|
1977
|
+
post_body = nil
|
|
1978
|
+
|
|
1979
|
+
|
|
1980
|
+
auth_names = ['PureCloud Auth']
|
|
1981
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
1982
|
+
:header_params => header_params,
|
|
1983
|
+
:query_params => query_params,
|
|
1984
|
+
:form_params => form_params,
|
|
1985
|
+
:body => post_body,
|
|
1986
|
+
:auth_names => auth_names,
|
|
1987
|
+
:return_type => 'String')
|
|
1988
|
+
if @api_client.config.debugging
|
|
1989
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1990
|
+
end
|
|
1991
|
+
return data, status_code, headers
|
|
1992
|
+
end
|
|
1993
|
+
|
|
1994
|
+
# Initiate the export of a contact list.
|
|
1995
|
+
# Returns 200 if received OK.
|
|
1996
|
+
# @param contact_list_id ContactList ID
|
|
1997
|
+
# @param [Hash] opts the optional parameters
|
|
1998
|
+
# @return [String]
|
|
1999
|
+
def post_contactlist_export(contact_list_id, opts = {})
|
|
2000
|
+
data, status_code, headers = post_contactlist_export_with_http_info(contact_list_id, opts)
|
|
2001
|
+
return data
|
|
2002
|
+
end
|
|
2003
|
+
|
|
2004
|
+
# Initiate the export of a contact list.
|
|
2005
|
+
# Returns 200 if received OK.
|
|
2006
|
+
# @param contact_list_id ContactList ID
|
|
2007
|
+
# @param [Hash] opts the optional parameters
|
|
2008
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
2009
|
+
def post_contactlist_export_with_http_info(contact_list_id, opts = {})
|
|
2010
|
+
if @api_client.config.debugging
|
|
2011
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_contactlist_export ..."
|
|
2012
|
+
end
|
|
2013
|
+
|
|
2014
|
+
# verify the required parameter 'contact_list_id' is set
|
|
2015
|
+
fail "Missing the required parameter 'contact_list_id' when calling post_contactlist_export" if contact_list_id.nil?
|
|
2016
|
+
|
|
2017
|
+
# resource path
|
|
2018
|
+
path = "/api/v1/outbound/contactlists/{contactListId}/export".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
|
|
2019
|
+
|
|
2020
|
+
# query parameters
|
|
2021
|
+
query_params = {}
|
|
2022
|
+
|
|
2023
|
+
# header parameters
|
|
2024
|
+
header_params = {}
|
|
2025
|
+
|
|
2026
|
+
# HTTP header 'Accept' (if needed)
|
|
2027
|
+
_header_accept = ['application/json']
|
|
2028
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2029
|
+
|
|
2030
|
+
# HTTP header 'Content-Type'
|
|
2031
|
+
_header_content_type = ['application/json']
|
|
2032
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2033
|
+
|
|
2034
|
+
# form parameters
|
|
2035
|
+
form_params = {}
|
|
2036
|
+
|
|
2037
|
+
# http body (model)
|
|
2038
|
+
post_body = nil
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
auth_names = ['PureCloud Auth']
|
|
2042
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
2043
|
+
:header_params => header_params,
|
|
2044
|
+
:query_params => query_params,
|
|
2045
|
+
:form_params => form_params,
|
|
2046
|
+
:body => post_body,
|
|
2047
|
+
:auth_names => auth_names,
|
|
2048
|
+
:return_type => 'String')
|
|
2049
|
+
if @api_client.config.debugging
|
|
2050
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_contactlist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2051
|
+
end
|
|
2052
|
+
return data, status_code, headers
|
|
2053
|
+
end
|
|
2054
|
+
|
|
2055
|
+
# Get dialer contactList import status.
|
|
2056
|
+
#
|
|
2057
|
+
# @param contact_list_id ContactList ID
|
|
2058
|
+
# @param [Hash] opts the optional parameters
|
|
2059
|
+
# @return [ImportStatus]
|
|
2060
|
+
def get_contactlist_importstatus(contact_list_id, opts = {})
|
|
2061
|
+
data, status_code, headers = get_contactlist_importstatus_with_http_info(contact_list_id, opts)
|
|
2062
|
+
return data
|
|
2063
|
+
end
|
|
2064
|
+
|
|
2065
|
+
# Get dialer contactList import status.
|
|
2066
|
+
#
|
|
2067
|
+
# @param contact_list_id ContactList ID
|
|
2068
|
+
# @param [Hash] opts the optional parameters
|
|
2069
|
+
# @return [Array<(ImportStatus, Fixnum, Hash)>] ImportStatus data, response status code and response headers
|
|
2070
|
+
def get_contactlist_importstatus_with_http_info(contact_list_id, opts = {})
|
|
2071
|
+
if @api_client.config.debugging
|
|
2072
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_contactlist_importstatus ..."
|
|
2073
|
+
end
|
|
2074
|
+
|
|
2075
|
+
# verify the required parameter 'contact_list_id' is set
|
|
2076
|
+
fail "Missing the required parameter 'contact_list_id' when calling get_contactlist_importstatus" if contact_list_id.nil?
|
|
2077
|
+
|
|
2078
|
+
# resource path
|
|
2079
|
+
path = "/api/v1/outbound/contactlists/{contactListId}/importstatus".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
|
|
2080
|
+
|
|
2081
|
+
# query parameters
|
|
2082
|
+
query_params = {}
|
|
2083
|
+
|
|
2084
|
+
# header parameters
|
|
2085
|
+
header_params = {}
|
|
2086
|
+
|
|
2087
|
+
# HTTP header 'Accept' (if needed)
|
|
2088
|
+
_header_accept = ['application/json']
|
|
2089
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2090
|
+
|
|
2091
|
+
# HTTP header 'Content-Type'
|
|
2092
|
+
_header_content_type = ['application/json']
|
|
2093
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2094
|
+
|
|
2095
|
+
# form parameters
|
|
2096
|
+
form_params = {}
|
|
2097
|
+
|
|
2098
|
+
# http body (model)
|
|
2099
|
+
post_body = nil
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
auth_names = ['PureCloud Auth']
|
|
2103
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
2104
|
+
:header_params => header_params,
|
|
2105
|
+
:query_params => query_params,
|
|
2106
|
+
:form_params => form_params,
|
|
2107
|
+
:body => post_body,
|
|
2108
|
+
:auth_names => auth_names,
|
|
2109
|
+
:return_type => 'ImportStatus')
|
|
2110
|
+
if @api_client.config.debugging
|
|
2111
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_contactlist_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2112
|
+
end
|
|
2113
|
+
return data, status_code, headers
|
|
2114
|
+
end
|
|
2115
|
+
|
|
2116
|
+
# Get Dialer campaign's penetration rate
|
|
2117
|
+
# Get dialer campaign's penetration rate.
|
|
2118
|
+
# @param contact_list_id ContactList ID
|
|
2119
|
+
# @param campaign_id Campaign ID
|
|
2120
|
+
# @param [Hash] opts the optional parameters
|
|
2121
|
+
# @return [PenetrationRate]
|
|
2122
|
+
def get_contactlist_penetrationrate(contact_list_id, campaign_id, opts = {})
|
|
2123
|
+
data, status_code, headers = get_contactlist_penetrationrate_with_http_info(contact_list_id, campaign_id, opts)
|
|
2124
|
+
return data
|
|
2125
|
+
end
|
|
2126
|
+
|
|
2127
|
+
# Get Dialer campaign's penetration rate
|
|
2128
|
+
# Get dialer campaign's penetration rate.
|
|
2129
|
+
# @param contact_list_id ContactList ID
|
|
2130
|
+
# @param campaign_id Campaign ID
|
|
2131
|
+
# @param [Hash] opts the optional parameters
|
|
2132
|
+
# @return [Array<(PenetrationRate, Fixnum, Hash)>] PenetrationRate data, response status code and response headers
|
|
2133
|
+
def get_contactlist_penetrationrate_with_http_info(contact_list_id, campaign_id, opts = {})
|
|
2134
|
+
if @api_client.config.debugging
|
|
2135
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_contactlist_penetrationrate ..."
|
|
2136
|
+
end
|
|
2137
|
+
|
|
2138
|
+
# verify the required parameter 'contact_list_id' is set
|
|
2139
|
+
fail "Missing the required parameter 'contact_list_id' when calling get_contactlist_penetrationrate" if contact_list_id.nil?
|
|
2140
|
+
|
|
2141
|
+
# verify the required parameter 'campaign_id' is set
|
|
2142
|
+
fail "Missing the required parameter 'campaign_id' when calling get_contactlist_penetrationrate" if campaign_id.nil?
|
|
2143
|
+
|
|
2144
|
+
# resource path
|
|
2145
|
+
path = "/api/v1/outbound/contactlists/{contactListId}/{campaignId}/penetrationrate".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
2146
|
+
|
|
2147
|
+
# query parameters
|
|
2148
|
+
query_params = {}
|
|
2149
|
+
|
|
2150
|
+
# header parameters
|
|
2151
|
+
header_params = {}
|
|
2152
|
+
|
|
2153
|
+
# HTTP header 'Accept' (if needed)
|
|
2154
|
+
_header_accept = ['application/json']
|
|
2155
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2156
|
+
|
|
2157
|
+
# HTTP header 'Content-Type'
|
|
2158
|
+
_header_content_type = ['application/json']
|
|
2159
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2160
|
+
|
|
2161
|
+
# form parameters
|
|
2162
|
+
form_params = {}
|
|
2163
|
+
|
|
2164
|
+
# http body (model)
|
|
2165
|
+
post_body = nil
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
auth_names = ['PureCloud Auth']
|
|
2169
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
2170
|
+
:header_params => header_params,
|
|
2171
|
+
:query_params => query_params,
|
|
2172
|
+
:form_params => form_params,
|
|
2173
|
+
:body => post_body,
|
|
2174
|
+
:auth_names => auth_names,
|
|
2175
|
+
:return_type => 'PenetrationRate')
|
|
2176
|
+
if @api_client.config.debugging
|
|
2177
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_contactlist_penetrationrate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2178
|
+
end
|
|
2179
|
+
return data, status_code, headers
|
|
2180
|
+
end
|
|
2181
|
+
|
|
2182
|
+
# Add phone numbers to a Dialer DNC list.
|
|
2183
|
+
#
|
|
2184
|
+
# @param conversation_id Conversation ID
|
|
2185
|
+
# @param [Hash] opts the optional parameters
|
|
2186
|
+
# @return [nil]
|
|
2187
|
+
def post_conversation_dnc(conversation_id, opts = {})
|
|
2188
|
+
post_conversation_dnc_with_http_info(conversation_id, opts)
|
|
2189
|
+
return nil
|
|
2190
|
+
end
|
|
2191
|
+
|
|
2192
|
+
# Add phone numbers to a Dialer DNC list.
|
|
2193
|
+
#
|
|
2194
|
+
# @param conversation_id Conversation ID
|
|
2195
|
+
# @param [Hash] opts the optional parameters
|
|
2196
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
2197
|
+
def post_conversation_dnc_with_http_info(conversation_id, opts = {})
|
|
2198
|
+
if @api_client.config.debugging
|
|
2199
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_conversation_dnc ..."
|
|
2200
|
+
end
|
|
2201
|
+
|
|
2202
|
+
# verify the required parameter 'conversation_id' is set
|
|
2203
|
+
fail "Missing the required parameter 'conversation_id' when calling post_conversation_dnc" if conversation_id.nil?
|
|
2204
|
+
|
|
2205
|
+
# resource path
|
|
2206
|
+
path = "/api/v1/outbound/conversations/{conversationId}/dnc".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
2207
|
+
|
|
2208
|
+
# query parameters
|
|
2209
|
+
query_params = {}
|
|
2210
|
+
|
|
2211
|
+
# header parameters
|
|
2212
|
+
header_params = {}
|
|
2213
|
+
|
|
2214
|
+
# HTTP header 'Accept' (if needed)
|
|
2215
|
+
_header_accept = ['application/json']
|
|
2216
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2217
|
+
|
|
2218
|
+
# HTTP header 'Content-Type'
|
|
2219
|
+
_header_content_type = ['application/json']
|
|
2220
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2221
|
+
|
|
2222
|
+
# form parameters
|
|
2223
|
+
form_params = {}
|
|
2224
|
+
|
|
2225
|
+
# http body (model)
|
|
2226
|
+
post_body = nil
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
auth_names = ['PureCloud Auth']
|
|
2230
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
2231
|
+
:header_params => header_params,
|
|
2232
|
+
:query_params => query_params,
|
|
2233
|
+
:form_params => form_params,
|
|
2234
|
+
:body => post_body,
|
|
2235
|
+
:auth_names => auth_names)
|
|
2236
|
+
if @api_client.config.debugging
|
|
2237
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_conversation_dnc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2238
|
+
end
|
|
2239
|
+
return data, status_code, headers
|
|
2240
|
+
end
|
|
2241
|
+
|
|
2242
|
+
# Query dialer DNC lists
|
|
2243
|
+
#
|
|
2244
|
+
# @param [Hash] opts the optional parameters
|
|
2245
|
+
# @option opts [BOOLEAN] :include_import_status Import status
|
|
2246
|
+
# @option opts [BOOLEAN] :import_status Import status
|
|
2247
|
+
# @option opts [BOOLEAN] :include_size Include size
|
|
2248
|
+
# @option opts [Integer] :page_size Page size
|
|
2249
|
+
# @option opts [Integer] :page_number Page number
|
|
2250
|
+
# @option opts [String] :filter_type Filter type
|
|
2251
|
+
# @option opts [String] :name Name
|
|
2252
|
+
# @option opts [String] :sort_by Sort by
|
|
2253
|
+
# @option opts [String] :sort_order Sort order
|
|
2254
|
+
# @return [DncListEntityListing]
|
|
2255
|
+
def get_dnclists(opts = {})
|
|
2256
|
+
data, status_code, headers = get_dnclists_with_http_info(opts)
|
|
2257
|
+
return data
|
|
2258
|
+
end
|
|
2259
|
+
|
|
2260
|
+
# Query dialer DNC lists
|
|
2261
|
+
#
|
|
2262
|
+
# @param [Hash] opts the optional parameters
|
|
2263
|
+
# @option opts [BOOLEAN] :include_import_status Import status
|
|
2264
|
+
# @option opts [BOOLEAN] :import_status Import status
|
|
2265
|
+
# @option opts [BOOLEAN] :include_size Include size
|
|
2266
|
+
# @option opts [Integer] :page_size Page size
|
|
2267
|
+
# @option opts [Integer] :page_number Page number
|
|
2268
|
+
# @option opts [String] :filter_type Filter type
|
|
2269
|
+
# @option opts [String] :name Name
|
|
2270
|
+
# @option opts [String] :sort_by Sort by
|
|
2271
|
+
# @option opts [String] :sort_order Sort order
|
|
2272
|
+
# @return [Array<(DncListEntityListing, Fixnum, Hash)>] DncListEntityListing data, response status code and response headers
|
|
2273
|
+
def get_dnclists_with_http_info(opts = {})
|
|
2274
|
+
if @api_client.config.debugging
|
|
2275
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_dnclists ..."
|
|
2276
|
+
end
|
|
2277
|
+
|
|
2278
|
+
if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
|
|
2279
|
+
fail 'invalid value for "filter_type", must be one of EQUALS, REGEX, CONTAINS, PREFIX, LESSTHAN, LESSTHANEQUALTO, GREATERTHAN, GREATERTHANEQUALTO, BEGINSWITH, ENDSWITH'
|
|
2280
|
+
end
|
|
2281
|
+
|
|
2282
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
2283
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
2284
|
+
end
|
|
2285
|
+
|
|
2286
|
+
# resource path
|
|
2287
|
+
path = "/api/v1/outbound/dnclists".sub('{format}','json')
|
|
2288
|
+
|
|
2289
|
+
# query parameters
|
|
2290
|
+
query_params = {}
|
|
2291
|
+
query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
|
|
2292
|
+
query_params[:'importStatus'] = opts[:'import_status'] if opts[:'import_status']
|
|
2293
|
+
query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
|
|
2294
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
2295
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
2296
|
+
query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
|
|
2297
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
2298
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
2299
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
2300
|
+
|
|
2301
|
+
# header parameters
|
|
2302
|
+
header_params = {}
|
|
2303
|
+
|
|
2304
|
+
# HTTP header 'Accept' (if needed)
|
|
2305
|
+
_header_accept = ['application/json']
|
|
2306
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2307
|
+
|
|
2308
|
+
# HTTP header 'Content-Type'
|
|
2309
|
+
_header_content_type = ['application/json']
|
|
2310
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2311
|
+
|
|
2312
|
+
# form parameters
|
|
2313
|
+
form_params = {}
|
|
2314
|
+
|
|
2315
|
+
# http body (model)
|
|
2316
|
+
post_body = nil
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
auth_names = ['PureCloud Auth']
|
|
2320
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
2321
|
+
:header_params => header_params,
|
|
2322
|
+
:query_params => query_params,
|
|
2323
|
+
:form_params => form_params,
|
|
2324
|
+
:body => post_body,
|
|
2325
|
+
:auth_names => auth_names,
|
|
2326
|
+
:return_type => 'DncListEntityListing')
|
|
2327
|
+
if @api_client.config.debugging
|
|
2328
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2329
|
+
end
|
|
2330
|
+
return data, status_code, headers
|
|
2331
|
+
end
|
|
2332
|
+
|
|
2333
|
+
# Create dialer DNC list
|
|
2334
|
+
#
|
|
2335
|
+
# @param [Hash] opts the optional parameters
|
|
2336
|
+
# @option opts [DncList] :body DncList
|
|
2337
|
+
# @return [DncList]
|
|
2338
|
+
def post_dnclists(opts = {})
|
|
2339
|
+
data, status_code, headers = post_dnclists_with_http_info(opts)
|
|
2340
|
+
return data
|
|
2341
|
+
end
|
|
2342
|
+
|
|
2343
|
+
# Create dialer DNC list
|
|
2344
|
+
#
|
|
2345
|
+
# @param [Hash] opts the optional parameters
|
|
2346
|
+
# @option opts [DncList] :body DncList
|
|
2347
|
+
# @return [Array<(DncList, Fixnum, Hash)>] DncList data, response status code and response headers
|
|
2348
|
+
def post_dnclists_with_http_info(opts = {})
|
|
2349
|
+
if @api_client.config.debugging
|
|
2350
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_dnclists ..."
|
|
2351
|
+
end
|
|
2352
|
+
|
|
2353
|
+
# resource path
|
|
2354
|
+
path = "/api/v1/outbound/dnclists".sub('{format}','json')
|
|
2355
|
+
|
|
2356
|
+
# query parameters
|
|
2357
|
+
query_params = {}
|
|
2358
|
+
|
|
2359
|
+
# header parameters
|
|
2360
|
+
header_params = {}
|
|
2361
|
+
|
|
2362
|
+
# HTTP header 'Accept' (if needed)
|
|
2363
|
+
_header_accept = ['application/json']
|
|
2364
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2365
|
+
|
|
2366
|
+
# HTTP header 'Content-Type'
|
|
2367
|
+
_header_content_type = ['application/json']
|
|
2368
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2369
|
+
|
|
2370
|
+
# form parameters
|
|
2371
|
+
form_params = {}
|
|
2372
|
+
|
|
2373
|
+
# http body (model)
|
|
2374
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
2375
|
+
|
|
2376
|
+
|
|
2377
|
+
auth_names = ['PureCloud Auth']
|
|
2378
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
2379
|
+
:header_params => header_params,
|
|
2380
|
+
:query_params => query_params,
|
|
2381
|
+
:form_params => form_params,
|
|
2382
|
+
:body => post_body,
|
|
2383
|
+
:auth_names => auth_names,
|
|
2384
|
+
:return_type => 'DncList')
|
|
2385
|
+
if @api_client.config.debugging
|
|
2386
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2387
|
+
end
|
|
2388
|
+
return data, status_code, headers
|
|
2389
|
+
end
|
|
2390
|
+
|
|
2391
|
+
# Get dialer DNC list
|
|
2392
|
+
#
|
|
2393
|
+
# @param dnc_list_id DncList ID
|
|
2394
|
+
# @param [Hash] opts the optional parameters
|
|
2395
|
+
# @option opts [BOOLEAN] :include_import_status Import status
|
|
2396
|
+
# @option opts [BOOLEAN] :import_status Import status
|
|
2397
|
+
# @option opts [BOOLEAN] :include_size Include size
|
|
2398
|
+
# @return [DncList]
|
|
2399
|
+
def get_dnclist(dnc_list_id, opts = {})
|
|
2400
|
+
data, status_code, headers = get_dnclist_with_http_info(dnc_list_id, opts)
|
|
2401
|
+
return data
|
|
2402
|
+
end
|
|
2403
|
+
|
|
2404
|
+
# Get dialer DNC list
|
|
2405
|
+
#
|
|
2406
|
+
# @param dnc_list_id DncList ID
|
|
2407
|
+
# @param [Hash] opts the optional parameters
|
|
2408
|
+
# @option opts [BOOLEAN] :include_import_status Import status
|
|
2409
|
+
# @option opts [BOOLEAN] :import_status Import status
|
|
2410
|
+
# @option opts [BOOLEAN] :include_size Include size
|
|
2411
|
+
# @return [Array<(DncList, Fixnum, Hash)>] DncList data, response status code and response headers
|
|
2412
|
+
def get_dnclist_with_http_info(dnc_list_id, opts = {})
|
|
2413
|
+
if @api_client.config.debugging
|
|
2414
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_dnclist ..."
|
|
2415
|
+
end
|
|
2416
|
+
|
|
2417
|
+
# verify the required parameter 'dnc_list_id' is set
|
|
2418
|
+
fail "Missing the required parameter 'dnc_list_id' when calling get_dnclist" if dnc_list_id.nil?
|
|
2419
|
+
|
|
2420
|
+
# resource path
|
|
2421
|
+
path = "/api/v1/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)
|
|
2422
|
+
|
|
2423
|
+
# query parameters
|
|
2424
|
+
query_params = {}
|
|
2425
|
+
query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
|
|
2426
|
+
query_params[:'importStatus'] = opts[:'import_status'] if opts[:'import_status']
|
|
2427
|
+
query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
|
|
2428
|
+
|
|
2429
|
+
# header parameters
|
|
2430
|
+
header_params = {}
|
|
2431
|
+
|
|
2432
|
+
# HTTP header 'Accept' (if needed)
|
|
2433
|
+
_header_accept = ['application/json']
|
|
2434
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2435
|
+
|
|
2436
|
+
# HTTP header 'Content-Type'
|
|
2437
|
+
_header_content_type = ['application/json']
|
|
2438
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2439
|
+
|
|
2440
|
+
# form parameters
|
|
2441
|
+
form_params = {}
|
|
2442
|
+
|
|
2443
|
+
# http body (model)
|
|
2444
|
+
post_body = nil
|
|
2445
|
+
|
|
2446
|
+
|
|
2447
|
+
auth_names = ['PureCloud Auth']
|
|
2448
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
2449
|
+
:header_params => header_params,
|
|
2450
|
+
:query_params => query_params,
|
|
2451
|
+
:form_params => form_params,
|
|
2452
|
+
:body => post_body,
|
|
2453
|
+
:auth_names => auth_names,
|
|
2454
|
+
:return_type => 'DncList')
|
|
2455
|
+
if @api_client.config.debugging
|
|
2456
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2457
|
+
end
|
|
2458
|
+
return data, status_code, headers
|
|
2459
|
+
end
|
|
2460
|
+
|
|
2461
|
+
# Update dialer DNC list
|
|
2462
|
+
#
|
|
2463
|
+
# @param dnc_list_id DncList ID
|
|
2464
|
+
# @param [Hash] opts the optional parameters
|
|
2465
|
+
# @option opts [DncList] :body DncList
|
|
2466
|
+
# @return [DncList]
|
|
2467
|
+
def put_dnclist(dnc_list_id, opts = {})
|
|
2468
|
+
data, status_code, headers = put_dnclist_with_http_info(dnc_list_id, opts)
|
|
2469
|
+
return data
|
|
2470
|
+
end
|
|
2471
|
+
|
|
2472
|
+
# Update dialer DNC list
|
|
2473
|
+
#
|
|
2474
|
+
# @param dnc_list_id DncList ID
|
|
2475
|
+
# @param [Hash] opts the optional parameters
|
|
2476
|
+
# @option opts [DncList] :body DncList
|
|
2477
|
+
# @return [Array<(DncList, Fixnum, Hash)>] DncList data, response status code and response headers
|
|
2478
|
+
def put_dnclist_with_http_info(dnc_list_id, opts = {})
|
|
2479
|
+
if @api_client.config.debugging
|
|
2480
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_dnclist ..."
|
|
2481
|
+
end
|
|
2482
|
+
|
|
2483
|
+
# verify the required parameter 'dnc_list_id' is set
|
|
2484
|
+
fail "Missing the required parameter 'dnc_list_id' when calling put_dnclist" if dnc_list_id.nil?
|
|
2485
|
+
|
|
2486
|
+
# resource path
|
|
2487
|
+
path = "/api/v1/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)
|
|
2488
|
+
|
|
2489
|
+
# query parameters
|
|
2490
|
+
query_params = {}
|
|
2491
|
+
|
|
2492
|
+
# header parameters
|
|
2493
|
+
header_params = {}
|
|
2494
|
+
|
|
2495
|
+
# HTTP header 'Accept' (if needed)
|
|
2496
|
+
_header_accept = ['application/json']
|
|
2497
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2498
|
+
|
|
2499
|
+
# HTTP header 'Content-Type'
|
|
2500
|
+
_header_content_type = ['application/json']
|
|
2501
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2502
|
+
|
|
2503
|
+
# form parameters
|
|
2504
|
+
form_params = {}
|
|
2505
|
+
|
|
2506
|
+
# http body (model)
|
|
2507
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
auth_names = ['PureCloud Auth']
|
|
2511
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
2512
|
+
:header_params => header_params,
|
|
2513
|
+
:query_params => query_params,
|
|
2514
|
+
:form_params => form_params,
|
|
2515
|
+
:body => post_body,
|
|
2516
|
+
:auth_names => auth_names,
|
|
2517
|
+
:return_type => 'DncList')
|
|
2518
|
+
if @api_client.config.debugging
|
|
2519
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2520
|
+
end
|
|
2521
|
+
return data, status_code, headers
|
|
2522
|
+
end
|
|
2523
|
+
|
|
2524
|
+
# Delete dialer DNC list
|
|
2525
|
+
#
|
|
2526
|
+
# @param dnc_list_id DncList ID
|
|
2527
|
+
# @param [Hash] opts the optional parameters
|
|
2528
|
+
# @return [String]
|
|
2529
|
+
def delete_dnclist(dnc_list_id, opts = {})
|
|
2530
|
+
data, status_code, headers = delete_dnclist_with_http_info(dnc_list_id, opts)
|
|
2531
|
+
return data
|
|
2532
|
+
end
|
|
2533
|
+
|
|
2534
|
+
# Delete dialer DNC list
|
|
2535
|
+
#
|
|
2536
|
+
# @param dnc_list_id DncList ID
|
|
2537
|
+
# @param [Hash] opts the optional parameters
|
|
2538
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
2539
|
+
def delete_dnclist_with_http_info(dnc_list_id, opts = {})
|
|
2540
|
+
if @api_client.config.debugging
|
|
2541
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_dnclist ..."
|
|
2542
|
+
end
|
|
2543
|
+
|
|
2544
|
+
# verify the required parameter 'dnc_list_id' is set
|
|
2545
|
+
fail "Missing the required parameter 'dnc_list_id' when calling delete_dnclist" if dnc_list_id.nil?
|
|
2546
|
+
|
|
2547
|
+
# resource path
|
|
2548
|
+
path = "/api/v1/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)
|
|
2549
|
+
|
|
2550
|
+
# query parameters
|
|
2551
|
+
query_params = {}
|
|
2552
|
+
|
|
2553
|
+
# header parameters
|
|
2554
|
+
header_params = {}
|
|
2555
|
+
|
|
2556
|
+
# HTTP header 'Accept' (if needed)
|
|
2557
|
+
_header_accept = ['application/json']
|
|
2558
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2559
|
+
|
|
2560
|
+
# HTTP header 'Content-Type'
|
|
2561
|
+
_header_content_type = ['application/json']
|
|
2562
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2563
|
+
|
|
2564
|
+
# form parameters
|
|
2565
|
+
form_params = {}
|
|
2566
|
+
|
|
2567
|
+
# http body (model)
|
|
2568
|
+
post_body = nil
|
|
2569
|
+
|
|
2570
|
+
|
|
2571
|
+
auth_names = ['PureCloud Auth']
|
|
2572
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
2573
|
+
:header_params => header_params,
|
|
2574
|
+
:query_params => query_params,
|
|
2575
|
+
:form_params => form_params,
|
|
2576
|
+
:body => post_body,
|
|
2577
|
+
:auth_names => auth_names,
|
|
2578
|
+
:return_type => 'String')
|
|
2579
|
+
if @api_client.config.debugging
|
|
2580
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2581
|
+
end
|
|
2582
|
+
return data, status_code, headers
|
|
2583
|
+
end
|
|
2584
|
+
|
|
2585
|
+
# Initiate the export of a dnc list.
|
|
2586
|
+
# Returns 200 if received OK.
|
|
2587
|
+
# @param dnc_list_id DncList ID
|
|
2588
|
+
# @param [Hash] opts the optional parameters
|
|
2589
|
+
# @return [String]
|
|
2590
|
+
def post_dnclist_export(dnc_list_id, opts = {})
|
|
2591
|
+
data, status_code, headers = post_dnclist_export_with_http_info(dnc_list_id, opts)
|
|
2592
|
+
return data
|
|
2593
|
+
end
|
|
2594
|
+
|
|
2595
|
+
# Initiate the export of a dnc list.
|
|
2596
|
+
# Returns 200 if received OK.
|
|
2597
|
+
# @param dnc_list_id DncList ID
|
|
2598
|
+
# @param [Hash] opts the optional parameters
|
|
2599
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
2600
|
+
def post_dnclist_export_with_http_info(dnc_list_id, opts = {})
|
|
2601
|
+
if @api_client.config.debugging
|
|
2602
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_dnclist_export ..."
|
|
2603
|
+
end
|
|
2604
|
+
|
|
2605
|
+
# verify the required parameter 'dnc_list_id' is set
|
|
2606
|
+
fail "Missing the required parameter 'dnc_list_id' when calling post_dnclist_export" if dnc_list_id.nil?
|
|
2607
|
+
|
|
2608
|
+
# resource path
|
|
2609
|
+
path = "/api/v1/outbound/dnclists/{dncListId}/export".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)
|
|
2610
|
+
|
|
2611
|
+
# query parameters
|
|
2612
|
+
query_params = {}
|
|
2613
|
+
|
|
2614
|
+
# header parameters
|
|
2615
|
+
header_params = {}
|
|
2616
|
+
|
|
2617
|
+
# HTTP header 'Accept' (if needed)
|
|
2618
|
+
_header_accept = ['application/json']
|
|
2619
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2620
|
+
|
|
2621
|
+
# HTTP header 'Content-Type'
|
|
2622
|
+
_header_content_type = ['application/json']
|
|
2623
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2624
|
+
|
|
2625
|
+
# form parameters
|
|
2626
|
+
form_params = {}
|
|
2627
|
+
|
|
2628
|
+
# http body (model)
|
|
2629
|
+
post_body = nil
|
|
2630
|
+
|
|
2631
|
+
|
|
2632
|
+
auth_names = ['PureCloud Auth']
|
|
2633
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
2634
|
+
:header_params => header_params,
|
|
2635
|
+
:query_params => query_params,
|
|
2636
|
+
:form_params => form_params,
|
|
2637
|
+
:body => post_body,
|
|
2638
|
+
:auth_names => auth_names,
|
|
2639
|
+
:return_type => 'String')
|
|
2640
|
+
if @api_client.config.debugging
|
|
2641
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_dnclist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2642
|
+
end
|
|
2643
|
+
return data, status_code, headers
|
|
2644
|
+
end
|
|
2645
|
+
|
|
2646
|
+
# Get dialer dncList import status.
|
|
2647
|
+
#
|
|
2648
|
+
# @param dnc_list_id DncList ID
|
|
2649
|
+
# @param [Hash] opts the optional parameters
|
|
2650
|
+
# @return [ImportStatus]
|
|
2651
|
+
def get_dnclist_importstatus(dnc_list_id, opts = {})
|
|
2652
|
+
data, status_code, headers = get_dnclist_importstatus_with_http_info(dnc_list_id, opts)
|
|
2653
|
+
return data
|
|
2654
|
+
end
|
|
2655
|
+
|
|
2656
|
+
# Get dialer dncList import status.
|
|
2657
|
+
#
|
|
2658
|
+
# @param dnc_list_id DncList ID
|
|
2659
|
+
# @param [Hash] opts the optional parameters
|
|
2660
|
+
# @return [Array<(ImportStatus, Fixnum, Hash)>] ImportStatus data, response status code and response headers
|
|
2661
|
+
def get_dnclist_importstatus_with_http_info(dnc_list_id, opts = {})
|
|
2662
|
+
if @api_client.config.debugging
|
|
2663
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_dnclist_importstatus ..."
|
|
2664
|
+
end
|
|
2665
|
+
|
|
2666
|
+
# verify the required parameter 'dnc_list_id' is set
|
|
2667
|
+
fail "Missing the required parameter 'dnc_list_id' when calling get_dnclist_importstatus" if dnc_list_id.nil?
|
|
2668
|
+
|
|
2669
|
+
# resource path
|
|
2670
|
+
path = "/api/v1/outbound/dnclists/{dncListId}/importstatus".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)
|
|
2671
|
+
|
|
2672
|
+
# query parameters
|
|
2673
|
+
query_params = {}
|
|
2674
|
+
|
|
2675
|
+
# header parameters
|
|
2676
|
+
header_params = {}
|
|
2677
|
+
|
|
2678
|
+
# HTTP header 'Accept' (if needed)
|
|
2679
|
+
_header_accept = ['application/json']
|
|
2680
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2681
|
+
|
|
2682
|
+
# HTTP header 'Content-Type'
|
|
2683
|
+
_header_content_type = ['application/json']
|
|
2684
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2685
|
+
|
|
2686
|
+
# form parameters
|
|
2687
|
+
form_params = {}
|
|
2688
|
+
|
|
2689
|
+
# http body (model)
|
|
2690
|
+
post_body = nil
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
auth_names = ['PureCloud Auth']
|
|
2694
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
2695
|
+
:header_params => header_params,
|
|
2696
|
+
:query_params => query_params,
|
|
2697
|
+
:form_params => form_params,
|
|
2698
|
+
:body => post_body,
|
|
2699
|
+
:auth_names => auth_names,
|
|
2700
|
+
:return_type => 'ImportStatus')
|
|
2701
|
+
if @api_client.config.debugging
|
|
2702
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_dnclist_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2703
|
+
end
|
|
2704
|
+
return data, status_code, headers
|
|
2705
|
+
end
|
|
2706
|
+
|
|
2707
|
+
# Add phone numbers to a Dialer DNC list.
|
|
2708
|
+
#
|
|
2709
|
+
# @param dnc_list_id DncList ID
|
|
2710
|
+
# @param [Hash] opts the optional parameters
|
|
2711
|
+
# @option opts [Array<String>] :body DNC Phone Numbers
|
|
2712
|
+
# @return [nil]
|
|
2713
|
+
def post_dnclist_phonenumbers(dnc_list_id, opts = {})
|
|
2714
|
+
post_dnclist_phonenumbers_with_http_info(dnc_list_id, opts)
|
|
2715
|
+
return nil
|
|
2716
|
+
end
|
|
2717
|
+
|
|
2718
|
+
# Add phone numbers to a Dialer DNC list.
|
|
2719
|
+
#
|
|
2720
|
+
# @param dnc_list_id DncList ID
|
|
2721
|
+
# @param [Hash] opts the optional parameters
|
|
2722
|
+
# @option opts [Array<String>] :body DNC Phone Numbers
|
|
2723
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
2724
|
+
def post_dnclist_phonenumbers_with_http_info(dnc_list_id, opts = {})
|
|
2725
|
+
if @api_client.config.debugging
|
|
2726
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_dnclist_phonenumbers ..."
|
|
2727
|
+
end
|
|
2728
|
+
|
|
2729
|
+
# verify the required parameter 'dnc_list_id' is set
|
|
2730
|
+
fail "Missing the required parameter 'dnc_list_id' when calling post_dnclist_phonenumbers" if dnc_list_id.nil?
|
|
2731
|
+
|
|
2732
|
+
# resource path
|
|
2733
|
+
path = "/api/v1/outbound/dnclists/{dncListId}/phonenumbers".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)
|
|
2734
|
+
|
|
2735
|
+
# query parameters
|
|
2736
|
+
query_params = {}
|
|
2737
|
+
|
|
2738
|
+
# header parameters
|
|
2739
|
+
header_params = {}
|
|
2740
|
+
|
|
2741
|
+
# HTTP header 'Accept' (if needed)
|
|
2742
|
+
_header_accept = ['application/json']
|
|
2743
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2744
|
+
|
|
2745
|
+
# HTTP header 'Content-Type'
|
|
2746
|
+
_header_content_type = ['application/json']
|
|
2747
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2748
|
+
|
|
2749
|
+
# form parameters
|
|
2750
|
+
form_params = {}
|
|
2751
|
+
|
|
2752
|
+
# http body (model)
|
|
2753
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
2754
|
+
|
|
2755
|
+
|
|
2756
|
+
auth_names = ['PureCloud Auth']
|
|
2757
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
2758
|
+
:header_params => header_params,
|
|
2759
|
+
:query_params => query_params,
|
|
2760
|
+
:form_params => form_params,
|
|
2761
|
+
:body => post_body,
|
|
2762
|
+
:auth_names => auth_names)
|
|
2763
|
+
if @api_client.config.debugging
|
|
2764
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_dnclist_phonenumbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2765
|
+
end
|
|
2766
|
+
return data, status_code, headers
|
|
2767
|
+
end
|
|
2768
|
+
|
|
2769
|
+
# Get dialer preview for user
|
|
2770
|
+
#
|
|
2771
|
+
# @param [Hash] opts the optional parameters
|
|
2772
|
+
# @return [Array<Preview>]
|
|
2773
|
+
def get_previews(opts = {})
|
|
2774
|
+
data, status_code, headers = get_previews_with_http_info(opts)
|
|
2775
|
+
return data
|
|
2776
|
+
end
|
|
2777
|
+
|
|
2778
|
+
# Get dialer preview for user
|
|
2779
|
+
#
|
|
2780
|
+
# @param [Hash] opts the optional parameters
|
|
2781
|
+
# @return [Array<(Array<Preview>, Fixnum, Hash)>] Array<Preview> data, response status code and response headers
|
|
2782
|
+
def get_previews_with_http_info(opts = {})
|
|
2783
|
+
if @api_client.config.debugging
|
|
2784
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_previews ..."
|
|
2785
|
+
end
|
|
2786
|
+
|
|
2787
|
+
# resource path
|
|
2788
|
+
path = "/api/v1/outbound/previews".sub('{format}','json')
|
|
2789
|
+
|
|
2790
|
+
# query parameters
|
|
2791
|
+
query_params = {}
|
|
2792
|
+
|
|
2793
|
+
# header parameters
|
|
2794
|
+
header_params = {}
|
|
2795
|
+
|
|
2796
|
+
# HTTP header 'Accept' (if needed)
|
|
2797
|
+
_header_accept = ['application/json']
|
|
2798
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2799
|
+
|
|
2800
|
+
# HTTP header 'Content-Type'
|
|
2801
|
+
_header_content_type = ['application/json']
|
|
2802
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2803
|
+
|
|
2804
|
+
# form parameters
|
|
2805
|
+
form_params = {}
|
|
2806
|
+
|
|
2807
|
+
# http body (model)
|
|
2808
|
+
post_body = nil
|
|
2809
|
+
|
|
2810
|
+
|
|
2811
|
+
auth_names = ['PureCloud Auth']
|
|
2812
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
2813
|
+
:header_params => header_params,
|
|
2814
|
+
:query_params => query_params,
|
|
2815
|
+
:form_params => form_params,
|
|
2816
|
+
:body => post_body,
|
|
2817
|
+
:auth_names => auth_names,
|
|
2818
|
+
:return_type => 'Array<Preview>')
|
|
2819
|
+
if @api_client.config.debugging
|
|
2820
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_previews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2821
|
+
end
|
|
2822
|
+
return data, status_code, headers
|
|
2823
|
+
end
|
|
2824
|
+
|
|
2825
|
+
# Get dialer preview
|
|
2826
|
+
#
|
|
2827
|
+
# @param preview_id preview ID
|
|
2828
|
+
# @param [Hash] opts the optional parameters
|
|
2829
|
+
# @return [Preview]
|
|
2830
|
+
def get_preview(preview_id, opts = {})
|
|
2831
|
+
data, status_code, headers = get_preview_with_http_info(preview_id, opts)
|
|
2832
|
+
return data
|
|
2833
|
+
end
|
|
2834
|
+
|
|
2835
|
+
# Get dialer preview
|
|
2836
|
+
#
|
|
2837
|
+
# @param preview_id preview ID
|
|
2838
|
+
# @param [Hash] opts the optional parameters
|
|
2839
|
+
# @return [Array<(Preview, Fixnum, Hash)>] Preview data, response status code and response headers
|
|
2840
|
+
def get_preview_with_http_info(preview_id, opts = {})
|
|
2841
|
+
if @api_client.config.debugging
|
|
2842
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_preview ..."
|
|
2843
|
+
end
|
|
2844
|
+
|
|
2845
|
+
# verify the required parameter 'preview_id' is set
|
|
2846
|
+
fail "Missing the required parameter 'preview_id' when calling get_preview" if preview_id.nil?
|
|
2847
|
+
|
|
2848
|
+
# resource path
|
|
2849
|
+
path = "/api/v1/outbound/previews/{previewId}".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)
|
|
2850
|
+
|
|
2851
|
+
# query parameters
|
|
2852
|
+
query_params = {}
|
|
2853
|
+
|
|
2854
|
+
# header parameters
|
|
2855
|
+
header_params = {}
|
|
2856
|
+
|
|
2857
|
+
# HTTP header 'Accept' (if needed)
|
|
2858
|
+
_header_accept = ['application/json']
|
|
2859
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2860
|
+
|
|
2861
|
+
# HTTP header 'Content-Type'
|
|
2862
|
+
_header_content_type = ['application/json']
|
|
2863
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2864
|
+
|
|
2865
|
+
# form parameters
|
|
2866
|
+
form_params = {}
|
|
2867
|
+
|
|
2868
|
+
# http body (model)
|
|
2869
|
+
post_body = nil
|
|
2870
|
+
|
|
2871
|
+
|
|
2872
|
+
auth_names = ['PureCloud Auth']
|
|
2873
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
2874
|
+
:header_params => header_params,
|
|
2875
|
+
:query_params => query_params,
|
|
2876
|
+
:form_params => form_params,
|
|
2877
|
+
:body => post_body,
|
|
2878
|
+
:auth_names => auth_names,
|
|
2879
|
+
:return_type => 'Preview')
|
|
2880
|
+
if @api_client.config.debugging
|
|
2881
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2882
|
+
end
|
|
2883
|
+
return data, status_code, headers
|
|
2884
|
+
end
|
|
2885
|
+
|
|
2886
|
+
# Disposition preview call
|
|
2887
|
+
#
|
|
2888
|
+
# @param preview_id preview ID
|
|
2889
|
+
# @param [Hash] opts the optional parameters
|
|
2890
|
+
# @option opts [DialerDispositionCallCommand] :body
|
|
2891
|
+
# @return [String]
|
|
2892
|
+
def post_preview_dispositioncall(preview_id, opts = {})
|
|
2893
|
+
data, status_code, headers = post_preview_dispositioncall_with_http_info(preview_id, opts)
|
|
2894
|
+
return data
|
|
2895
|
+
end
|
|
2896
|
+
|
|
2897
|
+
# Disposition preview call
|
|
2898
|
+
#
|
|
2899
|
+
# @param preview_id preview ID
|
|
2900
|
+
# @param [Hash] opts the optional parameters
|
|
2901
|
+
# @option opts [DialerDispositionCallCommand] :body
|
|
2902
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
2903
|
+
def post_preview_dispositioncall_with_http_info(preview_id, opts = {})
|
|
2904
|
+
if @api_client.config.debugging
|
|
2905
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_preview_dispositioncall ..."
|
|
2906
|
+
end
|
|
2907
|
+
|
|
2908
|
+
# verify the required parameter 'preview_id' is set
|
|
2909
|
+
fail "Missing the required parameter 'preview_id' when calling post_preview_dispositioncall" if preview_id.nil?
|
|
2910
|
+
|
|
2911
|
+
# resource path
|
|
2912
|
+
path = "/api/v1/outbound/previews/{previewId}/dispositioncall".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)
|
|
2913
|
+
|
|
2914
|
+
# query parameters
|
|
2915
|
+
query_params = {}
|
|
2916
|
+
|
|
2917
|
+
# header parameters
|
|
2918
|
+
header_params = {}
|
|
2919
|
+
|
|
2920
|
+
# HTTP header 'Accept' (if needed)
|
|
2921
|
+
_header_accept = ['application/json']
|
|
2922
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2923
|
+
|
|
2924
|
+
# HTTP header 'Content-Type'
|
|
2925
|
+
_header_content_type = ['application/json']
|
|
2926
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2927
|
+
|
|
2928
|
+
# form parameters
|
|
2929
|
+
form_params = {}
|
|
2930
|
+
|
|
2931
|
+
# http body (model)
|
|
2932
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
2933
|
+
|
|
2934
|
+
|
|
2935
|
+
auth_names = ['PureCloud Auth']
|
|
2936
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
2937
|
+
:header_params => header_params,
|
|
2938
|
+
:query_params => query_params,
|
|
2939
|
+
:form_params => form_params,
|
|
2940
|
+
:body => post_body,
|
|
2941
|
+
:auth_names => auth_names,
|
|
2942
|
+
:return_type => 'String')
|
|
2943
|
+
if @api_client.config.debugging
|
|
2944
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_preview_dispositioncall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2945
|
+
end
|
|
2946
|
+
return data, status_code, headers
|
|
2947
|
+
end
|
|
2948
|
+
|
|
2949
|
+
# place preview call
|
|
2950
|
+
#
|
|
2951
|
+
# @param preview_id preview ID
|
|
2952
|
+
# @param [Hash] opts the optional parameters
|
|
2953
|
+
# @option opts [DialerPlaceCallCommand] :body
|
|
2954
|
+
# @return [DialerCall]
|
|
2955
|
+
def post_preview_placecall(preview_id, opts = {})
|
|
2956
|
+
data, status_code, headers = post_preview_placecall_with_http_info(preview_id, opts)
|
|
2957
|
+
return data
|
|
2958
|
+
end
|
|
2959
|
+
|
|
2960
|
+
# place preview call
|
|
2961
|
+
#
|
|
2962
|
+
# @param preview_id preview ID
|
|
2963
|
+
# @param [Hash] opts the optional parameters
|
|
2964
|
+
# @option opts [DialerPlaceCallCommand] :body
|
|
2965
|
+
# @return [Array<(DialerCall, Fixnum, Hash)>] DialerCall data, response status code and response headers
|
|
2966
|
+
def post_preview_placecall_with_http_info(preview_id, opts = {})
|
|
2967
|
+
if @api_client.config.debugging
|
|
2968
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_preview_placecall ..."
|
|
2969
|
+
end
|
|
2970
|
+
|
|
2971
|
+
# verify the required parameter 'preview_id' is set
|
|
2972
|
+
fail "Missing the required parameter 'preview_id' when calling post_preview_placecall" if preview_id.nil?
|
|
2973
|
+
|
|
2974
|
+
# resource path
|
|
2975
|
+
path = "/api/v1/outbound/previews/{previewId}/placecall".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)
|
|
2976
|
+
|
|
2977
|
+
# query parameters
|
|
2978
|
+
query_params = {}
|
|
2979
|
+
|
|
2980
|
+
# header parameters
|
|
2981
|
+
header_params = {}
|
|
2982
|
+
|
|
2983
|
+
# HTTP header 'Accept' (if needed)
|
|
2984
|
+
_header_accept = ['application/json']
|
|
2985
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
2986
|
+
|
|
2987
|
+
# HTTP header 'Content-Type'
|
|
2988
|
+
_header_content_type = ['application/json']
|
|
2989
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
2990
|
+
|
|
2991
|
+
# form parameters
|
|
2992
|
+
form_params = {}
|
|
2993
|
+
|
|
2994
|
+
# http body (model)
|
|
2995
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
2996
|
+
|
|
2997
|
+
|
|
2998
|
+
auth_names = ['PureCloud Auth']
|
|
2999
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
3000
|
+
:header_params => header_params,
|
|
3001
|
+
:query_params => query_params,
|
|
3002
|
+
:form_params => form_params,
|
|
3003
|
+
:body => post_body,
|
|
3004
|
+
:auth_names => auth_names,
|
|
3005
|
+
:return_type => 'DialerCall')
|
|
3006
|
+
if @api_client.config.debugging
|
|
3007
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_preview_placecall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3008
|
+
end
|
|
3009
|
+
return data, status_code, headers
|
|
3010
|
+
end
|
|
3011
|
+
|
|
3012
|
+
# Query a list of Rule Sets.
|
|
3013
|
+
#
|
|
3014
|
+
# @param [Hash] opts the optional parameters
|
|
3015
|
+
# @option opts [Integer] :page_size Page size
|
|
3016
|
+
# @option opts [Integer] :page_number Page number
|
|
3017
|
+
# @option opts [String] :filter_type Filter type
|
|
3018
|
+
# @option opts [String] :name Name
|
|
3019
|
+
# @option opts [String] :sort_by Sort by
|
|
3020
|
+
# @option opts [String] :sort_order Sort order
|
|
3021
|
+
# @return [RuleSetEntityListing]
|
|
3022
|
+
def get_rulesets(opts = {})
|
|
3023
|
+
data, status_code, headers = get_rulesets_with_http_info(opts)
|
|
3024
|
+
return data
|
|
3025
|
+
end
|
|
3026
|
+
|
|
3027
|
+
# Query a list of Rule Sets.
|
|
3028
|
+
#
|
|
3029
|
+
# @param [Hash] opts the optional parameters
|
|
3030
|
+
# @option opts [Integer] :page_size Page size
|
|
3031
|
+
# @option opts [Integer] :page_number Page number
|
|
3032
|
+
# @option opts [String] :filter_type Filter type
|
|
3033
|
+
# @option opts [String] :name Name
|
|
3034
|
+
# @option opts [String] :sort_by Sort by
|
|
3035
|
+
# @option opts [String] :sort_order Sort order
|
|
3036
|
+
# @return [Array<(RuleSetEntityListing, Fixnum, Hash)>] RuleSetEntityListing data, response status code and response headers
|
|
3037
|
+
def get_rulesets_with_http_info(opts = {})
|
|
3038
|
+
if @api_client.config.debugging
|
|
3039
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_rulesets ..."
|
|
3040
|
+
end
|
|
3041
|
+
|
|
3042
|
+
if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
|
|
3043
|
+
fail 'invalid value for "filter_type", must be one of EQUALS, REGEX, CONTAINS, PREFIX, LESSTHAN, LESSTHANEQUALTO, GREATERTHAN, GREATERTHANEQUALTO, BEGINSWITH, ENDSWITH'
|
|
3044
|
+
end
|
|
3045
|
+
|
|
3046
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
3047
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
3048
|
+
end
|
|
3049
|
+
|
|
3050
|
+
# resource path
|
|
3051
|
+
path = "/api/v1/outbound/rulesets".sub('{format}','json')
|
|
3052
|
+
|
|
3053
|
+
# query parameters
|
|
3054
|
+
query_params = {}
|
|
3055
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
3056
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
3057
|
+
query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
|
|
3058
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
3059
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
3060
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
3061
|
+
|
|
3062
|
+
# header parameters
|
|
3063
|
+
header_params = {}
|
|
3064
|
+
|
|
3065
|
+
# HTTP header 'Accept' (if needed)
|
|
3066
|
+
_header_accept = ['application/json']
|
|
3067
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3068
|
+
|
|
3069
|
+
# HTTP header 'Content-Type'
|
|
3070
|
+
_header_content_type = ['application/json']
|
|
3071
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3072
|
+
|
|
3073
|
+
# form parameters
|
|
3074
|
+
form_params = {}
|
|
3075
|
+
|
|
3076
|
+
# http body (model)
|
|
3077
|
+
post_body = nil
|
|
3078
|
+
|
|
3079
|
+
|
|
3080
|
+
auth_names = ['PureCloud Auth']
|
|
3081
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
3082
|
+
:header_params => header_params,
|
|
3083
|
+
:query_params => query_params,
|
|
3084
|
+
:form_params => form_params,
|
|
3085
|
+
:body => post_body,
|
|
3086
|
+
:auth_names => auth_names,
|
|
3087
|
+
:return_type => 'RuleSetEntityListing')
|
|
3088
|
+
if @api_client.config.debugging
|
|
3089
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3090
|
+
end
|
|
3091
|
+
return data, status_code, headers
|
|
3092
|
+
end
|
|
3093
|
+
|
|
3094
|
+
# Create a Dialer Call Analysis Response Set.
|
|
3095
|
+
#
|
|
3096
|
+
# @param [Hash] opts the optional parameters
|
|
3097
|
+
# @option opts [RuleSet] :body RuleSet
|
|
3098
|
+
# @return [RuleSet]
|
|
3099
|
+
def post_rulesets(opts = {})
|
|
3100
|
+
data, status_code, headers = post_rulesets_with_http_info(opts)
|
|
3101
|
+
return data
|
|
3102
|
+
end
|
|
3103
|
+
|
|
3104
|
+
# Create a Dialer Call Analysis Response Set.
|
|
3105
|
+
#
|
|
3106
|
+
# @param [Hash] opts the optional parameters
|
|
3107
|
+
# @option opts [RuleSet] :body RuleSet
|
|
3108
|
+
# @return [Array<(RuleSet, Fixnum, Hash)>] RuleSet data, response status code and response headers
|
|
3109
|
+
def post_rulesets_with_http_info(opts = {})
|
|
3110
|
+
if @api_client.config.debugging
|
|
3111
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_rulesets ..."
|
|
3112
|
+
end
|
|
3113
|
+
|
|
3114
|
+
# resource path
|
|
3115
|
+
path = "/api/v1/outbound/rulesets".sub('{format}','json')
|
|
3116
|
+
|
|
3117
|
+
# query parameters
|
|
3118
|
+
query_params = {}
|
|
3119
|
+
|
|
3120
|
+
# header parameters
|
|
3121
|
+
header_params = {}
|
|
3122
|
+
|
|
3123
|
+
# HTTP header 'Accept' (if needed)
|
|
3124
|
+
_header_accept = ['application/json']
|
|
3125
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3126
|
+
|
|
3127
|
+
# HTTP header 'Content-Type'
|
|
3128
|
+
_header_content_type = ['application/json']
|
|
3129
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3130
|
+
|
|
3131
|
+
# form parameters
|
|
3132
|
+
form_params = {}
|
|
3133
|
+
|
|
3134
|
+
# http body (model)
|
|
3135
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
3136
|
+
|
|
3137
|
+
|
|
3138
|
+
auth_names = ['PureCloud Auth']
|
|
3139
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
3140
|
+
:header_params => header_params,
|
|
3141
|
+
:query_params => query_params,
|
|
3142
|
+
:form_params => form_params,
|
|
3143
|
+
:body => post_body,
|
|
3144
|
+
:auth_names => auth_names,
|
|
3145
|
+
:return_type => 'RuleSet')
|
|
3146
|
+
if @api_client.config.debugging
|
|
3147
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3148
|
+
end
|
|
3149
|
+
return data, status_code, headers
|
|
3150
|
+
end
|
|
3151
|
+
|
|
3152
|
+
# Get a Rule Set by ID.
|
|
3153
|
+
#
|
|
3154
|
+
# @param rule_set_id Rule Set ID
|
|
3155
|
+
# @param [Hash] opts the optional parameters
|
|
3156
|
+
# @return [RuleSet]
|
|
3157
|
+
def get_ruleset(rule_set_id, opts = {})
|
|
3158
|
+
data, status_code, headers = get_ruleset_with_http_info(rule_set_id, opts)
|
|
3159
|
+
return data
|
|
3160
|
+
end
|
|
3161
|
+
|
|
3162
|
+
# Get a Rule Set by ID.
|
|
3163
|
+
#
|
|
3164
|
+
# @param rule_set_id Rule Set ID
|
|
3165
|
+
# @param [Hash] opts the optional parameters
|
|
3166
|
+
# @return [Array<(RuleSet, Fixnum, Hash)>] RuleSet data, response status code and response headers
|
|
3167
|
+
def get_ruleset_with_http_info(rule_set_id, opts = {})
|
|
3168
|
+
if @api_client.config.debugging
|
|
3169
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_ruleset ..."
|
|
3170
|
+
end
|
|
3171
|
+
|
|
3172
|
+
# verify the required parameter 'rule_set_id' is set
|
|
3173
|
+
fail "Missing the required parameter 'rule_set_id' when calling get_ruleset" if rule_set_id.nil?
|
|
3174
|
+
|
|
3175
|
+
# resource path
|
|
3176
|
+
path = "/api/v1/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)
|
|
3177
|
+
|
|
3178
|
+
# query parameters
|
|
3179
|
+
query_params = {}
|
|
3180
|
+
|
|
3181
|
+
# header parameters
|
|
3182
|
+
header_params = {}
|
|
3183
|
+
|
|
3184
|
+
# HTTP header 'Accept' (if needed)
|
|
3185
|
+
_header_accept = ['application/json']
|
|
3186
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3187
|
+
|
|
3188
|
+
# HTTP header 'Content-Type'
|
|
3189
|
+
_header_content_type = ['application/json']
|
|
3190
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3191
|
+
|
|
3192
|
+
# form parameters
|
|
3193
|
+
form_params = {}
|
|
3194
|
+
|
|
3195
|
+
# http body (model)
|
|
3196
|
+
post_body = nil
|
|
3197
|
+
|
|
3198
|
+
|
|
3199
|
+
auth_names = ['PureCloud Auth']
|
|
3200
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
3201
|
+
:header_params => header_params,
|
|
3202
|
+
:query_params => query_params,
|
|
3203
|
+
:form_params => form_params,
|
|
3204
|
+
:body => post_body,
|
|
3205
|
+
:auth_names => auth_names,
|
|
3206
|
+
:return_type => 'RuleSet')
|
|
3207
|
+
if @api_client.config.debugging
|
|
3208
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3209
|
+
end
|
|
3210
|
+
return data, status_code, headers
|
|
3211
|
+
end
|
|
3212
|
+
|
|
3213
|
+
# Update a RuleSet.
|
|
3214
|
+
#
|
|
3215
|
+
# @param rule_set_id Rule Set ID
|
|
3216
|
+
# @param [Hash] opts the optional parameters
|
|
3217
|
+
# @option opts [RuleSet] :body RuleSet
|
|
3218
|
+
# @return [RuleSet]
|
|
3219
|
+
def put_ruleset(rule_set_id, opts = {})
|
|
3220
|
+
data, status_code, headers = put_ruleset_with_http_info(rule_set_id, opts)
|
|
3221
|
+
return data
|
|
3222
|
+
end
|
|
3223
|
+
|
|
3224
|
+
# Update a RuleSet.
|
|
3225
|
+
#
|
|
3226
|
+
# @param rule_set_id Rule Set ID
|
|
3227
|
+
# @param [Hash] opts the optional parameters
|
|
3228
|
+
# @option opts [RuleSet] :body RuleSet
|
|
3229
|
+
# @return [Array<(RuleSet, Fixnum, Hash)>] RuleSet data, response status code and response headers
|
|
3230
|
+
def put_ruleset_with_http_info(rule_set_id, opts = {})
|
|
3231
|
+
if @api_client.config.debugging
|
|
3232
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_ruleset ..."
|
|
3233
|
+
end
|
|
3234
|
+
|
|
3235
|
+
# verify the required parameter 'rule_set_id' is set
|
|
3236
|
+
fail "Missing the required parameter 'rule_set_id' when calling put_ruleset" if rule_set_id.nil?
|
|
3237
|
+
|
|
3238
|
+
# resource path
|
|
3239
|
+
path = "/api/v1/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)
|
|
3240
|
+
|
|
3241
|
+
# query parameters
|
|
3242
|
+
query_params = {}
|
|
3243
|
+
|
|
3244
|
+
# header parameters
|
|
3245
|
+
header_params = {}
|
|
3246
|
+
|
|
3247
|
+
# HTTP header 'Accept' (if needed)
|
|
3248
|
+
_header_accept = ['application/json']
|
|
3249
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3250
|
+
|
|
3251
|
+
# HTTP header 'Content-Type'
|
|
3252
|
+
_header_content_type = ['application/json']
|
|
3253
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3254
|
+
|
|
3255
|
+
# form parameters
|
|
3256
|
+
form_params = {}
|
|
3257
|
+
|
|
3258
|
+
# http body (model)
|
|
3259
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
3260
|
+
|
|
3261
|
+
|
|
3262
|
+
auth_names = ['PureCloud Auth']
|
|
3263
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
3264
|
+
:header_params => header_params,
|
|
3265
|
+
:query_params => query_params,
|
|
3266
|
+
:form_params => form_params,
|
|
3267
|
+
:body => post_body,
|
|
3268
|
+
:auth_names => auth_names,
|
|
3269
|
+
:return_type => 'RuleSet')
|
|
3270
|
+
if @api_client.config.debugging
|
|
3271
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3272
|
+
end
|
|
3273
|
+
return data, status_code, headers
|
|
3274
|
+
end
|
|
3275
|
+
|
|
3276
|
+
# Delete a Rule set.
|
|
3277
|
+
#
|
|
3278
|
+
# @param rule_set_id Rule Set ID
|
|
3279
|
+
# @param [Hash] opts the optional parameters
|
|
3280
|
+
# @return [String]
|
|
3281
|
+
def delete_ruleset(rule_set_id, opts = {})
|
|
3282
|
+
data, status_code, headers = delete_ruleset_with_http_info(rule_set_id, opts)
|
|
3283
|
+
return data
|
|
3284
|
+
end
|
|
3285
|
+
|
|
3286
|
+
# Delete a Rule set.
|
|
3287
|
+
#
|
|
3288
|
+
# @param rule_set_id Rule Set ID
|
|
3289
|
+
# @param [Hash] opts the optional parameters
|
|
3290
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
3291
|
+
def delete_ruleset_with_http_info(rule_set_id, opts = {})
|
|
3292
|
+
if @api_client.config.debugging
|
|
3293
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_ruleset ..."
|
|
3294
|
+
end
|
|
3295
|
+
|
|
3296
|
+
# verify the required parameter 'rule_set_id' is set
|
|
3297
|
+
fail "Missing the required parameter 'rule_set_id' when calling delete_ruleset" if rule_set_id.nil?
|
|
3298
|
+
|
|
3299
|
+
# resource path
|
|
3300
|
+
path = "/api/v1/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)
|
|
3301
|
+
|
|
3302
|
+
# query parameters
|
|
3303
|
+
query_params = {}
|
|
3304
|
+
|
|
3305
|
+
# header parameters
|
|
3306
|
+
header_params = {}
|
|
3307
|
+
|
|
3308
|
+
# HTTP header 'Accept' (if needed)
|
|
3309
|
+
_header_accept = ['application/json']
|
|
3310
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3311
|
+
|
|
3312
|
+
# HTTP header 'Content-Type'
|
|
3313
|
+
_header_content_type = ['application/json']
|
|
3314
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3315
|
+
|
|
3316
|
+
# form parameters
|
|
3317
|
+
form_params = {}
|
|
3318
|
+
|
|
3319
|
+
# http body (model)
|
|
3320
|
+
post_body = nil
|
|
3321
|
+
|
|
3322
|
+
|
|
3323
|
+
auth_names = ['PureCloud Auth']
|
|
3324
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
3325
|
+
:header_params => header_params,
|
|
3326
|
+
:query_params => query_params,
|
|
3327
|
+
:form_params => form_params,
|
|
3328
|
+
:body => post_body,
|
|
3329
|
+
:auth_names => auth_names,
|
|
3330
|
+
:return_type => 'String')
|
|
3331
|
+
if @api_client.config.debugging
|
|
3332
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3333
|
+
end
|
|
3334
|
+
return data, status_code, headers
|
|
3335
|
+
end
|
|
3336
|
+
|
|
3337
|
+
# Query for a list of dialer campaign schedules.
|
|
3338
|
+
#
|
|
3339
|
+
# @param [Hash] opts the optional parameters
|
|
3340
|
+
# @return [Array<CampaignSchedule>]
|
|
3341
|
+
def get_schedules_campaigns(opts = {})
|
|
3342
|
+
data, status_code, headers = get_schedules_campaigns_with_http_info(opts)
|
|
3343
|
+
return data
|
|
3344
|
+
end
|
|
3345
|
+
|
|
3346
|
+
# Query for a list of dialer campaign schedules.
|
|
3347
|
+
#
|
|
3348
|
+
# @param [Hash] opts the optional parameters
|
|
3349
|
+
# @return [Array<(Array<CampaignSchedule>, Fixnum, Hash)>] Array<CampaignSchedule> data, response status code and response headers
|
|
3350
|
+
def get_schedules_campaigns_with_http_info(opts = {})
|
|
3351
|
+
if @api_client.config.debugging
|
|
3352
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_campaigns ..."
|
|
3353
|
+
end
|
|
3354
|
+
|
|
3355
|
+
# resource path
|
|
3356
|
+
path = "/api/v1/outbound/schedules/campaigns".sub('{format}','json')
|
|
3357
|
+
|
|
3358
|
+
# query parameters
|
|
3359
|
+
query_params = {}
|
|
3360
|
+
|
|
3361
|
+
# header parameters
|
|
3362
|
+
header_params = {}
|
|
3363
|
+
|
|
3364
|
+
# HTTP header 'Accept' (if needed)
|
|
3365
|
+
_header_accept = ['application/json']
|
|
3366
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3367
|
+
|
|
3368
|
+
# HTTP header 'Content-Type'
|
|
3369
|
+
_header_content_type = ['application/json']
|
|
3370
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3371
|
+
|
|
3372
|
+
# form parameters
|
|
3373
|
+
form_params = {}
|
|
3374
|
+
|
|
3375
|
+
# http body (model)
|
|
3376
|
+
post_body = nil
|
|
3377
|
+
|
|
3378
|
+
|
|
3379
|
+
auth_names = ['PureCloud Auth']
|
|
3380
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
3381
|
+
:header_params => header_params,
|
|
3382
|
+
:query_params => query_params,
|
|
3383
|
+
:form_params => form_params,
|
|
3384
|
+
:body => post_body,
|
|
3385
|
+
:auth_names => auth_names,
|
|
3386
|
+
:return_type => 'Array<CampaignSchedule>')
|
|
3387
|
+
if @api_client.config.debugging
|
|
3388
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_schedules_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3389
|
+
end
|
|
3390
|
+
return data, status_code, headers
|
|
3391
|
+
end
|
|
3392
|
+
|
|
3393
|
+
# Get a dialer campaign schedule.
|
|
3394
|
+
#
|
|
3395
|
+
# @param campaign_id Campaign ID
|
|
3396
|
+
# @param [Hash] opts the optional parameters
|
|
3397
|
+
# @return [CampaignSchedule]
|
|
3398
|
+
def get_schedules_campaign(campaign_id, opts = {})
|
|
3399
|
+
data, status_code, headers = get_schedules_campaign_with_http_info(campaign_id, opts)
|
|
3400
|
+
return data
|
|
3401
|
+
end
|
|
3402
|
+
|
|
3403
|
+
# Get a dialer campaign schedule.
|
|
3404
|
+
#
|
|
3405
|
+
# @param campaign_id Campaign ID
|
|
3406
|
+
# @param [Hash] opts the optional parameters
|
|
3407
|
+
# @return [Array<(CampaignSchedule, Fixnum, Hash)>] CampaignSchedule data, response status code and response headers
|
|
3408
|
+
def get_schedules_campaign_with_http_info(campaign_id, opts = {})
|
|
3409
|
+
if @api_client.config.debugging
|
|
3410
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_campaign ..."
|
|
3411
|
+
end
|
|
3412
|
+
|
|
3413
|
+
# verify the required parameter 'campaign_id' is set
|
|
3414
|
+
fail "Missing the required parameter 'campaign_id' when calling get_schedules_campaign" if campaign_id.nil?
|
|
3415
|
+
|
|
3416
|
+
# resource path
|
|
3417
|
+
path = "/api/v1/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
3418
|
+
|
|
3419
|
+
# query parameters
|
|
3420
|
+
query_params = {}
|
|
3421
|
+
|
|
3422
|
+
# header parameters
|
|
3423
|
+
header_params = {}
|
|
3424
|
+
|
|
3425
|
+
# HTTP header 'Accept' (if needed)
|
|
3426
|
+
_header_accept = ['application/json']
|
|
3427
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3428
|
+
|
|
3429
|
+
# HTTP header 'Content-Type'
|
|
3430
|
+
_header_content_type = ['application/json']
|
|
3431
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3432
|
+
|
|
3433
|
+
# form parameters
|
|
3434
|
+
form_params = {}
|
|
3435
|
+
|
|
3436
|
+
# http body (model)
|
|
3437
|
+
post_body = nil
|
|
3438
|
+
|
|
3439
|
+
|
|
3440
|
+
auth_names = ['PureCloud Auth']
|
|
3441
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
3442
|
+
:header_params => header_params,
|
|
3443
|
+
:query_params => query_params,
|
|
3444
|
+
:form_params => form_params,
|
|
3445
|
+
:body => post_body,
|
|
3446
|
+
:auth_names => auth_names,
|
|
3447
|
+
:return_type => 'CampaignSchedule')
|
|
3448
|
+
if @api_client.config.debugging
|
|
3449
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3450
|
+
end
|
|
3451
|
+
return data, status_code, headers
|
|
3452
|
+
end
|
|
3453
|
+
|
|
3454
|
+
# Update a new campaign schedule.
|
|
3455
|
+
#
|
|
3456
|
+
# @param campaign_id Campaign ID
|
|
3457
|
+
# @param [Hash] opts the optional parameters
|
|
3458
|
+
# @option opts [CampaignSchedule] :body CampaignSchedule
|
|
3459
|
+
# @return [CampaignSchedule]
|
|
3460
|
+
def put_schedules_campaign(campaign_id, opts = {})
|
|
3461
|
+
data, status_code, headers = put_schedules_campaign_with_http_info(campaign_id, opts)
|
|
3462
|
+
return data
|
|
3463
|
+
end
|
|
3464
|
+
|
|
3465
|
+
# Update a new campaign schedule.
|
|
3466
|
+
#
|
|
3467
|
+
# @param campaign_id Campaign ID
|
|
3468
|
+
# @param [Hash] opts the optional parameters
|
|
3469
|
+
# @option opts [CampaignSchedule] :body CampaignSchedule
|
|
3470
|
+
# @return [Array<(CampaignSchedule, Fixnum, Hash)>] CampaignSchedule data, response status code and response headers
|
|
3471
|
+
def put_schedules_campaign_with_http_info(campaign_id, opts = {})
|
|
3472
|
+
if @api_client.config.debugging
|
|
3473
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_schedules_campaign ..."
|
|
3474
|
+
end
|
|
3475
|
+
|
|
3476
|
+
# verify the required parameter 'campaign_id' is set
|
|
3477
|
+
fail "Missing the required parameter 'campaign_id' when calling put_schedules_campaign" if campaign_id.nil?
|
|
3478
|
+
|
|
3479
|
+
# resource path
|
|
3480
|
+
path = "/api/v1/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
3481
|
+
|
|
3482
|
+
# query parameters
|
|
3483
|
+
query_params = {}
|
|
3484
|
+
|
|
3485
|
+
# header parameters
|
|
3486
|
+
header_params = {}
|
|
3487
|
+
|
|
3488
|
+
# HTTP header 'Accept' (if needed)
|
|
3489
|
+
_header_accept = ['application/json']
|
|
3490
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3491
|
+
|
|
3492
|
+
# HTTP header 'Content-Type'
|
|
3493
|
+
_header_content_type = ['application/json']
|
|
3494
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3495
|
+
|
|
3496
|
+
# form parameters
|
|
3497
|
+
form_params = {}
|
|
3498
|
+
|
|
3499
|
+
# http body (model)
|
|
3500
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
3501
|
+
|
|
3502
|
+
|
|
3503
|
+
auth_names = ['PureCloud Auth']
|
|
3504
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
3505
|
+
:header_params => header_params,
|
|
3506
|
+
:query_params => query_params,
|
|
3507
|
+
:form_params => form_params,
|
|
3508
|
+
:body => post_body,
|
|
3509
|
+
:auth_names => auth_names,
|
|
3510
|
+
:return_type => 'CampaignSchedule')
|
|
3511
|
+
if @api_client.config.debugging
|
|
3512
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3513
|
+
end
|
|
3514
|
+
return data, status_code, headers
|
|
3515
|
+
end
|
|
3516
|
+
|
|
3517
|
+
# Delete a dialer campaign schedule.
|
|
3518
|
+
#
|
|
3519
|
+
# @param campaign_id Campaign ID
|
|
3520
|
+
# @param [Hash] opts the optional parameters
|
|
3521
|
+
# @return [String]
|
|
3522
|
+
def delete_schedules_campaign(campaign_id, opts = {})
|
|
3523
|
+
data, status_code, headers = delete_schedules_campaign_with_http_info(campaign_id, opts)
|
|
3524
|
+
return data
|
|
3525
|
+
end
|
|
3526
|
+
|
|
3527
|
+
# Delete a dialer campaign schedule.
|
|
3528
|
+
#
|
|
3529
|
+
# @param campaign_id Campaign ID
|
|
3530
|
+
# @param [Hash] opts the optional parameters
|
|
3531
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
3532
|
+
def delete_schedules_campaign_with_http_info(campaign_id, opts = {})
|
|
3533
|
+
if @api_client.config.debugging
|
|
3534
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_schedules_campaign ..."
|
|
3535
|
+
end
|
|
3536
|
+
|
|
3537
|
+
# verify the required parameter 'campaign_id' is set
|
|
3538
|
+
fail "Missing the required parameter 'campaign_id' when calling delete_schedules_campaign" if campaign_id.nil?
|
|
3539
|
+
|
|
3540
|
+
# resource path
|
|
3541
|
+
path = "/api/v1/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)
|
|
3542
|
+
|
|
3543
|
+
# query parameters
|
|
3544
|
+
query_params = {}
|
|
3545
|
+
|
|
3546
|
+
# header parameters
|
|
3547
|
+
header_params = {}
|
|
3548
|
+
|
|
3549
|
+
# HTTP header 'Accept' (if needed)
|
|
3550
|
+
_header_accept = ['application/json']
|
|
3551
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3552
|
+
|
|
3553
|
+
# HTTP header 'Content-Type'
|
|
3554
|
+
_header_content_type = ['application/json']
|
|
3555
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3556
|
+
|
|
3557
|
+
# form parameters
|
|
3558
|
+
form_params = {}
|
|
3559
|
+
|
|
3560
|
+
# http body (model)
|
|
3561
|
+
post_body = nil
|
|
3562
|
+
|
|
3563
|
+
|
|
3564
|
+
auth_names = ['PureCloud Auth']
|
|
3565
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
3566
|
+
:header_params => header_params,
|
|
3567
|
+
:query_params => query_params,
|
|
3568
|
+
:form_params => form_params,
|
|
3569
|
+
:body => post_body,
|
|
3570
|
+
:auth_names => auth_names,
|
|
3571
|
+
:return_type => 'String')
|
|
3572
|
+
if @api_client.config.debugging
|
|
3573
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3574
|
+
end
|
|
3575
|
+
return data, status_code, headers
|
|
3576
|
+
end
|
|
3577
|
+
|
|
3578
|
+
# Query for a list of dialer sequence schedules.
|
|
3579
|
+
#
|
|
3580
|
+
# @param [Hash] opts the optional parameters
|
|
3581
|
+
# @return [Array<SequenceSchedule>]
|
|
3582
|
+
def get_schedules_sequences(opts = {})
|
|
3583
|
+
data, status_code, headers = get_schedules_sequences_with_http_info(opts)
|
|
3584
|
+
return data
|
|
3585
|
+
end
|
|
3586
|
+
|
|
3587
|
+
# Query for a list of dialer sequence schedules.
|
|
3588
|
+
#
|
|
3589
|
+
# @param [Hash] opts the optional parameters
|
|
3590
|
+
# @return [Array<(Array<SequenceSchedule>, Fixnum, Hash)>] Array<SequenceSchedule> data, response status code and response headers
|
|
3591
|
+
def get_schedules_sequences_with_http_info(opts = {})
|
|
3592
|
+
if @api_client.config.debugging
|
|
3593
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_sequences ..."
|
|
3594
|
+
end
|
|
3595
|
+
|
|
3596
|
+
# resource path
|
|
3597
|
+
path = "/api/v1/outbound/schedules/sequences".sub('{format}','json')
|
|
3598
|
+
|
|
3599
|
+
# query parameters
|
|
3600
|
+
query_params = {}
|
|
3601
|
+
|
|
3602
|
+
# header parameters
|
|
3603
|
+
header_params = {}
|
|
3604
|
+
|
|
3605
|
+
# HTTP header 'Accept' (if needed)
|
|
3606
|
+
_header_accept = ['application/json']
|
|
3607
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3608
|
+
|
|
3609
|
+
# HTTP header 'Content-Type'
|
|
3610
|
+
_header_content_type = ['application/json']
|
|
3611
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3612
|
+
|
|
3613
|
+
# form parameters
|
|
3614
|
+
form_params = {}
|
|
3615
|
+
|
|
3616
|
+
# http body (model)
|
|
3617
|
+
post_body = nil
|
|
3618
|
+
|
|
3619
|
+
|
|
3620
|
+
auth_names = ['PureCloud Auth']
|
|
3621
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
3622
|
+
:header_params => header_params,
|
|
3623
|
+
:query_params => query_params,
|
|
3624
|
+
:form_params => form_params,
|
|
3625
|
+
:body => post_body,
|
|
3626
|
+
:auth_names => auth_names,
|
|
3627
|
+
:return_type => 'Array<SequenceSchedule>')
|
|
3628
|
+
if @api_client.config.debugging
|
|
3629
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_schedules_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3630
|
+
end
|
|
3631
|
+
return data, status_code, headers
|
|
3632
|
+
end
|
|
3633
|
+
|
|
3634
|
+
# Get a dialer sequence schedule.
|
|
3635
|
+
#
|
|
3636
|
+
# @param sequence_id Sequence ID
|
|
3637
|
+
# @param [Hash] opts the optional parameters
|
|
3638
|
+
# @return [SequenceSchedule]
|
|
3639
|
+
def get_schedules_sequence(sequence_id, opts = {})
|
|
3640
|
+
data, status_code, headers = get_schedules_sequence_with_http_info(sequence_id, opts)
|
|
3641
|
+
return data
|
|
3642
|
+
end
|
|
3643
|
+
|
|
3644
|
+
# Get a dialer sequence schedule.
|
|
3645
|
+
#
|
|
3646
|
+
# @param sequence_id Sequence ID
|
|
3647
|
+
# @param [Hash] opts the optional parameters
|
|
3648
|
+
# @return [Array<(SequenceSchedule, Fixnum, Hash)>] SequenceSchedule data, response status code and response headers
|
|
3649
|
+
def get_schedules_sequence_with_http_info(sequence_id, opts = {})
|
|
3650
|
+
if @api_client.config.debugging
|
|
3651
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_sequence ..."
|
|
3652
|
+
end
|
|
3653
|
+
|
|
3654
|
+
# verify the required parameter 'sequence_id' is set
|
|
3655
|
+
fail "Missing the required parameter 'sequence_id' when calling get_schedules_sequence" if sequence_id.nil?
|
|
3656
|
+
|
|
3657
|
+
# resource path
|
|
3658
|
+
path = "/api/v1/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)
|
|
3659
|
+
|
|
3660
|
+
# query parameters
|
|
3661
|
+
query_params = {}
|
|
3662
|
+
|
|
3663
|
+
# header parameters
|
|
3664
|
+
header_params = {}
|
|
3665
|
+
|
|
3666
|
+
# HTTP header 'Accept' (if needed)
|
|
3667
|
+
_header_accept = ['application/json']
|
|
3668
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3669
|
+
|
|
3670
|
+
# HTTP header 'Content-Type'
|
|
3671
|
+
_header_content_type = ['application/json']
|
|
3672
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3673
|
+
|
|
3674
|
+
# form parameters
|
|
3675
|
+
form_params = {}
|
|
3676
|
+
|
|
3677
|
+
# http body (model)
|
|
3678
|
+
post_body = nil
|
|
3679
|
+
|
|
3680
|
+
|
|
3681
|
+
auth_names = ['PureCloud Auth']
|
|
3682
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
3683
|
+
:header_params => header_params,
|
|
3684
|
+
:query_params => query_params,
|
|
3685
|
+
:form_params => form_params,
|
|
3686
|
+
:body => post_body,
|
|
3687
|
+
:auth_names => auth_names,
|
|
3688
|
+
:return_type => 'SequenceSchedule')
|
|
3689
|
+
if @api_client.config.debugging
|
|
3690
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3691
|
+
end
|
|
3692
|
+
return data, status_code, headers
|
|
3693
|
+
end
|
|
3694
|
+
|
|
3695
|
+
# Update a new sequence schedule.
|
|
3696
|
+
#
|
|
3697
|
+
# @param sequence_id Sequence ID
|
|
3698
|
+
# @param [Hash] opts the optional parameters
|
|
3699
|
+
# @option opts [SequenceSchedule] :body SequenceSchedule
|
|
3700
|
+
# @return [SequenceSchedule]
|
|
3701
|
+
def put_schedules_sequence(sequence_id, opts = {})
|
|
3702
|
+
data, status_code, headers = put_schedules_sequence_with_http_info(sequence_id, opts)
|
|
3703
|
+
return data
|
|
3704
|
+
end
|
|
3705
|
+
|
|
3706
|
+
# Update a new sequence schedule.
|
|
3707
|
+
#
|
|
3708
|
+
# @param sequence_id Sequence ID
|
|
3709
|
+
# @param [Hash] opts the optional parameters
|
|
3710
|
+
# @option opts [SequenceSchedule] :body SequenceSchedule
|
|
3711
|
+
# @return [Array<(SequenceSchedule, Fixnum, Hash)>] SequenceSchedule data, response status code and response headers
|
|
3712
|
+
def put_schedules_sequence_with_http_info(sequence_id, opts = {})
|
|
3713
|
+
if @api_client.config.debugging
|
|
3714
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_schedules_sequence ..."
|
|
3715
|
+
end
|
|
3716
|
+
|
|
3717
|
+
# verify the required parameter 'sequence_id' is set
|
|
3718
|
+
fail "Missing the required parameter 'sequence_id' when calling put_schedules_sequence" if sequence_id.nil?
|
|
3719
|
+
|
|
3720
|
+
# resource path
|
|
3721
|
+
path = "/api/v1/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)
|
|
3722
|
+
|
|
3723
|
+
# query parameters
|
|
3724
|
+
query_params = {}
|
|
3725
|
+
|
|
3726
|
+
# header parameters
|
|
3727
|
+
header_params = {}
|
|
3728
|
+
|
|
3729
|
+
# HTTP header 'Accept' (if needed)
|
|
3730
|
+
_header_accept = ['application/json']
|
|
3731
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3732
|
+
|
|
3733
|
+
# HTTP header 'Content-Type'
|
|
3734
|
+
_header_content_type = ['application/json']
|
|
3735
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3736
|
+
|
|
3737
|
+
# form parameters
|
|
3738
|
+
form_params = {}
|
|
3739
|
+
|
|
3740
|
+
# http body (model)
|
|
3741
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
3742
|
+
|
|
3743
|
+
|
|
3744
|
+
auth_names = ['PureCloud Auth']
|
|
3745
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
3746
|
+
:header_params => header_params,
|
|
3747
|
+
:query_params => query_params,
|
|
3748
|
+
:form_params => form_params,
|
|
3749
|
+
:body => post_body,
|
|
3750
|
+
:auth_names => auth_names,
|
|
3751
|
+
:return_type => 'SequenceSchedule')
|
|
3752
|
+
if @api_client.config.debugging
|
|
3753
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3754
|
+
end
|
|
3755
|
+
return data, status_code, headers
|
|
3756
|
+
end
|
|
3757
|
+
|
|
3758
|
+
# Delete a dialer sequence schedule.
|
|
3759
|
+
#
|
|
3760
|
+
# @param sequence_id Sequence ID
|
|
3761
|
+
# @param [Hash] opts the optional parameters
|
|
3762
|
+
# @return [String]
|
|
3763
|
+
def delete_schedules_sequence(sequence_id, opts = {})
|
|
3764
|
+
data, status_code, headers = delete_schedules_sequence_with_http_info(sequence_id, opts)
|
|
3765
|
+
return data
|
|
3766
|
+
end
|
|
3767
|
+
|
|
3768
|
+
# Delete a dialer sequence schedule.
|
|
3769
|
+
#
|
|
3770
|
+
# @param sequence_id Sequence ID
|
|
3771
|
+
# @param [Hash] opts the optional parameters
|
|
3772
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
3773
|
+
def delete_schedules_sequence_with_http_info(sequence_id, opts = {})
|
|
3774
|
+
if @api_client.config.debugging
|
|
3775
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_schedules_sequence ..."
|
|
3776
|
+
end
|
|
3777
|
+
|
|
3778
|
+
# verify the required parameter 'sequence_id' is set
|
|
3779
|
+
fail "Missing the required parameter 'sequence_id' when calling delete_schedules_sequence" if sequence_id.nil?
|
|
3780
|
+
|
|
3781
|
+
# resource path
|
|
3782
|
+
path = "/api/v1/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)
|
|
3783
|
+
|
|
3784
|
+
# query parameters
|
|
3785
|
+
query_params = {}
|
|
3786
|
+
|
|
3787
|
+
# header parameters
|
|
3788
|
+
header_params = {}
|
|
3789
|
+
|
|
3790
|
+
# HTTP header 'Accept' (if needed)
|
|
3791
|
+
_header_accept = ['application/json']
|
|
3792
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3793
|
+
|
|
3794
|
+
# HTTP header 'Content-Type'
|
|
3795
|
+
_header_content_type = ['application/json']
|
|
3796
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3797
|
+
|
|
3798
|
+
# form parameters
|
|
3799
|
+
form_params = {}
|
|
3800
|
+
|
|
3801
|
+
# http body (model)
|
|
3802
|
+
post_body = nil
|
|
3803
|
+
|
|
3804
|
+
|
|
3805
|
+
auth_names = ['PureCloud Auth']
|
|
3806
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
3807
|
+
:header_params => header_params,
|
|
3808
|
+
:query_params => query_params,
|
|
3809
|
+
:form_params => form_params,
|
|
3810
|
+
:body => post_body,
|
|
3811
|
+
:auth_names => auth_names,
|
|
3812
|
+
:return_type => 'String')
|
|
3813
|
+
if @api_client.config.debugging
|
|
3814
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3815
|
+
end
|
|
3816
|
+
return data, status_code, headers
|
|
3817
|
+
end
|
|
3818
|
+
|
|
3819
|
+
# Query a list of dialer campaign sequences.
|
|
3820
|
+
#
|
|
3821
|
+
# @param [Hash] opts the optional parameters
|
|
3822
|
+
# @option opts [Integer] :page_size Page size
|
|
3823
|
+
# @option opts [Integer] :page_number Page number
|
|
3824
|
+
# @option opts [String] :filter_type Filter type
|
|
3825
|
+
# @option opts [String] :name Name
|
|
3826
|
+
# @option opts [String] :sort_by Sort by
|
|
3827
|
+
# @option opts [String] :sort_order Sort order
|
|
3828
|
+
# @return [CampaignSequenceEntityListing]
|
|
3829
|
+
def get_sequences(opts = {})
|
|
3830
|
+
data, status_code, headers = get_sequences_with_http_info(opts)
|
|
3831
|
+
return data
|
|
3832
|
+
end
|
|
3833
|
+
|
|
3834
|
+
# Query a list of dialer campaign sequences.
|
|
3835
|
+
#
|
|
3836
|
+
# @param [Hash] opts the optional parameters
|
|
3837
|
+
# @option opts [Integer] :page_size Page size
|
|
3838
|
+
# @option opts [Integer] :page_number Page number
|
|
3839
|
+
# @option opts [String] :filter_type Filter type
|
|
3840
|
+
# @option opts [String] :name Name
|
|
3841
|
+
# @option opts [String] :sort_by Sort by
|
|
3842
|
+
# @option opts [String] :sort_order Sort order
|
|
3843
|
+
# @return [Array<(CampaignSequenceEntityListing, Fixnum, Hash)>] CampaignSequenceEntityListing data, response status code and response headers
|
|
3844
|
+
def get_sequences_with_http_info(opts = {})
|
|
3845
|
+
if @api_client.config.debugging
|
|
3846
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_sequences ..."
|
|
3847
|
+
end
|
|
3848
|
+
|
|
3849
|
+
if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
|
|
3850
|
+
fail 'invalid value for "filter_type", must be one of EQUALS, REGEX, CONTAINS, PREFIX, LESSTHAN, LESSTHANEQUALTO, GREATERTHAN, GREATERTHANEQUALTO, BEGINSWITH, ENDSWITH'
|
|
3851
|
+
end
|
|
3852
|
+
|
|
3853
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
3854
|
+
fail 'invalid value for "sort_order", must be one of ascending, descending'
|
|
3855
|
+
end
|
|
3856
|
+
|
|
3857
|
+
# resource path
|
|
3858
|
+
path = "/api/v1/outbound/sequences".sub('{format}','json')
|
|
3859
|
+
|
|
3860
|
+
# query parameters
|
|
3861
|
+
query_params = {}
|
|
3862
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
3863
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
3864
|
+
query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
|
|
3865
|
+
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
3866
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
3867
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
3868
|
+
|
|
3869
|
+
# header parameters
|
|
3870
|
+
header_params = {}
|
|
3871
|
+
|
|
3872
|
+
# HTTP header 'Accept' (if needed)
|
|
3873
|
+
_header_accept = ['application/json']
|
|
3874
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3875
|
+
|
|
3876
|
+
# HTTP header 'Content-Type'
|
|
3877
|
+
_header_content_type = ['application/json']
|
|
3878
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3879
|
+
|
|
3880
|
+
# form parameters
|
|
3881
|
+
form_params = {}
|
|
3882
|
+
|
|
3883
|
+
# http body (model)
|
|
3884
|
+
post_body = nil
|
|
3885
|
+
|
|
3886
|
+
|
|
3887
|
+
auth_names = ['PureCloud Auth']
|
|
3888
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
3889
|
+
:header_params => header_params,
|
|
3890
|
+
:query_params => query_params,
|
|
3891
|
+
:form_params => form_params,
|
|
3892
|
+
:body => post_body,
|
|
3893
|
+
:auth_names => auth_names,
|
|
3894
|
+
:return_type => 'CampaignSequenceEntityListing')
|
|
3895
|
+
if @api_client.config.debugging
|
|
3896
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3897
|
+
end
|
|
3898
|
+
return data, status_code, headers
|
|
3899
|
+
end
|
|
3900
|
+
|
|
3901
|
+
# Create a new campaign sequence.
|
|
3902
|
+
#
|
|
3903
|
+
# @param [Hash] opts the optional parameters
|
|
3904
|
+
# @option opts [CampaignSequence] :body Organization
|
|
3905
|
+
# @return [CampaignSequence]
|
|
3906
|
+
def post_sequences(opts = {})
|
|
3907
|
+
data, status_code, headers = post_sequences_with_http_info(opts)
|
|
3908
|
+
return data
|
|
3909
|
+
end
|
|
3910
|
+
|
|
3911
|
+
# Create a new campaign sequence.
|
|
3912
|
+
#
|
|
3913
|
+
# @param [Hash] opts the optional parameters
|
|
3914
|
+
# @option opts [CampaignSequence] :body Organization
|
|
3915
|
+
# @return [Array<(CampaignSequence, Fixnum, Hash)>] CampaignSequence data, response status code and response headers
|
|
3916
|
+
def post_sequences_with_http_info(opts = {})
|
|
3917
|
+
if @api_client.config.debugging
|
|
3918
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#post_sequences ..."
|
|
3919
|
+
end
|
|
3920
|
+
|
|
3921
|
+
# resource path
|
|
3922
|
+
path = "/api/v1/outbound/sequences".sub('{format}','json')
|
|
3923
|
+
|
|
3924
|
+
# query parameters
|
|
3925
|
+
query_params = {}
|
|
3926
|
+
|
|
3927
|
+
# header parameters
|
|
3928
|
+
header_params = {}
|
|
3929
|
+
|
|
3930
|
+
# HTTP header 'Accept' (if needed)
|
|
3931
|
+
_header_accept = ['application/json']
|
|
3932
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3933
|
+
|
|
3934
|
+
# HTTP header 'Content-Type'
|
|
3935
|
+
_header_content_type = ['application/json']
|
|
3936
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3937
|
+
|
|
3938
|
+
# form parameters
|
|
3939
|
+
form_params = {}
|
|
3940
|
+
|
|
3941
|
+
# http body (model)
|
|
3942
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
3943
|
+
|
|
3944
|
+
|
|
3945
|
+
auth_names = ['PureCloud Auth']
|
|
3946
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
3947
|
+
:header_params => header_params,
|
|
3948
|
+
:query_params => query_params,
|
|
3949
|
+
:form_params => form_params,
|
|
3950
|
+
:body => post_body,
|
|
3951
|
+
:auth_names => auth_names,
|
|
3952
|
+
:return_type => 'CampaignSequence')
|
|
3953
|
+
if @api_client.config.debugging
|
|
3954
|
+
@api_client.config.logger.debug "API called: OutboundApi#post_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3955
|
+
end
|
|
3956
|
+
return data, status_code, headers
|
|
3957
|
+
end
|
|
3958
|
+
|
|
3959
|
+
# Get a dialer campaign sequence.
|
|
3960
|
+
#
|
|
3961
|
+
# @param sequence_id Campaign Sequence ID
|
|
3962
|
+
# @param [Hash] opts the optional parameters
|
|
3963
|
+
# @return [CampaignSequence]
|
|
3964
|
+
def get_sequence(sequence_id, opts = {})
|
|
3965
|
+
data, status_code, headers = get_sequence_with_http_info(sequence_id, opts)
|
|
3966
|
+
return data
|
|
3967
|
+
end
|
|
3968
|
+
|
|
3969
|
+
# Get a dialer campaign sequence.
|
|
3970
|
+
#
|
|
3971
|
+
# @param sequence_id Campaign Sequence ID
|
|
3972
|
+
# @param [Hash] opts the optional parameters
|
|
3973
|
+
# @return [Array<(CampaignSequence, Fixnum, Hash)>] CampaignSequence data, response status code and response headers
|
|
3974
|
+
def get_sequence_with_http_info(sequence_id, opts = {})
|
|
3975
|
+
if @api_client.config.debugging
|
|
3976
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_sequence ..."
|
|
3977
|
+
end
|
|
3978
|
+
|
|
3979
|
+
# verify the required parameter 'sequence_id' is set
|
|
3980
|
+
fail "Missing the required parameter 'sequence_id' when calling get_sequence" if sequence_id.nil?
|
|
3981
|
+
|
|
3982
|
+
# resource path
|
|
3983
|
+
path = "/api/v1/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)
|
|
3984
|
+
|
|
3985
|
+
# query parameters
|
|
3986
|
+
query_params = {}
|
|
3987
|
+
|
|
3988
|
+
# header parameters
|
|
3989
|
+
header_params = {}
|
|
3990
|
+
|
|
3991
|
+
# HTTP header 'Accept' (if needed)
|
|
3992
|
+
_header_accept = ['application/json']
|
|
3993
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
3994
|
+
|
|
3995
|
+
# HTTP header 'Content-Type'
|
|
3996
|
+
_header_content_type = ['application/json']
|
|
3997
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
3998
|
+
|
|
3999
|
+
# form parameters
|
|
4000
|
+
form_params = {}
|
|
4001
|
+
|
|
4002
|
+
# http body (model)
|
|
4003
|
+
post_body = nil
|
|
4004
|
+
|
|
4005
|
+
|
|
4006
|
+
auth_names = ['PureCloud Auth']
|
|
4007
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
4008
|
+
:header_params => header_params,
|
|
4009
|
+
:query_params => query_params,
|
|
4010
|
+
:form_params => form_params,
|
|
4011
|
+
:body => post_body,
|
|
4012
|
+
:auth_names => auth_names,
|
|
4013
|
+
:return_type => 'CampaignSequence')
|
|
4014
|
+
if @api_client.config.debugging
|
|
4015
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4016
|
+
end
|
|
4017
|
+
return data, status_code, headers
|
|
4018
|
+
end
|
|
4019
|
+
|
|
4020
|
+
# Update a new campaign sequence.
|
|
4021
|
+
#
|
|
4022
|
+
# @param sequence_id Campaign Sequence ID
|
|
4023
|
+
# @param [Hash] opts the optional parameters
|
|
4024
|
+
# @option opts [CampaignSequence] :body Organization
|
|
4025
|
+
# @return [CampaignSequence]
|
|
4026
|
+
def put_sequence(sequence_id, opts = {})
|
|
4027
|
+
data, status_code, headers = put_sequence_with_http_info(sequence_id, opts)
|
|
4028
|
+
return data
|
|
4029
|
+
end
|
|
4030
|
+
|
|
4031
|
+
# Update a new campaign sequence.
|
|
4032
|
+
#
|
|
4033
|
+
# @param sequence_id Campaign Sequence ID
|
|
4034
|
+
# @param [Hash] opts the optional parameters
|
|
4035
|
+
# @option opts [CampaignSequence] :body Organization
|
|
4036
|
+
# @return [Array<(CampaignSequence, Fixnum, Hash)>] CampaignSequence data, response status code and response headers
|
|
4037
|
+
def put_sequence_with_http_info(sequence_id, opts = {})
|
|
4038
|
+
if @api_client.config.debugging
|
|
4039
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_sequence ..."
|
|
4040
|
+
end
|
|
4041
|
+
|
|
4042
|
+
# verify the required parameter 'sequence_id' is set
|
|
4043
|
+
fail "Missing the required parameter 'sequence_id' when calling put_sequence" if sequence_id.nil?
|
|
4044
|
+
|
|
4045
|
+
# resource path
|
|
4046
|
+
path = "/api/v1/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)
|
|
4047
|
+
|
|
4048
|
+
# query parameters
|
|
4049
|
+
query_params = {}
|
|
4050
|
+
|
|
4051
|
+
# header parameters
|
|
4052
|
+
header_params = {}
|
|
4053
|
+
|
|
4054
|
+
# HTTP header 'Accept' (if needed)
|
|
4055
|
+
_header_accept = ['application/json']
|
|
4056
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
4057
|
+
|
|
4058
|
+
# HTTP header 'Content-Type'
|
|
4059
|
+
_header_content_type = ['application/json']
|
|
4060
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
4061
|
+
|
|
4062
|
+
# form parameters
|
|
4063
|
+
form_params = {}
|
|
4064
|
+
|
|
4065
|
+
# http body (model)
|
|
4066
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
4067
|
+
|
|
4068
|
+
|
|
4069
|
+
auth_names = ['PureCloud Auth']
|
|
4070
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
4071
|
+
:header_params => header_params,
|
|
4072
|
+
:query_params => query_params,
|
|
4073
|
+
:form_params => form_params,
|
|
4074
|
+
:body => post_body,
|
|
4075
|
+
:auth_names => auth_names,
|
|
4076
|
+
:return_type => 'CampaignSequence')
|
|
4077
|
+
if @api_client.config.debugging
|
|
4078
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4079
|
+
end
|
|
4080
|
+
return data, status_code, headers
|
|
4081
|
+
end
|
|
4082
|
+
|
|
4083
|
+
# Delete a dialer campaign sequence.
|
|
4084
|
+
#
|
|
4085
|
+
# @param sequence_id Campaign Sequence ID
|
|
4086
|
+
# @param [Hash] opts the optional parameters
|
|
4087
|
+
# @return [String]
|
|
4088
|
+
def delete_sequence(sequence_id, opts = {})
|
|
4089
|
+
data, status_code, headers = delete_sequence_with_http_info(sequence_id, opts)
|
|
4090
|
+
return data
|
|
4091
|
+
end
|
|
4092
|
+
|
|
4093
|
+
# Delete a dialer campaign sequence.
|
|
4094
|
+
#
|
|
4095
|
+
# @param sequence_id Campaign Sequence ID
|
|
4096
|
+
# @param [Hash] opts the optional parameters
|
|
4097
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
4098
|
+
def delete_sequence_with_http_info(sequence_id, opts = {})
|
|
4099
|
+
if @api_client.config.debugging
|
|
4100
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#delete_sequence ..."
|
|
4101
|
+
end
|
|
4102
|
+
|
|
4103
|
+
# verify the required parameter 'sequence_id' is set
|
|
4104
|
+
fail "Missing the required parameter 'sequence_id' when calling delete_sequence" if sequence_id.nil?
|
|
4105
|
+
|
|
4106
|
+
# resource path
|
|
4107
|
+
path = "/api/v1/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)
|
|
4108
|
+
|
|
4109
|
+
# query parameters
|
|
4110
|
+
query_params = {}
|
|
4111
|
+
|
|
4112
|
+
# header parameters
|
|
4113
|
+
header_params = {}
|
|
4114
|
+
|
|
4115
|
+
# HTTP header 'Accept' (if needed)
|
|
4116
|
+
_header_accept = ['application/json']
|
|
4117
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
4118
|
+
|
|
4119
|
+
# HTTP header 'Content-Type'
|
|
4120
|
+
_header_content_type = ['application/json']
|
|
4121
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
4122
|
+
|
|
4123
|
+
# form parameters
|
|
4124
|
+
form_params = {}
|
|
4125
|
+
|
|
4126
|
+
# http body (model)
|
|
4127
|
+
post_body = nil
|
|
4128
|
+
|
|
4129
|
+
|
|
4130
|
+
auth_names = ['PureCloud Auth']
|
|
4131
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
4132
|
+
:header_params => header_params,
|
|
4133
|
+
:query_params => query_params,
|
|
4134
|
+
:form_params => form_params,
|
|
4135
|
+
:body => post_body,
|
|
4136
|
+
:auth_names => auth_names,
|
|
4137
|
+
:return_type => 'String')
|
|
4138
|
+
if @api_client.config.debugging
|
|
4139
|
+
@api_client.config.logger.debug "API called: OutboundApi#delete_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4140
|
+
end
|
|
4141
|
+
return data, status_code, headers
|
|
4142
|
+
end
|
|
4143
|
+
|
|
4144
|
+
# Get the Dialer wrap up code mapping.
|
|
4145
|
+
#
|
|
4146
|
+
# @param [Hash] opts the optional parameters
|
|
4147
|
+
# @return [WrapUpCodeMapping]
|
|
4148
|
+
def get_wrapupcodemappings(opts = {})
|
|
4149
|
+
data, status_code, headers = get_wrapupcodemappings_with_http_info(opts)
|
|
4150
|
+
return data
|
|
4151
|
+
end
|
|
4152
|
+
|
|
4153
|
+
# Get the Dialer wrap up code mapping.
|
|
4154
|
+
#
|
|
4155
|
+
# @param [Hash] opts the optional parameters
|
|
4156
|
+
# @return [Array<(WrapUpCodeMapping, Fixnum, Hash)>] WrapUpCodeMapping data, response status code and response headers
|
|
4157
|
+
def get_wrapupcodemappings_with_http_info(opts = {})
|
|
4158
|
+
if @api_client.config.debugging
|
|
4159
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#get_wrapupcodemappings ..."
|
|
4160
|
+
end
|
|
4161
|
+
|
|
4162
|
+
# resource path
|
|
4163
|
+
path = "/api/v1/outbound/wrapupcodemappings".sub('{format}','json')
|
|
4164
|
+
|
|
4165
|
+
# query parameters
|
|
4166
|
+
query_params = {}
|
|
4167
|
+
|
|
4168
|
+
# header parameters
|
|
4169
|
+
header_params = {}
|
|
4170
|
+
|
|
4171
|
+
# HTTP header 'Accept' (if needed)
|
|
4172
|
+
_header_accept = ['application/json']
|
|
4173
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
4174
|
+
|
|
4175
|
+
# HTTP header 'Content-Type'
|
|
4176
|
+
_header_content_type = ['application/json']
|
|
4177
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
4178
|
+
|
|
4179
|
+
# form parameters
|
|
4180
|
+
form_params = {}
|
|
4181
|
+
|
|
4182
|
+
# http body (model)
|
|
4183
|
+
post_body = nil
|
|
4184
|
+
|
|
4185
|
+
|
|
4186
|
+
auth_names = ['PureCloud Auth']
|
|
4187
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
4188
|
+
:header_params => header_params,
|
|
4189
|
+
:query_params => query_params,
|
|
4190
|
+
:form_params => form_params,
|
|
4191
|
+
:body => post_body,
|
|
4192
|
+
:auth_names => auth_names,
|
|
4193
|
+
:return_type => 'WrapUpCodeMapping')
|
|
4194
|
+
if @api_client.config.debugging
|
|
4195
|
+
@api_client.config.logger.debug "API called: OutboundApi#get_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4196
|
+
end
|
|
4197
|
+
return data, status_code, headers
|
|
4198
|
+
end
|
|
4199
|
+
|
|
4200
|
+
# Update the Dialer wrap up code mapping.
|
|
4201
|
+
#
|
|
4202
|
+
# @param [Hash] opts the optional parameters
|
|
4203
|
+
# @option opts [WrapUpCodeMapping] :body wrapUpCodeMapping
|
|
4204
|
+
# @return [WrapUpCodeMapping]
|
|
4205
|
+
def put_wrapupcodemappings(opts = {})
|
|
4206
|
+
data, status_code, headers = put_wrapupcodemappings_with_http_info(opts)
|
|
4207
|
+
return data
|
|
4208
|
+
end
|
|
4209
|
+
|
|
4210
|
+
# Update the Dialer wrap up code mapping.
|
|
4211
|
+
#
|
|
4212
|
+
# @param [Hash] opts the optional parameters
|
|
4213
|
+
# @option opts [WrapUpCodeMapping] :body wrapUpCodeMapping
|
|
4214
|
+
# @return [Array<(WrapUpCodeMapping, Fixnum, Hash)>] WrapUpCodeMapping data, response status code and response headers
|
|
4215
|
+
def put_wrapupcodemappings_with_http_info(opts = {})
|
|
4216
|
+
if @api_client.config.debugging
|
|
4217
|
+
@api_client.config.logger.debug "Calling API: OutboundApi#put_wrapupcodemappings ..."
|
|
4218
|
+
end
|
|
4219
|
+
|
|
4220
|
+
# resource path
|
|
4221
|
+
path = "/api/v1/outbound/wrapupcodemappings".sub('{format}','json')
|
|
4222
|
+
|
|
4223
|
+
# query parameters
|
|
4224
|
+
query_params = {}
|
|
4225
|
+
|
|
4226
|
+
# header parameters
|
|
4227
|
+
header_params = {}
|
|
4228
|
+
|
|
4229
|
+
# HTTP header 'Accept' (if needed)
|
|
4230
|
+
_header_accept = ['application/json']
|
|
4231
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
4232
|
+
|
|
4233
|
+
# HTTP header 'Content-Type'
|
|
4234
|
+
_header_content_type = ['application/json']
|
|
4235
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
4236
|
+
|
|
4237
|
+
# form parameters
|
|
4238
|
+
form_params = {}
|
|
4239
|
+
|
|
4240
|
+
# http body (model)
|
|
4241
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
4242
|
+
|
|
4243
|
+
|
|
4244
|
+
auth_names = ['PureCloud Auth']
|
|
4245
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
4246
|
+
:header_params => header_params,
|
|
4247
|
+
:query_params => query_params,
|
|
4248
|
+
:form_params => form_params,
|
|
4249
|
+
:body => post_body,
|
|
4250
|
+
:auth_names => auth_names,
|
|
4251
|
+
:return_type => 'WrapUpCodeMapping')
|
|
4252
|
+
if @api_client.config.debugging
|
|
4253
|
+
@api_client.config.logger.debug "API called: OutboundApi#put_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4254
|
+
end
|
|
4255
|
+
return data, status_code, headers
|
|
4256
|
+
end
|
|
4257
|
+
end
|
|
4258
|
+
end
|
|
4259
|
+
|
|
4260
|
+
|
|
4261
|
+
|
|
4262
|
+
|