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,1699 @@
|
|
|
1
|
+
require "uri"
|
|
2
|
+
|
|
3
|
+
module PureCloud
|
|
4
|
+
class ConversationsApi
|
|
5
|
+
attr_accessor :api_client
|
|
6
|
+
|
|
7
|
+
def initialize(api_client = ApiClient.default)
|
|
8
|
+
@api_client = api_client
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# Get conversations
|
|
12
|
+
#
|
|
13
|
+
# @param [Hash] opts the optional parameters
|
|
14
|
+
# @option opts [String] :communication_type Call or Chat communication filtering
|
|
15
|
+
# @return [ConversationEntityListing]
|
|
16
|
+
def get_conversations(opts = {})
|
|
17
|
+
data, status_code, headers = get_conversations_with_http_info(opts)
|
|
18
|
+
return data
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Get conversations
|
|
22
|
+
#
|
|
23
|
+
# @param [Hash] opts the optional parameters
|
|
24
|
+
# @option opts [String] :communication_type Call or Chat communication filtering
|
|
25
|
+
# @return [Array<(ConversationEntityListing, Fixnum, Hash)>] ConversationEntityListing data, response status code and response headers
|
|
26
|
+
def get_conversations_with_http_info(opts = {})
|
|
27
|
+
if @api_client.config.debugging
|
|
28
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_conversations ..."
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# resource path
|
|
32
|
+
path = "/api/v1/conversations".sub('{format}','json')
|
|
33
|
+
|
|
34
|
+
# query parameters
|
|
35
|
+
query_params = {}
|
|
36
|
+
query_params[:'communicationType'] = opts[:'communication_type'] if opts[:'communication_type']
|
|
37
|
+
|
|
38
|
+
# header parameters
|
|
39
|
+
header_params = {}
|
|
40
|
+
|
|
41
|
+
# HTTP header 'Accept' (if needed)
|
|
42
|
+
_header_accept = ['application/json']
|
|
43
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
44
|
+
|
|
45
|
+
# HTTP header 'Content-Type'
|
|
46
|
+
_header_content_type = ['application/json']
|
|
47
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
48
|
+
|
|
49
|
+
# form parameters
|
|
50
|
+
form_params = {}
|
|
51
|
+
|
|
52
|
+
# http body (model)
|
|
53
|
+
post_body = nil
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
auth_names = ['PureCloud Auth']
|
|
57
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
58
|
+
:header_params => header_params,
|
|
59
|
+
:query_params => query_params,
|
|
60
|
+
:form_params => form_params,
|
|
61
|
+
:body => post_body,
|
|
62
|
+
:auth_names => auth_names,
|
|
63
|
+
:return_type => 'ConversationEntityListing')
|
|
64
|
+
if @api_client.config.debugging
|
|
65
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
66
|
+
end
|
|
67
|
+
return data, status_code, headers
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
# Create conversation
|
|
71
|
+
#
|
|
72
|
+
# @param [Hash] opts the optional parameters
|
|
73
|
+
# @option opts [String] :call Phone number to call
|
|
74
|
+
# @option opts [String] :call_from Queue id to place the call from
|
|
75
|
+
# @option opts [String] :call_queue_id Queue id to call
|
|
76
|
+
# @option opts [String] :call_user_id User id to call (this will call the default number)
|
|
77
|
+
# @option opts [Integer] :priority Priority level to use for routing when calling a queue
|
|
78
|
+
# @option opts [String] :language_id Language id to use for routing when calling a queue
|
|
79
|
+
# @option opts [Array<String>] :skill_ids Skill ids to use for routing when calling a queue
|
|
80
|
+
# @option opts [String] :body
|
|
81
|
+
# @return [ConversationResponse]
|
|
82
|
+
def post_conversations(opts = {})
|
|
83
|
+
data, status_code, headers = post_conversations_with_http_info(opts)
|
|
84
|
+
return data
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Create conversation
|
|
88
|
+
#
|
|
89
|
+
# @param [Hash] opts the optional parameters
|
|
90
|
+
# @option opts [String] :call Phone number to call
|
|
91
|
+
# @option opts [String] :call_from Queue id to place the call from
|
|
92
|
+
# @option opts [String] :call_queue_id Queue id to call
|
|
93
|
+
# @option opts [String] :call_user_id User id to call (this will call the default number)
|
|
94
|
+
# @option opts [Integer] :priority Priority level to use for routing when calling a queue
|
|
95
|
+
# @option opts [String] :language_id Language id to use for routing when calling a queue
|
|
96
|
+
# @option opts [Array<String>] :skill_ids Skill ids to use for routing when calling a queue
|
|
97
|
+
# @option opts [String] :body
|
|
98
|
+
# @return [Array<(ConversationResponse, Fixnum, Hash)>] ConversationResponse data, response status code and response headers
|
|
99
|
+
def post_conversations_with_http_info(opts = {})
|
|
100
|
+
if @api_client.config.debugging
|
|
101
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_conversations ..."
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# resource path
|
|
105
|
+
path = "/api/v1/conversations".sub('{format}','json')
|
|
106
|
+
|
|
107
|
+
# query parameters
|
|
108
|
+
query_params = {}
|
|
109
|
+
query_params[:'call'] = opts[:'call'] if opts[:'call']
|
|
110
|
+
query_params[:'callFrom'] = opts[:'call_from'] if opts[:'call_from']
|
|
111
|
+
query_params[:'callQueueId'] = opts[:'call_queue_id'] if opts[:'call_queue_id']
|
|
112
|
+
query_params[:'callUserId'] = opts[:'call_user_id'] if opts[:'call_user_id']
|
|
113
|
+
query_params[:'priority'] = opts[:'priority'] if opts[:'priority']
|
|
114
|
+
query_params[:'languageId'] = opts[:'language_id'] if opts[:'language_id']
|
|
115
|
+
query_params[:'skillIds'] = @api_client.build_collection_param(opts[:'skill_ids'], :multi) if opts[:'skill_ids']
|
|
116
|
+
|
|
117
|
+
# header parameters
|
|
118
|
+
header_params = {}
|
|
119
|
+
|
|
120
|
+
# HTTP header 'Accept' (if needed)
|
|
121
|
+
_header_accept = ['application/json']
|
|
122
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
123
|
+
|
|
124
|
+
# HTTP header 'Content-Type'
|
|
125
|
+
_header_content_type = ['application/json']
|
|
126
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
127
|
+
|
|
128
|
+
# form parameters
|
|
129
|
+
form_params = {}
|
|
130
|
+
|
|
131
|
+
# http body (model)
|
|
132
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
auth_names = ['PureCloud Auth']
|
|
136
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
137
|
+
:header_params => header_params,
|
|
138
|
+
:query_params => query_params,
|
|
139
|
+
:form_params => form_params,
|
|
140
|
+
:body => post_body,
|
|
141
|
+
:auth_names => auth_names,
|
|
142
|
+
:return_type => 'ConversationResponse')
|
|
143
|
+
if @api_client.config.debugging
|
|
144
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
145
|
+
end
|
|
146
|
+
return data, status_code, headers
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Create Fax Conversation
|
|
150
|
+
#
|
|
151
|
+
# @param [Hash] opts the optional parameters
|
|
152
|
+
# @option opts [FaxSendRequest] :body Fax
|
|
153
|
+
# @return [FaxSendResponse]
|
|
154
|
+
def post_fax(opts = {})
|
|
155
|
+
data, status_code, headers = post_fax_with_http_info(opts)
|
|
156
|
+
return data
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
# Create Fax Conversation
|
|
160
|
+
#
|
|
161
|
+
# @param [Hash] opts the optional parameters
|
|
162
|
+
# @option opts [FaxSendRequest] :body Fax
|
|
163
|
+
# @return [Array<(FaxSendResponse, Fixnum, Hash)>] FaxSendResponse data, response status code and response headers
|
|
164
|
+
def post_fax_with_http_info(opts = {})
|
|
165
|
+
if @api_client.config.debugging
|
|
166
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_fax ..."
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
# resource path
|
|
170
|
+
path = "/api/v1/conversations/fax".sub('{format}','json')
|
|
171
|
+
|
|
172
|
+
# query parameters
|
|
173
|
+
query_params = {}
|
|
174
|
+
|
|
175
|
+
# header parameters
|
|
176
|
+
header_params = {}
|
|
177
|
+
|
|
178
|
+
# HTTP header 'Accept' (if needed)
|
|
179
|
+
_header_accept = ['application/json']
|
|
180
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
181
|
+
|
|
182
|
+
# HTTP header 'Content-Type'
|
|
183
|
+
_header_content_type = ['application/json']
|
|
184
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
185
|
+
|
|
186
|
+
# form parameters
|
|
187
|
+
form_params = {}
|
|
188
|
+
|
|
189
|
+
# http body (model)
|
|
190
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
auth_names = ['PureCloud Auth']
|
|
194
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
195
|
+
:header_params => header_params,
|
|
196
|
+
:query_params => query_params,
|
|
197
|
+
:form_params => form_params,
|
|
198
|
+
:body => post_body,
|
|
199
|
+
:auth_names => auth_names,
|
|
200
|
+
:return_type => 'FaxSendResponse')
|
|
201
|
+
if @api_client.config.debugging
|
|
202
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_fax\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
203
|
+
end
|
|
204
|
+
return data, status_code, headers
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
# Get the maximum number of participants that this user can have on a conference
|
|
208
|
+
#
|
|
209
|
+
# @param [Hash] opts the optional parameters
|
|
210
|
+
# @return [MaxParticipants]
|
|
211
|
+
def get_maximumconferenceparties(opts = {})
|
|
212
|
+
data, status_code, headers = get_maximumconferenceparties_with_http_info(opts)
|
|
213
|
+
return data
|
|
214
|
+
end
|
|
215
|
+
|
|
216
|
+
# Get the maximum number of participants that this user can have on a conference
|
|
217
|
+
#
|
|
218
|
+
# @param [Hash] opts the optional parameters
|
|
219
|
+
# @return [Array<(MaxParticipants, Fixnum, Hash)>] MaxParticipants data, response status code and response headers
|
|
220
|
+
def get_maximumconferenceparties_with_http_info(opts = {})
|
|
221
|
+
if @api_client.config.debugging
|
|
222
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_maximumconferenceparties ..."
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# resource path
|
|
226
|
+
path = "/api/v1/conversations/maximumconferenceparties".sub('{format}','json')
|
|
227
|
+
|
|
228
|
+
# query parameters
|
|
229
|
+
query_params = {}
|
|
230
|
+
|
|
231
|
+
# header parameters
|
|
232
|
+
header_params = {}
|
|
233
|
+
|
|
234
|
+
# HTTP header 'Accept' (if needed)
|
|
235
|
+
_header_accept = ['application/json']
|
|
236
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
237
|
+
|
|
238
|
+
# HTTP header 'Content-Type'
|
|
239
|
+
_header_content_type = ['application/json']
|
|
240
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
241
|
+
|
|
242
|
+
# form parameters
|
|
243
|
+
form_params = {}
|
|
244
|
+
|
|
245
|
+
# http body (model)
|
|
246
|
+
post_body = nil
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
auth_names = ['PureCloud Auth']
|
|
250
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
251
|
+
:header_params => header_params,
|
|
252
|
+
:query_params => query_params,
|
|
253
|
+
:form_params => form_params,
|
|
254
|
+
:body => post_body,
|
|
255
|
+
:auth_names => auth_names,
|
|
256
|
+
:return_type => 'MaxParticipants')
|
|
257
|
+
if @api_client.config.debugging
|
|
258
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_maximumconferenceparties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
259
|
+
end
|
|
260
|
+
return data, status_code, headers
|
|
261
|
+
end
|
|
262
|
+
|
|
263
|
+
# Query historical conversations
|
|
264
|
+
#
|
|
265
|
+
# @param body Query parameters
|
|
266
|
+
# @param [Hash] opts the optional parameters
|
|
267
|
+
# @return [ConversationQueryResponse]
|
|
268
|
+
def post_query(body, opts = {})
|
|
269
|
+
data, status_code, headers = post_query_with_http_info(body, opts)
|
|
270
|
+
return data
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
# Query historical conversations
|
|
274
|
+
#
|
|
275
|
+
# @param body Query parameters
|
|
276
|
+
# @param [Hash] opts the optional parameters
|
|
277
|
+
# @return [Array<(ConversationQueryResponse, Fixnum, Hash)>] ConversationQueryResponse data, response status code and response headers
|
|
278
|
+
def post_query_with_http_info(body, opts = {})
|
|
279
|
+
if @api_client.config.debugging
|
|
280
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_query ..."
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
# verify the required parameter 'body' is set
|
|
284
|
+
fail "Missing the required parameter 'body' when calling post_query" if body.nil?
|
|
285
|
+
|
|
286
|
+
# resource path
|
|
287
|
+
path = "/api/v1/conversations/query".sub('{format}','json')
|
|
288
|
+
|
|
289
|
+
# query parameters
|
|
290
|
+
query_params = {}
|
|
291
|
+
|
|
292
|
+
# header parameters
|
|
293
|
+
header_params = {}
|
|
294
|
+
|
|
295
|
+
# HTTP header 'Accept' (if needed)
|
|
296
|
+
_header_accept = ['application/json']
|
|
297
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
298
|
+
|
|
299
|
+
# HTTP header 'Content-Type'
|
|
300
|
+
_header_content_type = ['application/json']
|
|
301
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
302
|
+
|
|
303
|
+
# form parameters
|
|
304
|
+
form_params = {}
|
|
305
|
+
|
|
306
|
+
# http body (model)
|
|
307
|
+
post_body = @api_client.object_to_http_body(body)
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
auth_names = ['PureCloud Auth']
|
|
311
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
312
|
+
:header_params => header_params,
|
|
313
|
+
:query_params => query_params,
|
|
314
|
+
:form_params => form_params,
|
|
315
|
+
:body => post_body,
|
|
316
|
+
:auth_names => auth_names,
|
|
317
|
+
:return_type => 'ConversationQueryResponse')
|
|
318
|
+
if @api_client.config.debugging
|
|
319
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
320
|
+
end
|
|
321
|
+
return data, status_code, headers
|
|
322
|
+
end
|
|
323
|
+
|
|
324
|
+
# Query historical conversations with a date/time anchor
|
|
325
|
+
#
|
|
326
|
+
# @param anchor A point in time within the interval for the query that bounds the query. In the form of YYYYMMDDHHmmssSSSZX where YYYY is the 4-digit year, MM is the 2-digit month, DD is the 2-digit day-of-month, HH is the 2-digit hour-of-day (00-23), mm is the 2-digit minute, ss is the 2-digit second, SSS is the 3-digit millisecond, Z is the UTC offset expressed as 'Z', '+nnnn', '-nnnn', '+nn:nn', '-nn:nn', and X is either 'A' (for the anchor point being at the earliest point in the query) or 'D' (for the anchor point being the latest point in the query
|
|
327
|
+
# @param body Query parameters
|
|
328
|
+
# @param [Hash] opts the optional parameters
|
|
329
|
+
# @return [ConversationQueryResponse]
|
|
330
|
+
def post_query_0(anchor, body, opts = {})
|
|
331
|
+
data, status_code, headers = post_query_0_with_http_info(anchor, body, opts)
|
|
332
|
+
return data
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
# Query historical conversations with a date/time anchor
|
|
336
|
+
#
|
|
337
|
+
# @param anchor A point in time within the interval for the query that bounds the query. In the form of YYYYMMDDHHmmssSSSZX where YYYY is the 4-digit year, MM is the 2-digit month, DD is the 2-digit day-of-month, HH is the 2-digit hour-of-day (00-23), mm is the 2-digit minute, ss is the 2-digit second, SSS is the 3-digit millisecond, Z is the UTC offset expressed as 'Z', '+nnnn', '-nnnn', '+nn:nn', '-nn:nn', and X is either 'A' (for the anchor point being at the earliest point in the query) or 'D' (for the anchor point being the latest point in the query
|
|
338
|
+
# @param body Query parameters
|
|
339
|
+
# @param [Hash] opts the optional parameters
|
|
340
|
+
# @return [Array<(ConversationQueryResponse, Fixnum, Hash)>] ConversationQueryResponse data, response status code and response headers
|
|
341
|
+
def post_query_0_with_http_info(anchor, body, opts = {})
|
|
342
|
+
if @api_client.config.debugging
|
|
343
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_query_0 ..."
|
|
344
|
+
end
|
|
345
|
+
|
|
346
|
+
# verify the required parameter 'anchor' is set
|
|
347
|
+
fail "Missing the required parameter 'anchor' when calling post_query_0" if anchor.nil?
|
|
348
|
+
|
|
349
|
+
# verify the required parameter 'body' is set
|
|
350
|
+
fail "Missing the required parameter 'body' when calling post_query_0" if body.nil?
|
|
351
|
+
|
|
352
|
+
# resource path
|
|
353
|
+
path = "/api/v1/conversations/query/{anchor}".sub('{format}','json').sub('{' + 'anchor' + '}', anchor.to_s)
|
|
354
|
+
|
|
355
|
+
# query parameters
|
|
356
|
+
query_params = {}
|
|
357
|
+
|
|
358
|
+
# header parameters
|
|
359
|
+
header_params = {}
|
|
360
|
+
|
|
361
|
+
# HTTP header 'Accept' (if needed)
|
|
362
|
+
_header_accept = ['application/json']
|
|
363
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
364
|
+
|
|
365
|
+
# HTTP header 'Content-Type'
|
|
366
|
+
_header_content_type = ['application/json']
|
|
367
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
368
|
+
|
|
369
|
+
# form parameters
|
|
370
|
+
form_params = {}
|
|
371
|
+
|
|
372
|
+
# http body (model)
|
|
373
|
+
post_body = @api_client.object_to_http_body(body)
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
auth_names = ['PureCloud Auth']
|
|
377
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
378
|
+
:header_params => header_params,
|
|
379
|
+
:query_params => query_params,
|
|
380
|
+
:form_params => form_params,
|
|
381
|
+
:body => post_body,
|
|
382
|
+
:auth_names => auth_names,
|
|
383
|
+
:return_type => 'ConversationQueryResponse')
|
|
384
|
+
if @api_client.config.debugging
|
|
385
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_query_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
386
|
+
end
|
|
387
|
+
return data, status_code, headers
|
|
388
|
+
end
|
|
389
|
+
|
|
390
|
+
# Get conversation
|
|
391
|
+
#
|
|
392
|
+
# @param conversation_id conversation ID
|
|
393
|
+
# @param [Hash] opts the optional parameters
|
|
394
|
+
# @return [Conversation]
|
|
395
|
+
def get(conversation_id, opts = {})
|
|
396
|
+
data, status_code, headers = get_with_http_info(conversation_id, opts)
|
|
397
|
+
return data
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
# Get conversation
|
|
401
|
+
#
|
|
402
|
+
# @param conversation_id conversation ID
|
|
403
|
+
# @param [Hash] opts the optional parameters
|
|
404
|
+
# @return [Array<(Conversation, Fixnum, Hash)>] Conversation data, response status code and response headers
|
|
405
|
+
def get_with_http_info(conversation_id, opts = {})
|
|
406
|
+
if @api_client.config.debugging
|
|
407
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get ..."
|
|
408
|
+
end
|
|
409
|
+
|
|
410
|
+
# verify the required parameter 'conversation_id' is set
|
|
411
|
+
fail "Missing the required parameter 'conversation_id' when calling get" if conversation_id.nil?
|
|
412
|
+
|
|
413
|
+
# resource path
|
|
414
|
+
path = "/api/v1/conversations/{conversationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
415
|
+
|
|
416
|
+
# query parameters
|
|
417
|
+
query_params = {}
|
|
418
|
+
|
|
419
|
+
# header parameters
|
|
420
|
+
header_params = {}
|
|
421
|
+
|
|
422
|
+
# HTTP header 'Accept' (if needed)
|
|
423
|
+
_header_accept = ['application/json']
|
|
424
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
425
|
+
|
|
426
|
+
# HTTP header 'Content-Type'
|
|
427
|
+
_header_content_type = ['application/json']
|
|
428
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
429
|
+
|
|
430
|
+
# form parameters
|
|
431
|
+
form_params = {}
|
|
432
|
+
|
|
433
|
+
# http body (model)
|
|
434
|
+
post_body = nil
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
auth_names = ['PureCloud Auth']
|
|
438
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
439
|
+
:header_params => header_params,
|
|
440
|
+
:query_params => query_params,
|
|
441
|
+
:form_params => form_params,
|
|
442
|
+
:body => post_body,
|
|
443
|
+
:auth_names => auth_names,
|
|
444
|
+
:return_type => 'Conversation')
|
|
445
|
+
if @api_client.config.debugging
|
|
446
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
447
|
+
end
|
|
448
|
+
return data, status_code, headers
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
# Update conversation
|
|
452
|
+
#
|
|
453
|
+
# @param conversation_id conversation ID
|
|
454
|
+
# @param [Hash] opts the optional parameters
|
|
455
|
+
# @option opts [Conversation] :body Conversation
|
|
456
|
+
# @return [Conversation]
|
|
457
|
+
def put(conversation_id, opts = {})
|
|
458
|
+
data, status_code, headers = put_with_http_info(conversation_id, opts)
|
|
459
|
+
return data
|
|
460
|
+
end
|
|
461
|
+
|
|
462
|
+
# Update conversation
|
|
463
|
+
#
|
|
464
|
+
# @param conversation_id conversation ID
|
|
465
|
+
# @param [Hash] opts the optional parameters
|
|
466
|
+
# @option opts [Conversation] :body Conversation
|
|
467
|
+
# @return [Array<(Conversation, Fixnum, Hash)>] Conversation data, response status code and response headers
|
|
468
|
+
def put_with_http_info(conversation_id, opts = {})
|
|
469
|
+
if @api_client.config.debugging
|
|
470
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#put ..."
|
|
471
|
+
end
|
|
472
|
+
|
|
473
|
+
# verify the required parameter 'conversation_id' is set
|
|
474
|
+
fail "Missing the required parameter 'conversation_id' when calling put" if conversation_id.nil?
|
|
475
|
+
|
|
476
|
+
# resource path
|
|
477
|
+
path = "/api/v1/conversations/{conversationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
478
|
+
|
|
479
|
+
# query parameters
|
|
480
|
+
query_params = {}
|
|
481
|
+
|
|
482
|
+
# header parameters
|
|
483
|
+
header_params = {}
|
|
484
|
+
|
|
485
|
+
# HTTP header 'Accept' (if needed)
|
|
486
|
+
_header_accept = ['application/json']
|
|
487
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
488
|
+
|
|
489
|
+
# HTTP header 'Content-Type'
|
|
490
|
+
_header_content_type = ['application/json']
|
|
491
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
492
|
+
|
|
493
|
+
# form parameters
|
|
494
|
+
form_params = {}
|
|
495
|
+
|
|
496
|
+
# http body (model)
|
|
497
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
auth_names = ['PureCloud Auth']
|
|
501
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
502
|
+
:header_params => header_params,
|
|
503
|
+
:query_params => query_params,
|
|
504
|
+
:form_params => form_params,
|
|
505
|
+
:body => post_body,
|
|
506
|
+
:auth_names => auth_names,
|
|
507
|
+
:return_type => 'Conversation')
|
|
508
|
+
if @api_client.config.debugging
|
|
509
|
+
@api_client.config.logger.debug "API called: ConversationsApi#put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
510
|
+
end
|
|
511
|
+
return data, status_code, headers
|
|
512
|
+
end
|
|
513
|
+
|
|
514
|
+
# Get conversation messages
|
|
515
|
+
#
|
|
516
|
+
# @param conversation_id conversation ID
|
|
517
|
+
# @param [Hash] opts the optional parameters
|
|
518
|
+
# @return [EmailMessageListing]
|
|
519
|
+
def get_messages(conversation_id, opts = {})
|
|
520
|
+
data, status_code, headers = get_messages_with_http_info(conversation_id, opts)
|
|
521
|
+
return data
|
|
522
|
+
end
|
|
523
|
+
|
|
524
|
+
# Get conversation messages
|
|
525
|
+
#
|
|
526
|
+
# @param conversation_id conversation ID
|
|
527
|
+
# @param [Hash] opts the optional parameters
|
|
528
|
+
# @return [Array<(EmailMessageListing, Fixnum, Hash)>] EmailMessageListing data, response status code and response headers
|
|
529
|
+
def get_messages_with_http_info(conversation_id, opts = {})
|
|
530
|
+
if @api_client.config.debugging
|
|
531
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_messages ..."
|
|
532
|
+
end
|
|
533
|
+
|
|
534
|
+
# verify the required parameter 'conversation_id' is set
|
|
535
|
+
fail "Missing the required parameter 'conversation_id' when calling get_messages" if conversation_id.nil?
|
|
536
|
+
|
|
537
|
+
# resource path
|
|
538
|
+
path = "/api/v1/conversations/{conversationId}/messages".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
539
|
+
|
|
540
|
+
# query parameters
|
|
541
|
+
query_params = {}
|
|
542
|
+
|
|
543
|
+
# header parameters
|
|
544
|
+
header_params = {}
|
|
545
|
+
|
|
546
|
+
# HTTP header 'Accept' (if needed)
|
|
547
|
+
_header_accept = ['application/json']
|
|
548
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
549
|
+
|
|
550
|
+
# HTTP header 'Content-Type'
|
|
551
|
+
_header_content_type = ['application/json']
|
|
552
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
553
|
+
|
|
554
|
+
# form parameters
|
|
555
|
+
form_params = {}
|
|
556
|
+
|
|
557
|
+
# http body (model)
|
|
558
|
+
post_body = nil
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
auth_names = ['PureCloud Auth']
|
|
562
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
563
|
+
:header_params => header_params,
|
|
564
|
+
:query_params => query_params,
|
|
565
|
+
:form_params => form_params,
|
|
566
|
+
:body => post_body,
|
|
567
|
+
:auth_names => auth_names,
|
|
568
|
+
:return_type => 'EmailMessageListing')
|
|
569
|
+
if @api_client.config.debugging
|
|
570
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
571
|
+
end
|
|
572
|
+
return data, status_code, headers
|
|
573
|
+
end
|
|
574
|
+
|
|
575
|
+
# Send an email reply
|
|
576
|
+
#
|
|
577
|
+
# @param conversation_id conversation ID
|
|
578
|
+
# @param [Hash] opts the optional parameters
|
|
579
|
+
# @option opts [EmailMessage] :body Reply
|
|
580
|
+
# @return [EmailMessage]
|
|
581
|
+
def post_messages(conversation_id, opts = {})
|
|
582
|
+
data, status_code, headers = post_messages_with_http_info(conversation_id, opts)
|
|
583
|
+
return data
|
|
584
|
+
end
|
|
585
|
+
|
|
586
|
+
# Send an email reply
|
|
587
|
+
#
|
|
588
|
+
# @param conversation_id conversation ID
|
|
589
|
+
# @param [Hash] opts the optional parameters
|
|
590
|
+
# @option opts [EmailMessage] :body Reply
|
|
591
|
+
# @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
|
|
592
|
+
def post_messages_with_http_info(conversation_id, opts = {})
|
|
593
|
+
if @api_client.config.debugging
|
|
594
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_messages ..."
|
|
595
|
+
end
|
|
596
|
+
|
|
597
|
+
# verify the required parameter 'conversation_id' is set
|
|
598
|
+
fail "Missing the required parameter 'conversation_id' when calling post_messages" if conversation_id.nil?
|
|
599
|
+
|
|
600
|
+
# resource path
|
|
601
|
+
path = "/api/v1/conversations/{conversationId}/messages".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
602
|
+
|
|
603
|
+
# query parameters
|
|
604
|
+
query_params = {}
|
|
605
|
+
|
|
606
|
+
# header parameters
|
|
607
|
+
header_params = {}
|
|
608
|
+
|
|
609
|
+
# HTTP header 'Accept' (if needed)
|
|
610
|
+
_header_accept = ['application/json']
|
|
611
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
612
|
+
|
|
613
|
+
# HTTP header 'Content-Type'
|
|
614
|
+
_header_content_type = ['application/json']
|
|
615
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
616
|
+
|
|
617
|
+
# form parameters
|
|
618
|
+
form_params = {}
|
|
619
|
+
|
|
620
|
+
# http body (model)
|
|
621
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
auth_names = ['PureCloud Auth']
|
|
625
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
626
|
+
:header_params => header_params,
|
|
627
|
+
:query_params => query_params,
|
|
628
|
+
:form_params => form_params,
|
|
629
|
+
:body => post_body,
|
|
630
|
+
:auth_names => auth_names,
|
|
631
|
+
:return_type => 'EmailMessage')
|
|
632
|
+
if @api_client.config.debugging
|
|
633
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
634
|
+
end
|
|
635
|
+
return data, status_code, headers
|
|
636
|
+
end
|
|
637
|
+
|
|
638
|
+
# Get conversation draft reply
|
|
639
|
+
#
|
|
640
|
+
# @param conversation_id conversation ID
|
|
641
|
+
# @param [Hash] opts the optional parameters
|
|
642
|
+
# @return [EmailMessage]
|
|
643
|
+
def get_messages_draft(conversation_id, opts = {})
|
|
644
|
+
data, status_code, headers = get_messages_draft_with_http_info(conversation_id, opts)
|
|
645
|
+
return data
|
|
646
|
+
end
|
|
647
|
+
|
|
648
|
+
# Get conversation draft reply
|
|
649
|
+
#
|
|
650
|
+
# @param conversation_id conversation ID
|
|
651
|
+
# @param [Hash] opts the optional parameters
|
|
652
|
+
# @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
|
|
653
|
+
def get_messages_draft_with_http_info(conversation_id, opts = {})
|
|
654
|
+
if @api_client.config.debugging
|
|
655
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_messages_draft ..."
|
|
656
|
+
end
|
|
657
|
+
|
|
658
|
+
# verify the required parameter 'conversation_id' is set
|
|
659
|
+
fail "Missing the required parameter 'conversation_id' when calling get_messages_draft" if conversation_id.nil?
|
|
660
|
+
|
|
661
|
+
# resource path
|
|
662
|
+
path = "/api/v1/conversations/{conversationId}/messages/draft".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
663
|
+
|
|
664
|
+
# query parameters
|
|
665
|
+
query_params = {}
|
|
666
|
+
|
|
667
|
+
# header parameters
|
|
668
|
+
header_params = {}
|
|
669
|
+
|
|
670
|
+
# HTTP header 'Accept' (if needed)
|
|
671
|
+
_header_accept = ['application/json']
|
|
672
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
673
|
+
|
|
674
|
+
# HTTP header 'Content-Type'
|
|
675
|
+
_header_content_type = ['application/json']
|
|
676
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
677
|
+
|
|
678
|
+
# form parameters
|
|
679
|
+
form_params = {}
|
|
680
|
+
|
|
681
|
+
# http body (model)
|
|
682
|
+
post_body = nil
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
auth_names = ['PureCloud Auth']
|
|
686
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
687
|
+
:header_params => header_params,
|
|
688
|
+
:query_params => query_params,
|
|
689
|
+
:form_params => form_params,
|
|
690
|
+
:body => post_body,
|
|
691
|
+
:auth_names => auth_names,
|
|
692
|
+
:return_type => 'EmailMessage')
|
|
693
|
+
if @api_client.config.debugging
|
|
694
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_messages_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
695
|
+
end
|
|
696
|
+
return data, status_code, headers
|
|
697
|
+
end
|
|
698
|
+
|
|
699
|
+
# Update conversation draft reply
|
|
700
|
+
#
|
|
701
|
+
# @param conversation_id conversation ID
|
|
702
|
+
# @param [Hash] opts the optional parameters
|
|
703
|
+
# @option opts [EmailMessage] :body Draft
|
|
704
|
+
# @return [EmailMessage]
|
|
705
|
+
def put_messages_draft(conversation_id, opts = {})
|
|
706
|
+
data, status_code, headers = put_messages_draft_with_http_info(conversation_id, opts)
|
|
707
|
+
return data
|
|
708
|
+
end
|
|
709
|
+
|
|
710
|
+
# Update conversation draft reply
|
|
711
|
+
#
|
|
712
|
+
# @param conversation_id conversation ID
|
|
713
|
+
# @param [Hash] opts the optional parameters
|
|
714
|
+
# @option opts [EmailMessage] :body Draft
|
|
715
|
+
# @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
|
|
716
|
+
def put_messages_draft_with_http_info(conversation_id, opts = {})
|
|
717
|
+
if @api_client.config.debugging
|
|
718
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#put_messages_draft ..."
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
# verify the required parameter 'conversation_id' is set
|
|
722
|
+
fail "Missing the required parameter 'conversation_id' when calling put_messages_draft" if conversation_id.nil?
|
|
723
|
+
|
|
724
|
+
# resource path
|
|
725
|
+
path = "/api/v1/conversations/{conversationId}/messages/draft".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
726
|
+
|
|
727
|
+
# query parameters
|
|
728
|
+
query_params = {}
|
|
729
|
+
|
|
730
|
+
# header parameters
|
|
731
|
+
header_params = {}
|
|
732
|
+
|
|
733
|
+
# HTTP header 'Accept' (if needed)
|
|
734
|
+
_header_accept = ['application/json']
|
|
735
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
736
|
+
|
|
737
|
+
# HTTP header 'Content-Type'
|
|
738
|
+
_header_content_type = ['application/json']
|
|
739
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
740
|
+
|
|
741
|
+
# form parameters
|
|
742
|
+
form_params = {}
|
|
743
|
+
|
|
744
|
+
# http body (model)
|
|
745
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
auth_names = ['PureCloud Auth']
|
|
749
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
750
|
+
:header_params => header_params,
|
|
751
|
+
:query_params => query_params,
|
|
752
|
+
:form_params => form_params,
|
|
753
|
+
:body => post_body,
|
|
754
|
+
:auth_names => auth_names,
|
|
755
|
+
:return_type => 'EmailMessage')
|
|
756
|
+
if @api_client.config.debugging
|
|
757
|
+
@api_client.config.logger.debug "API called: ConversationsApi#put_messages_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
758
|
+
end
|
|
759
|
+
return data, status_code, headers
|
|
760
|
+
end
|
|
761
|
+
|
|
762
|
+
# Delete attachment from draft
|
|
763
|
+
#
|
|
764
|
+
# @param conversation_id conversation ID
|
|
765
|
+
# @param attachment_id attachment ID
|
|
766
|
+
# @param [Hash] opts the optional parameters
|
|
767
|
+
# @return [String]
|
|
768
|
+
def delete_messages_draft_attachment(conversation_id, attachment_id, opts = {})
|
|
769
|
+
data, status_code, headers = delete_messages_draft_attachment_with_http_info(conversation_id, attachment_id, opts)
|
|
770
|
+
return data
|
|
771
|
+
end
|
|
772
|
+
|
|
773
|
+
# Delete attachment from draft
|
|
774
|
+
#
|
|
775
|
+
# @param conversation_id conversation ID
|
|
776
|
+
# @param attachment_id attachment ID
|
|
777
|
+
# @param [Hash] opts the optional parameters
|
|
778
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
779
|
+
def delete_messages_draft_attachment_with_http_info(conversation_id, attachment_id, opts = {})
|
|
780
|
+
if @api_client.config.debugging
|
|
781
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#delete_messages_draft_attachment ..."
|
|
782
|
+
end
|
|
783
|
+
|
|
784
|
+
# verify the required parameter 'conversation_id' is set
|
|
785
|
+
fail "Missing the required parameter 'conversation_id' when calling delete_messages_draft_attachment" if conversation_id.nil?
|
|
786
|
+
|
|
787
|
+
# verify the required parameter 'attachment_id' is set
|
|
788
|
+
fail "Missing the required parameter 'attachment_id' when calling delete_messages_draft_attachment" if attachment_id.nil?
|
|
789
|
+
|
|
790
|
+
# resource path
|
|
791
|
+
path = "/api/v1/conversations/{conversationId}/messages/draft/attachments/{attachmentId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'attachmentId' + '}', attachment_id.to_s)
|
|
792
|
+
|
|
793
|
+
# query parameters
|
|
794
|
+
query_params = {}
|
|
795
|
+
|
|
796
|
+
# header parameters
|
|
797
|
+
header_params = {}
|
|
798
|
+
|
|
799
|
+
# HTTP header 'Accept' (if needed)
|
|
800
|
+
_header_accept = ['application/json']
|
|
801
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
802
|
+
|
|
803
|
+
# HTTP header 'Content-Type'
|
|
804
|
+
_header_content_type = ['application/json']
|
|
805
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
806
|
+
|
|
807
|
+
# form parameters
|
|
808
|
+
form_params = {}
|
|
809
|
+
|
|
810
|
+
# http body (model)
|
|
811
|
+
post_body = nil
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
auth_names = ['PureCloud Auth']
|
|
815
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
816
|
+
:header_params => header_params,
|
|
817
|
+
:query_params => query_params,
|
|
818
|
+
:form_params => form_params,
|
|
819
|
+
:body => post_body,
|
|
820
|
+
:auth_names => auth_names,
|
|
821
|
+
:return_type => 'String')
|
|
822
|
+
if @api_client.config.debugging
|
|
823
|
+
@api_client.config.logger.debug "API called: ConversationsApi#delete_messages_draft_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
824
|
+
end
|
|
825
|
+
return data, status_code, headers
|
|
826
|
+
end
|
|
827
|
+
|
|
828
|
+
# Get conversation message
|
|
829
|
+
#
|
|
830
|
+
# @param conversation_id conversation ID
|
|
831
|
+
# @param id message ID
|
|
832
|
+
# @param [Hash] opts the optional parameters
|
|
833
|
+
# @return [EmailMessage]
|
|
834
|
+
def get_messages_0(conversation_id, id, opts = {})
|
|
835
|
+
data, status_code, headers = get_messages_0_with_http_info(conversation_id, id, opts)
|
|
836
|
+
return data
|
|
837
|
+
end
|
|
838
|
+
|
|
839
|
+
# Get conversation message
|
|
840
|
+
#
|
|
841
|
+
# @param conversation_id conversation ID
|
|
842
|
+
# @param id message ID
|
|
843
|
+
# @param [Hash] opts the optional parameters
|
|
844
|
+
# @return [Array<(EmailMessage, Fixnum, Hash)>] EmailMessage data, response status code and response headers
|
|
845
|
+
def get_messages_0_with_http_info(conversation_id, id, opts = {})
|
|
846
|
+
if @api_client.config.debugging
|
|
847
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_messages_0 ..."
|
|
848
|
+
end
|
|
849
|
+
|
|
850
|
+
# verify the required parameter 'conversation_id' is set
|
|
851
|
+
fail "Missing the required parameter 'conversation_id' when calling get_messages_0" if conversation_id.nil?
|
|
852
|
+
|
|
853
|
+
# verify the required parameter 'id' is set
|
|
854
|
+
fail "Missing the required parameter 'id' when calling get_messages_0" if id.nil?
|
|
855
|
+
|
|
856
|
+
# resource path
|
|
857
|
+
path = "/api/v1/conversations/{conversationId}/messages/{id}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'id' + '}', id.to_s)
|
|
858
|
+
|
|
859
|
+
# query parameters
|
|
860
|
+
query_params = {}
|
|
861
|
+
|
|
862
|
+
# header parameters
|
|
863
|
+
header_params = {}
|
|
864
|
+
|
|
865
|
+
# HTTP header 'Accept' (if needed)
|
|
866
|
+
_header_accept = ['application/json']
|
|
867
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
868
|
+
|
|
869
|
+
# HTTP header 'Content-Type'
|
|
870
|
+
_header_content_type = ['application/json']
|
|
871
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
872
|
+
|
|
873
|
+
# form parameters
|
|
874
|
+
form_params = {}
|
|
875
|
+
|
|
876
|
+
# http body (model)
|
|
877
|
+
post_body = nil
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
auth_names = ['PureCloud Auth']
|
|
881
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
882
|
+
:header_params => header_params,
|
|
883
|
+
:query_params => query_params,
|
|
884
|
+
:form_params => form_params,
|
|
885
|
+
:body => post_body,
|
|
886
|
+
:auth_names => auth_names,
|
|
887
|
+
:return_type => 'EmailMessage')
|
|
888
|
+
if @api_client.config.debugging
|
|
889
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_messages_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
890
|
+
end
|
|
891
|
+
return data, status_code, headers
|
|
892
|
+
end
|
|
893
|
+
|
|
894
|
+
# Add participants to a conversation
|
|
895
|
+
#
|
|
896
|
+
# @param conversation_id conversation ID
|
|
897
|
+
# @param [Hash] opts the optional parameters
|
|
898
|
+
# @option opts [Conversation] :body Conversation
|
|
899
|
+
# @return [Conversation]
|
|
900
|
+
def post_participants(conversation_id, opts = {})
|
|
901
|
+
data, status_code, headers = post_participants_with_http_info(conversation_id, opts)
|
|
902
|
+
return data
|
|
903
|
+
end
|
|
904
|
+
|
|
905
|
+
# Add participants to a conversation
|
|
906
|
+
#
|
|
907
|
+
# @param conversation_id conversation ID
|
|
908
|
+
# @param [Hash] opts the optional parameters
|
|
909
|
+
# @option opts [Conversation] :body Conversation
|
|
910
|
+
# @return [Array<(Conversation, Fixnum, Hash)>] Conversation data, response status code and response headers
|
|
911
|
+
def post_participants_with_http_info(conversation_id, opts = {})
|
|
912
|
+
if @api_client.config.debugging
|
|
913
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_participants ..."
|
|
914
|
+
end
|
|
915
|
+
|
|
916
|
+
# verify the required parameter 'conversation_id' is set
|
|
917
|
+
fail "Missing the required parameter 'conversation_id' when calling post_participants" if conversation_id.nil?
|
|
918
|
+
|
|
919
|
+
# resource path
|
|
920
|
+
path = "/api/v1/conversations/{conversationId}/participants".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
921
|
+
|
|
922
|
+
# query parameters
|
|
923
|
+
query_params = {}
|
|
924
|
+
|
|
925
|
+
# header parameters
|
|
926
|
+
header_params = {}
|
|
927
|
+
|
|
928
|
+
# HTTP header 'Accept' (if needed)
|
|
929
|
+
_header_accept = ['application/json']
|
|
930
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
931
|
+
|
|
932
|
+
# HTTP header 'Content-Type'
|
|
933
|
+
_header_content_type = ['application/json']
|
|
934
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
935
|
+
|
|
936
|
+
# form parameters
|
|
937
|
+
form_params = {}
|
|
938
|
+
|
|
939
|
+
# http body (model)
|
|
940
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
auth_names = ['PureCloud Auth']
|
|
944
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
945
|
+
:header_params => header_params,
|
|
946
|
+
:query_params => query_params,
|
|
947
|
+
:form_params => form_params,
|
|
948
|
+
:body => post_body,
|
|
949
|
+
:auth_names => auth_names,
|
|
950
|
+
:return_type => 'Conversation')
|
|
951
|
+
if @api_client.config.debugging
|
|
952
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_participants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
953
|
+
end
|
|
954
|
+
return data, status_code, headers
|
|
955
|
+
end
|
|
956
|
+
|
|
957
|
+
# Update a participant.
|
|
958
|
+
# Specify the state as CONNECTED, DISCONNECTED. You can specify a wrap-up code.
|
|
959
|
+
# @param conversation_id conversation ID
|
|
960
|
+
# @param participant_id participant ID
|
|
961
|
+
# @param [Hash] opts the optional parameters
|
|
962
|
+
# @option opts [ParticipantRequest] :body
|
|
963
|
+
# @return [nil]
|
|
964
|
+
def put_participant(conversation_id, participant_id, opts = {})
|
|
965
|
+
put_participant_with_http_info(conversation_id, participant_id, opts)
|
|
966
|
+
return nil
|
|
967
|
+
end
|
|
968
|
+
|
|
969
|
+
# Update a participant.
|
|
970
|
+
# Specify the state as CONNECTED, DISCONNECTED. You can specify a wrap-up code.
|
|
971
|
+
# @param conversation_id conversation ID
|
|
972
|
+
# @param participant_id participant ID
|
|
973
|
+
# @param [Hash] opts the optional parameters
|
|
974
|
+
# @option opts [ParticipantRequest] :body
|
|
975
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
976
|
+
def put_participant_with_http_info(conversation_id, participant_id, opts = {})
|
|
977
|
+
if @api_client.config.debugging
|
|
978
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#put_participant ..."
|
|
979
|
+
end
|
|
980
|
+
|
|
981
|
+
# verify the required parameter 'conversation_id' is set
|
|
982
|
+
fail "Missing the required parameter 'conversation_id' when calling put_participant" if conversation_id.nil?
|
|
983
|
+
|
|
984
|
+
# verify the required parameter 'participant_id' is set
|
|
985
|
+
fail "Missing the required parameter 'participant_id' when calling put_participant" if participant_id.nil?
|
|
986
|
+
|
|
987
|
+
# resource path
|
|
988
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
989
|
+
|
|
990
|
+
# query parameters
|
|
991
|
+
query_params = {}
|
|
992
|
+
|
|
993
|
+
# header parameters
|
|
994
|
+
header_params = {}
|
|
995
|
+
|
|
996
|
+
# HTTP header 'Accept' (if needed)
|
|
997
|
+
_header_accept = ['application/json']
|
|
998
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
999
|
+
|
|
1000
|
+
# HTTP header 'Content-Type'
|
|
1001
|
+
_header_content_type = ['application/json']
|
|
1002
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1003
|
+
|
|
1004
|
+
# form parameters
|
|
1005
|
+
form_params = {}
|
|
1006
|
+
|
|
1007
|
+
# http body (model)
|
|
1008
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
auth_names = ['PureCloud Auth']
|
|
1012
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
1013
|
+
:header_params => header_params,
|
|
1014
|
+
:query_params => query_params,
|
|
1015
|
+
:form_params => form_params,
|
|
1016
|
+
:body => post_body,
|
|
1017
|
+
:auth_names => auth_names)
|
|
1018
|
+
if @api_client.config.debugging
|
|
1019
|
+
@api_client.config.logger.debug "API called: ConversationsApi#put_participant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1020
|
+
end
|
|
1021
|
+
return data, status_code, headers
|
|
1022
|
+
end
|
|
1023
|
+
|
|
1024
|
+
# Update the attributes on a conversation participant.
|
|
1025
|
+
#
|
|
1026
|
+
# @param conversation_id conversation ID
|
|
1027
|
+
# @param participant_id participant ID
|
|
1028
|
+
# @param [Hash] opts the optional parameters
|
|
1029
|
+
# @option opts [ParticipantAttributes] :body
|
|
1030
|
+
# @return [nil]
|
|
1031
|
+
def put_participant_attributes(conversation_id, participant_id, opts = {})
|
|
1032
|
+
put_participant_attributes_with_http_info(conversation_id, participant_id, opts)
|
|
1033
|
+
return nil
|
|
1034
|
+
end
|
|
1035
|
+
|
|
1036
|
+
# Update the attributes on a conversation participant.
|
|
1037
|
+
#
|
|
1038
|
+
# @param conversation_id conversation ID
|
|
1039
|
+
# @param participant_id participant ID
|
|
1040
|
+
# @param [Hash] opts the optional parameters
|
|
1041
|
+
# @option opts [ParticipantAttributes] :body
|
|
1042
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1043
|
+
def put_participant_attributes_with_http_info(conversation_id, participant_id, opts = {})
|
|
1044
|
+
if @api_client.config.debugging
|
|
1045
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#put_participant_attributes ..."
|
|
1046
|
+
end
|
|
1047
|
+
|
|
1048
|
+
# verify the required parameter 'conversation_id' is set
|
|
1049
|
+
fail "Missing the required parameter 'conversation_id' when calling put_participant_attributes" if conversation_id.nil?
|
|
1050
|
+
|
|
1051
|
+
# verify the required parameter 'participant_id' is set
|
|
1052
|
+
fail "Missing the required parameter 'participant_id' when calling put_participant_attributes" if participant_id.nil?
|
|
1053
|
+
|
|
1054
|
+
# resource path
|
|
1055
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}/attributes".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
1056
|
+
|
|
1057
|
+
# query parameters
|
|
1058
|
+
query_params = {}
|
|
1059
|
+
|
|
1060
|
+
# header parameters
|
|
1061
|
+
header_params = {}
|
|
1062
|
+
|
|
1063
|
+
# HTTP header 'Accept' (if needed)
|
|
1064
|
+
_header_accept = ['application/json']
|
|
1065
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1066
|
+
|
|
1067
|
+
# HTTP header 'Content-Type'
|
|
1068
|
+
_header_content_type = ['application/json']
|
|
1069
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1070
|
+
|
|
1071
|
+
# form parameters
|
|
1072
|
+
form_params = {}
|
|
1073
|
+
|
|
1074
|
+
# http body (model)
|
|
1075
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
auth_names = ['PureCloud Auth']
|
|
1079
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
1080
|
+
:header_params => header_params,
|
|
1081
|
+
:query_params => query_params,
|
|
1082
|
+
:form_params => form_params,
|
|
1083
|
+
:body => post_body,
|
|
1084
|
+
:auth_names => auth_names)
|
|
1085
|
+
if @api_client.config.debugging
|
|
1086
|
+
@api_client.config.logger.debug "API called: ConversationsApi#put_participant_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1087
|
+
end
|
|
1088
|
+
return data, status_code, headers
|
|
1089
|
+
end
|
|
1090
|
+
|
|
1091
|
+
# Change who can speak
|
|
1092
|
+
#
|
|
1093
|
+
# @param conversation_id conversation ID
|
|
1094
|
+
# @param participant_id The object of the transfer
|
|
1095
|
+
# @param [Hash] opts the optional parameters
|
|
1096
|
+
# @option opts [ConsultTransferUpdate] :body new speak to
|
|
1097
|
+
# @return [ConsultTransferResponse]
|
|
1098
|
+
def put_participant_consult(conversation_id, participant_id, opts = {})
|
|
1099
|
+
data, status_code, headers = put_participant_consult_with_http_info(conversation_id, participant_id, opts)
|
|
1100
|
+
return data
|
|
1101
|
+
end
|
|
1102
|
+
|
|
1103
|
+
# Change who can speak
|
|
1104
|
+
#
|
|
1105
|
+
# @param conversation_id conversation ID
|
|
1106
|
+
# @param participant_id The object of the transfer
|
|
1107
|
+
# @param [Hash] opts the optional parameters
|
|
1108
|
+
# @option opts [ConsultTransferUpdate] :body new speak to
|
|
1109
|
+
# @return [Array<(ConsultTransferResponse, Fixnum, Hash)>] ConsultTransferResponse data, response status code and response headers
|
|
1110
|
+
def put_participant_consult_with_http_info(conversation_id, participant_id, opts = {})
|
|
1111
|
+
if @api_client.config.debugging
|
|
1112
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#put_participant_consult ..."
|
|
1113
|
+
end
|
|
1114
|
+
|
|
1115
|
+
# verify the required parameter 'conversation_id' is set
|
|
1116
|
+
fail "Missing the required parameter 'conversation_id' when calling put_participant_consult" if conversation_id.nil?
|
|
1117
|
+
|
|
1118
|
+
# verify the required parameter 'participant_id' is set
|
|
1119
|
+
fail "Missing the required parameter 'participant_id' when calling put_participant_consult" if participant_id.nil?
|
|
1120
|
+
|
|
1121
|
+
# resource path
|
|
1122
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}/consult".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
1123
|
+
|
|
1124
|
+
# query parameters
|
|
1125
|
+
query_params = {}
|
|
1126
|
+
|
|
1127
|
+
# header parameters
|
|
1128
|
+
header_params = {}
|
|
1129
|
+
|
|
1130
|
+
# HTTP header 'Accept' (if needed)
|
|
1131
|
+
_header_accept = ['application/json']
|
|
1132
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1133
|
+
|
|
1134
|
+
# HTTP header 'Content-Type'
|
|
1135
|
+
_header_content_type = ['application/json']
|
|
1136
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1137
|
+
|
|
1138
|
+
# form parameters
|
|
1139
|
+
form_params = {}
|
|
1140
|
+
|
|
1141
|
+
# http body (model)
|
|
1142
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
auth_names = ['PureCloud Auth']
|
|
1146
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
|
1147
|
+
:header_params => header_params,
|
|
1148
|
+
:query_params => query_params,
|
|
1149
|
+
:form_params => form_params,
|
|
1150
|
+
:body => post_body,
|
|
1151
|
+
:auth_names => auth_names,
|
|
1152
|
+
:return_type => 'ConsultTransferResponse')
|
|
1153
|
+
if @api_client.config.debugging
|
|
1154
|
+
@api_client.config.logger.debug "API called: ConversationsApi#put_participant_consult\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1155
|
+
end
|
|
1156
|
+
return data, status_code, headers
|
|
1157
|
+
end
|
|
1158
|
+
|
|
1159
|
+
# Initiate and update consult transfer
|
|
1160
|
+
#
|
|
1161
|
+
# @param conversation_id conversation ID
|
|
1162
|
+
# @param participant_id The object of the transfer
|
|
1163
|
+
# @param [Hash] opts the optional parameters
|
|
1164
|
+
# @option opts [ConsultTransfer] :body Destination address & initial speak to
|
|
1165
|
+
# @return [ConsultTransferResponse]
|
|
1166
|
+
def post_participant_consult(conversation_id, participant_id, opts = {})
|
|
1167
|
+
data, status_code, headers = post_participant_consult_with_http_info(conversation_id, participant_id, opts)
|
|
1168
|
+
return data
|
|
1169
|
+
end
|
|
1170
|
+
|
|
1171
|
+
# Initiate and update consult transfer
|
|
1172
|
+
#
|
|
1173
|
+
# @param conversation_id conversation ID
|
|
1174
|
+
# @param participant_id The object of the transfer
|
|
1175
|
+
# @param [Hash] opts the optional parameters
|
|
1176
|
+
# @option opts [ConsultTransfer] :body Destination address & initial speak to
|
|
1177
|
+
# @return [Array<(ConsultTransferResponse, Fixnum, Hash)>] ConsultTransferResponse data, response status code and response headers
|
|
1178
|
+
def post_participant_consult_with_http_info(conversation_id, participant_id, opts = {})
|
|
1179
|
+
if @api_client.config.debugging
|
|
1180
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_participant_consult ..."
|
|
1181
|
+
end
|
|
1182
|
+
|
|
1183
|
+
# verify the required parameter 'conversation_id' is set
|
|
1184
|
+
fail "Missing the required parameter 'conversation_id' when calling post_participant_consult" if conversation_id.nil?
|
|
1185
|
+
|
|
1186
|
+
# verify the required parameter 'participant_id' is set
|
|
1187
|
+
fail "Missing the required parameter 'participant_id' when calling post_participant_consult" if participant_id.nil?
|
|
1188
|
+
|
|
1189
|
+
# resource path
|
|
1190
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}/consult".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
1191
|
+
|
|
1192
|
+
# query parameters
|
|
1193
|
+
query_params = {}
|
|
1194
|
+
|
|
1195
|
+
# header parameters
|
|
1196
|
+
header_params = {}
|
|
1197
|
+
|
|
1198
|
+
# HTTP header 'Accept' (if needed)
|
|
1199
|
+
_header_accept = ['application/json']
|
|
1200
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1201
|
+
|
|
1202
|
+
# HTTP header 'Content-Type'
|
|
1203
|
+
_header_content_type = ['application/json']
|
|
1204
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1205
|
+
|
|
1206
|
+
# form parameters
|
|
1207
|
+
form_params = {}
|
|
1208
|
+
|
|
1209
|
+
# http body (model)
|
|
1210
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
auth_names = ['PureCloud Auth']
|
|
1214
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
1215
|
+
:header_params => header_params,
|
|
1216
|
+
:query_params => query_params,
|
|
1217
|
+
:form_params => form_params,
|
|
1218
|
+
:body => post_body,
|
|
1219
|
+
:auth_names => auth_names,
|
|
1220
|
+
:return_type => 'ConsultTransferResponse')
|
|
1221
|
+
if @api_client.config.debugging
|
|
1222
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_participant_consult\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1223
|
+
end
|
|
1224
|
+
return data, status_code, headers
|
|
1225
|
+
end
|
|
1226
|
+
|
|
1227
|
+
# Cancel the transfer
|
|
1228
|
+
#
|
|
1229
|
+
# @param conversation_id conversation ID
|
|
1230
|
+
# @param participant_id The object of the transfer
|
|
1231
|
+
# @param [Hash] opts the optional parameters
|
|
1232
|
+
# @return [String]
|
|
1233
|
+
def delete_participant_consult(conversation_id, participant_id, opts = {})
|
|
1234
|
+
data, status_code, headers = delete_participant_consult_with_http_info(conversation_id, participant_id, opts)
|
|
1235
|
+
return data
|
|
1236
|
+
end
|
|
1237
|
+
|
|
1238
|
+
# Cancel the transfer
|
|
1239
|
+
#
|
|
1240
|
+
# @param conversation_id conversation ID
|
|
1241
|
+
# @param participant_id The object of the transfer
|
|
1242
|
+
# @param [Hash] opts the optional parameters
|
|
1243
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
|
1244
|
+
def delete_participant_consult_with_http_info(conversation_id, participant_id, opts = {})
|
|
1245
|
+
if @api_client.config.debugging
|
|
1246
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#delete_participant_consult ..."
|
|
1247
|
+
end
|
|
1248
|
+
|
|
1249
|
+
# verify the required parameter 'conversation_id' is set
|
|
1250
|
+
fail "Missing the required parameter 'conversation_id' when calling delete_participant_consult" if conversation_id.nil?
|
|
1251
|
+
|
|
1252
|
+
# verify the required parameter 'participant_id' is set
|
|
1253
|
+
fail "Missing the required parameter 'participant_id' when calling delete_participant_consult" if participant_id.nil?
|
|
1254
|
+
|
|
1255
|
+
# resource path
|
|
1256
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}/consult".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
1257
|
+
|
|
1258
|
+
# query parameters
|
|
1259
|
+
query_params = {}
|
|
1260
|
+
|
|
1261
|
+
# header parameters
|
|
1262
|
+
header_params = {}
|
|
1263
|
+
|
|
1264
|
+
# HTTP header 'Accept' (if needed)
|
|
1265
|
+
_header_accept = ['application/json']
|
|
1266
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1267
|
+
|
|
1268
|
+
# HTTP header 'Content-Type'
|
|
1269
|
+
_header_content_type = ['application/json']
|
|
1270
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1271
|
+
|
|
1272
|
+
# form parameters
|
|
1273
|
+
form_params = {}
|
|
1274
|
+
|
|
1275
|
+
# http body (model)
|
|
1276
|
+
post_body = nil
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
auth_names = ['PureCloud Auth']
|
|
1280
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
|
1281
|
+
:header_params => header_params,
|
|
1282
|
+
:query_params => query_params,
|
|
1283
|
+
:form_params => form_params,
|
|
1284
|
+
:body => post_body,
|
|
1285
|
+
:auth_names => auth_names,
|
|
1286
|
+
:return_type => 'String')
|
|
1287
|
+
if @api_client.config.debugging
|
|
1288
|
+
@api_client.config.logger.debug "API called: ConversationsApi#delete_participant_consult\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1289
|
+
end
|
|
1290
|
+
return data, status_code, headers
|
|
1291
|
+
end
|
|
1292
|
+
|
|
1293
|
+
# Listen in on the conversation from the point of view of a given participant.
|
|
1294
|
+
#
|
|
1295
|
+
# @param conversation_id conversation ID
|
|
1296
|
+
# @param participant_id participant ID
|
|
1297
|
+
# @param [Hash] opts the optional parameters
|
|
1298
|
+
# @return [nil]
|
|
1299
|
+
def post_participant_monitor(conversation_id, participant_id, opts = {})
|
|
1300
|
+
post_participant_monitor_with_http_info(conversation_id, participant_id, opts)
|
|
1301
|
+
return nil
|
|
1302
|
+
end
|
|
1303
|
+
|
|
1304
|
+
# Listen in on the conversation from the point of view of a given participant.
|
|
1305
|
+
#
|
|
1306
|
+
# @param conversation_id conversation ID
|
|
1307
|
+
# @param participant_id participant ID
|
|
1308
|
+
# @param [Hash] opts the optional parameters
|
|
1309
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1310
|
+
def post_participant_monitor_with_http_info(conversation_id, participant_id, opts = {})
|
|
1311
|
+
if @api_client.config.debugging
|
|
1312
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_participant_monitor ..."
|
|
1313
|
+
end
|
|
1314
|
+
|
|
1315
|
+
# verify the required parameter 'conversation_id' is set
|
|
1316
|
+
fail "Missing the required parameter 'conversation_id' when calling post_participant_monitor" if conversation_id.nil?
|
|
1317
|
+
|
|
1318
|
+
# verify the required parameter 'participant_id' is set
|
|
1319
|
+
fail "Missing the required parameter 'participant_id' when calling post_participant_monitor" if participant_id.nil?
|
|
1320
|
+
|
|
1321
|
+
# resource path
|
|
1322
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}/monitor".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
1323
|
+
|
|
1324
|
+
# query parameters
|
|
1325
|
+
query_params = {}
|
|
1326
|
+
|
|
1327
|
+
# header parameters
|
|
1328
|
+
header_params = {}
|
|
1329
|
+
|
|
1330
|
+
# HTTP header 'Accept' (if needed)
|
|
1331
|
+
_header_accept = ['application/json']
|
|
1332
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1333
|
+
|
|
1334
|
+
# HTTP header 'Content-Type'
|
|
1335
|
+
_header_content_type = ['application/json']
|
|
1336
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1337
|
+
|
|
1338
|
+
# form parameters
|
|
1339
|
+
form_params = {}
|
|
1340
|
+
|
|
1341
|
+
# http body (model)
|
|
1342
|
+
post_body = nil
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
auth_names = ['PureCloud Auth']
|
|
1346
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
1347
|
+
:header_params => header_params,
|
|
1348
|
+
:query_params => query_params,
|
|
1349
|
+
:form_params => form_params,
|
|
1350
|
+
:body => post_body,
|
|
1351
|
+
:auth_names => auth_names)
|
|
1352
|
+
if @api_client.config.debugging
|
|
1353
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_participant_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1354
|
+
end
|
|
1355
|
+
return data, status_code, headers
|
|
1356
|
+
end
|
|
1357
|
+
|
|
1358
|
+
# Replace this participant with the specified user and/or address
|
|
1359
|
+
#
|
|
1360
|
+
# @param conversation_id conversation ID
|
|
1361
|
+
# @param participant_id participant ID
|
|
1362
|
+
# @param [Hash] opts the optional parameters
|
|
1363
|
+
# @option opts [String] :user_id The user that will replace this participant. If address is not supplied then the user's Work address will be used. This parameter is required when replacing a participant that has an active chat.
|
|
1364
|
+
# @option opts [String] :address The address that will be used to contact the new participant
|
|
1365
|
+
# @option opts [String] :username The username of the person that will replace this participant. This field is only used if the userId is blank.
|
|
1366
|
+
# @option opts [String] :queue_id The id of the queue that will replace this participant.
|
|
1367
|
+
# @option opts [BOOLEAN] :voicemail Indicates this participant will be replaced by the voicemail inbox of the participant.
|
|
1368
|
+
# @return [nil]
|
|
1369
|
+
def post_participant_replace(conversation_id, participant_id, opts = {})
|
|
1370
|
+
post_participant_replace_with_http_info(conversation_id, participant_id, opts)
|
|
1371
|
+
return nil
|
|
1372
|
+
end
|
|
1373
|
+
|
|
1374
|
+
# Replace this participant with the specified user and/or address
|
|
1375
|
+
#
|
|
1376
|
+
# @param conversation_id conversation ID
|
|
1377
|
+
# @param participant_id participant ID
|
|
1378
|
+
# @param [Hash] opts the optional parameters
|
|
1379
|
+
# @option opts [String] :user_id The user that will replace this participant. If address is not supplied then the user's Work address will be used. This parameter is required when replacing a participant that has an active chat.
|
|
1380
|
+
# @option opts [String] :address The address that will be used to contact the new participant
|
|
1381
|
+
# @option opts [String] :username The username of the person that will replace this participant. This field is only used if the userId is blank.
|
|
1382
|
+
# @option opts [String] :queue_id The id of the queue that will replace this participant.
|
|
1383
|
+
# @option opts [BOOLEAN] :voicemail Indicates this participant will be replaced by the voicemail inbox of the participant.
|
|
1384
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1385
|
+
def post_participant_replace_with_http_info(conversation_id, participant_id, opts = {})
|
|
1386
|
+
if @api_client.config.debugging
|
|
1387
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#post_participant_replace ..."
|
|
1388
|
+
end
|
|
1389
|
+
|
|
1390
|
+
# verify the required parameter 'conversation_id' is set
|
|
1391
|
+
fail "Missing the required parameter 'conversation_id' when calling post_participant_replace" if conversation_id.nil?
|
|
1392
|
+
|
|
1393
|
+
# verify the required parameter 'participant_id' is set
|
|
1394
|
+
fail "Missing the required parameter 'participant_id' when calling post_participant_replace" if participant_id.nil?
|
|
1395
|
+
|
|
1396
|
+
# resource path
|
|
1397
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}/replace".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
1398
|
+
|
|
1399
|
+
# query parameters
|
|
1400
|
+
query_params = {}
|
|
1401
|
+
query_params[:'userId'] = opts[:'user_id'] if opts[:'user_id']
|
|
1402
|
+
query_params[:'address'] = opts[:'address'] if opts[:'address']
|
|
1403
|
+
query_params[:'username'] = opts[:'username'] if opts[:'username']
|
|
1404
|
+
query_params[:'queueId'] = opts[:'queue_id'] if opts[:'queue_id']
|
|
1405
|
+
query_params[:'voicemail'] = opts[:'voicemail'] if opts[:'voicemail']
|
|
1406
|
+
|
|
1407
|
+
# header parameters
|
|
1408
|
+
header_params = {}
|
|
1409
|
+
|
|
1410
|
+
# HTTP header 'Accept' (if needed)
|
|
1411
|
+
_header_accept = ['application/json']
|
|
1412
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1413
|
+
|
|
1414
|
+
# HTTP header 'Content-Type'
|
|
1415
|
+
_header_content_type = ['application/json']
|
|
1416
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1417
|
+
|
|
1418
|
+
# form parameters
|
|
1419
|
+
form_params = {}
|
|
1420
|
+
|
|
1421
|
+
# http body (model)
|
|
1422
|
+
post_body = nil
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
auth_names = ['PureCloud Auth']
|
|
1426
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
|
1427
|
+
:header_params => header_params,
|
|
1428
|
+
:query_params => query_params,
|
|
1429
|
+
:form_params => form_params,
|
|
1430
|
+
:body => post_body,
|
|
1431
|
+
:auth_names => auth_names)
|
|
1432
|
+
if @api_client.config.debugging
|
|
1433
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_participant_replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1434
|
+
end
|
|
1435
|
+
return data, status_code, headers
|
|
1436
|
+
end
|
|
1437
|
+
|
|
1438
|
+
# Get the wrap-up for this conversation participant.
|
|
1439
|
+
#
|
|
1440
|
+
# @param conversation_id conversation ID
|
|
1441
|
+
# @param participant_id participant ID
|
|
1442
|
+
# @param [Hash] opts the optional parameters
|
|
1443
|
+
# @option opts [BOOLEAN] :provisional Indicates if the wrap-up code is provisional.
|
|
1444
|
+
# @return [WrapupCode]
|
|
1445
|
+
def get_participant_wrapup(conversation_id, participant_id, opts = {})
|
|
1446
|
+
data, status_code, headers = get_participant_wrapup_with_http_info(conversation_id, participant_id, opts)
|
|
1447
|
+
return data
|
|
1448
|
+
end
|
|
1449
|
+
|
|
1450
|
+
# Get the wrap-up for this conversation participant.
|
|
1451
|
+
#
|
|
1452
|
+
# @param conversation_id conversation ID
|
|
1453
|
+
# @param participant_id participant ID
|
|
1454
|
+
# @param [Hash] opts the optional parameters
|
|
1455
|
+
# @option opts [BOOLEAN] :provisional Indicates if the wrap-up code is provisional.
|
|
1456
|
+
# @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers
|
|
1457
|
+
def get_participant_wrapup_with_http_info(conversation_id, participant_id, opts = {})
|
|
1458
|
+
if @api_client.config.debugging
|
|
1459
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_participant_wrapup ..."
|
|
1460
|
+
end
|
|
1461
|
+
|
|
1462
|
+
# verify the required parameter 'conversation_id' is set
|
|
1463
|
+
fail "Missing the required parameter 'conversation_id' when calling get_participant_wrapup" if conversation_id.nil?
|
|
1464
|
+
|
|
1465
|
+
# verify the required parameter 'participant_id' is set
|
|
1466
|
+
fail "Missing the required parameter 'participant_id' when calling get_participant_wrapup" if participant_id.nil?
|
|
1467
|
+
|
|
1468
|
+
# resource path
|
|
1469
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}/wrapup".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
1470
|
+
|
|
1471
|
+
# query parameters
|
|
1472
|
+
query_params = {}
|
|
1473
|
+
query_params[:'provisional'] = opts[:'provisional'] if opts[:'provisional']
|
|
1474
|
+
|
|
1475
|
+
# header parameters
|
|
1476
|
+
header_params = {}
|
|
1477
|
+
|
|
1478
|
+
# HTTP header 'Accept' (if needed)
|
|
1479
|
+
_header_accept = ['application/json']
|
|
1480
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1481
|
+
|
|
1482
|
+
# HTTP header 'Content-Type'
|
|
1483
|
+
_header_content_type = ['application/json']
|
|
1484
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1485
|
+
|
|
1486
|
+
# form parameters
|
|
1487
|
+
form_params = {}
|
|
1488
|
+
|
|
1489
|
+
# http body (model)
|
|
1490
|
+
post_body = nil
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
auth_names = ['PureCloud Auth']
|
|
1494
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1495
|
+
:header_params => header_params,
|
|
1496
|
+
:query_params => query_params,
|
|
1497
|
+
:form_params => form_params,
|
|
1498
|
+
:body => post_body,
|
|
1499
|
+
:auth_names => auth_names,
|
|
1500
|
+
:return_type => 'WrapupCode')
|
|
1501
|
+
if @api_client.config.debugging
|
|
1502
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_participant_wrapup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1503
|
+
end
|
|
1504
|
+
return data, status_code, headers
|
|
1505
|
+
end
|
|
1506
|
+
|
|
1507
|
+
# Get list of wrapup codes for this conversation participant
|
|
1508
|
+
#
|
|
1509
|
+
# @param conversation_id conversation ID
|
|
1510
|
+
# @param participant_id participant ID
|
|
1511
|
+
# @param [Hash] opts the optional parameters
|
|
1512
|
+
# @return [WrapupCode]
|
|
1513
|
+
def get_participant_wrapupcodes(conversation_id, participant_id, opts = {})
|
|
1514
|
+
data, status_code, headers = get_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts)
|
|
1515
|
+
return data
|
|
1516
|
+
end
|
|
1517
|
+
|
|
1518
|
+
# Get list of wrapup codes for this conversation participant
|
|
1519
|
+
#
|
|
1520
|
+
# @param conversation_id conversation ID
|
|
1521
|
+
# @param participant_id participant ID
|
|
1522
|
+
# @param [Hash] opts the optional parameters
|
|
1523
|
+
# @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers
|
|
1524
|
+
def get_participant_wrapupcodes_with_http_info(conversation_id, participant_id, opts = {})
|
|
1525
|
+
if @api_client.config.debugging
|
|
1526
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_participant_wrapupcodes ..."
|
|
1527
|
+
end
|
|
1528
|
+
|
|
1529
|
+
# verify the required parameter 'conversation_id' is set
|
|
1530
|
+
fail "Missing the required parameter 'conversation_id' when calling get_participant_wrapupcodes" if conversation_id.nil?
|
|
1531
|
+
|
|
1532
|
+
# verify the required parameter 'participant_id' is set
|
|
1533
|
+
fail "Missing the required parameter 'participant_id' when calling get_participant_wrapupcodes" if participant_id.nil?
|
|
1534
|
+
|
|
1535
|
+
# resource path
|
|
1536
|
+
path = "/api/v1/conversations/{conversationId}/participants/{participantId}/wrapupcodes".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
1537
|
+
|
|
1538
|
+
# query parameters
|
|
1539
|
+
query_params = {}
|
|
1540
|
+
|
|
1541
|
+
# header parameters
|
|
1542
|
+
header_params = {}
|
|
1543
|
+
|
|
1544
|
+
# HTTP header 'Accept' (if needed)
|
|
1545
|
+
_header_accept = ['application/json']
|
|
1546
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1547
|
+
|
|
1548
|
+
# HTTP header 'Content-Type'
|
|
1549
|
+
_header_content_type = ['application/json']
|
|
1550
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1551
|
+
|
|
1552
|
+
# form parameters
|
|
1553
|
+
form_params = {}
|
|
1554
|
+
|
|
1555
|
+
# http body (model)
|
|
1556
|
+
post_body = nil
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
auth_names = ['PureCloud Auth']
|
|
1560
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1561
|
+
:header_params => header_params,
|
|
1562
|
+
:query_params => query_params,
|
|
1563
|
+
:form_params => form_params,
|
|
1564
|
+
:body => post_body,
|
|
1565
|
+
:auth_names => auth_names,
|
|
1566
|
+
:return_type => 'WrapupCode')
|
|
1567
|
+
if @api_client.config.debugging
|
|
1568
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_participant_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1569
|
+
end
|
|
1570
|
+
return data, status_code, headers
|
|
1571
|
+
end
|
|
1572
|
+
|
|
1573
|
+
# Get possible tags for Conversation
|
|
1574
|
+
#
|
|
1575
|
+
# @param conversation_id conversation ID
|
|
1576
|
+
# @param [Hash] opts the optional parameters
|
|
1577
|
+
# @return [Tag]
|
|
1578
|
+
def get_tags(conversation_id, opts = {})
|
|
1579
|
+
data, status_code, headers = get_tags_with_http_info(conversation_id, opts)
|
|
1580
|
+
return data
|
|
1581
|
+
end
|
|
1582
|
+
|
|
1583
|
+
# Get possible tags for Conversation
|
|
1584
|
+
#
|
|
1585
|
+
# @param conversation_id conversation ID
|
|
1586
|
+
# @param [Hash] opts the optional parameters
|
|
1587
|
+
# @return [Array<(Tag, Fixnum, Hash)>] Tag data, response status code and response headers
|
|
1588
|
+
def get_tags_with_http_info(conversation_id, opts = {})
|
|
1589
|
+
if @api_client.config.debugging
|
|
1590
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_tags ..."
|
|
1591
|
+
end
|
|
1592
|
+
|
|
1593
|
+
# verify the required parameter 'conversation_id' is set
|
|
1594
|
+
fail "Missing the required parameter 'conversation_id' when calling get_tags" if conversation_id.nil?
|
|
1595
|
+
|
|
1596
|
+
# resource path
|
|
1597
|
+
path = "/api/v1/conversations/{conversationId}/tags".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
1598
|
+
|
|
1599
|
+
# query parameters
|
|
1600
|
+
query_params = {}
|
|
1601
|
+
|
|
1602
|
+
# header parameters
|
|
1603
|
+
header_params = {}
|
|
1604
|
+
|
|
1605
|
+
# HTTP header 'Accept' (if needed)
|
|
1606
|
+
_header_accept = ['application/json']
|
|
1607
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1608
|
+
|
|
1609
|
+
# HTTP header 'Content-Type'
|
|
1610
|
+
_header_content_type = ['application/json']
|
|
1611
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1612
|
+
|
|
1613
|
+
# form parameters
|
|
1614
|
+
form_params = {}
|
|
1615
|
+
|
|
1616
|
+
# http body (model)
|
|
1617
|
+
post_body = nil
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
auth_names = ['PureCloud Auth']
|
|
1621
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1622
|
+
:header_params => header_params,
|
|
1623
|
+
:query_params => query_params,
|
|
1624
|
+
:form_params => form_params,
|
|
1625
|
+
:body => post_body,
|
|
1626
|
+
:auth_names => auth_names,
|
|
1627
|
+
:return_type => 'Tag')
|
|
1628
|
+
if @api_client.config.debugging
|
|
1629
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1630
|
+
end
|
|
1631
|
+
return data, status_code, headers
|
|
1632
|
+
end
|
|
1633
|
+
|
|
1634
|
+
# Get possible wrap-up codes for Conversation
|
|
1635
|
+
#
|
|
1636
|
+
# @param conversation_id conversation ID
|
|
1637
|
+
# @param [Hash] opts the optional parameters
|
|
1638
|
+
# @return [WrapupCode]
|
|
1639
|
+
def get_wrapupcodes(conversation_id, opts = {})
|
|
1640
|
+
data, status_code, headers = get_wrapupcodes_with_http_info(conversation_id, opts)
|
|
1641
|
+
return data
|
|
1642
|
+
end
|
|
1643
|
+
|
|
1644
|
+
# Get possible wrap-up codes for Conversation
|
|
1645
|
+
#
|
|
1646
|
+
# @param conversation_id conversation ID
|
|
1647
|
+
# @param [Hash] opts the optional parameters
|
|
1648
|
+
# @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers
|
|
1649
|
+
def get_wrapupcodes_with_http_info(conversation_id, opts = {})
|
|
1650
|
+
if @api_client.config.debugging
|
|
1651
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi#get_wrapupcodes ..."
|
|
1652
|
+
end
|
|
1653
|
+
|
|
1654
|
+
# verify the required parameter 'conversation_id' is set
|
|
1655
|
+
fail "Missing the required parameter 'conversation_id' when calling get_wrapupcodes" if conversation_id.nil?
|
|
1656
|
+
|
|
1657
|
+
# resource path
|
|
1658
|
+
path = "/api/v1/conversations/{conversationId}/wrapupcodes".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
|
|
1659
|
+
|
|
1660
|
+
# query parameters
|
|
1661
|
+
query_params = {}
|
|
1662
|
+
|
|
1663
|
+
# header parameters
|
|
1664
|
+
header_params = {}
|
|
1665
|
+
|
|
1666
|
+
# HTTP header 'Accept' (if needed)
|
|
1667
|
+
_header_accept = ['application/json']
|
|
1668
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
|
1669
|
+
|
|
1670
|
+
# HTTP header 'Content-Type'
|
|
1671
|
+
_header_content_type = ['application/json']
|
|
1672
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
|
1673
|
+
|
|
1674
|
+
# form parameters
|
|
1675
|
+
form_params = {}
|
|
1676
|
+
|
|
1677
|
+
# http body (model)
|
|
1678
|
+
post_body = nil
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
auth_names = ['PureCloud Auth']
|
|
1682
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
|
1683
|
+
:header_params => header_params,
|
|
1684
|
+
:query_params => query_params,
|
|
1685
|
+
:form_params => form_params,
|
|
1686
|
+
:body => post_body,
|
|
1687
|
+
:auth_names => auth_names,
|
|
1688
|
+
:return_type => 'WrapupCode')
|
|
1689
|
+
if @api_client.config.debugging
|
|
1690
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1691
|
+
end
|
|
1692
|
+
return data, status_code, headers
|
|
1693
|
+
end
|
|
1694
|
+
end
|
|
1695
|
+
end
|
|
1696
|
+
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|