Module: PureCloud

Defined in:
lib/purecloud.rb,
lib/purecloud.rb,
lib/purecloud/version.rb,
lib/purecloud/api_error.rb,
lib/purecloud/api_client.rb,
lib/purecloud/models/app.rb,
lib/purecloud/models/did.rb,
lib/purecloud/models/dns.rb,
lib/purecloud/models/ivr.rb,
lib/purecloud/models/tag.rb,
lib/purecloud/models/vpn.rb,
lib/purecloud/api/fax_api.rb,
lib/purecloud/models/body.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/rate.rb,
lib/purecloud/models/ring.rb,
lib/purecloud/models/rule.rb,
lib/purecloud/models/site.rb,
lib/purecloud/models/tier.rb,
lib/purecloud/models/user.rb,
lib/purecloud/models/view.rb,
lib/purecloud/models/agent.rb,
lib/purecloud/models/alert.rb,
lib/purecloud/models/email.rb,
lib/purecloud/models/entry.rb,
lib/purecloud/models/facet.rb,
lib/purecloud/models/group.rb,
lib/purecloud/models/order.rb,
lib/purecloud/models/phone.rb,
lib/purecloud/models/queue.rb,
lib/purecloud/models/quote.rb,
lib/purecloud/models/share.rb,
lib/purecloud/models/skill.rb,
lib/purecloud/models/trace.rb,
lib/purecloud/models/value.rb,
lib/purecloud/models/video.rb,
lib/purecloud/api/users_api.rb,
lib/purecloud/configuration.rb,
lib/purecloud/models/action.rb,
lib/purecloud/models/body_1.rb,
lib/purecloud/models/body_2.rb,
lib/purecloud/models/change.rb,
lib/purecloud/models/charge.rb,
lib/purecloud/models/detail.rb,
lib/purecloud/models/entity.rb,
lib/purecloud/models/facets.rb,
lib/purecloud/models/filter.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/account.rb,
lib/purecloud/models/actions.rb,
lib/purecloud/models/address.rb,
lib/purecloud/models/carrier.rb,
lib/purecloud/models/channel.rb,
lib/purecloud/models/contact.rb,
lib/purecloud/models/gateway.rb,
lib/purecloud/models/invoice.rb,
lib/purecloud/models/library.rb,
lib/purecloud/models/license.rb,
lib/purecloud/models/preview.rb,
lib/purecloud/models/product.rb,
lib/purecloud/models/segment.rb,
lib/purecloud/models/service.rb,
lib/purecloud/models/session.rb,
lib/purecloud/models/sort_by.rb,
lib/purecloud/models/station.rb,
lib/purecloud/models/support.rb,
lib/purecloud/api/quality_api.rb,
lib/purecloud/api/routing_api.rb,
lib/purecloud/api/scripts_api.rb,
lib/purecloud/models/bullseye.rb,
lib/purecloud/models/callback.rb,
lib/purecloud/models/campaign.rb,
lib/purecloud/models/contract.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/gistener.rb,
lib/purecloud/models/greeting.rb,
lib/purecloud/models/language.rb,
lib/purecloud/models/location.rb,
lib/purecloud/models/metabase.rb,
lib/purecloud/models/reaction.rb,
lib/purecloud/models/response.rb,
lib/purecloud/models/rule_set.rb,
lib/purecloud/models/schedule.rb,
lib/purecloud/models/template.rb,
lib/purecloud/api/outbound_api.rb,
lib/purecloud/api/presence_api.rb,
lib/purecloud/api/stations_api.rb,
lib/purecloud/models/attribute.rb,
lib/purecloud/models/condition.rb,
lib/purecloud/models/data_item.rb,
lib/purecloud/models/edge_line.rb,
lib/purecloud/models/extension.rb,
lib/purecloud/models/flow_body.rb,
lib/purecloud/models/group_tag.rb,
lib/purecloud/models/line_base.rb,
lib/purecloud/models/lock_info.rb,
lib/purecloud/models/one_login.rb,
lib/purecloud/models/parameter.rb,
lib/purecloud/models/recording.rb,
lib/purecloud/models/sort_item.rb,
lib/purecloud/models/tag_model.rb,
lib/purecloud/models/tag_value.rb,
lib/purecloud/models/time_slot.rb,
lib/purecloud/models/time_zone.rb,
lib/purecloud/models/work_item.rb,
lib/purecloud/models/workspace.rb,
lib/purecloud/api/analytics_api.rb,
lib/purecloud/api/architect_api.rb,
lib/purecloud/api/downloads_api.rb,
lib/purecloud/api/greetings_api.rb,
lib/purecloud/api/languages_api.rb,
lib/purecloud/api/licensing_api.rb,
lib/purecloud/api/locations_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/batch_item.rb,
lib/purecloud/models/csv_schema.rb,
lib/purecloud/models/dependency.rb,
lib/purecloud/models/edge_group.rb,
lib/purecloud/models/error_body.rb,
lib/purecloud/models/evaluation.rb,
lib/purecloud/models/facet_info.rb,
lib/purecloud/models/facet_item.rb,
lib/purecloud/models/facet_term.rb,
lib/purecloud/models/flow_state.rb,
lib/purecloud/models/occurrence.rb,
lib/purecloud/models/phone_base.rb,
lib/purecloud/models/pure_cloud.rb,
lib/purecloud/models/salesforce.rb,
lib/purecloud/models/sort_field.rb,
lib/purecloud/models/trace_list.rb,
lib/purecloud/models/trunk_base.rb,
lib/purecloud/models/user_image.rb,
lib/purecloud/models/user_param.rb,
lib/purecloud/models/user_queue.rb,
lib/purecloud/models/user_skill.rb,
lib/purecloud/models/voice_rate.rb,
lib/purecloud/api/attributes_api.rb,
lib/purecloud/api/compliance_api.rb,
lib/purecloud/models/batch_reply.rb,
lib/purecloud/models/byte_buffer.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/destination.rb,
lib/purecloud/models/dialer_call.rb,
lib/purecloud/models/email_setup.rb,
lib/purecloud/models/facet_entry.rb,
lib/purecloud/models/facet_group.rb,
lib/purecloud/models/fax_summary.rb,
lib/purecloud/models/filter_item.rb,
lib/purecloud/models/geolocation.rb,
lib/purecloud/models/line_status.rb,
lib/purecloud/models/noc_support.rb,
lib/purecloud/models/number_plan.rb,
lib/purecloud/models/participant.rb,
lib/purecloud/models/permissions.rb,
lib/purecloud/models/publication.rb,
lib/purecloud/models/reservation.rb,
lib/purecloud/models/server_date.rb,
lib/purecloud/models/user_status.rb,
lib/purecloud/models/utilization.rb,
lib/purecloud/models/wrapup_code.rb,
lib/purecloud/models/xlsx_schema.rb,
lib/purecloud/api/geolocation_api.rb,
lib/purecloud/models/acw_settings.rb,
lib/purecloud/models/audit_change.rb,
lib/purecloud/models/chat_message.rb,
lib/purecloud/models/connect_rate.rb,
lib/purecloud/models/contact_list.rb,
lib/purecloud/models/contract_job.rb,
lib/purecloud/models/conversation.rb,
lib/purecloud/models/digit_length.rb,
lib/purecloud/models/facet_result.rb,
lib/purecloud/models/fax_document.rb,
lib/purecloud/models/flow_details.rb,
lib/purecloud/models/flow_exec_id.rb,
lib/purecloud/models/flow_publish.rb,
lib/purecloud/models/flow_version.rb,
lib/purecloud/models/group_images.rb,
lib/purecloud/models/hipaa_config.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/quote_charge.rb,
lib/purecloud/models/response_set.rb,
lib/purecloud/models/service_type.rb,
lib/purecloud/models/sheet_schema.rb,
lib/purecloud/models/time_allowed.rb,
lib/purecloud/models/url_response.rb,
lib/purecloud/models/audit_message.rb,
lib/purecloud/models/batch_command.rb,
lib/purecloud/models/callable_time.rb,
lib/purecloud/models/channel_topic.rb,
lib/purecloud/models/contact_sales.rb,
lib/purecloud/models/delta_request.rb,
lib/purecloud/models/domain_entity.rb,
lib/purecloud/models/email_address.rb,
lib/purecloud/models/email_message.rb,
lib/purecloud/models/error_details.rb,
lib/purecloud/models/facet_request.rb,
lib/purecloud/models/failed_object.rb,
lib/purecloud/models/hardware_rate.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/o_auth_client.rb,
lib/purecloud/models/out_of_office.rb,
lib/purecloud/models/phones_reboot.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/quote_listing.rb,
lib/purecloud/models/response_text.rb,
lib/purecloud/models/service_level.rb,
lib/purecloud/models/sub_data_item.rb,
lib/purecloud/models/system_prompt.rb,
lib/purecloud/models/time_interval.rb,
lib/purecloud/models/unread_metric.rb,
lib/purecloud/models/uri_reference.rb,
lib/purecloud/models/user_presence.rb,
lib/purecloud/api/authorization_api.rb,
lib/purecloud/api/configuration_api.rb,
lib/purecloud/api/conversations_api.rb,
lib/purecloud/api/notifications_api.rb,
lib/purecloud/models/account_status.rb,
lib/purecloud/models/agent_activity.rb,
lib/purecloud/models/automate_queue.rb,
lib/purecloud/models/billing_period.rb,
lib/purecloud/models/campaign_stats.rb,
lib/purecloud/models/command_status.rb,
lib/purecloud/models/delta_document.rb,
lib/purecloud/models/delta_response.rb,
lib/purecloud/models/dialer_preview.rb,
lib/purecloud/models/document_audit.rb,
lib/purecloud/models/domain_license.rb,
lib/purecloud/models/edge_interface.rb,
lib/purecloud/models/encryption_key.rb,
lib/purecloud/models/extension_pool.rb,
lib/purecloud/models/flow_config_id.rb,
lib/purecloud/models/greeting_owner.rb,
lib/purecloud/models/inbound_domain.rb,
lib/purecloud/models/outbound_route.rb,
lib/purecloud/models/policy_actions.rb,
lib/purecloud/models/progress_model.rb,
lib/purecloud/models/provision_info.rb,
lib/purecloud/models/question_group.rb,
lib/purecloud/models/question_score.rb,
lib/purecloud/models/report_request.rb,
lib/purecloud/models/routing_status.rb,
lib/purecloud/models/schedule_group.rb,
lib/purecloud/models/search_request.rb,
lib/purecloud/models/social_account.rb,
lib/purecloud/models/term_attribute.rb,
lib/purecloud/models/transform_lens.rb,
lib/purecloud/models/user_recording.rb,
lib/purecloud/models/account_manager.rb,
lib/purecloud/models/address_listing.rb,
lib/purecloud/models/attribute_value.rb,
lib/purecloud/models/available_topic.rb,
lib/purecloud/models/basic_transform.rb,
lib/purecloud/models/batch_item_body.rb,
lib/purecloud/models/call_forwarding.rb,
lib/purecloud/models/carrier_address.rb,
lib/purecloud/models/column_collapse.rb,
lib/purecloud/models/data_value_info.rb,
lib/purecloud/models/dependency_type.rb,
lib/purecloud/models/document_update.rb,
lib/purecloud/models/document_upload.rb,
lib/purecloud/models/evaluation_form.rb,
lib/purecloud/models/flow_input_data.rb,
lib/purecloud/models/line_properties.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/schema_category.rb,
lib/purecloud/models/service_context.rb,
lib/purecloud/models/session_request.rb,
lib/purecloud/models/shared_response.rb,
lib/purecloud/models/sheet_transform.rb,
lib/purecloud/models/table_transform.rb,
lib/purecloud/models/transform_model.rb,
lib/purecloud/models/unpivot_columns.rb,
lib/purecloud/models/upload_progress.rb,
lib/purecloud/models/voice_rates_csv.rb,
lib/purecloud/models/work_item_cache.rb,
lib/purecloud/api/user_recordings_api.rb,
lib/purecloud/models/account_overview.rb,
lib/purecloud/models/batch_reply_item.rb,
lib/purecloud/models/chat_participant.rb,
lib/purecloud/models/chat_search_item.rb,
lib/purecloud/models/consult_transfer.rb,
lib/purecloud/models/customer_account.rb,
lib/purecloud/models/delete_retention.rb,
lib/purecloud/models/diagnostic_email.rb,
lib/purecloud/models/email_attachment.rb,
lib/purecloud/models/facet_statistics.rb,
lib/purecloud/models/fax_send_request.rb,
lib/purecloud/models/flow_body_format.rb,
lib/purecloud/models/max_participants.rb,
lib/purecloud/models/metric_threshold.rb,
lib/purecloud/models/orphan_recording.rb,
lib/purecloud/models/penetration_rate.rb,
lib/purecloud/models/published_result.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/workspace_create.rb,
lib/purecloud/models/workspace_member.rb,
lib/purecloud/models/archive_retention.rb,
lib/purecloud/models/callable_time_set.rb,
lib/purecloud/models/campaign_schedule.rb,
lib/purecloud/models/campaign_sequence.rb,
lib/purecloud/models/chat_message_user.rb,
lib/purecloud/models/content_sort_item.rb,
lib/purecloud/models/dependency_object.rb,
lib/purecloud/models/dependency_status.rb,
lib/purecloud/models/domain_permission.rb,
lib/purecloud/models/download_response.rb,
lib/purecloud/models/facet_filter_item.rb,
lib/purecloud/models/facet_result_item.rb,
lib/purecloud/models/fax_send_response.rb,
lib/purecloud/models/flow_history_item.rb,
lib/purecloud/models/flow_lock_request.rb,
lib/purecloud/models/indexed_transform.rb,
lib/purecloud/models/pin_configuration.rb,
lib/purecloud/models/policy_conditions.rb,
lib/purecloud/models/rest_error_detail.rb,
lib/purecloud/models/sequence_schedule.rb,
lib/purecloud/models/social_expression.rb,
lib/purecloud/models/tag_query_request.rb,
lib/purecloud/models/voice_rate_update.rb,
lib/purecloud/models/voicemail_message.rb,
lib/purecloud/models/work_item_actions.rb,
lib/purecloud/models/work_item_command.rb,
lib/purecloud/models/work_item_details.rb,
lib/purecloud/models/workspace_summary.rb,
lib/purecloud/models/did_entity_listing.rb,
lib/purecloud/models/document_thumbnail.rb,
lib/purecloud/models/duration_condition.rb,
lib/purecloud/models/evaluator_activity.rb,
lib/purecloud/models/ivr_entity_listing.rb,
lib/purecloud/models/parsed_certificate.rb,
lib/purecloud/models/phone_capabilities.rb,
lib/purecloud/models/quality_audit_page.rb,
lib/purecloud/models/retention_duration.rb,
lib/purecloud/models/transform_endpoint.rb,
lib/purecloud/models/transform_progress.rb,
lib/purecloud/models/twitter_expression.rb,
lib/purecloud/models/user_authorization.rb,
lib/purecloud/api/content_management_api.rb,
lib/purecloud/models/associated_document.rb,
lib/purecloud/models/audit_search_result.rb,
lib/purecloud/models/certificate_details.rb,
lib/purecloud/models/chat_search_listing.rb,
lib/purecloud/models/chat_search_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/expression_response.rb,
lib/purecloud/models/facet_key_attribute.rb,
lib/purecloud/models/flow_entity_listing.rb,
lib/purecloud/models/flow_launch_request.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/organization_create.rb,
lib/purecloud/models/participant_request.rb,
lib/purecloud/models/penetration_rate_id.rb,
lib/purecloud/models/phone_number_column.rb,
lib/purecloud/models/phone_number_status.rb,
lib/purecloud/models/put_management_unit.rb,
lib/purecloud/models/rule_entity_listing.rb,
lib/purecloud/models/site_entity_listing.rb,
lib/purecloud/models/system_prompt_asset.rb,
lib/purecloud/models/third_party_account.rb,
lib/purecloud/models/user_entity_listing.rb,
lib/purecloud/models/voice_rate_extended.rb,
lib/purecloud/models/voice_xml_operation.rb,
lib/purecloud/api/orphaned_recordings_api.rb,
lib/purecloud/models/alert_entity_listing.rb,
lib/purecloud/models/campaign_diagnostics.rb,
lib/purecloud/models/common_audit_request.rb,
lib/purecloud/models/create_share_request.rb,
lib/purecloud/models/dialer_audit_request.rb,
lib/purecloud/models/domain_network_route.rb,
lib/purecloud/models/flow_upload_response.rb,
lib/purecloud/models/geolocation_settings.rb,
lib/purecloud/models/group_entity_listing.rb,
lib/purecloud/models/number_order_request.rb,
lib/purecloud/models/organization_address.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/share_entity_listing.rb,
lib/purecloud/models/skill_entity_listing.rb,
lib/purecloud/models/text_table_transform.rb,
lib/purecloud/models/topic_entity_listing.rb,
lib/purecloud/models/user_action_category.rb,
lib/purecloud/models/user_action_metadata.rb,
lib/purecloud/models/users_entity_listing.rb,
lib/purecloud/models/voicemail_media_info.rb,
lib/purecloud/models/work_item_definition.rb,
lib/purecloud/models/wrap_up_code_mapping.rb,
lib/purecloud/models/automate_queue_member.rb,
lib/purecloud/models/content_query_request.rb,
lib/purecloud/models/conversation_response.rb,
lib/purecloud/models/create_share_response.rb,
lib/purecloud/models/default_greeting_list.rb,
lib/purecloud/models/domain_entity_listing.rb,
lib/purecloud/models/email_message_listing.rb,
lib/purecloud/models/evaluation_assignment.rb,
lib/purecloud/models/flow_activate_request.rb,
lib/purecloud/models/flow_config_meta_data.rb,
lib/purecloud/models/hardware_rate_listing.rb,
lib/purecloud/models/key_rotation_schedule.rb,
lib/purecloud/models/org_media_utilization.rb,
lib/purecloud/models/organization_presence.rb,
lib/purecloud/models/policy_entity_listing.rb,
lib/purecloud/models/prompt_entity_listing.rb,
lib/purecloud/models/queues_entity_listing.rb,
lib/purecloud/models/script_entity_listing.rb,
lib/purecloud/models/spreadsheet_transform.rb,
lib/purecloud/models/trunk_base_assignment.rb,
lib/purecloud/models/user_station_resource.rb,
lib/purecloud/models/voicemail_user_policy.rb,
lib/purecloud/models/audit_entity_reference.rb,
lib/purecloud/models/calibration_assignment.rb,
lib/purecloud/models/carrier_entity_listing.rb,
lib/purecloud/models/channel_entity_listing.rb,
lib/purecloud/models/client_transform_model.rb,
lib/purecloud/models/contact_sales_response.rb,
lib/purecloud/models/domain_network_address.rb,
lib/purecloud/models/evaluation_scoring_set.rb,
lib/purecloud/models/flow_terminate_request.rb,
lib/purecloud/models/library_entity_listing.rb,
lib/purecloud/models/licenses_by_permission.rb,
lib/purecloud/models/org_license_assignment.rb,
lib/purecloud/models/participant_attributes.rb,
lib/purecloud/models/response_query_request.rb,
lib/purecloud/models/response_query_results.rb,
lib/purecloud/models/service_entity_listing.rb,
lib/purecloud/models/session_entity_listing.rb,
lib/purecloud/models/station_entity_listing.rb,
lib/purecloud/models/voicemail_mailbox_info.rb,
lib/purecloud/models/attribute_query_request.rb,
lib/purecloud/models/campaign_entity_listing.rb,
lib/purecloud/models/consult_transfer_update.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/embedded_signature_view.rb,
lib/purecloud/models/endpoint_entity_listing.rb,
lib/purecloud/models/flow_report_result_item.rb,
lib/purecloud/models/language_entity_listing.rb,
lib/purecloud/models/location_address_fields.rb,
lib/purecloud/models/location_entity_listing.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/schedule_entity_listing.rb,
lib/purecloud/models/signature_document_info.rb,
lib/purecloud/models/socialize_entity_filter.rb,
lib/purecloud/models/template_entity_listing.rb,
lib/purecloud/models/user_license_assignment.rb,
lib/purecloud/models/work_item_command_group.rb,
lib/purecloud/models/agent_evaluator_activity.rb,
lib/purecloud/models/attribute_entity_listing.rb,
lib/purecloud/models/contact_callback_request.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/evaluation_query_request.rb,
lib/purecloud/models/extension_entity_listing.rb,
lib/purecloud/models/flow_history_result_item.rb,
lib/purecloud/models/line_base_entity_listing.rb,
lib/purecloud/models/management_unit_timezone.rb,
lib/purecloud/models/orphan_recording_listing.rb,
lib/purecloud/models/resource_condition_value.rb,
lib/purecloud/models/socialize_filter_request.rb,
lib/purecloud/models/tag_value_entity_listing.rb,
lib/purecloud/models/third_party_subscription.rb,
lib/purecloud/models/time_zone_entity_listing.rb,
lib/purecloud/models/validate_address_request.rb,
lib/purecloud/models/voice_rate_international.rb,
lib/purecloud/models/work_item_search_details.rb,
lib/purecloud/models/work_item_submit_request.rb,
lib/purecloud/models/workspace_entity_listing.rb,
lib/purecloud/api/telephony_providers_edge_api.rb,
lib/purecloud/models/consult_transfer_response.rb,
lib/purecloud/models/content_facet_filter_item.rb,
lib/purecloud/models/dialer_place_call_command.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/location_emergency_number.rb,
lib/purecloud/models/phone_base_entity_listing.rb,
lib/purecloud/models/twitter_expression_buffer.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/calibration_entity_listing.rb,
lib/purecloud/models/domain_org_role_difference.rb,
lib/purecloud/models/flow_details_search_result.rb,
lib/purecloud/models/resource_permission_policy.rb,
lib/purecloud/models/work_item_transfer_request.rb,
lib/purecloud/models/wrapup_code_entity_listing.rb,
lib/purecloud/models/campaign_schedule_intervals.rb,
lib/purecloud/models/contact_list_entity_listing.rb,
lib/purecloud/models/conversation_entity_listing.rb,
lib/purecloud/models/conversation_query_response.rb,
lib/purecloud/models/create_share_request_member.rb,
lib/purecloud/models/domain_organization_product.rb,
lib/purecloud/models/fax_document_entity_listing.rb,
lib/purecloud/models/flow_version_entity_listing.rb,
lib/purecloud/models/prompt_asset_entity_listing.rb,
lib/purecloud/models/publish_script_request_data.rb,
lib/purecloud/models/queue_member_entity_listing.rb,
lib/purecloud/models/response_set_entity_listing.rb,
lib/purecloud/models/available_additional_service.rb,
lib/purecloud/models/callable_contacts_diagnostic.rb,
lib/purecloud/models/client_spreadsheet_transform.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/inbound_route_entity_listing.rb,
lib/purecloud/models/o_auth_client_entity_listing.rb,
lib/purecloud/models/primary_user_presence_source.rb,
lib/purecloud/models/queue_utilization_diagnostic.rb,
lib/purecloud/models/system_prompt_entity_listing.rb,
lib/purecloud/models/user_action_metadata_request.rb,
lib/purecloud/models/user_presence_entity_listing.rb,
lib/purecloud/models/agent_activity_entity_listing.rb,
lib/purecloud/models/command_status_entity_listing.rb,
lib/purecloud/models/document_audit_entity_listing.rb,
lib/purecloud/models/domain_invoice_entity_listing.rb,
lib/purecloud/models/domain_license_entity_listing.rb,
lib/purecloud/models/encryption_key_entity_listing.rb,
lib/purecloud/models/extension_pool_entity_listing.rb,
lib/purecloud/models/flow_version_config_meta_data.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/schedule_group_entity_listing.rb,
lib/purecloud/models/trunk_metabase_entity_listing.rb,
lib/purecloud/models/user_recording_entity_listing.rb,
lib/purecloud/models/voicemail_organization_policy.rb,
lib/purecloud/models/backend_flow_available_actions.rb,
lib/purecloud/models/backend_work_item_data_element.rb,
lib/purecloud/models/dependency_type_entity_listing.rb,
lib/purecloud/models/domain_resource_condition_node.rb,
lib/purecloud/models/evaluation_form_entity_listing.rb,
lib/purecloud/models/favorite_template_request_data.rb,
lib/purecloud/models/o_auth_provider_entity_listing.rb,
lib/purecloud/models/phone_meta_base_entity_listing.rb,
lib/purecloud/models/report_schedule_entity_listing.rb,
lib/purecloud/models/schema_category_entity_listing.rb,
lib/purecloud/models/dialer_disposition_call_command.rb,
lib/purecloud/models/domain_edge_software_update_dto.rb,
lib/purecloud/models/domain_network_command_response.rb,
lib/purecloud/models/domain_resource_condition_value.rb,
lib/purecloud/models/evaluation_form_and_scoring_set.rb,
lib/purecloud/models/report_meta_data_entity_listing.rb,
lib/purecloud/models/schema_reference_entity_listing.rb,
lib/purecloud/models/security_profile_entity_listing.rb,
lib/purecloud/models/workspace_member_entity_listing.rb,
lib/purecloud/models/callable_time_set_entity_listing.rb,
lib/purecloud/models/campaign_sequence_entity_listing.rb,
lib/purecloud/models/dependency_object_entity_listing.rb,
lib/purecloud/models/domain_edge_software_version_dto.rb,
lib/purecloud/models/logical_interface_entity_listing.rb,
lib/purecloud/models/organization_role_entity_listing.rb,
lib/purecloud/models/voicemail_message_entity_listing.rb,
lib/purecloud/models/consumed_resources_entity_listing.rb,
lib/purecloud/models/evaluator_activity_entity_listing.rb,
lib/purecloud/models/flow_associate_workspaces_request.rb,
lib/purecloud/models/physical_interface_entity_listing.rb,
lib/purecloud/models/consuming_resources_entity_listing.rb,
lib/purecloud/models/domain_entity_listing_query_result.rb,
lib/purecloud/models/linked_entity_listing_flow_details.rb,
lib/purecloud/models/system_prompt_asset_entity_listing.rb,
lib/purecloud/models/voice_xml_operation_entity_listing.rb,
lib/purecloud/models/organization_product_entity_listing.rb,
lib/purecloud/models/text_table_transform_entity_listing.rb,
lib/purecloud/models/user_action_category_entity_listing.rb,
lib/purecloud/models/user_action_metadata_entity_listing.rb,
lib/purecloud/models/available_additional_service_listing.rb,
lib/purecloud/models/certificate_authority_entity_listing.rb,
lib/purecloud/models/domain_billing_period_entity_listing.rb,
lib/purecloud/models/flow_config_meta_data_entity_listing.rb,
lib/purecloud/models/organization_presence_entity_listing.rb,
lib/purecloud/models/permission_collection_entity_listing.rb,
lib/purecloud/models/spreadsheet_transform_entity_listing.rb,
lib/purecloud/models/domain_entity_listing_evaluation_form.rb,
lib/purecloud/models/report_run_entry_entity_domain_listing.rb,
lib/purecloud/models/work_item_search_details_search_result.rb,
lib/purecloud/models/flow_history_result_item_entity_listing.rb,
lib/purecloud/models/voice_rate_international_entity_listing.rb,
lib/purecloud/models/create_template_from_script_request_data.rb,
lib/purecloud/models/deleted_resource_consumer_entity_listing.rb,
lib/purecloud/models/domain_third_party_account_entity_listing.rb,
lib/purecloud/models/conversation_historical_query_request_body.rb,
lib/purecloud/models/conversation_historical_query_request_filter.rb,
lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb,
lib/purecloud/models/domain_third_party_subscription_entity_listing.rb,
lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb,
lib/purecloud/models/linked_entity_listing_work_item_search_details.rb

