Module: PureCloud

Defined in:
lib/purecloud/version.rb,
lib/purecloud.rb,
lib/purecloud.rb,
lib/purecloud/api_error.rb,
lib/purecloud/api_client.rb,
lib/purecloud/models/did.rb,
lib/purecloud/api/fax_api.rb,
lib/purecloud/models/adfs.rb,
lib/purecloud/models/call.rb,
lib/purecloud/models/chat.rb,
lib/purecloud/models/edge.rb,
lib/purecloud/models/flow.rb,
lib/purecloud/models/line.rb,
lib/purecloud/models/okta.rb,
lib/purecloud/models/page.rb,
lib/purecloud/models/ring.rb,
lib/purecloud/models/site.rb,
lib/purecloud/models/user.rb,
lib/purecloud/models/agent.rb,
lib/purecloud/models/email.rb,
lib/purecloud/models/empty.rb,
lib/purecloud/models/entry.rb,
lib/purecloud/models/group.rb,
lib/purecloud/models/phone.rb,
lib/purecloud/models/queue.rb,
lib/purecloud/models/share.rb,
lib/purecloud/models/trunk.rb,
lib/purecloud/models/usage.rb,
lib/purecloud/models/video.rb,
lib/purecloud/api/users_api.rb,
lib/purecloud/configuration.rb,
lib/purecloud/models/change.rb,
lib/purecloud/models/detail.rb,
lib/purecloud/models/number.rb,
lib/purecloud/models/policy.rb,
lib/purecloud/models/prompt.rb,
lib/purecloud/models/script.rb,
lib/purecloud/models/wrapup.rb,
lib/purecloud/api/groups_api.rb,
lib/purecloud/api/o_auth_api.rb,
lib/purecloud/api/search_api.rb,
lib/purecloud/api/tokens_api.rb,
lib/purecloud/models/actions.rb,
lib/purecloud/models/address.rb,
lib/purecloud/models/channel.rb,
lib/purecloud/models/contact.rb,
lib/purecloud/models/g_suite.rb,
lib/purecloud/models/keyword.rb,
lib/purecloud/models/library.rb,
lib/purecloud/models/section.rb,
lib/purecloud/models/segment.rb,
lib/purecloud/models/station.rb,
lib/purecloud/models/user_me.rb,
lib/purecloud/api/quality_api.rb,
lib/purecloud/api/routing_api.rb,
lib/purecloud/api/scripts_api.rb,
lib/purecloud/api/suggest_api.rb,
lib/purecloud/models/bullseye.rb,
lib/purecloud/models/callback.rb,
lib/purecloud/models/campaign.rb,
lib/purecloud/models/did_pool.rb,
lib/purecloud/models/dnc_list.rb,
lib/purecloud/models/document.rb,
lib/purecloud/models/endpoint.rb,
lib/purecloud/models/greeting.rb,
lib/purecloud/models/language.rb,
lib/purecloud/models/location.rb,
lib/purecloud/models/metabase.rb,
lib/purecloud/models/question.rb,
lib/purecloud/models/reaction.rb,
lib/purecloud/models/response.rb,
lib/purecloud/models/rule_set.rb,
lib/purecloud/api/alerting_api.rb,
lib/purecloud/api/outbound_api.rb,
lib/purecloud/api/presence_api.rb,
lib/purecloud/api/stations_api.rb,
lib/purecloud/models/adjacents.rb,
lib/purecloud/models/attribute.rb,
lib/purecloud/models/condition.rb,
lib/purecloud/models/edge_line.rb,
lib/purecloud/models/event_log.rb,
lib/purecloud/models/extension.rb,
lib/purecloud/models/json_node.rb,
lib/purecloud/models/line_base.rb,
lib/purecloud/models/lock_info.rb,
lib/purecloud/models/meta_data.rb,
lib/purecloud/models/one_login.rb,
lib/purecloud/models/operation.rb,
lib/purecloud/models/parameter.rb,
lib/purecloud/models/recording.rb,
lib/purecloud/models/sort_item.rb,
lib/purecloud/models/tag_value.rb,
lib/purecloud/models/time_slot.rb,
lib/purecloud/models/time_zone.rb,
lib/purecloud/models/workspace.rb,
lib/purecloud/api/analytics_api.rb,
lib/purecloud/api/architect_api.rb,
lib/purecloud/api/greetings_api.rb,
lib/purecloud/api/languages_api.rb,
lib/purecloud/api/locations_api.rb,
lib/purecloud/api/recording_api.rb,
lib/purecloud/api/utilities_api.rb,
lib/purecloud/api/voicemail_api.rb,
lib/purecloud/models/annotation.rb,
lib/purecloud/models/attachment.rb,
lib/purecloud/models/audit_user.rb,
lib/purecloud/models/call_basic.rb,
lib/purecloud/models/edge_group.rb,
lib/purecloud/models/error_body.rb,
lib/purecloud/models/evaluation.rb,
lib/purecloud/models/export_uri.rb,
lib/purecloud/models/facet_info.rb,
lib/purecloud/models/facet_term.rb,
lib/purecloud/models/fax_status.rb,
lib/purecloud/models/field_list.rb,
lib/purecloud/models/phone_base.rb,
lib/purecloud/models/pure_cloud.rb,
lib/purecloud/models/salesforce.rb,
lib/purecloud/models/trunk_base.rb,
lib/purecloud/models/usage_item.rb,
lib/purecloud/models/user_image.rb,
lib/purecloud/models/user_param.rb,
lib/purecloud/models/user_queue.rb,
lib/purecloud/api/attributes_api.rb,
lib/purecloud/models/audit_facet.rb,
lib/purecloud/models/calibration.rb,
lib/purecloud/models/call_record.rb,
lib/purecloud/models/certificate.rb,
lib/purecloud/models/cover_sheet.rb,
lib/purecloud/models/create_user.rb,
lib/purecloud/models/destination.rb,
lib/purecloud/models/dialer_rule.rb,
lib/purecloud/models/domain_role.rb,
lib/purecloud/models/email_setup.rb,
lib/purecloud/models/facet_entry.rb,
lib/purecloud/models/fax_summary.rb,
lib/purecloud/models/geolocation.rb,
lib/purecloud/models/keyword_set.rb,
lib/purecloud/models/line_status.rb,
lib/purecloud/models/number_plan.rb,
lib/purecloud/models/paging_spec.rb,
lib/purecloud/models/participant.rb,
lib/purecloud/models/screenshare.rb,
lib/purecloud/models/server_date.rb,
lib/purecloud/models/utilization.rb,
lib/purecloud/models/wrapup_code.rb,
lib/purecloud/api/geolocation_api.rb,
lib/purecloud/models/acw_settings.rb,
lib/purecloud/models/audit_change.rb,
lib/purecloud/models/audit_entity.rb,
lib/purecloud/models/audit_filter.rb,
lib/purecloud/models/call_command.rb,
lib/purecloud/models/chat_message.rb,
lib/purecloud/models/connect_rate.rb,
lib/purecloud/models/contact_list.rb,
lib/purecloud/models/contact_sort.rb,
lib/purecloud/models/conversation.rb,
lib/purecloud/models/digit_length.rb,
lib/purecloud/models/fax_document.rb,
lib/purecloud/models/field_config.rb,
lib/purecloud/models/flow_version.rb,
lib/purecloud/models/group_update.rb,
lib/purecloud/models/identity_now.rb,
lib/purecloud/models/media_result.rb,
lib/purecloud/models/organization.rb,
lib/purecloud/models/phone_column.rb,
lib/purecloud/models/phone_status.rb,
lib/purecloud/models/prompt_asset.rb,
lib/purecloud/models/query_result.rb,
lib/purecloud/models/queue_member.rb,
lib/purecloud/models/response_set.rb,
lib/purecloud/models/routing_data.rb,
lib/purecloud/models/time_allowed.rb,
lib/purecloud/models/user_station.rb,
lib/purecloud/api/organization_api.rb,
lib/purecloud/models/activity_code.rb,
lib/purecloud/models/answer_option.rb,
lib/purecloud/models/audit_message.rb,
lib/purecloud/models/callable_time.rb,
lib/purecloud/models/campaign_rule.rb,
lib/purecloud/models/channel_topic.rb,
lib/purecloud/models/dialer_action.rb,
lib/purecloud/models/domain_entity.rb,
lib/purecloud/models/edge_logs_job.rb,
lib/purecloud/models/email_address.rb,
lib/purecloud/models/email_message.rb,
lib/purecloud/models/error_details.rb,
lib/purecloud/models/event_message.rb,
lib/purecloud/models/feature_state.rb,
lib/purecloud/models/field_configs.rb,
lib/purecloud/models/group_contact.rb,
lib/purecloud/models/import_status.rb,
lib/purecloud/models/inbound_route.rb,
lib/purecloud/models/media_setting.rb,
lib/purecloud/models/media_summary.rb,
lib/purecloud/models/member_entity.rb,
lib/purecloud/models/numeric_range.rb,
lib/purecloud/models/o_auth_client.rb,
lib/purecloud/models/out_of_office.rb,
lib/purecloud/models/phones_reboot.rb,
lib/purecloud/models/ping_identity.rb,
lib/purecloud/models/policy_create.rb,
lib/purecloud/models/policy_errors.rb,
lib/purecloud/models/quality_audit.rb,
lib/purecloud/models/query_request.rb,
lib/purecloud/models/query_results.rb,
lib/purecloud/models/response_text.rb,
lib/purecloud/models/routing_skill.rb,
lib/purecloud/models/service_level.rb,
lib/purecloud/models/shared_entity.rb,
lib/purecloud/models/system_prompt.rb,
lib/purecloud/models/time_interval.rb,
lib/purecloud/models/unread_metric.rb,
lib/purecloud/models/unread_status.rb,
lib/purecloud/models/uri_reference.rb,
lib/purecloud/models/user_presence.rb,
lib/purecloud/models/user_schedule.rb,
lib/purecloud/models/user_stations.rb,
lib/purecloud/api/authorization_api.rb,
lib/purecloud/api/conversations_api.rb,
lib/purecloud/api/notifications_api.rb,
lib/purecloud/models/agent_activity.rb,
lib/purecloud/models/analytics_view.rb,
lib/purecloud/models/attempt_limits.rb,
lib/purecloud/models/callback_basic.rb,
lib/purecloud/models/campaign_stats.rb,
lib/purecloud/models/command_status.rb,
lib/purecloud/models/dialer_contact.rb,
lib/purecloud/models/dialer_preview.rb,
lib/purecloud/models/document_audit.rb,
lib/purecloud/models/edge_interface.rb,
lib/purecloud/models/encryption_key.rb,
lib/purecloud/models/extension_pool.rb,
lib/purecloud/models/greeting_owner.rb,
lib/purecloud/models/inbound_domain.rb,
lib/purecloud/models/media_policies.rb,
lib/purecloud/models/outbound_route.rb,
lib/purecloud/models/policy_actions.rb,
lib/purecloud/models/provision_info.rb,
lib/purecloud/models/question_group.rb,
lib/purecloud/models/question_score.rb,
lib/purecloud/models/routing_status.rb,
lib/purecloud/models/search_request.rb,
lib/purecloud/models/street_address.rb,
lib/purecloud/models/term_attribute.rb,
lib/purecloud/models/user_recording.rb,
lib/purecloud/models/available_topic.rb,
lib/purecloud/models/call_forwarding.rb,
lib/purecloud/models/cobrowsesession.rb,
lib/purecloud/models/dnc_list_create.rb,
lib/purecloud/models/document_update.rb,
lib/purecloud/models/document_upload.rb,
lib/purecloud/models/edge_trunk_base.rb,
lib/purecloud/models/evaluation_form.rb,
lib/purecloud/models/heart_beat_rule.rb,
lib/purecloud/models/management_unit.rb,
lib/purecloud/models/o_auth_provider.rb,
lib/purecloud/models/replace_request.rb,
lib/purecloud/models/report_schedule.rb,
lib/purecloud/models/response_filter.rb,
lib/purecloud/models/schema_category.rb,
lib/purecloud/models/search_criteria.rb,
lib/purecloud/models/service_context.rb,
lib/purecloud/models/shared_response.rb,
lib/purecloud/models/system_presence.rb,
lib/purecloud/models/user_agent_info.rb,
lib/purecloud/models/vm_pairing_info.rb,
lib/purecloud/api/user_recordings_api.rb,
lib/purecloud/models/consult_transfer.rb,
lib/purecloud/models/delete_retention.rb,
lib/purecloud/models/email_attachment.rb,
lib/purecloud/models/facet_statistics.rb,
lib/purecloud/models/fax_send_request.rb,
lib/purecloud/models/greeting_listing.rb,
lib/purecloud/models/heart_beat_alert.rb,
lib/purecloud/models/location_address.rb,
lib/purecloud/models/max_participants.rb,
lib/purecloud/models/orphan_recording.rb,
lib/purecloud/models/query_facet_info.rb,
lib/purecloud/models/replace_response.rb,
lib/purecloud/models/report_meta_data.rb,
lib/purecloud/models/report_run_entry.rb,
lib/purecloud/models/run_now_response.rb,
lib/purecloud/models/security_profile.rb,
lib/purecloud/models/skills_to_remove.rb,
lib/purecloud/models/time_off_request.rb,
lib/purecloud/models/transfer_request.rb,
lib/purecloud/models/workspace_create.rb,
lib/purecloud/models/workspace_member.rb,
lib/purecloud/models/aggregation_query.rb,
lib/purecloud/models/aggregation_range.rb,
lib/purecloud/models/analytics_session.rb,
lib/purecloud/models/archive_retention.rb,
lib/purecloud/models/call_conversation.rb,
lib/purecloud/models/call_media_policy.rb,
lib/purecloud/models/callable_time_set.rb,
lib/purecloud/models/campaign_progress.rb,
lib/purecloud/models/campaign_schedule.rb,
lib/purecloud/models/campaign_sequence.rb,
lib/purecloud/models/chat_conversation.rb,
lib/purecloud/models/chat_media_policy.rb,
lib/purecloud/models/chat_message_user.rb,
lib/purecloud/models/content_sort_item.rb,
lib/purecloud/models/conversation_chat.rb,
lib/purecloud/models/disconnect_reason.rb,
lib/purecloud/models/domain_permission.rb,
lib/purecloud/models/download_response.rb,
lib/purecloud/models/fax_send_response.rb,
lib/purecloud/models/observation_query.rb,
lib/purecloud/models/participant_basic.rb,
lib/purecloud/models/pin_configuration.rb,
lib/purecloud/models/policy_conditions.rb,
lib/purecloud/models/rest_error_detail.rb,
lib/purecloud/models/schedule_interval.rb,
lib/purecloud/models/sequence_schedule.rb,
lib/purecloud/models/social_expression.rb,
lib/purecloud/models/tag_query_request.rb,
lib/purecloud/models/voicemail_message.rb,
lib/purecloud/models/workspace_summary.rb,
lib/purecloud/api/identity_provider_api.rb,
lib/purecloud/models/aggregation_result.rb,
lib/purecloud/models/analytics_property.rb,
lib/purecloud/models/calibration_create.rb,
lib/purecloud/models/campaign_time_slot.rb,
lib/purecloud/models/conversation_basic.rb,
lib/purecloud/models/conversation_query.rb,
lib/purecloud/models/did_entity_listing.rb,
lib/purecloud/models/document_attribute.rb,
lib/purecloud/models/document_thumbnail.rb,
lib/purecloud/models/duration_condition.rb,
lib/purecloud/models/edge_logs_job_file.rb,
lib/purecloud/models/email_conversation.rb,
lib/purecloud/models/email_media_policy.rb,
lib/purecloud/models/evaluator_activity.rb,
lib/purecloud/models/parsed_certificate.rb,
lib/purecloud/models/phone_capabilities.rb,
lib/purecloud/models/prediction_results.rb,
lib/purecloud/models/quality_audit_page.rb,
lib/purecloud/models/recording_settings.rb,
lib/purecloud/models/retention_duration.rb,
lib/purecloud/models/search_aggregation.rb,
lib/purecloud/models/user_authorization.rb,
lib/purecloud/models/user_details_query.rb,
lib/purecloud/models/user_presence_rule.rb,
lib/purecloud/models/user_routing_skill.rb,
lib/purecloud/api/content_management_api.rb,
lib/purecloud/models/aggregate_view_data.rb,
lib/purecloud/models/audit_search_result.rb,
lib/purecloud/models/callback_identifier.rb,
lib/purecloud/models/certificate_details.rb,
lib/purecloud/models/content_filter_item.rb,
lib/purecloud/models/create_call_request.rb,
lib/purecloud/models/domain_capabilities.rb,
lib/purecloud/models/edge_entity_listing.rb,
lib/purecloud/models/edge_version_report.rb,
lib/purecloud/models/expansion_criterium.rb,
lib/purecloud/models/facet_key_attribute.rb,
lib/purecloud/models/flow_entity_listing.rb,
lib/purecloud/models/greeting_audio_file.rb,
lib/purecloud/models/greeting_media_info.rb,
lib/purecloud/models/line_entity_listing.rb,
lib/purecloud/models/location_definition.rb,
lib/purecloud/models/outbound_route_base.rb,
lib/purecloud/models/phone_number_column.rb,
lib/purecloud/models/phone_number_status.rb,
lib/purecloud/models/prompt_asset_create.rb,
lib/purecloud/models/queue_email_address.rb,
lib/purecloud/models/routing_status_rule.rb,
lib/purecloud/models/rule_set_diagnostic.rb,
lib/purecloud/models/site_entity_listing.rb,
lib/purecloud/models/statistical_summary.rb,
lib/purecloud/models/subscriber_response.rb,
lib/purecloud/models/system_prompt_asset.rb,
lib/purecloud/models/user_entity_listing.rb,
lib/purecloud/models/user_presence_alert.rb,
lib/purecloud/models/user_schedule_shift.rb,
lib/purecloud/models/user_search_request.rb,
lib/purecloud/api/response_management_api.rb,
lib/purecloud/models/analytics_evaluation.rb,
lib/purecloud/models/campaign_diagnostics.rb,
lib/purecloud/models/campaign_interaction.rb,
lib/purecloud/models/campaign_rule_action.rb,
lib/purecloud/models/create_call_response.rb,
lib/purecloud/models/create_email_request.rb,
lib/purecloud/models/create_queue_request.rb,
lib/purecloud/models/create_share_request.rb,
lib/purecloud/models/dialer_audit_request.rb,
lib/purecloud/models/documentation_result.rb,
lib/purecloud/models/domain_network_route.rb,
lib/purecloud/models/geolocation_settings.rb,
lib/purecloud/models/group_entity_listing.rb,
lib/purecloud/models/group_members_update.rb,
lib/purecloud/models/group_search_request.rb,
lib/purecloud/models/media_summary_detail.rb,
lib/purecloud/models/phone_entity_listing.rb,
lib/purecloud/models/policy_error_message.rb,
lib/purecloud/models/question_group_score.rb,
lib/purecloud/models/queue_entity_listing.rb,
lib/purecloud/models/response_entity_list.rb,
lib/purecloud/models/routing_status_alert.rb,
lib/purecloud/models/share_entity_listing.rb,
lib/purecloud/models/skill_entity_listing.rb,
lib/purecloud/models/statistical_response.rb,
lib/purecloud/models/trunk_entity_listing.rb,
lib/purecloud/models/user_search_criteria.rb,
lib/purecloud/models/visibility_condition.rb,
lib/purecloud/models/voicemail_media_info.rb,
lib/purecloud/models/wrap_up_code_mapping.rb,
lib/purecloud/api/workforce_management_api.rb,
lib/purecloud/models/aggregate_metric_data.rb,
lib/purecloud/models/analytics_participant.rb,
lib/purecloud/models/analytics_user_detail.rb,
lib/purecloud/models/attribute_filter_item.rb,
lib/purecloud/models/callback_conversation.rb,
lib/purecloud/models/campaign_interactions.rb,
lib/purecloud/models/campaign_notification.rb,
lib/purecloud/models/cobrowse_conversation.rb,
lib/purecloud/models/content_query_request.rb,
lib/purecloud/models/create_share_response.rb,
lib/purecloud/models/default_greeting_list.rb,
lib/purecloud/models/dnc_list_notification.rb,
lib/purecloud/models/domain_entity_listing.rb,
lib/purecloud/models/edge_logs_job_request.rb,
lib/purecloud/models/email_message_listing.rb,
lib/purecloud/models/evaluation_assignment.rb,
lib/purecloud/models/group_search_criteria.rb,
lib/purecloud/models/key_rotation_schedule.rb,
lib/purecloud/models/o_auth_client_listing.rb,
lib/purecloud/models/org_media_utilization.rb,
lib/purecloud/models/organization_features.rb,
lib/purecloud/models/organization_presence.rb,
lib/purecloud/models/orphan_update_request.rb,
lib/purecloud/models/policy_entity_listing.rb,
lib/purecloud/models/prompt_entity_listing.rb,
lib/purecloud/models/response_substitution.rb,
lib/purecloud/models/rule_set_notification.rb,
lib/purecloud/models/script_entity_listing.rb,
lib/purecloud/models/time_off_request_list.rb,
lib/purecloud/models/trunk_base_assignment.rb,
lib/purecloud/models/users_search_response.rb,
lib/purecloud/models/voicemail_user_policy.rb,
lib/purecloud/models/analytics_conversation.rb,
lib/purecloud/models/analytics_query_clause.rb,
lib/purecloud/models/analytics_query_filter.rb,
lib/purecloud/models/audit_entity_reference.rb,
lib/purecloud/models/available_translations.rb,
lib/purecloud/models/calibration_assignment.rb,
lib/purecloud/models/call_media_participant.rb,
lib/purecloud/models/campaign_rule_entities.rb,
lib/purecloud/models/channel_entity_listing.rb,
lib/purecloud/models/chat_media_participant.rb,
lib/purecloud/models/copy_voicemail_message.rb,
lib/purecloud/models/domain_network_address.rb,
lib/purecloud/models/edge_logs_job_response.rb,
lib/purecloud/models/edge_reboot_parameters.rb,
lib/purecloud/models/evaluation_scoring_set.rb,
lib/purecloud/models/groups_search_response.rb,
lib/purecloud/models/interaction_stats_rule.rb,
lib/purecloud/models/library_entity_listing.rb,
lib/purecloud/models/participant_attributes.rb,
lib/purecloud/models/property_index_request.rb,
lib/purecloud/models/response_query_request.rb,
lib/purecloud/models/response_query_results.rb,
lib/purecloud/models/station_entity_listing.rb,
lib/purecloud/models/suggest_search_request.rb,
lib/purecloud/models/time_off_request_patch.rb,
lib/purecloud/models/user_schedule_activity.rb,
lib/purecloud/models/voicemail_group_policy.rb,
lib/purecloud/models/voicemail_mailbox_info.rb,
lib/purecloud/models/activity_code_container.rb,
lib/purecloud/models/attribute_query_request.rb,
lib/purecloud/models/available_language_list.rb,
lib/purecloud/models/campaign_entity_listing.rb,
lib/purecloud/models/campaign_rule_condition.rb,
lib/purecloud/models/consult_transfer_update.rb,
lib/purecloud/models/create_callback_command.rb,
lib/purecloud/models/create_web_chat_request.rb,
lib/purecloud/models/did_pool_entity_listing.rb,
lib/purecloud/models/dnc_list_entity_listing.rb,
lib/purecloud/models/document_entity_listing.rb,
lib/purecloud/models/domain_schema_reference.rb,
lib/purecloud/models/edge_auto_update_config.rb,
lib/purecloud/models/email_media_participant.rb,
lib/purecloud/models/endpoint_entity_listing.rb,
lib/purecloud/models/export_uri_notification.rb,
lib/purecloud/models/interaction_stats_alert.rb,
lib/purecloud/models/language_entity_listing.rb,
lib/purecloud/models/location_search_request.rb,
lib/purecloud/models/presence_query_response.rb,
lib/purecloud/models/recording_email_message.rb,
lib/purecloud/models/resource_condition_node.rb,
lib/purecloud/models/response_entity_listing.rb,
lib/purecloud/models/rule_set_entity_listing.rb,
lib/purecloud/models/suggest_search_criteria.rb,
lib/purecloud/models/user_routing_skill_post.rb,
lib/purecloud/models/user_schedule_adherence.rb,
lib/purecloud/models/user_schedule_container.rb,
lib/purecloud/models/wfm_user_entity_listing.rb,
lib/purecloud/models/agent_evaluator_activity.rb,
lib/purecloud/models/aggregate_data_container.rb,
lib/purecloud/models/aggregate_query_response.rb,
lib/purecloud/models/aggregation_result_entry.rb,
lib/purecloud/models/attribute_entity_listing.rb,
lib/purecloud/models/campaign_rule_parameters.rb,
lib/purecloud/models/contact_callback_request.rb,
lib/purecloud/models/create_callback_response.rb,
lib/purecloud/models/domain_logical_interface.rb,
lib/purecloud/models/domain_organization_role.rb,
lib/purecloud/models/domain_permission_policy.rb,
lib/purecloud/models/edge_line_entity_listing.rb,
lib/purecloud/models/edge_version_information.rb,
lib/purecloud/models/extension_entity_listing.rb,
lib/purecloud/models/fax_data_v2_notification.rb,
lib/purecloud/models/line_base_entity_listing.rb,
lib/purecloud/models/location_search_criteria.rb,
lib/purecloud/models/orphan_recording_listing.rb,
lib/purecloud/models/resource_condition_value.rb,
lib/purecloud/models/screen_recording_session.rb,
lib/purecloud/models/tag_value_entity_listing.rb,
lib/purecloud/models/time_zone_entity_listing.rb,
lib/purecloud/models/validate_address_request.rb,
lib/purecloud/models/voicemail_search_request.rb,
lib/purecloud/models/workspace_entity_listing.rb,
lib/purecloud/api/telephony_providers_edge_api.rb,
lib/purecloud/models/analytics_query_predicate.rb,
lib/purecloud/models/consult_transfer_response.rb,
lib/purecloud/models/contact_list_notification.rb,
lib/purecloud/models/content_facet_filter_item.rb,
lib/purecloud/models/conversation_notification.rb,
lib/purecloud/models/domain_physical_interface.rb,
lib/purecloud/models/edge_group_entity_listing.rb,
lib/purecloud/models/evaluation_entity_listing.rb,
lib/purecloud/models/heart_beat_rule_container.rb,
lib/purecloud/models/initiate_screen_recording.rb,
lib/purecloud/models/json_node_search_response.rb,
lib/purecloud/models/location_emergency_number.rb,
lib/purecloud/models/locations_search_response.rb,
lib/purecloud/models/media_participant_request.rb,
lib/purecloud/models/phone_base_entity_listing.rb,
lib/purecloud/models/queue_member_notification.rb,
lib/purecloud/models/response_set_notification.rb,
lib/purecloud/models/trunk_base_entity_listing.rb,
lib/purecloud/models/user_conversation_summary.rb,
lib/purecloud/models/user_queue_entity_listing.rb,
lib/purecloud/models/user_skill_entity_listing.rb,
lib/purecloud/models/validate_address_response.rb,
lib/purecloud/models/voicemail_search_criteria.rb,
lib/purecloud/models/calibration_entity_listing.rb,
lib/purecloud/models/callback_media_participant.rb,
lib/purecloud/models/campaign_rule_notification.rb,
lib/purecloud/models/cobrowse_media_participant.rb,
lib/purecloud/models/domain_org_role_difference.rb,
lib/purecloud/models/edge_service_state_request.rb,
lib/purecloud/models/heart_beat_alert_container.rb,
lib/purecloud/models/import_status_notification.rb,
lib/purecloud/models/keyword_set_entity_listing.rb,
lib/purecloud/models/observation_data_container.rb,
lib/purecloud/models/observation_query_response.rb,
lib/purecloud/models/out_of_office_notification.rb,
lib/purecloud/models/resource_permission_policy.rb,
lib/purecloud/models/rule_set_notification_rule.rb,
lib/purecloud/models/user_presence_notification.rb,
lib/purecloud/models/user_stations_notification.rb,
lib/purecloud/models/voicemails_search_response.rb,
lib/purecloud/models/wrapup_code_entity_listing.rb,
lib/purecloud/models/analytics_query_aggregation.rb,
lib/purecloud/models/attempt_limits_notification.rb,
lib/purecloud/models/contact_list_entity_listing.rb,
lib/purecloud/models/contact_phone_number_column.rb,
lib/purecloud/models/conversation_entity_listing.rb,
lib/purecloud/models/create_share_request_member.rb,
lib/purecloud/models/customer_interaction_center.rb,
lib/purecloud/models/dialer_event_entity_listing.rb,
lib/purecloud/models/domain_organization_product.rb,
lib/purecloud/models/fax_document_entity_listing.rb,
lib/purecloud/models/prompt_asset_entity_listing.rb,
lib/purecloud/models/queue_member_entity_listing.rb,
lib/purecloud/models/response_set_entity_listing.rb,
lib/purecloud/models/rule_set_notification_rules.rb,
lib/purecloud/models/call_media_policy_conditions.rb,
lib/purecloud/models/callable_contacts_diagnostic.rb,
lib/purecloud/models/campaign_notification_errors.rb,
lib/purecloud/models/campaign_rule_entity_listing.rb,
lib/purecloud/models/channel_topic_entity_listing.rb,
lib/purecloud/models/chat_media_policy_conditions.rb,
lib/purecloud/models/documentation_search_request.rb,
lib/purecloud/models/domain_certificate_authority.rb,
lib/purecloud/models/domain_permission_collection.rb,
lib/purecloud/models/domain_physical_capabilities.rb,
lib/purecloud/models/edge_logs_job_upload_request.rb,
lib/purecloud/models/heart_beat_rule_notification.rb,
lib/purecloud/models/inbound_route_entity_listing.rb,
lib/purecloud/models/local_encryption_key_request.rb,
lib/purecloud/models/o_auth_client_entity_listing.rb,
lib/purecloud/models/queue_utilization_diagnostic.rb,
lib/purecloud/models/rule_set_notification_action.rb,
lib/purecloud/models/system_prompt_entity_listing.rb,
lib/purecloud/models/user_presence_rule_container.rb,
lib/purecloud/models/agent_activity_entity_listing.rb,
lib/purecloud/models/attempt_limits_entity_listing.rb,
lib/purecloud/models/campaign_rule_action_entities.rb,
lib/purecloud/models/command_status_entity_listing.rb,
lib/purecloud/models/content_attribute_filter_item.rb,
lib/purecloud/models/document_audit_entity_listing.rb,
lib/purecloud/models/document_data_v2_notification.rb,
lib/purecloud/models/documentation_search_criteria.rb,
lib/purecloud/models/documentation_search_response.rb,
lib/purecloud/models/email_media_policy_conditions.rb,
lib/purecloud/models/encryption_key_entity_listing.rb,
lib/purecloud/models/extension_pool_entity_listing.rb,
lib/purecloud/models/heart_beat_alert_notification.rb,
lib/purecloud/models/inbound_domain_entity_listing.rb,
lib/purecloud/models/metered_evaluation_assignment.rb,
lib/purecloud/models/outbound_route_entity_listing.rb,
lib/purecloud/models/routing_status_rule_container.rb,
lib/purecloud/models/rule_set_notification_actions.rb,
lib/purecloud/models/trunk_metabase_entity_listing.rb,
lib/purecloud/models/trunk_recording_enabled_count.rb,
lib/purecloud/models/user_presence_alert_container.rb,
lib/purecloud/models/user_recording_entity_listing.rb,
lib/purecloud/models/voicemail_organization_policy.rb,
lib/purecloud/models/analytics_conversation_segment.rb,
lib/purecloud/models/analytics_user_presence_record.rb,
lib/purecloud/models/available_topic_entity_listing.rb,
lib/purecloud/models/call_conversation_notification.rb,
lib/purecloud/models/callable_time_set_notification.rb,
lib/purecloud/models/campaign_progress_notification.rb,
lib/purecloud/models/campaign_schedule_notification.rb,
lib/purecloud/models/campaign_sequence_notification.rb,
lib/purecloud/models/chat_conversation_notification.rb,
lib/purecloud/models/conversation_notification_call.rb,
lib/purecloud/models/conversation_notification_chat.rb,
lib/purecloud/models/conversation_notification_self.rb,
lib/purecloud/models/domain_resource_condition_node.rb,
lib/purecloud/models/evaluation_form_entity_listing.rb,
lib/purecloud/models/local_encryption_configuration.rb,
lib/purecloud/models/o_auth_provider_entity_listing.rb,
lib/purecloud/models/phone_meta_base_entity_listing.rb,
lib/purecloud/models/recording_data_v2_notification.rb,
lib/purecloud/models/report_schedule_entity_listing.rb,
lib/purecloud/models/routing_status_alert_container.rb,
lib/purecloud/models/schema_category_entity_listing.rb,
lib/purecloud/models/sequence_schedule_notification.rb,
lib/purecloud/models/voicemail_message_notification.rb,
lib/purecloud/models/analytics_routing_status_record.rb,
lib/purecloud/models/conversation_notification_calls.rb,
lib/purecloud/models/conversation_notification_chats.rb,
lib/purecloud/models/conversation_notification_email.rb,
lib/purecloud/models/conversation_notification_video.rb,
lib/purecloud/models/domain_edge_software_update_dto.rb,
lib/purecloud/models/domain_network_command_response.rb,
lib/purecloud/models/domain_organization_role_create.rb,
lib/purecloud/models/domain_organization_role_update.rb,
lib/purecloud/models/domain_resource_condition_value.rb,
lib/purecloud/models/email_conversation_notification.rb,
lib/purecloud/models/estimated_wait_time_predictions.rb,
lib/purecloud/models/evaluation_form_and_scoring_set.rb,
lib/purecloud/models/out_of_office_notification_user.rb,
lib/purecloud/models/report_meta_data_entity_listing.rb,
lib/purecloud/models/rule_set_notification_condition.rb,
lib/purecloud/models/schema_reference_entity_listing.rb,
lib/purecloud/models/security_profile_entity_listing.rb,
lib/purecloud/models/user_list_schedule_request_body.rb,
lib/purecloud/models/user_stations_notification_user.rb,
lib/purecloud/models/video_conversation_notification.rb,
lib/purecloud/models/workspace_member_entity_listing.rb,
lib/purecloud/models/call_conversation_entity_listing.rb,
lib/purecloud/models/callable_time_set_entity_listing.rb,
lib/purecloud/models/campaign_sequence_entity_listing.rb,
lib/purecloud/models/chat_conversation_entity_listing.rb,
lib/purecloud/models/conversation_notification_emails.rb,
lib/purecloud/models/conversation_notification_videos.rb,
lib/purecloud/models/conversation_notification_wrapup.rb,
lib/purecloud/models/domain_edge_software_version_dto.rb,
lib/purecloud/models/interaction_stats_rule_container.rb,
lib/purecloud/models/logical_interface_entity_listing.rb,
lib/purecloud/models/organization_role_entity_listing.rb,
lib/purecloud/models/rule_set_notification_conditions.rb,
lib/purecloud/models/screen_recording_session_listing.rb,
lib/purecloud/models/screen_recording_session_request.rb,
lib/purecloud/models/social_conversation_notification.rb,
lib/purecloud/models/user_routing_status_notification.rb,
lib/purecloud/models/voicemail_message_entity_listing.rb,
lib/purecloud/models/conversation_notification_address.rb,
lib/purecloud/models/email_conversation_entity_listing.rb,
lib/purecloud/models/evaluator_activity_entity_listing.rb,
lib/purecloud/models/interaction_stats_alert_container.rb,
lib/purecloud/models/physical_interface_entity_listing.rb,
lib/purecloud/models/wrap_up_code_mapping_notification.rb,
lib/purecloud/models/callback_conversation_notification.rb,
lib/purecloud/models/campaign_notification_contact_sort.rb,
lib/purecloud/models/campaign_notification_phone_column.rb,
lib/purecloud/models/cobrowse_conversation_notification.rb,
lib/purecloud/models/conversation_notification_callback.rb,
lib/purecloud/models/conversation_notification_cobrowse.rb,
lib/purecloud/models/current_user_schedule_request_body.rb,
lib/purecloud/models/domain_entity_listing_query_result.rb,
lib/purecloud/models/fax_data_v2_notification_lock_data.rb,
lib/purecloud/models/fax_data_v2_notification_lock_info.rb,
lib/purecloud/models/fax_data_v2_notification_user_data.rb,
lib/purecloud/models/interaction_stat_rule_notification.rb,
lib/purecloud/models/outbound_route_base_entity_listing.rb,
lib/purecloud/models/response_set_notification_reaction.rb,
lib/purecloud/models/system_prompt_asset_entity_listing.rb,
lib/purecloud/models/campaign_notification_phone_columns.rb,
lib/purecloud/models/campaign_notification_uri_reference.rb,
lib/purecloud/models/conversation_notification_callbacks.rb,
lib/purecloud/models/dnc_list_notification_import_status.rb,
lib/purecloud/models/interaction_stat_alert_notification.rb,
lib/purecloud/models/organization_product_entity_listing.rb,
lib/purecloud/models/response_set_notification_responses.rb,
lib/purecloud/models/rule_set_notification_uri_reference.rb,
lib/purecloud/models/callback_conversation_entity_listing.rb,
lib/purecloud/models/certificate_authority_entity_listing.rb,
lib/purecloud/models/cobrowse_conversation_entity_listing.rb,
lib/purecloud/models/conversation_notification_error_info.rb,
lib/purecloud/models/conversation_notification_fax_status.rb,
lib/purecloud/models/organization_presence_entity_listing.rb,
lib/purecloud/models/permission_collection_entity_listing.rb,
lib/purecloud/models/time_off_request_update_notification.rb,
lib/purecloud/models/analytics_conversation_query_response.rb,
lib/purecloud/models/analytics_user_details_query_response.rb,
lib/purecloud/models/call_conversation_notification_detail.rb,
lib/purecloud/models/call_conversation_notification_wrapup.rb,
lib/purecloud/models/chat_conversation_notification_detail.rb,
lib/purecloud/models/chat_conversation_notification_wrapup.rb,
lib/purecloud/models/conversation_notification_participant.rb,
lib/purecloud/models/conversation_notification_screenshare.rb,
lib/purecloud/models/domain_entity_listing_evaluation_form.rb,
lib/purecloud/models/conversation_notification_participants.rb,
lib/purecloud/models/conversation_notification_screenshares.rb,
lib/purecloud/models/email_conversation_notification_detail.rb,
lib/purecloud/models/email_conversation_notification_wrapup.rb,
lib/purecloud/models/local_encryption_configuration_listing.rb,
lib/purecloud/models/report_run_entry_entity_domain_listing.rb,
lib/purecloud/models/screen_share_conversation_notification.rb,
lib/purecloud/models/user_conversation_summary_notification.rb,
lib/purecloud/models/user_schedule_full_day_time_off_marker.rb,
lib/purecloud/models/video_conversation_notification_detail.rb,
lib/purecloud/models/video_conversation_notification_wrapup.rb,
lib/purecloud/models/campaign_notification_rest_error_detail.rb,
lib/purecloud/models/contact_list_notification_import_status.rb,
lib/purecloud/models/contact_list_notification_phone_columns.rb,
lib/purecloud/models/contact_list_notification_uri_reference.rb,
lib/purecloud/models/conversation_notification_error_details.rb,
lib/purecloud/models/document_data_v2_notification_lock_data.rb,
lib/purecloud/models/document_data_v2_notification_lock_info.rb,
lib/purecloud/models/document_data_v2_notification_user_data.rb,
lib/purecloud/models/document_data_v2_notification_workspace.rb,
lib/purecloud/models/fax_data_v2_notification_workspace_data.rb,
lib/purecloud/models/social_conversation_notification_detail.rb,
lib/purecloud/models/social_conversation_notification_wrapup.rb,
lib/purecloud/models/user_stations_notification_user_station.rb,
lib/purecloud/models/attempt_limits_notification_recall_entry.rb,
lib/purecloud/models/callable_time_set_notification_time_slot.rb,
lib/purecloud/models/campaign_rule_notification_uri_reference.rb,
lib/purecloud/models/campaign_schedule_notification_intervals.rb,
lib/purecloud/models/conversation_notification_dialer_preview.rb,
lib/purecloud/models/document_data_v2_notification_created_by.rb,
lib/purecloud/models/recording_data_v2_notification_lock_data.rb,
lib/purecloud/models/recording_data_v2_notification_lock_info.rb,
lib/purecloud/models/recording_data_v2_notification_user_data.rb,
lib/purecloud/models/call_conversation_notification_error_body.rb,
lib/purecloud/models/call_conversation_notification_error_info.rb,
lib/purecloud/models/call_conversation_notification_fax_status.rb,
lib/purecloud/models/callable_time_set_notification_time_slots.rb,
lib/purecloud/models/callback_conversation_notification_detail.rb,
lib/purecloud/models/callback_conversation_notification_wrapup.rb,
lib/purecloud/models/chat_conversation_notification_error_body.rb,
lib/purecloud/models/chat_conversation_notification_error_info.rb,
lib/purecloud/models/cobrowse_conversation_notification_detail.rb,
lib/purecloud/models/cobrowse_conversation_notification_wrapup.rb,
lib/purecloud/models/time_off_request_update_notification_user.rb,
lib/purecloud/models/attempt_limits_notification_recall_entries.rb,
lib/purecloud/models/conversation_notification_cobrowsesessions.rb,
lib/purecloud/models/email_conversation_notification_error_body.rb,
lib/purecloud/models/email_conversation_notification_error_info.rb,
lib/purecloud/models/video_conversation_notification_error_body.rb,
lib/purecloud/models/video_conversation_notification_error_info.rb,
lib/purecloud/models/call_conversation_notification_participants.rb,
lib/purecloud/models/chat_conversation_notification_participants.rb,
lib/purecloud/models/conversation_notification_disconnect_reason.rb,
lib/purecloud/models/conversation_notification_social_expression.rb,
lib/purecloud/models/social_conversation_notification_error_body.rb,
lib/purecloud/models/social_conversation_notification_error_info.rb,
lib/purecloud/models/user_conversation_summary_notification_call.rb,
lib/purecloud/models/user_schedule_adherence_update_notification.rb,
lib/purecloud/models/call_conversation_notification_uri_reference.rb,
lib/purecloud/models/callable_time_set_notification_callable_time.rb,
lib/purecloud/models/campaign_progress_notification_uri_reference.rb,
lib/purecloud/models/campaign_schedule_notification_uri_reference.rb,
lib/purecloud/models/campaign_sequence_notification_uri_reference.rb,
lib/purecloud/models/chat_conversation_notification_uri_reference.rb,
lib/purecloud/models/conversation_notification_disconnect_reasons.rb,
lib/purecloud/models/conversation_notification_social_expressions.rb,
lib/purecloud/models/document_data_v2_notification_workspace_data.rb,
lib/purecloud/models/email_conversation_notification_participants.rb,
lib/purecloud/models/qualifier_mapping_observation_query_response.rb,
lib/purecloud/models/sequence_schedule_notification_uri_reference.rb,
lib/purecloud/models/video_conversation_notification_participants.rb,
lib/purecloud/models/callable_time_set_notification_callable_times.rb,
lib/purecloud/models/callback_conversation_notification_error_body.rb,
lib/purecloud/models/callback_conversation_notification_error_info.rb,
lib/purecloud/models/cobrowse_conversation_notification_error_body.rb,
lib/purecloud/models/cobrowse_conversation_notification_error_info.rb,
lib/purecloud/models/conversation_notification_phone_number_column.rb,
lib/purecloud/models/email_conversation_notification_uri_reference.rb,
lib/purecloud/models/recording_data_v2_notification_workspace_data.rb,
lib/purecloud/models/screen_share_conversation_notification_detail.rb,
lib/purecloud/models/screen_share_conversation_notification_wrapup.rb,
lib/purecloud/models/social_conversation_notification_participants.rb,
lib/purecloud/models/user_stations_notification_associated_station.rb,
lib/purecloud/models/video_conversation_notification_uri_reference.rb,
lib/purecloud/models/heart_beat_rule_notification_notification_user.rb,
lib/purecloud/models/social_conversation_notification_uri_reference.rb,
lib/purecloud/models/user_presence_notification_presence_definition.rb,
lib/purecloud/models/callback_conversation_notification_participants.rb,
lib/purecloud/models/campaign_rule_notification_campaign_rule_action.rb,
lib/purecloud/models/cobrowse_conversation_notification_participants.rb,
lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb,
lib/purecloud/models/heart_beat_alert_notification_notification_user.rb,
lib/purecloud/models/user_routing_status_notification_routing_status.rb,
lib/purecloud/models/callback_conversation_notification_uri_reference.rb,
lib/purecloud/models/campaign_rule_notification_campaign_rule_actions.rb,
lib/purecloud/models/campaign_schedule_notification_schedule_interval.rb,
lib/purecloud/models/cobrowse_conversation_notification_uri_reference.rb,
lib/purecloud/models/heart_beat_alert_notification_notification_users.rb,
lib/purecloud/models/recording_data_v2_notification_conversation_data.rb,
lib/purecloud/models/sequence_schedule_notification_schedule_interval.rb,
lib/purecloud/models/user_presence_notification_organization_presence.rb,
lib/purecloud/models/user_schedule_adherence_update_notification_user.rb,
lib/purecloud/models/callback_conversation_notification_dialer_preview.rb,
lib/purecloud/models/campaign_rule_notification_campaign_rule_entities.rb,
lib/purecloud/models/screen_share_conversation_notification_error_body.rb,
lib/purecloud/models/screen_share_conversation_notification_error_info.rb,
lib/purecloud/models/campaign_rule_notification_campaign_rule_condition.rb,
lib/purecloud/models/campaign_rule_notification_campaign_rule_conditions.rb,
lib/purecloud/models/screen_share_conversation_notification_participants.rb,
lib/purecloud/models/interaction_stat_rule_notification_notification_user.rb,
lib/purecloud/models/screen_share_conversation_notification_uri_reference.rb,
lib/purecloud/models/user_conversation_summary_notification_media_summary.rb,
lib/purecloud/models/call_conversation_notification_call_media_participant.rb,
lib/purecloud/models/callback_conversation_notification_error_info_details.rb,
lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb,
lib/purecloud/models/contact_list_notification_contact_phone_number_column.rb,
lib/purecloud/models/interaction_stat_alert_notification_notification_user.rb,
lib/purecloud/models/callback_conversation_notification_phone_number_column.rb,
lib/purecloud/models/email_conversation_notification_email_media_participant.rb,
lib/purecloud/models/video_conversation_notification_video_media_participant.rb,
lib/purecloud/models/campaign_rule_notification_campaign_rule_action_entities.rb,
lib/purecloud/models/social_conversation_notification_social_media_participant.rb,
lib/purecloud/models/user_conversation_summary_notification_call_contact_center.rb,
lib/purecloud/models/user_conversation_summary_notification_media_summary_detail.rb,
lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb,
lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb,
lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb

Overview

PureCloud Platform API

With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.

OpenAPI spec version: v2 Contact: [email protected] Generated by: github.com/swagger-api/swagger-codegen.git

License: ININ www.inin.com

Terms of Service: developer.mypurecloud.com/tos

Defined Under Namespace

Classes: ADFS, Actions, ActivityCode, ActivityCodeContainer, AcwSettings, Address, Adjacents, Agent, AgentActivity, AgentActivityEntityListing, AgentEvaluatorActivity, AggregateDataContainer, AggregateMetricData, AggregateQueryResponse, AggregateViewData, AggregationQuery, AggregationRange, AggregationResult, AggregationResultEntry, AlertingApi, AnalyticsApi, AnalyticsConversation, AnalyticsConversationQueryResponse, AnalyticsConversationSegment, AnalyticsEvaluation, AnalyticsParticipant, AnalyticsProperty, AnalyticsQueryAggregation, AnalyticsQueryClause, AnalyticsQueryFilter, AnalyticsQueryPredicate, AnalyticsRoutingStatusRecord, AnalyticsSession, AnalyticsUserDetail, AnalyticsUserDetailsQueryResponse, AnalyticsUserPresenceRecord, AnalyticsView, Annotation, AnswerOption, ApiClient, ApiError, ArchitectApi, ArchiveRetention, Attachment, AttemptLimits, AttemptLimitsEntityListing, AttemptLimitsNotification, AttemptLimitsNotificationRecallEntries, AttemptLimitsNotificationRecallEntry, Attribute, AttributeEntityListing, AttributeFilterItem, AttributeQueryRequest, AttributesApi, AuditChange, AuditEntity, AuditEntityReference, AuditFacet, AuditFilter, AuditMessage, AuditSearchResult, AuditUser, AuthorizationApi, AvailableLanguageList, AvailableTopic, AvailableTopicEntityListing, AvailableTranslations, Bullseye, Calibration, CalibrationAssignment, CalibrationCreate, CalibrationEntityListing, Call, CallBasic, CallCommand, CallConversation, CallConversationEntityListing, CallConversationNotification, CallConversationNotificationCallMediaParticipant, CallConversationNotificationDetail, CallConversationNotificationErrorBody, CallConversationNotificationErrorInfo, CallConversationNotificationFaxStatus, CallConversationNotificationParticipants, CallConversationNotificationUriReference, CallConversationNotificationWrapup, CallForwarding, CallMediaParticipant, CallMediaPolicy, CallMediaPolicyConditions, CallRecord, CallableContactsDiagnostic, CallableTime, CallableTimeSet, CallableTimeSetEntityListing, CallableTimeSetNotification, CallableTimeSetNotificationCallableTime, CallableTimeSetNotificationCallableTimes, CallableTimeSetNotificationTimeSlot, CallableTimeSetNotificationTimeSlots, Callback, CallbackBasic, CallbackConversation, CallbackConversationEntityListing, CallbackConversationNotification, CallbackConversationNotificationCallbackMediaParticipant, CallbackConversationNotificationDetail, CallbackConversationNotificationDialerPreview, CallbackConversationNotificationErrorBody, CallbackConversationNotificationErrorInfo, CallbackConversationNotificationErrorInfoDetails, CallbackConversationNotificationParticipants, CallbackConversationNotificationPhoneNumberColumn, CallbackConversationNotificationUriReference, CallbackConversationNotificationWrapup, CallbackIdentifier, CallbackMediaParticipant, Campaign, CampaignDiagnostics, CampaignEntityListing, CampaignInteraction, CampaignInteractions, CampaignNotification, CampaignNotificationContactSort, CampaignNotificationErrors, CampaignNotificationPhoneColumn, CampaignNotificationPhoneColumns, CampaignNotificationRestErrorDetail, CampaignNotificationUriReference, CampaignProgress, CampaignProgressNotification, CampaignProgressNotificationUriReference, CampaignRule, CampaignRuleAction, CampaignRuleActionEntities, CampaignRuleCondition, CampaignRuleEntities, CampaignRuleEntityListing, CampaignRuleNotification, CampaignRuleNotificationCampaignRuleAction, CampaignRuleNotificationCampaignRuleActionEntities, CampaignRuleNotificationCampaignRuleActions, CampaignRuleNotificationCampaignRuleCondition, CampaignRuleNotificationCampaignRuleConditions, CampaignRuleNotificationCampaignRuleEntities, CampaignRuleNotificationUriReference, CampaignRuleParameters, CampaignSchedule, CampaignScheduleNotification, CampaignScheduleNotificationIntervals, CampaignScheduleNotificationScheduleInterval, CampaignScheduleNotificationUriReference, CampaignSequence, CampaignSequenceEntityListing, CampaignSequenceNotification, CampaignSequenceNotificationUriReference, CampaignStats, CampaignTimeSlot, Certificate, CertificateAuthorityEntityListing, CertificateDetails, Change, Channel, ChannelEntityListing, ChannelTopic, ChannelTopicEntityListing, Chat, ChatConversation, ChatConversationEntityListing, ChatConversationNotification, ChatConversationNotificationChatMediaParticipant, ChatConversationNotificationDetail, ChatConversationNotificationErrorBody, ChatConversationNotificationErrorInfo, ChatConversationNotificationParticipants, ChatConversationNotificationUriReference, ChatConversationNotificationWrapup, ChatMediaParticipant, ChatMediaPolicy, ChatMediaPolicyConditions, ChatMessage, ChatMessageUser, CobrowseConversation, CobrowseConversationEntityListing, CobrowseConversationNotification, CobrowseConversationNotificationCobrowseMediaParticipant, CobrowseConversationNotificationDetail, CobrowseConversationNotificationErrorBody, CobrowseConversationNotificationErrorInfo, CobrowseConversationNotificationParticipants, CobrowseConversationNotificationUriReference, CobrowseConversationNotificationWrapup, CobrowseMediaParticipant, Cobrowsesession, CommandStatus, CommandStatusEntityListing, Condition, Configuration, ConnectRate, ConsultTransfer, ConsultTransferResponse, ConsultTransferUpdate, Contact, ContactCallbackRequest, ContactList, ContactListEntityListing, ContactListNotification, ContactListNotificationContactPhoneNumberColumn, ContactListNotificationImportStatus, ContactListNotificationPhoneColumns, ContactListNotificationUriReference, ContactPhoneNumberColumn, ContactSort, ContentAttributeFilterItem, ContentFacetFilterItem, ContentFilterItem, ContentManagementApi, ContentQueryRequest, ContentSortItem, Conversation, ConversationBasic, ConversationChat, ConversationEntityListing, ConversationNotification, ConversationNotificationAddress, ConversationNotificationCall, ConversationNotificationCallback, ConversationNotificationCallbacks, ConversationNotificationCalls, ConversationNotificationChat, ConversationNotificationChats, ConversationNotificationCobrowse, ConversationNotificationCobrowsesessions, ConversationNotificationDialerPreview, ConversationNotificationDisconnectReason, ConversationNotificationDisconnectReasons, ConversationNotificationEmail, ConversationNotificationEmails, ConversationNotificationErrorDetails, ConversationNotificationErrorInfo, ConversationNotificationFaxStatus, ConversationNotificationParticipant, ConversationNotificationParticipants, ConversationNotificationPhoneNumberColumn, ConversationNotificationScreenshare, ConversationNotificationScreenshares, ConversationNotificationSelf, ConversationNotificationSocialExpression, ConversationNotificationSocialExpressions, ConversationNotificationVideo, ConversationNotificationVideos, ConversationNotificationWrapup, ConversationQuery, ConversationsApi, CopyVoicemailMessage, CoverSheet, CreateCallRequest, CreateCallResponse, CreateCallbackCommand, CreateCallbackResponse, CreateEmailRequest, CreateQueueRequest, CreateShareRequest, CreateShareRequestMember, CreateShareResponse, CreateUser, CreateWebChatRequest, CurrentUserScheduleRequestBody, CustomerInteractionCenter, DID, DIDEntityListing, DIDPool, DIDPoolEntityListing, DefaultGreetingList, DeleteRetention, Destination, Detail, DialerAction, DialerAuditRequest, DialerContact, DialerEventEntityListing, DialerPreview, DialerRule, DigitLength, DisconnectReason, DncList, DncListCreate, DncListEntityListing, DncListNotification, DncListNotificationImportStatus, Document, DocumentAttribute, DocumentAudit, DocumentAuditEntityListing, DocumentDataV2Notification, DocumentDataV2NotificationCreatedBy, DocumentDataV2NotificationLockData, DocumentDataV2NotificationLockInfo, DocumentDataV2NotificationUserData, DocumentDataV2NotificationWorkspace, DocumentDataV2NotificationWorkspaceData, DocumentEntityListing, DocumentThumbnail, DocumentUpdate, DocumentUpload, DocumentationResult, DocumentationSearchCriteria, DocumentationSearchRequest, DocumentationSearchResponse, DomainCapabilities, DomainCertificateAuthority, DomainEdgeSoftwareUpdateDto, DomainEdgeSoftwareVersionDto, DomainEdgeSoftwareVersionDtoEntityListing, DomainEntity, DomainEntityListing, DomainEntityListingEvaluationForm, DomainEntityListingQueryResult, DomainLogicalInterface, DomainNetworkAddress, DomainNetworkCommandResponse, DomainNetworkRoute, DomainOrgRoleDifference, DomainOrganizationProduct, DomainOrganizationRole, DomainOrganizationRoleCreate, DomainOrganizationRoleUpdate, DomainPermission, DomainPermissionCollection, DomainPermissionPolicy, DomainPhysicalCapabilities, DomainPhysicalInterface, DomainResourceConditionNode, DomainResourceConditionValue, DomainRole, DomainSchemaReference, DownloadResponse, DurationCondition, Edge, EdgeAutoUpdateConfig, EdgeEntityListing, EdgeGroup, EdgeGroupEntityListing, EdgeInterface, EdgeLine, EdgeLineEntityListing, EdgeLogsJob, EdgeLogsJobFile, EdgeLogsJobRequest, EdgeLogsJobResponse, EdgeLogsJobUploadRequest, EdgeRebootParameters, EdgeServiceStateRequest, EdgeTrunkBase, EdgeVersionInformation, EdgeVersionReport, Email, EmailAddress, EmailAttachment, EmailConversation, EmailConversationEntityListing, EmailConversationNotification, EmailConversationNotificationDetail, EmailConversationNotificationEmailMediaParticipant, EmailConversationNotificationErrorBody, EmailConversationNotificationErrorInfo, EmailConversationNotificationParticipants, EmailConversationNotificationUriReference, EmailConversationNotificationWrapup, EmailMediaParticipant, EmailMediaPolicy, EmailMediaPolicyConditions, EmailMessage, EmailMessageListing, EmailSetup, Empty, EncryptionKey, EncryptionKeyEntityListing, Endpoint, EndpointEntityListing, Entry, ErrorBody, ErrorDetails, EstimatedWaitTimePredictions, Evaluation, EvaluationAssignment, EvaluationEntityListing, EvaluationForm, EvaluationFormAndScoringSet, EvaluationFormEntityListing, EvaluationScoringSet, EvaluatorActivity, EvaluatorActivityEntityListing, EventLog, EventMessage, ExpansionCriterium, ExportUri, ExportUriNotification, Extension, ExtensionEntityListing, ExtensionPool, ExtensionPoolEntityListing, FacetEntry, FacetInfo, FacetKeyAttribute, FacetStatistics, FacetTerm, FaxApi, FaxDataV2Notification, FaxDataV2NotificationLockData, FaxDataV2NotificationLockInfo, FaxDataV2NotificationUserData, FaxDataV2NotificationWorkspaceData, FaxDocument, FaxDocumentEntityListing, FaxSendRequest, FaxSendResponse, FaxStatus, FaxSummary, FeatureState, FieldConfig, FieldConfigs, FieldList, Flow, FlowEntityListing, FlowVersion, GSuite, Geolocation, GeolocationApi, GeolocationSettings, Greeting, GreetingAudioFile, GreetingListing, GreetingMediaInfo, GreetingOwner, GreetingsApi, Group, GroupContact, GroupEntityListing, GroupMembersUpdate, GroupSearchCriteria, GroupSearchRequest, GroupUpdate, GroupsApi, GroupsSearchResponse, HeartBeatAlert, HeartBeatAlertContainer, HeartBeatAlertNotification, HeartBeatAlertNotificationNotificationUser, HeartBeatAlertNotificationNotificationUsers, HeartBeatRule, HeartBeatRuleContainer, HeartBeatRuleNotification, HeartBeatRuleNotificationNotificationUser, IdentityNow, IdentityProviderApi, ImportStatus, ImportStatusNotification, InboundDomain, InboundDomainEntityListing, InboundRoute, InboundRouteEntityListing, InitiateScreenRecording, InteractionStatAlertNotification, InteractionStatAlertNotificationNotificationUser, InteractionStatRuleNotification, InteractionStatRuleNotificationNotificationUser, InteractionStatsAlert, InteractionStatsAlertContainer, InteractionStatsRule, InteractionStatsRuleContainer, JsonNode, JsonNodeSearchResponse, KeyRotationSchedule, Keyword, KeywordSet, KeywordSetEntityListing, Language, LanguageEntityListing, LanguagesApi, Library, LibraryEntityListing, Line, LineBase, LineBaseEntityListing, LineEntityListing, LineStatus, LocalEncryptionConfiguration, LocalEncryptionConfigurationListing, LocalEncryptionKeyRequest, Location, LocationAddress, LocationDefinition, LocationEmergencyNumber, LocationSearchCriteria, LocationSearchRequest, LocationsApi, LocationsSearchResponse, LockInfo, LogicalInterfaceEntityListing, ManagementUnit, MaxParticipants, MediaParticipantRequest, MediaPolicies, MediaResult, MediaSetting, MediaSummary, MediaSummaryDetail, MemberEntity, MetaData, Metabase, MeteredEvaluationAssignment, NotificationsApi, Number, NumberPlan, NumericRange, OAuthApi, OAuthClient, OAuthClientEntityListing, OAuthClientListing, OAuthProvider, OAuthProviderEntityListing, ObservationDataContainer, ObservationQuery, ObservationQueryResponse, Okta, OneLogin, Operation, OrgMediaUtilization, Organization, OrganizationApi, OrganizationFeatures, OrganizationPresence, OrganizationPresenceEntityListing, OrganizationProductEntityListing, OrganizationRoleEntityListing, OrphanRecording, OrphanRecordingListing, OrphanUpdateRequest, OutOfOffice, OutOfOfficeNotification, OutOfOfficeNotificationUser, OutboundApi, OutboundRoute, OutboundRouteBase, OutboundRouteBaseEntityListing, OutboundRouteEntityListing, PINConfiguration, Page, PagingSpec, Parameter, ParsedCertificate, Participant, ParticipantAttributes, ParticipantBasic, PermissionCollectionEntityListing, Phone, PhoneBase, PhoneBaseEntityListing, PhoneCapabilities, PhoneColumn, PhoneEntityListing, PhoneMetaBaseEntityListing, PhoneNumberColumn, PhoneNumberStatus, PhoneStatus, PhonesReboot, PhysicalInterfaceEntityListing, PingIdentity, Policy, PolicyActions, PolicyConditions, PolicyCreate, PolicyEntityListing, PolicyErrorMessage, PolicyErrors, PredictionResults, PresenceApi, PresenceQueryResponse, Prompt, PromptAsset, PromptAssetCreate, PromptAssetEntityListing, PromptEntityListing, PropertyIndexRequest, ProvisionInfo, PureCloud, QualifierMappingObservationQueryResponse, QualityApi, QualityAudit, QualityAuditPage, QueryFacetInfo, QueryRequest, QueryResult, QueryResults, Question, QuestionGroup, QuestionGroupScore, QuestionScore, Queue, QueueEmailAddress, QueueEntityListing, QueueMember, QueueMemberEntityListing, QueueMemberNotification, QueueUtilizationDiagnostic, Reaction, Recording, RecordingApi, RecordingDataV2Notification, RecordingDataV2NotificationConversationData, RecordingDataV2NotificationLockData, RecordingDataV2NotificationLockInfo, RecordingDataV2NotificationUserData, RecordingDataV2NotificationWorkspaceData, RecordingEmailMessage, RecordingSettings, ReplaceRequest, ReplaceResponse, ReportMetaData, ReportMetaDataEntityListing, ReportRunEntry, ReportRunEntryEntityDomainListing, ReportSchedule, ReportScheduleEntityListing, ResourceConditionNode, ResourceConditionValue, ResourcePermissionPolicy, Response, ResponseEntityList, ResponseEntityListing, ResponseFilter, ResponseManagementApi, ResponseQueryRequest, ResponseQueryResults, ResponseSet, ResponseSetEntityListing, ResponseSetNotification, ResponseSetNotificationReaction, ResponseSetNotificationResponses, ResponseSubstitution, ResponseText, RestErrorDetail, RetentionDuration, Ring, RoutingApi, RoutingData, RoutingSkill, RoutingStatus, RoutingStatusAlert, RoutingStatusAlertContainer, RoutingStatusRule, RoutingStatusRuleContainer, RuleSet, RuleSetDiagnostic, RuleSetEntityListing, RuleSetNotification, RuleSetNotificationAction, RuleSetNotificationActions, RuleSetNotificationCondition, RuleSetNotificationConditions, RuleSetNotificationRule, RuleSetNotificationRules, RuleSetNotificationUriReference, RunNowResponse, Salesforce, ScheduleInterval, SchemaCategory, SchemaCategoryEntityListing, SchemaReferenceEntityListing, ScreenRecordingSession, ScreenRecordingSessionListing, ScreenRecordingSessionRequest, ScreenShareConversationNotification, ScreenShareConversationNotificationDetail, ScreenShareConversationNotificationErrorBody, ScreenShareConversationNotificationErrorInfo, ScreenShareConversationNotificationParticipants, ScreenShareConversationNotificationScreenShareMediaParticipant, ScreenShareConversationNotificationUriReference, ScreenShareConversationNotificationWrapup, Screenshare, Script, ScriptEntityListing, ScriptsApi, SearchAggregation, SearchApi, SearchCriteria, SearchRequest, Section, SecurityProfile, SecurityProfileEntityListing, Segment, SequenceSchedule, SequenceScheduleNotification, SequenceScheduleNotificationScheduleInterval, SequenceScheduleNotificationUriReference, ServerDate, ServiceContext, ServiceLevel, Share, ShareEntityListing, SharedEntity, SharedResponse, Site, SiteEntityListing, SkillEntityListing, SkillsToRemove, SocialConversationNotification, SocialConversationNotificationDetail, SocialConversationNotificationErrorBody, SocialConversationNotificationErrorInfo, SocialConversationNotificationParticipants, SocialConversationNotificationSocialMediaParticipant, SocialConversationNotificationUriReference, SocialConversationNotificationWrapup, SocialExpression, SortItem, Station, StationEntityListing, StationsApi, StatisticalResponse, StatisticalSummary, StreetAddress, SubscriberResponse, SuggestApi, SuggestSearchCriteria, SuggestSearchRequest, SystemPresence, SystemPrompt, SystemPromptAsset, SystemPromptAssetEntityListing, SystemPromptEntityListing, TagQueryRequest, TagValue, TagValueEntityListing, TelephonyProvidersEdgeApi, TermAttribute, TimeAllowed, TimeInterval, TimeOffRequest, TimeOffRequestList, TimeOffRequestPatch, TimeOffRequestUpdateNotification, TimeOffRequestUpdateNotificationUser, TimeSlot, TimeZone, TimeZoneEntityListing, TokensApi, TransferRequest, Trunk, TrunkBase, TrunkBaseAssignment, TrunkBaseEntityListing, TrunkEntityListing, TrunkMetabaseEntityListing, TrunkRecordingEnabledCount, UnreadMetric, UnreadStatus, UriReference, Usage, UsageItem, User, UserAgentInfo, UserAuthorization, UserConversationSummary, UserConversationSummaryNotification, UserConversationSummaryNotificationCall, UserConversationSummaryNotificationCallContactCenter, UserConversationSummaryNotificationMediaSummary, UserConversationSummaryNotificationMediaSummaryDetail, UserDetailsQuery, UserEntityListing, UserImage, UserListScheduleRequestBody, UserMe, UserParam, UserPresence, UserPresenceAlert, UserPresenceAlertContainer, UserPresenceNotification, UserPresenceNotificationOrganizationPresence, UserPresenceNotificationPresenceDefinition, UserPresenceRule, UserPresenceRuleContainer, UserQueue, UserQueueEntityListing, UserRecording, UserRecordingEntityListing, UserRecordingsApi, UserRoutingSkill, UserRoutingSkillPost, UserRoutingStatusNotification, UserRoutingStatusNotificationRoutingStatus, UserSchedule, UserScheduleActivity, UserScheduleAdherence, UserScheduleAdherenceUpdateNotification, UserScheduleAdherenceUpdateNotificationUser, UserScheduleContainer, UserScheduleFullDayTimeOffMarker, UserScheduleShift, UserSearchCriteria, UserSearchRequest, UserSkillEntityListing, UserStation, UserStations, UserStationsNotification, UserStationsNotificationAssociatedStation, UserStationsNotificationUser, UserStationsNotificationUserStation, UsersApi, UsersSearchResponse, UtilitiesApi, Utilization, ValidateAddressRequest, ValidateAddressResponse, Video, VideoConversationNotification, VideoConversationNotificationDetail, VideoConversationNotificationErrorBody, VideoConversationNotificationErrorInfo, VideoConversationNotificationParticipants, VideoConversationNotificationUriReference, VideoConversationNotificationVideoMediaParticipant, VideoConversationNotificationWrapup, VisibilityCondition, VmPairingInfo, VoicemailApi, VoicemailGroupPolicy, VoicemailMailboxInfo, VoicemailMediaInfo, VoicemailMessage, VoicemailMessageEntityListing, VoicemailMessageNotification, VoicemailOrganizationPolicy, VoicemailSearchCriteria, VoicemailSearchRequest, VoicemailUserPolicy, VoicemailsSearchResponse, WfmUserEntityListing, WorkforceManagementApi, Workspace, WorkspaceCreate, WorkspaceEntityListing, WorkspaceMember, WorkspaceMemberEntityListing, WorkspaceSummary, WrapUpCodeMapping, WrapUpCodeMappingNotification, Wrapup, WrapupCode, WrapupCodeEntityListing