Defined Under Namespace

Classes: Account, AccountManager, AccountOverview, AccountStatus, Action, Actions, AcwSettings, Address, AddressListing, Agent, AgentActivity, AgentActivityEntityListing, AgentEvaluatorActivity, Alert, AlertEntityListing, AnalyticsApi, Annotation, ApiClient, ApiError, App, ArchitectApi, ArchiveRetention, AssociatedDocument, Attachment, Attribute, AttributeEntityListing, AttributeQueryRequest, AttributeValue, AttributesApi, AuditChange, AuditEntityReference, AuditMessage, AuditSearchResult, AuthorizationApi, AutomateQueue, AutomateQueueMember, AvailableAdditionalService, AvailableAdditionalServiceListing, AvailableTopic, BackendFlowAvailableActions, BackendWorkItemDataElement, BasicTransform, BatchCommand, BatchItem, BatchItemBody, BatchReply, BatchReplyItem, BillingPeriod, Body, Body1, Body2, Bullseye, ByteBuffer, Calibration, CalibrationAssignment, CalibrationEntityListing, Call, CallForwarding, CallRecord, CallableContactsDiagnostic, CallableTime, CallableTimeSet, CallableTimeSetEntityListing, Callback, Campaign, CampaignDiagnostics, CampaignEntityListing, CampaignSchedule, CampaignScheduleIntervals, CampaignSequence, CampaignSequenceEntityListing, CampaignStats, Carrier, CarrierAddress, CarrierEntityListing, Certificate, CertificateAuthorityEntityListing, CertificateDetails, Change, Channel, ChannelEntityListing, ChannelTopic, Charge, Chat, ChatMessage, ChatMessageUser, ChatParticipant, ChatSearchItem, ChatSearchListing, ChatSearchRequest, ClientSpreadsheetTransform, ClientTransformModel, ColumnCollapse, CommandStatus, CommandStatusEntityListing, CommonAuditRequest, ComplianceApi, Condition, Configuration, ConfigurationApi, ConnectRate, ConsultTransfer, ConsultTransferResponse, ConsultTransferUpdate, ConsumedResourcesEntityListing, ConsumingResourcesEntityListing, Contact, ContactCallbackRequest, ContactList, ContactListEntityListing, ContactSales, ContactSalesResponse, ContentFacetFilterItem, ContentManagementApi, ContentQueryRequest, ContentSortItem, Contract, ContractJob, Conversation, ConversationEntityListing, ConversationHistoricalQueryRequestBody, ConversationHistoricalQueryRequestFilter, ConversationQueryResponse, ConversationResponse, ConversationsApi, CoverSheet, CreateShareRequest, CreateShareRequestMember, CreateShareResponse, CreateTemplateFromScriptRequestData, CsvSchema, CustomerAccount, DID, DIDEntityListing, DIDPool, DIDPoolEntityListing, DataItem, DataValueInfo, DefaultGreetingList, DeleteRetention, DeletedResourceConsumerEntityListing, DeltaDocument, DeltaRequest, DeltaResponse, Dependency, DependencyObject, DependencyObjectEntityListing, DependencyStatus, DependencyType, DependencyTypeEntityListing, Destination, Detail, DiagnosticEmail, DialerAuditRequest, DialerCall, DialerDispositionCallCommand, DialerPlaceCallCommand, DialerPreview, DigitLength, DncList, DncListEntityListing, Dns, Document, DocumentAudit, DocumentAuditEntityListing, DocumentEntityListing, DocumentThumbnail, DocumentUpdate, DocumentUpload, DomainBillingPeriodEntityListing, DomainCapabilities, DomainCertificateAuthority, DomainEdgeSoftwareUpdateDto, DomainEdgeSoftwareVersionDto, DomainEntity, DomainEntityListing, DomainEntityListingEvaluationForm, DomainEntityListingQueryResult, DomainInvoiceEntityListing, DomainLicense, DomainLicenseEntityListing, DomainLogicalInterface, DomainNetworkAddress, DomainNetworkCommandResponse, DomainNetworkRoute, DomainOrgRoleDifference, DomainOrganizationProduct, DomainOrganizationRole, DomainPermission, DomainPermissionCollection, DomainPermissionPolicy, DomainPhysicalCapabilities, DomainPhysicalInterface, DomainResourceConditionNode, DomainResourceConditionValue, DomainSchemaReference, DomainThirdPartyAccountEntityListing, DomainThirdPartySubscriptionEntityListing, DomainVoiceRateResponseItemEntityListing, DownloadResponse, DownloadsApi, DurationCondition, Edge, EdgeAutoUpdateConfig, EdgeEntityListing, EdgeGroup, EdgeGroupEntityListing, EdgeInterface, EdgeLine, EdgeLineEntityListing, EdgeVersionInformation, EdgeVersionReport, Email, EmailAddress, EmailAttachment, EmailMessage, EmailMessageListing, EmailSetup, EmbeddedSignatureView, EncryptionKey, EncryptionKeyEntityListing, Endpoint, EndpointEntityListing, Entity, Entry, ErrorBody, ErrorDetails, Evaluation, EvaluationAssignment, EvaluationEntityListing, EvaluationForm, EvaluationFormAndScoringSet, EvaluationFormEntityListing, EvaluationQueryRequest, EvaluationScoringSet, EvaluatorActivity, EvaluatorActivityEntityListing, ExpansionCriterium, ExpressionResponse, Extension, ExtensionEntityListing, ExtensionPool, ExtensionPoolEntityListing, Facet, FacetEntry, FacetFilterItem, FacetGroup, FacetInfo, FacetItem, FacetKeyAttribute, FacetRequest, FacetResult, FacetResultItem, FacetStatistics, FacetTerm, Facets, FailedObject, FavoriteTemplateRequestData, FaxApi, FaxDocument, FaxDocumentEntityListing, FaxSendRequest, FaxSendResponse, FaxSummary, Filter, FilterItem, Flow, FlowActivateRequest, FlowAssociateWorkspacesRequest, FlowBody, FlowBodyFormat, FlowConfigId, FlowConfigMetaData, FlowConfigMetaDataEntityListing, FlowDetails, FlowDetailsSearchResult, FlowEntityListing, FlowExecId, FlowHistoryItem, FlowHistoryResultItem, FlowHistoryResultItemEntityListing, FlowInputData, FlowLaunchRequest, FlowLockRequest, FlowPublish, FlowReportResultItem, FlowState, FlowTerminateRequest, FlowUploadResponse, FlowVersion, FlowVersionConfigMetaData, FlowVersionConfigMetaDataEntityListing, FlowVersionEntityListing, Gateway, Geolocation, GeolocationApi, GeolocationSettings, Gistener, Greeting, GreetingAudioFile, GreetingMediaInfo, GreetingOwner, GreetingsApi, Group, GroupEntityListing, GroupImages, GroupTag, GroupsApi, HIPAAConfig, HardwareRate, HardwareRateListing, IVR, IVREntityListing, ImportStatus, InboundDomain, InboundDomainEntityListing, InboundRoute, InboundRouteEntityListing, IndexedTransform, Invoice, KeyRotationSchedule, Language, LanguageEntityListing, LanguagesApi, Library, LibraryEntityListing, License, LicensesByPermission, LicensingApi, Line, LineBase, LineBaseEntityListing, LineEntityListing, LineProperties, LineStatus, LinkedEntityListingFlowDetails, LinkedEntityListingWorkItemSearchDetails, Location, LocationAddressFields, LocationEmergencyNumber, LocationEntityListing, LocationsApi, LockInfo, LogicalInterfaceEntityListing, ManagementUnit, ManagementUnitTimezone, MaxParticipants, MediaResult, MediaSetting, MediaSummary, Metabase, MeteredEvaluationAssignment, MetricThreshold, NocSupport, NotificationsApi, Number, NumberOrderRequest, NumberPlan, OAuthApi, OAuthClient, OAuthClientEntityListing, OAuthProvider, OAuthProviderEntityListing, Occurrence, Okta, OneLogin, Order, OrgLicenseAssignment, OrgMediaUtilization, Organization, OrganizationAddress, OrganizationCreate, OrganizationPresence, OrganizationPresenceEntityListing, OrganizationProductEntityListing, OrganizationRoleEntityListing, OrphanRecording, OrphanRecordingListing, OrphanedRecordingsApi, OutOfOffice, OutboundApi, OutboundRoute, OutboundRouteEntityListing, PINConfiguration, Page, Parameter, ParsedCertificate, Participant, ParticipantAttributes, ParticipantRequest, PenetrationRate, PenetrationRateId, PermissionCollectionEntityListing, Permissions, Phone, PhoneBase, PhoneBaseEntityListing, PhoneCapabilities, PhoneColumn, PhoneEntityListing, PhoneMetaBaseEntityListing, PhoneNumberColumn, PhoneNumberStatus, PhoneStatus, PhonesReboot, PhysicalInterfaceEntityListing, Policy, PolicyActions, PolicyConditions, PolicyEntityListing, PolicyErrorMessage, PolicyErrors, PresenceApi, Preview, PrimaryUserPresenceSource, Product, ProgressModel, Prompt, PromptAsset, PromptAssetEntityListing, PromptEntityListing, ProvisionInfo, Publication, PublishScriptRequestData, PublishedResult, PureCloud, PutManagementUnit, QualityApi, QualityAudit, QualityAuditPage, QueryFacetInfo, QueryRequest, QueryResult, QueryResults, QuestionGroup, QuestionGroupScore, QuestionScore, Queue, QueueEntityListing, QueueMember, QueueMemberEntityListing, QueueUtilizationDiagnostic, QueuesEntityListing, Quote, QuoteCharge, QuoteListing, Rate, Reaction, Recording, ReplaceRequest, ReplaceResponse, ReportMetaData, ReportMetaDataEntityListing, ReportRequest, ReportRunEntry, ReportRunEntryEntityDomainListing, ReportSchedule, ReportScheduleEntityListing, Reservation, ResourceConditionNode, ResourceConditionValue, ResourcePermissionPolicy, Response, ResponseEntityList, ResponseEntityListing, ResponseQueryRequest, ResponseQueryResults, ResponseSet, ResponseSetEntityListing, ResponseText, RestErrorDetail, RetentionDuration, Ring, RoutingApi, RoutingStatus, Rule, RuleEntityListing, RuleSet, RuleSetEntityListing, RunNowResponse, Salesforce, Schedule, ScheduleEntityListing, ScheduleGroup, ScheduleGroupEntityListing, SchemaCategory, SchemaCategoryEntityListing, SchemaReferenceEntityListing, Script, ScriptEntityListing, ScriptsApi, SearchApi, SearchRequest, SecurityProfile, SecurityProfileEntityListing, Segment, SequenceSchedule, ServerDate, Service, ServiceContext, ServiceEntityListing, ServiceLevel, ServiceType, Session, SessionEntityListing, SessionRequest, Share, ShareEntityListing, SharedResponse, SheetSchema, SheetTransform, SignatureDocumentInfo, Site, SiteEntityListing, Skill, SkillEntityListing, SkillsToRemove, SocialAccount, SocialExpression, SocializeEntityFilter, SocializeFilterRequest, SortBy, SortField, SortItem, SpreadsheetTransform, SpreadsheetTransformEntityListing, Station, StationEntityListing, StationsApi, SubDataItem, Support, SystemPrompt, SystemPromptAsset, SystemPromptAssetEntityListing, SystemPromptEntityListing, TableTransform, Tag, TagModel, TagQueryRequest, TagValue, TagValueEntityListing, TelephonyProvidersEdgeApi, Template, TemplateEntityListing, TermAttribute, TextTableTransform, TextTableTransformEntityListing, ThirdPartyAccount, ThirdPartySubscription, Tier, TimeAllowed, TimeInterval, TimeSlot, TimeZone, TimeZoneEntityListing, TokensApi, TopicEntityListing, Trace, TraceList, TransformEndpoint, TransformLens, TransformModel, TransformProgress, TrunkBase, TrunkBaseAssignment, TrunkMetabaseEntityListing, TwitterExpression, TwitterExpressionBuffer, UnpivotColumns, UnreadMetric, UploadProgress, UriReference, UrlResponse, User, UserActionCategory, UserActionCategoryEntityListing, UserActionMetadata, UserActionMetadataEntityListing, UserActionMetadataRequest, UserAuthorization, UserConversationSummary, UserEntityListing, UserImage, UserLicenseAssignment, UserParam, UserPresence, UserPresenceEntityListing, UserQueue, UserQueueEntityListing, UserRecording, UserRecordingEntityListing, UserRecordingsApi, UserSkill, UserSkillEntityListing, UserStationResource, UserStatus, UsersApi, UsersEntityListing, UtilitiesApi, Utilization, ValidateAddressRequest, ValidateAddressResponse, Value, Video, View, VoiceRate, VoiceRateExtended, VoiceRateInternational, VoiceRateInternationalEntityListing, VoiceRateUpdate, VoiceRatesCsv, VoiceXmlOperation, VoiceXmlOperationEntityListing, VoicemailApi, VoicemailMailboxInfo, VoicemailMediaInfo, VoicemailMessage, VoicemailMessageEntityListing, VoicemailOrganizationPolicy, VoicemailUserPolicy, Vpn, WorkItem, WorkItemActions, WorkItemCache, WorkItemCommand, WorkItemCommandGroup, WorkItemDefinition, WorkItemDetails, WorkItemSearchDetails, WorkItemSearchDetailsSearchResult, WorkItemSubmitRequest, WorkItemTransferRequest, Workspace, WorkspaceCreate, WorkspaceEntityListing, WorkspaceMember, WorkspaceMemberEntityListing, WorkspaceSummary, WrapUpCodeMapping, Wrapup, WrapupCode, WrapupCodeEntityListing, XlsxSchema

Constant Summary collapse

VERSION = 
"0.0.0"

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)



679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/purecloud.rb', line 679

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.



659
660
661
662
663
664
665
 
# File 'lib/purecloud.rb', line 659

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 



693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/purecloud.rb', line 693

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" => authCode,
    "redirect_uri" => redirect_uri
  }

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

  return tokenResponse['access_token'];
end