Constant Summary collapse

VERSION = 
"0.70.1"

Class Method Summary collapse

Class Method Details

.authenticate_with_client_credentials(client_id, client_secret, environment = nil) ⇒ Object

Authenticates to PureCloud using the client credientals OAuth grant.

Parameters:

  • client_id —

    OAuth client id

  • client_secret —

    OAuth client secret

  • environment (defaults to: nil) —

    PureCloud environment (mypurecloud.com, mypurecloud.ie, mypurecloud.com.au, etc)



905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/purecloud.rb', line 905

def authenticate_with_client_credentials(client_id, client_secret, environment = nil)
  environment ||= "mypurecloud.com"
  self.configure.host = 'api.' + environment;

  basic = Base64.strict_encode64("#{client_id}:#{client_secret}")

  tokenData = JSON.parse RestClient.post("https://login.#{environment}/token",
                          {:grant_type => 'client_credentials'},
                          :Authorization => "Basic " + basic,
                          'content-type'=> 'application/x-www-form-urlencoded',
                          :accept => :json)
  self.configure.access_token = tokenData["access_token"]
end

.configure ⇒ Object

Customize default settings for the SDK using block.

PureCloud.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



885
886
887
888
889
890
891
 
# File 'lib/purecloud.rb', line 885

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end

.get_access_token_from_auth_code(auth_code, client_id, client_secret, redirect_uri, environment = nil) ⇒ Object

Retrieves an Access token given an authorization code (authorization code grant)

Parameters:

  • auth_code —

    Authorization code from the OAuth redirec

  • client_id —

    OAuth client id

  • client_secret —

    OAuth client secret

  • client_secret —

    OAuth redirect URI

  • environment (Optional) (defaults to: nil) —

    PureCloud environment (mypurecloud.com, mypurecloud.ie, mypurecloud.com.au, etc)



926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'lib/purecloud.rb', line 926

def get_access_token_from_auth_code(auth_code, client_id, client_secret, redirect_uri, environment = nil)
  environment ||= "mypurecloud.com"

  tokenFormData = {
    "grant_type" => "authorization_code",
    "code" => auth_code,
    "redirect_uri" => redirect_uri
  }

  tokenResponse =JSON.parse RestClient.post "https://#{client_id}:#{client_secret}@login.#{environment}/token", tokenFormData

  return tokenResponse['access_token'];
end