+
+<!DOCTYPE html> <html>
+
+<head>
+ <meta charset="utf-8">
+
+<meta name=“viewport” content=“width=device-width,
+initial-scale=1.0”> <title>
+
+Class: DropboxApi::Client
+
+ — Documentation by YARD 0.9.26
+
+</title>
+
+<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type=“text/javascript”>
+
+pathId = "DropboxApi::Client";
+relpath = '../';
+
+
+</script>
+
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+ <div class="nav_wrap">
+ <iframe id="nav" src="../class_list.html?1"></iframe>
+ <div id="resizer"></div>
+ </div>
+
+ <div id="main" tabindex="-1">
+ <div id="header">
+ <div id="menu">
+
+ <a href="../_index.html">Index (C)</a> »
+ <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+ »
+ <span class="title">Client</span>
+
+</div>
+
+ <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+ href="../class_list.html">
+
+ <svg width="24" height="24">
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+ </svg>
+</a>
+
+</div>
+
+ <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Client
+
+</h1> <div class=“box_info”>
+
+<dl>
+ <dt>Inherits:</dt>
+ <dd>
+ <span class="inheritName">Object</span>
+
+ <ul class="fullTree">
+ <li>Object</li>
+
+ <li class="next">DropboxApi::Client</li>
+
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+
+ </dd>
+</dl>
+
+<dl>
+ <dt>Defined in:</dt>
+ <dd>lib/dropbox_api/client.rb<span class="defines">,<br />
+lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb</span>
+
+</dd>
+
+</dl>
+
+</div>
+
+ <h2>
+ virtual
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#upload_by_chunks-instance_method" title="#upload_by_chunks (instance method)">#<strong>upload_by_chunks</strong>(path, content, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Creates a new file using the <em>upload session</em> endpoints.</p>
+
+</div></span>
+
+</li>
+
+ </ul>
+
+ <h2>
+ sharing
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#add_file_member-instance_method" title="#add_file_member (instance method)">#<strong>add_file_member</strong>(file, members, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Adds specified members to a file.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#add_folder_member-instance_method" title="#add_folder_member (instance method)">#<strong>add_folder_member</strong>(folder_id, members, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#create_shared_link_with_settings-instance_method" title="#create_shared_link_with_settings (instance method)">#<strong>create_shared_link_with_settings</strong>(path, settings = {}) ⇒ DropboxApi::Metadata::SharedLinkMetadata </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Create a shared link with custom settings.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_shared_link_metadata-instance_method" title="#get_shared_link_metadata (instance method)">#<strong>get_shared_link_metadata</strong>(preview_link, options = {}) ⇒ SharedFileMembers </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get the Metadata for a shared link.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#list_file_members-instance_method" title="#list_file_members (instance method)">#<strong>list_file_members</strong>(file_id, actions = [], options = {}) ⇒ SharedFileMembers </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Use to obtain the members who have been invited to a file, both inherited and uninherited members.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#list_folder_members-instance_method" title="#list_folder_members (instance method)">#<strong>list_folder_members</strong>(folder_id, actions = [], options = {}) ⇒ SharedFolderMembers </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Returns shared folder membership by its folder ID.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#list_shared_links-instance_method" title="#list_shared_links (instance method)">#<strong>list_shared_links</strong>(options = {}) ⇒ ListSharedLinksResult </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>List shared links of this user.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#revoke_shared_link-instance_method" title="#revoke_shared_link (instance method)">#<strong>revoke_shared_link</strong>(url) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Revoke a shared link.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#share_folder-instance_method" title="#share_folder (instance method)">#<strong>share_folder</strong>(path, options = {}) ⇒ DropboxApi::Results::ShareFolderLaunch </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Share a folder with collaborators.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#unshare_file-instance_method" title="#unshare_file (instance method)">#<strong>unshare_file</strong>(file) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Remove all members from this file.</p>
+
+</div></span>
+
+</li>
+
+ </ul>
+
+ <h2>
+ files
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#copy-instance_method" title="#copy (instance method)">#<strong>copy</strong>(from, to) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Copy a file or folder to a different location in the user's Dropbox.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#copy_batch-instance_method" title="#copy_batch (instance method)">#<strong>copy_batch</strong>(entries, options = {}) ⇒ String, Array </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Copy multiple files or folders to different locations at once in the user's Dropbox.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#copy_batch_check-instance_method" title="#copy_batch_check (instance method)">#<strong>copy_batch_check</strong>(async_job_id) ⇒ :in_progress, Array </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for <span class='object_link'><a href="#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#copy_reference_get-instance_method" title="#copy_reference_get (instance method)">#<strong>copy_reference_get</strong>(path) ⇒ DropboxApi::Results::GetCopyReferenceResult </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get a copy reference to a file or folder.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#copy_reference_save-instance_method" title="#copy_reference_save (instance method)">#<strong>copy_reference_save</strong>(copy_reference, path) ⇒ DropboxApi::Results::SaveCopyReferenceResult </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Save a copy reference returned by <span class='object_link'><a href="#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">#copy_reference_get</a></span> to the user's Dropbox.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#create_file_request-instance_method" title="#create_file_request (instance method)">#<strong>create_file_request</strong>(title, destination) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Create a file request for a given path.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#create_folder-instance_method" title="#create_folder (instance method)">#<strong>create_folder</strong>(path) ⇒ DropboxApi::Metadata::Folder </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Create a folder at a given path.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#create_folder_batch-instance_method" title="#create_folder_batch (instance method)">#<strong>create_folder_batch</strong>(paths, options = {}) ⇒ String, Array </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Create multiple folders at once.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#create_folder_batch_check-instance_method" title="#create_folder_batch_check (instance method)">#<strong>create_folder_batch_check</strong>(async_job_id) ⇒ Array </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for create_folder_batch.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Delete the file or folder at a given path.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#delete_batch-instance_method" title="#delete_batch (instance method)">#<strong>delete_batch</strong>(entries) ⇒ String, Array </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Delete multiple files/folders at once.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#delete_batch_check-instance_method" title="#delete_batch_check (instance method)">#<strong>delete_batch_check</strong>(async_job_id) ⇒ :in_progress, Array </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for delete_batch.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#download-instance_method" title="#download (instance method)">#<strong>download</strong>(path, &block) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Download a file from a user's Dropbox.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_metadata-instance_method" title="#get_metadata (instance method)">#<strong>get_metadata</strong>(path, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Returns the metadata for a file or folder.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_preview-instance_method" title="#get_preview (instance method)">#<strong>get_preview</strong>(path, &block) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get a preview for a file.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_temporary_link-instance_method" title="#get_temporary_link (instance method)">#<strong>get_temporary_link</strong>(path) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get a temporary link to stream content of a file.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_thumbnail-instance_method" title="#get_thumbnail (instance method)">#<strong>get_thumbnail</strong>(path, options = {}, &block) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get a thumbnail for an image.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_thumbnail_batch-instance_method" title="#get_thumbnail_batch (instance method)">#<strong>get_thumbnail_batch</strong>(paths, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get a thumbnails for a batch of images.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#list_folder-instance_method" title="#list_folder (instance method)">#<strong>list_folder</strong>(path, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Returns the contents of a folder.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#list_folder_continue-instance_method" title="#list_folder_continue (instance method)">#<strong>list_folder_continue</strong>(cursor) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Once a cursor has been retrieved from <code>list_folder</code>, use this to paginate through all files and retrieve updates to the folder.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#list_folder_get_latest_cursor-instance_method" title="#list_folder_get_latest_cursor (instance method)">#<strong>list_folder_get_latest_cursor</strong>(options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>A way to quickly get a cursor for the folder's state.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#list_folder_longpoll-instance_method" title="#list_folder_longpoll (instance method)">#<strong>list_folder_longpoll</strong>(cursor, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>A longpoll endpoint to wait for changes on an account.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#list_revisions-instance_method" title="#list_revisions (instance method)">#<strong>list_revisions</strong>(path, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Return revisions of a file.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#move-instance_method" title="#move (instance method)">#<strong>move</strong>(from, to, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Move a file or folder to a different location in the user's Dropbox.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#permanently_delete-instance_method" title="#permanently_delete (instance method)">#<strong>permanently_delete</strong>(path, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Permanently delete the file or folder at a given path.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#restore-instance_method" title="#restore (instance method)">#<strong>restore</strong>(path, rev) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Restore a file to a specific revision.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#save_url-instance_method" title="#save_url (instance method)">#<strong>save_url</strong>(path, url) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Save a specified URL into a file in user's Dropbox.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#save_url_check_job_status-instance_method" title="#save_url_check_job_status (instance method)">#<strong>save_url_check_job_status</strong>(job_id) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Check the status of a <code>save_url</code> job.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(query, options = nil, match_field_options = nil) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Searches for files and folders.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#search_continue-instance_method" title="#search_continue (instance method)">#<strong>search_continue</strong>(cursor) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>search:2.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#upload-instance_method" title="#upload (instance method)">#<strong>upload</strong>(path, content, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Creates a new file.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#upload_session_append_v2-instance_method" title="#upload_session_append_v2 (instance method)">#<strong>upload_session_append_v2</strong>(cursor, content, options = {}) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Append more data to an upload session.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#upload_session_finish-instance_method" title="#upload_session_finish (instance method)">#<strong>upload_session_finish</strong>(cursor, commit, content = nil) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Finish an upload session and save the uploaded data to the given file path.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#upload_session_start-instance_method" title="#upload_session_start (instance method)">#<strong>upload_session_start</strong>(content, options = {}) ⇒ DropboxApi::Metadata::UploadSessionCursor </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB.</p>
+
+</div></span>
+
+</li>
+
+ </ul>
+
+ <h2>
+ users
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_account-instance_method" title="#get_account (instance method)">#<strong>get_account</strong>(account_id) ⇒ BasicAccount </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get information about a user's account.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_account_batch-instance_method" title="#get_account_batch (instance method)">#<strong>get_account_batch</strong>(account_ids) ⇒ Array<BasicAccount> </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get information about multiple user accounts.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_current_account-instance_method" title="#get_current_account (instance method)">#<strong>get_current_account</strong> ⇒ BasicAccount </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get information about the current user's account.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#get_space_usage-instance_method" title="#get_space_usage (instance method)">#<strong>get_space_usage</strong> ⇒ SpaceUsage </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Get the space usage information for the current user's account.</p>
+
+</div></span>
+
+</li>
+
+ </ul>
+
+ <h2>
+ auth
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#token_revoke-instance_method" title="#token_revoke (instance method)">#<strong>token_revoke</strong> ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'><p>Revoke the access token for the current account.</p>
+
+</div></span>
+
+</li>
+
+ </ul>
+
+ <h2>
+ Instance Method Summary
+ <small><a href="#" class="summary_toggle">collapse</a></small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'], access_token: nil, on_token_refreshed: nil) ⇒ Client </a>
+
+</span>
+
+ <span class="note title constructor">constructor</span>
+
+ <span class="summary_desc"><div class='inline'><p>A new instance of Client.</p>
+
+</div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#middleware-instance_method" title="#middleware (instance method)">#<strong>middleware</strong> ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#namespace_id-instance_method" title="#namespace_id (instance method)">#<strong>namespace_id</strong> ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+ <li class="public ">
+<span class="summary_signature">
+
+ <a href="#namespace_id=-instance_method" title="#namespace_id= (instance method)">#<strong>namespace_id=</strong>(value) ⇒ Object </a>
+
+</span>
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+</ul>
+
+<div id=“constructor_details” class=“method_details_list”>
+
+<h2>Constructor Details</h2>
+
+ <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+ #<strong>initialize</strong>(oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'], access_token: nil, on_token_refreshed: nil) ⇒ <tt><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Returns a new instance of Client.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+</div> <table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/client.rb', line 4</span>
+
+<span class='kw'>def</span> <span class='id
+identifier rubyid_initialize'>initialize</span><span
+class='lparen'>(</span>
+
+<span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span> <span class='op'>=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DROPBOX_OAUTH_BEARER</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
+<span class='label'>access_token:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+<span class='label'>on_token_refreshed:</span> <span class='kw'>nil</span>
+
+<span class='rparen'>)</span>
+
+<span class='kw'>if</span> <span class='id identifier rubyid_access_token'>access_token</span>
+ <span class='ivar'>@connection_builder</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ConnectionBuilder.html" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ConnectionBuilder.html#initialize-instance_method" title="DropboxApi::ConnectionBuilder#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+ <span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span>
+ <span class='label'>on_token_refreshed:</span> <span class='id identifier rubyid_on_token_refreshed'>on_token_refreshed</span>
+ <span class='rparen'>)</span>
+<span class='kw'>elsif</span> <span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span>
+ <span class='ivar'>@connection_builder</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ConnectionBuilder.html" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ConnectionBuilder.html#initialize-instance_method" title="DropboxApi::ConnectionBuilder#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Either oauth_bearer or access_token should be set</span><span class='tstring_end'>"</span></span>
+<span class='kw'>end</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+</div>
+
+<div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
+
+ <div class="method_details first">
+<h3 class="signature first" id="add_file_member-instance_method">
+
+ #<strong>add_file_member</strong>(file, members, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Adds specified members to a file.</p>
+
+<p>The members parameter can be an Array or
+a single member element. Each element is represented by either a
+String or a <span class='object_link'><a
+href=“Metadata/Member.html” title=“DropboxApi::Metadata::Member
+(class)”>Metadata::Member</a></span> object. You can
+identify a member using his email or a Dropbox ID.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>file</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>File to which to add members. It can be a path or
+
+an ID such as id:3kmLmQFnf1AAAAAAAAAAAw.</p>
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>members</span>
+
+ <span class='type'></span>
+
+ —
+ <div class='inline'><p>Members to add. Note
+
+that even if an email address is given, this may result in a user being
+directy added to the membership if that email is the user's main
+account email.</p> </div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">quiet</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Whether added members should be notified
+
+via email and device notifications of their invite. The default for this
+field is false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">custom_message</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Message to send to added members
+
+in their invitation. This field is optional.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">access_level</span>
+ <span class="type">(<tt>AccessLevel</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>AccessLevel union object,
+
+describing what access level we want to give new members. The default for
+this is :viewer.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">add_message_as_comment</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Optional message to
+
+display to added members in their invitation. This field is
+optional.</p> </div>
+
+ </li>
+
+ </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+ <li><span class='object_link'><a href="Metadata/Member.html" title="DropboxApi::Metadata::Member (class)">Metadata::Member</a></span></li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ adds 1 member to a file
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10 11 12 13 14 15</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/bsd.pdf</span><span
+class='tstring_end'>'</span></span> <span
+class='id identifier rubyid_members'>members</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_add_file_member'>add_file_member</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>a@test.com</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_members'>members</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span><span class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_members'>members</span><span
+class='period'>.</span><span class='id identifier
+rubyid_first'>first</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/AddFileMemberResult.html" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span></span><span class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_members'>members</span><span
+class='period'>.</span><span class='id identifier
+rubyid_first'>first</span><span
+class='period'>.</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='symbol'>:viewer</span><span class='rparen'>)</span></pre>
+ </td>
+ </tr>
+ </table>
+ </li>
+
+ <li>
+ adds 2 members to a file
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+19 20 21 22 23 24 25 26 27</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/bsd.pdf</span><span
+class='tstring_end'>'</span></span> <span
+class='id identifier rubyid_members'>members</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_add_file_member'>add_file_member</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='comma'>,</span> <span
+class='qwords_beg'>%w(</span><span
+class='tstring_content'>a@test.com</span><span
+class='words_sep'> </span><span
+class='tstring_content'>b@test.com</span><span
+class='tstring_end'>)</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_members'>members</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span><span class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_members'>members</span><span
+class='period'>.</span><span class='id identifier
+rubyid_map'>map</span><span
+class='lparen'>(</span><span
+class='op'>&</span><span
+class='symbol'>:class</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_uniq'>uniq</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/AddFileMemberResult.html" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_members'>members</span><span
+class='period'>.</span><span class='id identifier
+rubyid_map'>map</span><span
+class='lparen'>(</span><span
+class='op'>&</span><span
+class='symbol'>:result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_uniq'>uniq</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:viewer</span><span class='rbracket'>]</span><span class='rparen'>)</span></pre>
+ </td>
+ </tr>
+ </table>
+ </li>
+
+ <li>
+ adds a member with comment
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+31 32 33 34 35 36 37</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/bsd.pdf</span><span
+class='tstring_end'>'</span></span> <span
+class='id identifier rubyid_members'>members</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_add_file_member'>add_file_member</span> <span
+class='id identifier rubyid_file'>file</span><span
+class='comma'>,</span>
+
+<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a@test.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
+<span class='label'>custom_message:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>See my file down here.</span><span class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_members'>members</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span><span class='rparen'>)</span></pre>
+ </td>
+ </tr>
+ </table>
+ </li>
+
+ <li>
+ adds a member with access level
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+41 42 43 44 45 46 47 48</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/bsd.pdf</span><span
+class='tstring_end'>'</span></span>
+
+<span class='comment'># Using :viewer_no_comment as access
+level will fail with no_permission. </span><span class='id
+identifier rubyid_expect'>expect</span> <span
+class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_add_file_member'>add_file_member</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span>
+ <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a@test.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
+ <span class='label'>access_level:</span> <span class='symbol'>:viewer_no_comment</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NoPermissionError.html”
+title=“DropboxApi::Errors::NoPermissionError
+(class)”>NoPermissionError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+34 35 36 37 38 39 40 41 42 43 44 45</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/add_file_member.rb', line 34</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:add_file_member</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_file'>file</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_members'>members</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='comma'>,</span> <span class='symbol'>:custom_message</span><span class='comma'>,</span> <span class='symbol'>:access_level</span><span class='comma'>,</span> <span class='symbol'>:add_message_as_comment</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:custom_message</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:access_level</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:viewer</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:add_message_as_comment</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>file:</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span>
+ <span class='label'>members:</span> <span class='id identifier rubyid_build_members_param'>build_members_param</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="add_folder_member-instance_method">
+
+ #<strong>add_folder_member</strong>(folder_id, members, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Allows an owner or editor (if the ACL update policy allows) of a shared
+
+folder to add another member.</p>
+
+<p>For the new member to get access to all the functionality for this
+folder, you will need to call mount_folder on their
+behalf.</p>
+
+<p>Apps must have full Dropbox access to use this endpoint.</p>
+
+<p>The members parameter can be an Array or
+a single member element. Each element is represented by either a
+String or a <span class='object_link'><a
+href=“Metadata/AddMember.html” title=“DropboxApi::Metadata::AddMember
+(class)”>Metadata::AddMember</a></span> object. This
+parameter can be just a string with an email.</p>
+
+<p>You can also build a <span class='object_link'><a
+href=“Metadata/AddMember.html” title=“DropboxApi::Metadata::AddMember
+(class)”>Metadata::AddMember</a></span> object and use it in
+the members parameter, this allows custom options for each
+member.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<div class="examples">
+ <p class="tag_title">Examples:</p>
+
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+
+<span class='id identifier
+rubyid_client'>client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_add_folder_member'>add_folder_member</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>1363389221</span><span
+class='tstring_end'>"</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>somebody@test.com</span><span
+class='tstring_end'>"</span></span></code></pre>
+
+</div>
+
+<p class=“tag_title”>Parameters:</p> <ul class=“param”>
+
+<li>
+
+ <span class='name'>folder_id</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The ID for the shared folder.</p>
+
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>members</span>
+
+ <span class='type'>(<tt>Array<AddMember,String></tt>)</span>
+
+ —
+ <div class='inline'><p>The intended list of members to
+
+add. Added members will receive invites to join the shared
+folder.</p> </div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">quiet</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Whether added members should be notified
+
+via email and device notifications of their invite. The default for this
+field is False.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">custom_message</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Optional message to display to
+
+added members in their invitation. This field is optional.</p>
+</div>
+
+ </li>
+
+ </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+ <li><span class='object_link'><a href="Metadata/AddMember.html" title="DropboxApi::Metadata::AddMember (class)">Metadata::AddMember</a></span></li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ shares the folder
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+
+<span class='id identifier
+rubyid_folder_id'>folder_id</span> <span
+class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>1236358158</span><span
+class='tstring_end'>'</span></span> <span
+class='id identifier rubyid_folder'>folder</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_add_folder_member'>add_folder_member</span> <span
+class='id identifier
+rubyid_folder_id'>folder_id</span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>somebody@test.com</span><span
+class='tstring_end'>'</span></span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ shares the folder, if the folder id is a number
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+
+<span class='id identifier
+rubyid_folder_id'>folder_id</span> <span
+class='op'>=</span> <span
+class='int'>1236358158</span> <span class='id
+identifier rubyid_folder'>folder</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_add_folder_member'>add_folder_member</span> <span
+class='id identifier
+rubyid_folder_id'>folder_id</span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>somebody@test.com</span><span
+class='tstring_end'>'</span></span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ shares the folder, if the param is an AddMember object
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+21 22</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+
+<span class='id identifier
+rubyid_folder_id'>folder_id</span> <span
+class='op'>=</span> <span
+class='int'>1236358158</span> <span class='id
+identifier rubyid_folder'>folder</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_add_folder_member'>add_folder_member</span> <span
+class='id identifier
+rubyid_folder_id'>folder_id</span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>somebody@test.com</span><span
+class='tstring_end'>'</span></span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ shares the folder, if the member param is an email string
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+28 29</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+
+<span class='id identifier
+rubyid_folder_id'>folder_id</span> <span
+class='op'>=</span> <span
+class='int'>1236358158</span> <span class='id
+identifier rubyid_folder'>folder</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_add_folder_member'>add_folder_member</span> <span
+class='id identifier
+rubyid_folder_id'>folder_id</span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>somebody@test.com</span><span
+class='tstring_end'>'</span></span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ fails with an invalid folder id
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+35 36 37 38 39</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+
+<span class='id identifier
+rubyid_folder_id'>folder_id</span> <span
+class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>xxx</span><span
+class='tstring_end'>'</span></span> <span
+class='id identifier rubyid_expect'>expect</span> <span
+class='lbrace'>{</span>
+
+<span class='id identifier rubyid_folder'>folder</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_add_folder_member'>add_folder_member</span> <span class='id identifier rubyid_folder_id'>folder_id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>somebody@test.com</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/InvalidIdError.html” title=“DropboxApi::Errors::InvalidIdError
+(class)”>InvalidIdError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+39 40 41 42 43 44 45 46 47 48</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/add_folder_member.rb', line 39</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:add_folder_member</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_folder_id'>folder_id</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_members'>members</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='comma'>,</span> <span class='symbol'>:custom_message</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:custom_message</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>shared_folder_id:</span> <span class='id identifier rubyid_folder_id'>folder_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
+ <span class='label'>members:</span> <span class='id identifier rubyid_build_members_param'>build_members_param</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="copy-instance_method">
+
+ #<strong>copy</strong>(from, to) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Copy a file or folder to a different location in the user's Dropbox.
+
+If the source path is a folder all its contents will be copied.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>from</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Path in the user's Dropbox to be copied or moved.</p>
+
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>to</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Path in the user's Dropbox that is the destination.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'></span>
+
+ <div class='inline'><p>The moved file.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the copied file on success
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_spec.rb', line 15</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy'>copy</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/a.jpg</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/b.jpg</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>b.jpg</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the file can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_spec.rb', line 15</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy'>copy</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/z.jpg</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/b.jpg</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the path is invalid
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+20 21 22</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_spec.rb', line 15</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy'>copy</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/../invalid_path.jpg</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/b.jpg</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/MalformedPathError.html”
+title=“DropboxApi::Errors::MalformedPathError
+(class)”>MalformedPathError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+15 16 17 18 19 20</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy.rb', line 15</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:copy</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_from'>from</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_to'>to</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>from_path:</span> <span class='id identifier rubyid_from'>from</span><span class='comma'>,</span>
+ <span class='label'>to_path:</span> <span class='id identifier rubyid_to'>to</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="copy_batch-instance_method">
+
+ #<strong>copy_batch</strong>(entries, options = {}) ⇒ <tt>String</tt>, <tt>Array</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Copy multiple files or folders to different locations at once in the
+
+user's Dropbox.</p>
+
+<p>This will either finish synchronously, or return a job ID and do
+the async copy job in background. Please use <span
+class='object_link'><a
+href=“#copy_batch_check-instance_method”
+title=“DropboxApi::Client#copy_batch_check
+(method)”>#copy_batch_check</a></span> to check the job
+status.</p>
+
+<p>Note: No errors are returned by this endpoint.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>entries</span>
+
+ <span class='type'>(<tt>Array<Hash></tt>)</span>
+
+ —
+ <div class='inline'><p>List of entries to be moved or copied.
+
+Each entry must be a hash with two keys: :from_path &
+:to_path.</p> </div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">autorename</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If there's a conflict with any file,
+
+have the Dropbox server try to autorename that file to avoid the conflict.
+The default for this field is false.</p> </div>
+
+ </li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+ —
+ <div class='inline'><p>Either the job id or the list of job statuses.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns an async job id
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+8 9 10 11 12 13 14</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_job_id'>job_id</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_batch'>copy_batch</span> <span
+class='lbracket'>[</span><span
+class='lbrace'>{</span>
+
+<span class='label'>from_path:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file.txt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
+<span class='label'>to_path:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_renamed.txt</span><span class='tstring_end'>"</span></span>
+
+<span class='rbrace'>}</span><span
+class='rbracket'>]</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_job_id'>job_id</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dbjid:AAA6b4uwc19nEau5k-OBI_h-hjrR7pNDaUA3_0hOwV-UZ2pkw_zXWp3FSuVZrQ0d9IXKGkwB5JdYI4mJZumLc6qZ</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></pre>
+ </td>
+ </tr>
+ </table>
+ </li>
+
+ <li>
+ if autorename option is true, returns an async job id
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+18 19 20 21 22 23 24</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_job_id'>job_id</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_batch'>copy_batch</span><span
+class='lparen'>(</span><span
+class='lbracket'>[</span><span
+class='lbrace'>{</span>
+
+<span class='label'>from_path:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2.txt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
+<span class='label'>to_path:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2_renamed.txt</span><span class='tstring_end'>"</span></span>
+
+<span class='rbrace'>}</span><span
+class='rbracket'>]</span><span
+class='comma'>,</span> <span
+class='label'>autorename:</span> <span
+class='kw'>true</span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_job_id'>job_id</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dbjid:AABe-bOUUq5nrybciMJxIxaGAD16nGCKByGyY3Z_2m6kshGW903XTikVT3_5V6JQQu20p3QxoCfws7_hT40deF6q</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></pre>
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+25 26 27 28 29 30 31 32 33 34</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 25</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:copy_batch</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_entries'>entries</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+ <span class='symbol'>:autorename</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>entries:</span> <span class='id identifier rubyid_entries'>entries</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="copy_batch_check-instance_method">
+
+ #<strong>copy_batch_check</strong>(async_job_id) ⇒ <tt>:in_progress</tt>, <tt>Array</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Returns the status of an asynchronous job for <span class='object_link'><a href="#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>. It
+
+returns a list of results for each entry.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>async_job_id</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Id of the asynchronous job.
+
+This is the value of a response returned from the method that launched the
+job.</p> </div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
+
+ —
+ <div class='inline'><p>This could be either the <code>:in_progress</code>
+
+flag or a list of job statuses.</p> </div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns all types of entries
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10 11</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_check_spec.rb', line 17</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_batch_check'>copy_batch_check</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsU</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns 'invalid_async_job_id' error
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_check_spec.rb', line 17</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch_check'>copy_batch_check</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsE</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/InvalidIdError.html” title=“DropboxApi::Errors::InvalidIdError
+(class)”>InvalidIdError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+17 18 19</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 17</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:copy_batch_check</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_async_job_id'>async_job_id</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="copy_reference_get-instance_method">
+
+ #<strong>copy_reference_get</strong>(path) ⇒ <tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get a copy reference to a file or folder.
+
+This reference string can be used to save that file or folder to another
+user's Dropbox by passing it to <span
+class='object_link'><a
+href=“#copy_reference_save-instance_method”
+title=“DropboxApi::Client#copy_reference_save
+(method)”>#copy_reference_save</a></span>.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path to the file or folder you want to get a
+
+copy reference to.</p> </div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>)</span>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a copy reference
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+8 9 10 11 12 13</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_reference_get'>copy_reference_get</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file.txt</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/GetCopyReferenceResult.html”
+title=“DropboxApi::Results::GetCopyReferenceResult
+(class)”>GetCopyReferenceResult</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_resource'>resource</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>file.txt</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_reference'>copy_reference</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>String</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_expires'>expires</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>Time</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns a copy reference
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+19 20 21 22 23 24</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_reference_get'>copy_reference_get</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/folder</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/GetCopyReferenceResult.html”
+title=“DropboxApi::Results::GetCopyReferenceResult
+(class)”>GetCopyReferenceResult</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_resource'>resource</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>folder</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_reference'>copy_reference</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>String</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_expires'>expires</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>Time</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+30 31 32</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_get'>copy_reference_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/c.jpg</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+16 17 18 19 20</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 16</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:copy_reference_get</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="copy_reference_save-instance_method">
+
+ #<strong>copy_reference_save</strong>(copy_reference, path) ⇒ <tt><span class='object_link'><a href="Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">DropboxApi::Results::SaveCopyReferenceResult</a></span></tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Save a copy reference returned by <span class='object_link'><a href="#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">#copy_reference_get</a></span> to the
+
+user's Dropbox.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>copy_reference</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>A copy reference returned by
+
+<span class='object_link'><a
+href=“#copy_reference_get-instance_method”
+title=“DropboxApi::Client#copy_reference_get
+(method)”>#copy_reference_get</a></span>.</p>
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Path in the user's Dropbox that is the destination.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt><span class='object_link'><a href="Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">DropboxApi::Results::SaveCopyReferenceResult</a></span></tt>)</span>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the saved file
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+10 11 12 13</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_reference_save'>copy_reference_save</span>
+<span class='ivar'>@copy_reference</span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/copied-file.txt</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/SaveCopyReferenceResult.html”
+title=“DropboxApi::Results::SaveCopyReferenceResult
+(class)”>SaveCopyReferenceResult</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_resource'>resource</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>copied-file.txt</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns the saved folder
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+19 20 21 22 23</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+
+<span class='id identifier
+rubyid_copy_reference'>copy_reference</span> <span
+class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>WI-v42h5NWxnbDZ2enpjbw</span><span
+class='tstring_end'>'</span></span> <span
+class='id identifier rubyid_result'>result</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_copy_reference_save'>copy_reference_save</span>
+<span class='id identifier
+rubyid_copy_reference'>copy_reference</span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/copied-folder</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/SaveCopyReferenceResult.html”
+title=“DropboxApi::Results::SaveCopyReferenceResult
+(class)”>SaveCopyReferenceResult</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_resource'>resource</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>copied-folder</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+30 31 32</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='ivar'>@copy_reference</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/copied-file.txt</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/FileConflictError.html”
+title=“DropboxApi::Errors::FileConflictError
+(class)”>FileConflictError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+38 39 40</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>invalid-reference</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/copied-file.txt</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/InvalidCopyReferenceError.html”
+title=“DropboxApi::Errors::InvalidCopyReferenceError
+(class)”>InvalidCopyReferenceError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+46 47 48</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='ivar'>@copy_reference</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>//copied-file.txt</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/MalformedPathError.html”
+title=“DropboxApi::Errors::MalformedPathError
+(class)”>MalformedPathError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+54 55 56</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='ivar'>@copy_reference</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/copied-file.txt</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NoPermissionError.html”
+title=“DropboxApi::Errors::NoPermissionError
+(class)”>NoPermissionError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+62 63 64</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='ivar'>@copy_reference</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/copied-file.txt</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+16 17 18 19 20 21</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_save.rb', line 16</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:copy_reference_save</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_copy_reference'>copy_reference</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_path'>path</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>copy_reference:</span> <span class='id identifier rubyid_copy_reference'>copy_reference</span><span class='comma'>,</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="create_file_request-instance_method">
+
+ #<strong>create_file_request</strong>(title, destination) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Create a file request for a given path.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>title</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The title of the file request. Must not be empty.</p>
+
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>destination</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path of the folder in the Dropbox where
+
+uploaded files will be sent. For apps with the app folder permission, this
+will be relative to the app folder.</p> </div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the new file request on success
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+8 9 10 11</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/file_requests/create_file_request_spec.rb', line 15</span>
+
+<span class='id identifier
+rubyid_file_request'>file_request</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_file_request'>create_file_request</span>
+<span class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>Arizona, baby</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/arizona_baby</span><span
+class='tstring_end'>"</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file_request'>file_request</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FileRequest.html” title=“DropboxApi::Metadata::FileRequest
+(class)”>FileRequest</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file_request'>file_request</span><span
+class='period'>.</span><span class='id identifier
+rubyid_title'>title</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>Arizona, baby</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises something if wrong path
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/file_requests/create_file_request_spec.rb', line 15</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_file_request'>create_file_request</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Arizona, baby</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file.txt</span><span class='tstring_end'>"</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/CreateFileRequestError.html”
+title=“DropboxApi::Errors::CreateFileRequestError
+(class)”>CreateFileRequestError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+15 16 17 18 19 20</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/file_requests/create_file_request.rb', line 15</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:create_file_request</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_title'>title</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_destination'>destination</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>title:</span> <span class='id identifier rubyid_title'>title</span><span class='comma'>,</span>
+ <span class='label'>destination:</span> <span class='id identifier rubyid_destination'>destination</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="create_folder-instance_method">
+
+ #<strong>create_folder</strong>(path) ⇒ <tt><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">DropboxApi::Metadata::Folder</a></span></tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Create a folder at a given path.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Path in the user's Dropbox to create.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">DropboxApi::Metadata::Folder</a></span></tt>)</span>
+
+ —
+ <div class='inline'><p>The new folder.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the new folder on success
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_spec.rb', line 13</span>
+
+<span class='id identifier rubyid_folder'>folder</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_folder'>create_folder</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/arizona_baby</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_folder'>folder</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_folder'>folder</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>arizona_baby</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the name is invalid
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_spec.rb', line 13</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder'>create_folder</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/arizona\\baby</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/MalformedPathError.html”
+title=“DropboxApi::Errors::MalformedPathError
+(class)”>MalformedPathError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the resource causes a conflict
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+20 21 22</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_spec.rb', line 13</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder'>create_folder</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/b.jpg</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/FileConflictError.html”
+title=“DropboxApi::Errors::FileConflictError
+(class)”>FileConflictError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+13 14 15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder.rb', line 13</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:create_folder</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="create_folder_batch-instance_method">
+
+ #<strong>create_folder_batch</strong>(paths, options = {}) ⇒ <tt>String</tt>, <tt>Array</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Create multiple folders at once.</p>
+
+<p>This route is asynchronous for large batches, which returns a job
+ID immediately and runs the create folder batch asynchronously. Otherwise,
+creates the folders and returns the result synchronously for smaller
+inputs. You can force asynchronous behaviour by using the
+:force_async flag. Use <span
+class='object_link'><a
+href=“#create_folder_batch_check-instance_method”
+title=“DropboxApi::Client#create_folder_batch_check
+(method)”>#create_folder_batch_check</a></span> to check the
+job status.</p>
+
+<p>Note: No errors are returned by this endpoint.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>paths</span>
+
+ <span class='type'>(<tt>Array</tt>)</span>
+
+ —
+ <div class='inline'><p>List of paths to be created in the user's Dropbox.
+
+Duplicate path arguments in the batch are considered only once.</p>
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">autorename</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If there's a conflict, have the
+
+Dropbox server try to autorename the folder to avoid the conflict. The
+default for this field is false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">force_async</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Whether to force the create to
+
+happen asynchronously. The default for this field is
+false.</p> </div>
+
+ </li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+ —
+ <div class='inline'><p>Either the job id or the list of job statuses.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the created folders synchronously
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_folder_batch'>create_folder_batch</span>
+<span class='lbracket'>[</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/Create Batch</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/Create Batch 1</span><span
+class='tstring_end'>'</span></span><span
+class='rbracket'>]</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_first'>first</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_last'>last</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns async_job_id when large entries are passed
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16 17 18 19</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+
+<span class='id identifier rubyid_paths'>paths</span>
+<span class='op'>=</span> <span
+class='lbracket'>[</span><span
+class='rbracket'>]</span> <span
+class='int'>100</span><span
+class='period'>.</span><span class='id identifier
+rubyid_times'>times</span> <span
+class='lbrace'>{</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_i'>i</span><span
+class='op'>|</span> <span class='id identifier
+rubyid_paths'>paths</span> <span
+class='op'><<</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>/Folder </span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_i'>i</span><span
+class='embexpr_end'>}</span><span
+class='tstring_end'>"</span></span><span
+class='rbrace'>}</span>
+
+<span class='id identifier
+rubyid_async_result'>async_result</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_folder_batch'>create_folder_batch</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_paths'>paths</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>Hash</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_have_key'>have_key</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>async_job_id</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns async_job_id when force_async is true
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+23 24 25 26</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+
+<span class='id identifier
+rubyid_async_result'>async_result</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_folder_batch'>create_folder_batch</span><span
+class='lparen'>(</span><span
+class='lbracket'>[</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/Create Batch 2</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/Create Batch 3</span><span
+class='tstring_end'>'</span></span><span
+class='rbracket'>]</span><span
+class='comma'>,</span> <span
+class='lbrace'>{</span> <span
+class='label'>force_async:</span> <span
+class='kw'>true</span> <span
+class='rbrace'>}</span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>Hash</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_have_key'>have_key</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>async_job_id</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ when autorename is true, does not return error for repeated entries
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+30 31 32</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_folder_batch'>create_folder_batch</span><span
+class='lparen'>(</span><span
+class='lbracket'>[</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/Create Batch 1</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/Create Batch 1</span><span
+class='tstring_end'>'</span></span><span
+class='rbracket'>]</span><span
+class='comma'>,</span> <span
+class='lbrace'>{</span> <span
+class='label'>autorename:</span> <span
+class='kw'>true</span> <span
+class='rbrace'>}</span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_not_to'>not_to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/FolderConflictError.html”
+title=“DropboxApi::Errors::FolderConflictError
+(class)”>FolderConflictError</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises error, when invalid option is passed
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+36 37 38</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/Create Batch 4</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/Create Batch 5</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>async:</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'>ArgumentError</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+28 29 30 31 32 33 34 35 36 37 38 39</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 28</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:create_folder_batch</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_paths'>paths</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+ <span class='symbol'>:autorename</span><span class='comma'>,</span>
+ <span class='symbol'>:force_async</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_async</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>paths:</span> <span class='id identifier rubyid_paths'>paths</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="create_folder_batch_check-instance_method">
+
+ #<strong>create_folder_batch_check</strong>(async_job_id) ⇒ <tt>Array</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Returns the status of an asynchronous job for create_folder_batch.
+
+If success, it returns list of result for each entry.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>async_job_id</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Id of the asynchronous job.
+
+This is the value of a response returned from the method that launched the
+job.</p> </div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>Array</tt>)</span>
+
+ —
+ <div class='inline'><p>A list of one result for each entry.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns mixed results with failure and success status for each entry
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10 11</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 16</span>
+
+<span class='id identifier
+rubyid_async_result'>async_result</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_folder_batch_check'>create_folder_batch_check</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQE</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/MalformedPathError.html”
+title=“DropboxApi::Errors::MalformedPathError
+(class)”>MalformedPathError</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/FolderConflictError.html”
+title=“DropboxApi::Errors::FolderConflictError
+(class)”>FolderConflictError</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error with an invalid async job id
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch_check'>create_folder_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/InvalidIdError.html” title=“DropboxApi::Errors::InvalidIdError
+(class)”>InvalidIdError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+16 17 18 19 20</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 16</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:create_folder_batch_check</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_async_job_id'>async_job_id</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="create_shared_link_with_settings-instance_method">
+
+ #<strong>create_shared_link_with_settings</strong>(path, settings = {}) ⇒ <tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Create a shared link with custom settings. If no settings are given then
+
+the default visibility is :public. (The resolved visibility, though, may
+depend on other aspects such as team and shared folder settings).</p>
+
+<p>NOTE: The settings parameter will only work for pro,
+business or enterprise accounts. It will return no permission error
+otherwise.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path to be shared by the shared link.</p>
+
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>settings</span>
+
+ <span class='type'>(<tt>SharedLinkSettings</tt>)</span>
+
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
+
+ —
+ <div class='inline'><p>The requested settings for the newly
+
+created shared link This field is optional.</p> </div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>settings</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">requested_visibility</span>
+ <span class="type">(<tt>Object</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The requested access for this
+
+shared link. This field is optional. Must be one of
+"public", "team_only" or
+"password".</p> </div>
+
+</li>
+
+<li>
+ <span class="name">link_password</span>
+ <span class="type">(<tt>Object</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If requested_visibility is
+
+"password" this is needed to specify the password to
+access the link. This field is optional.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">expires</span>
+ <span class="type">(<tt>Object</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Expiration time of the shared link. By default
+
+the link won't expire. This field is optional.</p>
+</div>
+
+ </li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>)</span>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ creates a shared link for basic and pro users
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+
+<span class='id identifier rubyid_link'>link</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span>
+<span class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file_for_sharing.docx</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_link'>link</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FileLinkMetadata.html”
+title=“DropboxApi::Metadata::FileLinkMetadata
+(class)”>FileLinkMetadata</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ creates a shared link with settings for pro users
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+
+<span class='id identifier rubyid_link'>link</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file_for_sharing.docx</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='lbrace'>{</span> <span
+class='label'>expires:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>2019-03-12T10:34:42Z</span><span
+class='tstring_end'>'</span></span> <span
+class='rbrace'>}</span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_link'>link</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FileLinkMetadata.html”
+title=“DropboxApi::Metadata::FileLinkMetadata
+(class)”>FileLinkMetadata</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if settings options are passed for basic users
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+20 21 22</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/file_for_sharing.docx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>expires:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>2019-03-12T10:34:42Z</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NoPermissionError.html”
+title=“DropboxApi::Errors::NoPermissionError
+(class)”>NoPermissionError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if already shared for basic and pro users
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+26 27 28</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/file_for_sharing.docx</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/SharedLinkAlreadyExistsError.html”
+title=“DropboxApi::Errors::SharedLinkAlreadyExistsError
+(class)”>SharedLinkAlreadyExistsError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ creates a shared link for basic and pro users
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+34 35 36</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+
+<span class='id identifier rubyid_link'>link</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span>
+<span class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/folder_for_sharing</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_link'>link</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FolderLinkMetadata.html”
+title=“DropboxApi::Metadata::FolderLinkMetadata
+(class)”>FolderLinkMetadata</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ creates a shared link with settings for pro users
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+40 41 42</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+
+<span class='id identifier rubyid_link'>link</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/folder_for_sharing</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='lbrace'>{</span> <span
+class='label'>expires:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>2019-03-12T10:34:42Z</span><span
+class='tstring_end'>'</span></span> <span
+class='rbrace'>}</span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_link'>link</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FolderLinkMetadata.html”
+title=“DropboxApi::Metadata::FolderLinkMetadata
+(class)”>FolderLinkMetadata</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if settings options are passed for basic user
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+46 47 48</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/folder_for_sharing</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>expires:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>2019-03-12T10:34:42Z</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NoPermissionError.html”
+title=“DropboxApi::Errors::NoPermissionError
+(class)”>NoPermissionError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+32 33 34 35 36 37 38 39 40 41 42 43 44 45 46</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 32</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:create_shared_link_with_settings</span>
+<span class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_settings'>settings</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+ <span class='symbol'>:requested_visibility</span><span class='comma'>,</span>
+ <span class='symbol'>:link_password</span><span class='comma'>,</span>
+ <span class='symbol'>:expires</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:requested_visibility</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>public</span><span class='tstring_end'>'</span></span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:link_password</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:expires</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+ <span class='label'>settings:</span> <span class='id identifier rubyid_settings'>settings</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="delete-instance_method">
+
+ #<strong>delete</strong>(path, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Delete the file or folder at a given path.</p>
+
+<p>If the path is a folder, all its contents will be deleted
+too.</p>
+
+<p>A successful response indicates that the file or folder was
+deleted. The returned metadata will be the corresponding <span
+class='object_link'><a href=“Metadata/File.html”
+title=“DropboxApi::Metadata::File
+(class)”>Metadata::File</a></span> or <span
+class='object_link'><a href=“Metadata/Folder.html”
+title=“DropboxApi::Metadata::Folder
+(class)”>Metadata::Folder</a></span> for the item at time of
+deletion, and not a <span class='object_link'><a
+href=“Metadata/Deleted.html” title=“DropboxApi::Metadata::Deleted
+(class)”>Metadata::Deleted</a></span> object.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Path in the user's Dropbox to delete.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">parent_rev</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Perform delete if given "rev"
+
+matches the existing file's latest "rev". This
+field does not support deleting a folder. If the given
+"rev" doesn't match, a <span
+class='object_link'><a href=“Errors/FileConflictError.html”
+title=“DropboxApi::Errors::FileConflictError
+(class)”>Errors::FileConflictError</a></span> will be
+raised.</p> </div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the deleted file
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+8 9 10 11</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_delete'>delete</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/will_be_deleted.txt</span><span
+class='tstring_end'>"</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>will_be_deleted.txt</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ won't delete the file if `parent_rev` doesn't match
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/wont_be_deleted.txt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>parent_rev:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1c0576c68d6</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/FileConflictError.html”
+title=“DropboxApi::Errors::FileConflictError
+(class)”>FileConflictError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns the deleted folder
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+21 22 23 24</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_folder'>folder</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_delete'>delete</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/folder</span><span
+class='tstring_end'>"</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_folder'>folder</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_folder'>folder</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>folder</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the name is invalid
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+28 29 30</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/unexisting folder</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+25 26 27 28 29 30 31</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete.rb', line 25</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:delete</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:parent_rev</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="delete_batch-instance_method">
+
+ #<strong>delete_batch</strong>(entries) ⇒ <tt>String</tt>, <tt>Array</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Delete multiple files/folders at once.</p>
+
+<p>This route is asynchronous, which returns a job ID immediately and
+runs the delete batch asynchronously. Use <span
+class='object_link'><a
+href=“#delete_batch_check-instance_method”
+title=“DropboxApi::Client#delete_batch_check
+(method)”>#delete_batch_check</a></span> to check the job
+status.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>entries</span>
+
+ <span class='type'>(<tt>Array</tt>)</span>
+
+ —
+ <div class='inline'><p>List of entries, each entry is a Hash with these
+
+fields: path (mandatory) & parent_rev
+(optional).</p> </div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+ —
+ <div class='inline'><p>Either the job id or the list of job statuses.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns async_job_id for multiple entries
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+9 10 11 12 13</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_spec.rb', line 17</span>
+
+<span class='id identifier
+rubyid_entries'>entries</span> <span
+class='op'>=</span> <span
+class='lbracket'>[</span><span
+class='lbrace'>{</span> <span
+class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/folder_to_delete_1</span><span
+class='tstring_end'>'</span></span> <span
+class='rbrace'>}</span><span
+class='comma'>,</span> <span
+class='lbrace'>{</span> <span
+class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/folder_to_delete_2</span><span
+class='tstring_end'>'</span></span> <span
+class='rbrace'>}</span><span
+class='rbracket'>]</span> <span class='id
+identifier rubyid_async_result'>async_result</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_delete_batch'>delete_batch</span> <span
+class='id identifier rubyid_entries'>entries</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>Hash</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_have_key'>have_key</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>async_job_id</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns async_job_id for single entry too
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+17 18 19 20 21</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_spec.rb', line 17</span>
+
+<span class='id identifier
+rubyid_entries'>entries</span> <span
+class='op'>=</span> <span
+class='lbracket'>[</span><span
+class='lbrace'>{</span> <span
+class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/folder_to_delete/file_to_delete.docx</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='label'>parent_rev:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>1c0576c68d6</span><span
+class='tstring_end'>'</span></span> <span
+class='rbrace'>}</span><span
+class='rbracket'>]</span> <span class='id
+identifier rubyid_async_result'>async_result</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_delete_batch'>delete_batch</span> <span
+class='id identifier rubyid_entries'>entries</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>Hash</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_have_key'>have_key</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>async_job_id</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+17 18 19 20 21</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 17</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:delete_batch</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_entries'>entries</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>entries:</span> <span class='id identifier rubyid_entries'>entries</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="delete_batch_check-instance_method">
+
+ #<strong>delete_batch_check</strong>(async_job_id) ⇒ <tt>:in_progress</tt>, <tt>Array</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Returns the status of an asynchronous job for delete_batch. If success,
+
+it returns list of result for each entry.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>async_job_id</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Id of the asynchronous job.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
+
+ —
+ <div class='inline'><p>This could be either the <code>:in_progress</code>
+
+flag or a list of job statuses.</p> </div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns mixed results when complete
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10 11 12</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_check_spec.rb', line 15</span>
+
+<span class='id identifier
+rubyid_async_result'>async_result</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_delete_batch_check'>delete_batch_check</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>dbjid:AAC2JUPMEtK-kEg7QVrNEemnX-FfQkJ_0r_tJJ2UpHhwvrUGrpw19CH4U5cfZKWPLxLVJoKgffTOy_zSKk6W953h</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/FileConflictError.html”
+title=“DropboxApi::Errors::FileConflictError
+(class)”>FileConflictError</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_async_result'>async_result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_a_kind_of'>a_kind_of</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error with an invalid async job id
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+16 17 18</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_check_spec.rb', line 15</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch_check'>delete_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/InvalidIdError.html” title=“DropboxApi::Errors::InvalidIdError
+(class)”>InvalidIdError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+15 16 17 18 19</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 15</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:delete_batch_check</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_async_job_id'>async_job_id</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="download-instance_method">
+
+ #<strong>download</strong>(path, &block) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Download a file from a user's Dropbox.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path of the file to download.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the file
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/download_spec.rb', line 12</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_download'>download</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file.txt</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>file.txt</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ yields the file contents
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16 17 18 19</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/download_spec.rb', line 12</span>
+
+<span class='id identifier
+rubyid_file_contents'>file_contents</span> <span
+class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_end'>'</span></span> <span
+class='id identifier rubyid_file'>file</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_download'>download</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file.txt</span><span
+class='tstring_end'>'</span></span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_chunk'>chunk</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_file_contents'>file_contents</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_file_contents'>file_contents</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_chunk'>chunk</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
+
+<span class='kw'>end</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file_contents'>file_contents</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>Hola Leo!n</span><span
+class='tstring_end'>"</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the name is invalid
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+23 24 25</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/download_spec.rb', line 12</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_download'>download</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/c.jpg</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+12 13 14</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/download.rb', line 12</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:download</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='comma'>,</span> <span
+class='op'>&</span><span class='id
+identifier rubyid_block'>block</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_account-instance_method">
+
+ #<strong>get_account</strong>(account_id) ⇒ <tt>BasicAccount</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get information about a user's account.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>account_id</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>A user's account identifier.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>BasicAccount</tt>)</span>
+
+ —
+ <div class='inline'><p>Basic information about any account.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the account information
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_spec.rb', line 13</span>
+
+<span class='id identifier
+rubyid_account'>account</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_account'>get_account</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_account'>account</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/BasicAccount.html” title=“DropboxApi::Metadata::BasicAccount
+(class)”>BasicAccount</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the account can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+13 14 15</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_spec.rb', line 13</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_account'>get_account</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NoAccountError.html” title=“DropboxApi::Errors::NoAccountError
+(class)”>NoAccountError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+13 14 15</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_account.rb', line 13</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_account</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_account_id'>account_id</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>account_id:</span> <span class='id identifier rubyid_account_id'>account_id</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_account_batch-instance_method">
+
+ #<strong>get_account_batch</strong>(account_ids) ⇒ <tt>Array<BasicAccount></tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get information about multiple user accounts. At most 300 accounts may
+
+be queried per request.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>account_ids</span>
+
+ <span class='type'>(<tt>Array<String></tt>)</span>
+
+ —
+ <div class='inline'><p>List of user account identifiers. Should not
+
+contain any duplicate account IDs.</p> </div>
+
+</li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>Array<BasicAccount></tt>)</span>
+
+ —
+ <div class='inline'><p>Basic information about any account.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns account information of all given IDs
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10 11 12 13 14 15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_batch_spec.rb', line 15</span>
+
+<span class='id identifier
+rubyid_test_accounts'>test_accounts</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span>
+
+<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dbid:AACiYqkuK0t_wIvlr9BduHKdhzk_H28Dg0U</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Antonio Hidalgo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Jesus Burgos</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span> <span class='id
+identifier rubyid_accounts'>accounts</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_account_batch'>get_account_batch</span> <span
+class='id identifier
+rubyid_test_accounts'>test_accounts</span><span
+class='period'>.</span><span class='id identifier
+rubyid_keys'>keys</span>
+
+<span class='id identifier
+rubyid_accounts'>accounts</span><span
+class='period'>.</span><span class='id identifier
+rubyid_each'>each</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_account'>account</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_account'>account</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/BasicAccount.html" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_account'>account</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_display_name'>display_name</span><span class='rparen'>)</span>
+ <span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='id identifier rubyid_test_accounts'>test_accounts</span><span class='lbracket'>[</span><span class='id identifier rubyid_account'>account</span><span class='period'>.</span><span class='id identifier rubyid_account_id'>account_id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if one account cannot be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+21 22 23 24 25 26 27 28</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_batch_spec.rb', line 15</span>
+
+<span class='id identifier
+rubyid_account_ids'>account_ids</span> <span
+class='op'>=</span> <span
+class='qwords_beg'>%w(</span><span
+class='words_sep'>
+
+</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX</span><span class='words_sep'>
+</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span class='words_sep'>
+
+</span><span
+class='tstring_end'>)</span></span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_account_batch'>get_account_batch</span> <span class='id identifier rubyid_account_ids'>account_ids</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NoAccountError.html” title=“DropboxApi::Errors::NoAccountError
+(class)”>NoAccountError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_account_batch.rb', line 15</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_account_batch</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_account_ids'>account_ids</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>account_ids:</span> <span class='id identifier rubyid_account_ids'>account_ids</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_current_account-instance_method">
+
+ #<strong>get_current_account</strong> ⇒ <tt>BasicAccount</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get information about the current user's account.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>BasicAccount</tt>)</span>
+
+ —
+ <div class='inline'><p>Detailed information about the current user's account.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the account usage information
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_space_usage_spec.rb', line 12</span>
+
+<span class='id identifier
+rubyid_space_usage'>space_usage</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_space_usage'>get_space_usage</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_space_usage'>space_usage</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/SpaceUsage.html” title=“DropboxApi::Metadata::SpaceUsage
+(class)”>SpaceUsage</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns the current account information
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_current_account_spec.rb', line 12</span>
+
+<span class='id identifier
+rubyid_account'>account</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_current_account'>get_current_account</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_account'>account</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/BasicAccount.html” title=“DropboxApi::Metadata::BasicAccount
+(class)”>BasicAccount</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_account'>account</span><span
+class='period'>.</span><span class='id identifier
+rubyid_root_info'>root_info</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/UserRootInfo.html” title=“DropboxApi::Metadata::UserRootInfo
+(class)”>UserRootInfo</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+12 13 14</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_current_account.rb', line 12</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_current_account</span> <span
+class='kw'>do</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='kw'>nil</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_metadata-instance_method">
+
+ #<strong>get_metadata</strong>(path, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Returns the metadata for a file or folder.</p>
+
+<p>Note: Metadata for the root folder is unsupported.</p>
+
+<p>If you request the media_info attribute, note that it
+could be set to :pending or nil.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path of a file or folder on Dropbox.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">include_media_info</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>, <code>media_info</code>
+
+is set for photo and video. The default for this field is
+false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">include_has_explicit_shared_members</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>,
+
+the results will include a flag for each file indicating whether or not
+that file has any explicit members. The default for this field is
+false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">include_deleted</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>,
+
+<span class='object_link'><a href=“Metadata/Deleted.html”
+title=“DropboxApi::Metadata::Deleted
+(class)”>Metadata::Deleted</a></span> will be returned for
+deleted file or folder, otherwise <span
+class='object_link'><a href=“Errors/NotFoundError.html”
+title=“DropboxApi::Errors::NotFoundError
+(class)”>Errors::NotFoundError</a></span> will be raised.
+The default for this field is false.</p> </div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ may return a `File`
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+8 9 10 11</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_metadata'>get_metadata</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/file.txt</span><span
+class='tstring_end'>"</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>file.txt</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ will parse time specific fields
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_metadata'>get_metadata</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/file.txt</span><span
+class='tstring_end'>"</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_client_modified'>client_modified</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='const'>Time</span><span
+class='period'>.</span><span class='id identifier
+rubyid_new'>new</span><span
+class='lparen'>(</span><span
+class='int'>1988</span><span
+class='comma'>,</span> <span
+class='int'>12</span><span
+class='comma'>,</span> <span
+class='int'>8</span><span
+class='comma'>,</span> <span
+class='int'>1</span><span
+class='comma'>,</span> <span
+class='int'>1</span><span
+class='comma'>,</span> <span
+class='int'>0</span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>+00:00</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ may return a `Folder`
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+21 22 23 24</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_folder'>folder</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_metadata'>get_metadata</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/folder</span><span
+class='tstring_end'>"</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_folder'>folder</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_folder'>folder</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>folder</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the path is wrong
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+28 29 30</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_metadata'>get_metadata</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/unexisting_folder</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if an invalid option is given
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+34 35 36</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_metadata'>get_metadata</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/file.txt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>invalid_option:</span> <span class='kw'>true</span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span> <span
+class='const'>ArgumentError</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+41 42 43</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_metadata'>get_metadata</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/deleted_file.txt</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ with `:include_deleted`, returns a `File`
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+47 48 49 50</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_metadata'>get_metadata</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/deleted_file.txt</span><span
+class='tstring_end'>"</span></span><span
+class='comma'>,</span> <span
+class='label'>include_deleted:</span> <span
+class='kw'>true</span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Deleted.html” title=“DropboxApi::Metadata::Deleted
+(class)”>Deleted</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>deleted_file.txt</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+30 31 32 33 34 35 36 37 38 39 40</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_metadata.rb', line 30</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_metadata</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+ <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+ <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+ <span class='symbol'>:include_has_explicit_shared_members</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_preview-instance_method">
+
+ #<strong>get_preview</strong>(path, &block) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get a preview for a file. Currently previews are only generated for the
+
+files with the following extensions: .doc, .docx, .docm, .ppt, .pps, .ppsx,
+.ppsm, .pptx, .pptm, .xls, .xlsx, .xlsm, .rtf</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path of the file to preview.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the file
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_preview_spec.rb', line 14</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_preview'>get_preview</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file.docx</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>file.docx</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the name is invalid
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_preview_spec.rb', line 14</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_preview'>get_preview</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/unknown_file.jpg</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_preview.rb', line 14</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_preview</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='comma'>,</span> <span
+class='op'>&</span><span class='id
+identifier rubyid_block'>block</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_shared_link_metadata-instance_method">
+
+ #<strong>get_shared_link_metadata</strong>(preview_link, options = {}) ⇒ <tt>SharedFileMembers</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get the Metadata for a shared link</p>
+
+<p>If a preview url is given, returns the shared file or folder that
+is represent by that link.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">path</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If the shared link is to a folder,
+
+this parameter can be used to retrieve the metadata for a specific file or
+sub-folder in this folder. A relative path should be used.</p>
+</div>
+
+</li>
+
+<li>
+ <span class="name">link_password</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If the shared link has
+
+a password, this parameter can be used.</p> </div>
+
+ </li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>SharedFileMembers</tt>)</span>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ works with a file
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+11 12 13 14 15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23</span>
+
+<span class='id identifier
+rubyid_shared_link'>shared_link</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_file.txt</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
+<span class='period'>.</span><span class='id identifier rubyid_links'>links</span>
+<span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_shared_link_metadata'>get_shared_link_metadata</span>
+<span class='id identifier
+rubyid_shared_link'>shared_link</span><span
+class='period'>.</span><span class='id identifier
+rubyid_url'>url</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FileLinkMetadata.html”
+title=“DropboxApi::Metadata::FileLinkMetadata
+(class)”>FileLinkMetadata</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ works with a folder
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+21 22 23 24 25 26 27</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23</span>
+
+<span class='id identifier
+rubyid_shared_link'>shared_link</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
+<span class='period'>.</span><span class='id identifier rubyid_links'>links</span>
+<span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_shared_link_metadata'>get_shared_link_metadata</span>
+<span class='id identifier
+rubyid_shared_link'>shared_link</span><span
+class='period'>.</span><span class='id identifier
+rubyid_url'>url</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FolderLinkMetadata.html”
+title=“DropboxApi::Metadata::FolderLinkMetadata
+(class)”>FolderLinkMetadata</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the link can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+31 32 33 34 35</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23</span>
+
+<span class='id identifier
+rubyid_bad_link'>bad_link</span> <span
+class='op'>=</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>www.dropbox.com/sh/abcd/1234?dl=0
+class='tstring_end'>'</span></span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_shared_link_metadata'>get_shared_link_metadata</span> <span class='id identifier rubyid_bad_link'>bad_link</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/SharedLinkNotFoundError.html”
+title=“DropboxApi::Errors::SharedLinkNotFoundError
+(class)”>SharedLinkNotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+23 24 25 26 27 28 29</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb', line 23</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_shared_link_metadata</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_preview_link'>preview_link</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:link_password</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span>
+ <span class='label'>url:</span> <span class='id identifier rubyid_preview_link'>preview_link</span>
+<span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_space_usage-instance_method">
+
+ #<strong>get_space_usage</strong> ⇒ <tt>SpaceUsage</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get the space usage information for the current user's account.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>SpaceUsage</tt>)</span>
+
+ —
+ <div class='inline'><p>Information about a user's space usage and quota.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+12 13 14</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_space_usage.rb', line 12</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_space_usage</span> <span
+class='kw'>do</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='kw'>nil</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_temporary_link-instance_method">
+
+ #<strong>get_temporary_link</strong>(path) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get a temporary link to stream content of a file. This link will expire
+
+in four hours and afterwards you will get 410 Gone. Content-Type of the
+link is determined automatically by the file's mime type.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path to the file you want a temporary link to.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a GetTemporaryLinkResult with file and link
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_temporary_link_spec.rb', line 14</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_temporary_link'>get_temporary_link</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/img.png</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/GetTemporaryLinkResult.html”
+title=“DropboxApi::Results::GetTemporaryLinkResult
+(class)”>GetTemporaryLinkResult</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>img.png</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the file can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_temporary_link_spec.rb', line 14</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_preview'>get_preview</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/unknown_file.jpg</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_temporary_link.rb', line 14</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_temporary_link</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_thumbnail-instance_method">
+
+ #<strong>get_thumbnail</strong>(path, options = {}, &block) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get a thumbnail for an image.</p>
+
+<p>This method currently supports files with the following file
+extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger
+than 20MB in size won't be converted to a thumbnail.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<div class="examples">
+ <p class="tag_title">Examples:</p>
+
+ <pre class="example code"><code><span class='comment'># Save thumbnail to a local file
+
+</span><span class='id identifier
+rubyid_client'>client</span> <span
+class='op'>=</span> <span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“” title=“DropboxApi::Client
+(class)”>Client</a></span></span><span
+class='period'>.</span><span class='id identifier
+rubyid_new'><span class='object_link'><a
+href=“#initialize-instance_method” title=“DropboxApi::Client#initialize
+(method)”>new</a></span></span> <span class='id
+identifier rubyid_file'>file</span> <span
+class='op'>=</span> <span
+class='const'>File</span><span
+class='period'>.</span><span class='id identifier
+rubyid_open'>open</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>thumbnail.png</span><span
+class='tstring_end'>"</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>w</span><span
+class='tstring_end'>"</span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_client'>client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_thumbnail'>get_thumbnail</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>/dropbox_image.png</span><span
+class='tstring_end'>"</span></span>
+<span class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_thumbnail_content'>thumbnail_content</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+
+<span class='kw'>end</span> <span class='id
+identifier rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_close'>close</span></code></pre>
+
+<pre class="example code"><code><span class='comment'># Save thumbnail to a local file with .jpg format
+
+</span><span class='id identifier
+rubyid_client'>client</span> <span
+class='op'>=</span> <span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“” title=“DropboxApi::Client
+(class)”>Client</a></span></span><span
+class='period'>.</span><span class='id identifier
+rubyid_new'><span class='object_link'><a
+href=“#initialize-instance_method” title=“DropboxApi::Client#initialize
+(method)”>new</a></span></span> <span class='id
+identifier rubyid_file'>file</span> <span
+class='op'>=</span> <span
+class='const'>File</span><span
+class='period'>.</span><span class='id identifier
+rubyid_open'>open</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>thumbnail.jpg</span><span
+class='tstring_end'>"</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>w</span><span
+class='tstring_end'>"</span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_client'>client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_thumbnail'>get_thumbnail</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>/dropbox_image.png</span><span
+class='tstring_end'>"</span></span><span
+class='comma'>,</span> <span
+class='symbol'>:format</span> <span
+class='op'>=></span> <span
+class='symbol'>:jpeg</span><span
+class='rparen'>)</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_thumbnail_content'>thumbnail_content</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+
+<span class='kw'>end</span> <span class='id
+identifier rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_close'>close</span></code></pre>
+
+<pre class="example code"><code><span class='comment'># Upload thumbnail to Amazon S3 (assuming you're using their SDK)
+
+</span><span class='id identifier
+rubyid_s3_object'>s3_object</span> <span
+class='op'>=</span> <span
+class='const'>AWS</span><span
+class='op'>::</span><span
+class='const'>S3</span><span
+class='period'>.</span><span class='id identifier
+rubyid_new'>new</span><span
+class='period'>.</span><span class='id identifier
+rubyid_s3'>s3</span><span
+class='period'>.</span><span class='id identifier
+rubyid_buckets'>buckets</span><span
+class='lbracket'>[</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>my-bucket</span><span
+class='tstring_end'>'</span></span><span
+class='rbracket'>]</span><span
+class='period'>.</span><span class='id identifier
+rubyid_objects'>objects</span><span
+class='lbracket'>[</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>key</span><span
+class='tstring_end'>'</span></span><span
+class='rbracket'>]</span> <span
+class='comment'>#=> <AWS::S3::S3Object …>
+</span><span class='id identifier
+rubyid_client'>client</span> <span
+class='op'>=</span> <span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“” title=“DropboxApi::Client
+(class)”>Client</a></span></span><span
+class='period'>.</span><span class='id identifier
+rubyid_new'><span class='object_link'><a
+href=“#initialize-instance_method” title=“DropboxApi::Client#initialize
+(method)”>new</a></span></span> <span class='id
+identifier rubyid_client'>client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_thumbnail'>get_thumbnail</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='tstring_content'>/dropbox_image.png</span><span
+class='tstring_end'>"</span></span>
+<span class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_thumbnail_content'>thumbnail_content</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_s3_object'>s3_object</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+
+<span class='kw'>end</span></code></pre>
+
+</div>
+
+<p class=“tag_title”>Parameters:</p> <ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path to the image file you want to thumbnail.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">format</span>
+ <span class="type">(<tt>:jpeg</tt>, <tt>:png</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The format for the thumbnail image,
+
+:jpeg (default) or :png. For images that are
+photos, :jpeg should be preferred, while png is better for
+screenshots and digital arts. The default is :jpeg.</p>
+</div>
+
+</li>
+
+<li>
+ <span class="name">size</span>
+ <span class="type">(<tt>:w32h32</tt>, <tt>:w64h64</tt>, <tt>:w128h128</tt>, <tt>:w640h480</tt>, <tt>:w1024h768</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The size for the thumbnail image. The default is <code>:w64h64</code>.</p>
+
+</div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a file
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_thumbnail'>get_thumbnail</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/img.png</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>img.png</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the file can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_thumbnail'>get_thumbnail</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/unknown_file.jpg</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an argument error with invalid options
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+20 21 22</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_thumbnail'>get_thumbnail</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>invalid_arg:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>value</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'>ArgumentError</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+48 49 50 51 52 53 54 55 56</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_thumbnail.rb', line 48</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_thumbnail</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='comma'>,</span> <span
+class='op'>&</span><span class='id
+identifier rubyid_block'>block</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='comma'>,</span> <span class='symbol'>:size</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:jpeg</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:size</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:w64h64</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="get_thumbnail_batch-instance_method">
+
+ #<strong>get_thumbnail_batch</strong>(paths, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Get a thumbnails for a batch of images.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>paths</span>
+
+ <span class='type'>(<tt>Array<String></tt>)</span>
+
+ —
+ <div class='inline'><p>The paths to the image files you want thumbnails for.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">format</span>
+ <span class="type">(<tt>:jpeg</tt>, <tt>:png</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The format for the thumbnail image,
+
+:jpeg (default) or :png. For images that are
+photos, :jpeg should be preferred, while png is better for
+screenshots and digital arts. The default is :jpeg.</p>
+</div>
+
+</li>
+
+<li>
+ <span class="name">size</span>
+ <span class="type">(<tt>:w32h32</tt>, <tt>:w64h64</tt>, <tt>:w128h128</tt>, <tt>:w640h480</tt>, <tt>:w1024h768</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The size for the thumbnail image. The default is <code>:w64h64</code>.</p>
+
+</div>
+
+</li>
+
+<li>
+ <span class="name">mode</span>
+ <span class="type">(<tt>:strict</tt>, <tt>:bestfit</tt>, <tt>:fitone_bestfit</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>How to resize and crop the image to achieve the desired size. The default
+
+for this union is strict.</p> </div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns files
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+9 10 11 12 13 14</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_thumbnail_batch'>get_thumbnail_batch</span>
+<span class='lbracket'>[</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/img.png</span><span
+class='tstring_end'>"</span></span><span
+class='rbracket'>]</span> <span class='id
+identifier rubyid_entry'>entry</span> <span
+class='op'>=</span> <span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_entries'>entries</span><span
+class='period'>.</span><span class='id identifier
+rubyid_first'>first</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_entry'>entry</span><span
+class='period'>.</span><span class='id identifier
+rubyid_metadata'>metadata</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_entry'>entry</span><span
+class='period'>.</span><span class='id identifier
+rubyid_thumbnail'>thumbnail</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'>String</span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_entry'>entry</span><span
+class='period'>.</span><span class='id identifier
+rubyid_metadata'>metadata</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>img.png</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ includes an error entry if the file can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+18 19</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_get_thumbnail_batch'>get_thumbnail_batch</span>
+<span class='lbracket'>[</span><span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/unknown_file.jpg</span><span
+class='tstring_end'>"</span></span><span
+class='rbracket'>]</span> <span class='id
+identifier rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_entries'>entries</span><span
+class='period'>.</span><span class='id identifier
+rubyid_first'>first</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an argument error with invalid options
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+23 24 25</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_thumbnail_batch'>get_thumbnail_batch</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>invalid_arg:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>value</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'>ArgumentError</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+23 24 25 26 27 28 29 30</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 23</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:get_thumbnail_batch</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_paths'>paths</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='comma'>,</span> <span class='symbol'>:size</span><span class='comma'>,</span> <span class='symbol'>:mode</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:jpeg</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:size</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:w64h64</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:mode</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:strict</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>entries:</span> <span class='id identifier rubyid_build_entries_params'>build_entries_params</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="list_file_members-instance_method">
+
+ #<strong>list_file_members</strong>(file_id, actions = [], options = {}) ⇒ <tt>SharedFileMembers</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Use to obtain the members who have been invited to a file, both
+
+inherited and uninherited members.</p>
+
+<p>Apps must have full Dropbox access to use this endpoint.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<div class="examples">
+ <p class="tag_title">Examples:</p>
+
+ <p class="example_title"><div class='inline'><p>List file members.</p>
+
+</div></p>
+
+<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>"</span></span></code></pre>
+
+ <p class="example_title"><div class='inline'><p>List file members, with detail of permission to make owner.</p>
+
+</div></p>
+
+<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:make_owner</span><span class='rbracket'>]</span></code></pre>
+
+ <p class="example_title"><div class='inline'><p>List file members, using the path instead of file ID.</p>
+
+</div></p>
+
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/my/file.pdf</span><span class='tstring_end'>"</span></span></code></pre>
+
+</div>
+
+<p class=“tag_title”>Parameters:</p> <ul class=“param”>
+
+<li>
+
+ <span class='name'>file_id</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The ID for the shared file.</p>
+
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>actions</span>
+
+ <span class='type'>(<tt>Array</tt>)</span>
+
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
+
+ —
+ <div class='inline'><p>This is an optional list of actions. The permissions for the actions
+
+requested will be included in the result.</p> </div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">include_inherited</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>Whether to include members
+
+who only have access from a parent shared folder. The default for this
+field is true.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">limit</span>
+ <span class="type">(<tt>Numeric</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The maximum number of results that
+
+include members, groups and invitees to return per request. The default for
+this field is 100.</p> </div>
+
+ </li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>SharedFileMembers</tt>)</span>
+
+ —
+ <div class='inline'><p>Shared file user and group membership.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+ <li><span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">Metadata::MemberActionList</a></span></li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ lists file members
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_file_members_spec.rb', line 37</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_file_members'>list_file_members</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>1231273663</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/SharedFileMembers.html”
+title=“DropboxApi::Results::SharedFileMembers
+(class)”>SharedFileMembers</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ lists file members including member actions
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+13 14 15</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_file_members_spec.rb', line 37</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_file_members'>list_file_members</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>1231273663</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='lbracket'>[</span><span
+class='symbol'>:remove</span><span
+class='comma'>,</span> <span
+class='symbol'>:make_owner</span><span
+class='rbracket'>]</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/SharedFileMembers.html”
+title=“DropboxApi::Results::SharedFileMembers
+(class)”>SharedFileMembers</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+37 38 39 40 41 42 43 44 45</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_file_members.rb', line 37</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:list_file_members</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_file_id'>file_id</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_actions'>actions</span> <span
+class='op'>=</span> <span
+class='lbracket'>[</span><span
+class='rbracket'>]</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='comma'>,</span> <span class='symbol'>:include_inherited</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>100</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>file:</span> <span class='id identifier rubyid_file_id'>file_id</span><span class='comma'>,</span>
+ <span class='label'>actions:</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Metadata/MemberActionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberActionList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_actions'>actions</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="list_folder-instance_method">
+
+ #<strong>list_folder</strong>(path, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Returns the contents of a folder.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path to the folder you want to read.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">recursive</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>, the list folder operation
+
+will be applied recursively to all subfolders and the response will contain
+contents of all subfolders. The default for this field is
+false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">include_media_info</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>, media_info
+
+is set for photo and video. The default for this field is
+false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">include_deleted</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>,
+
+<span class='object_link'><a href=“Metadata/Deleted.html”
+title=“DropboxApi::Metadata::Deleted
+(class)”>Metadata::Deleted</a></span> will be returned for
+deleted file or folder, otherwise <span
+class='object_link'><a href=“Errors/NotFoundError.html”
+title=“DropboxApi::Errors::NotFoundError
+(class)”>Errors::NotFoundError</a></span> will be raised.
+The default for this field is false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">limit</span>
+ <span class="type">(<tt>Numeric</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If present, will specify max number of
+
+results per request (Note: <a href=“www.dropbox.com/developers/documentation/http/documentation#files-list_folder”
+target=“_parent” title=“Dropbox docs”>Dropbox docs</a> indicate
+this is "approximate", and more may be
+returned)</p> </div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a ListFolderResult
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder'>list_folder</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/ListFolderResult.html”
+title=“DropboxApi::Results::ListFolderResult
+(class)”>ListFolderResult</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the file can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/unexisting_folder</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns all entries as metadata objects
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+20 21 22 23 24</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder'>list_folder</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_entries'>entries</span><span
+class='period'>.</span><span class='id identifier
+rubyid_each'>each</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_resource'>resource</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ lists entries in shared folder if given
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+28 29 30 31 32 33 34</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_shared_links'>list_shared_links</span><span
+class='lparen'>(</span><span
+class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>"</span><span
+class='embexpr_beg'>#{</span><span class='id
+identifier rubyid_path_prefix'>path_prefix</span><span
+class='embexpr_end'>}</span><span
+class='tstring_content'>/shared_folder</span><span
+class='tstring_end'>"</span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_result'>result</span> <span
+class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder'>list_folder</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='label'>shared_>
+<span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_links'>links</span><span
+class='period'>.</span><span class='id identifier
+rubyid_first'>first</span><span
+class='period'>.</span><span class='id identifier
+rubyid_url'>url</span>
+
+<span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_entries'>entries</span><span
+class='period'>.</span><span class='id identifier
+rubyid_each'>each</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_resource'>resource</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span>
+
+<span class='kw'>end</span> <span class='id
+identifier rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_entries'>entries</span><span
+class='period'>.</span><span class='id identifier
+rubyid_map'>map</span><span
+class='lparen'>(</span><span
+class='op'>&</span><span
+class='symbol'>:name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_inspect'>inspect</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_include'>include</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>cow.txt</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an argument error with invalid options
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+38 39 40</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>invalid_arg:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>value</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'>ArgumentError</span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ works with a namespace_id
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+45 46</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+
+<span class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_namespace_id'>namespace_id</span> <span
+class='op'>=</span> <span
+class='int'>70721710</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder'>list_folder</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/dropbox_api_fixtures</span><span
+class='tstring_end'>'</span></span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ fails with an invalid namespace ID
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+50 51 52 53 54</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+
+<span class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_namespace_id'>namespace_id</span> <span
+class='op'>=</span> <span
+class='int'>938429923</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='kw'>do</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/dropbox_api_fixtures</span><span class='tstring_end'>'</span></span>
+
+<span class='kw'>end</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/HttpError.html” title=“DropboxApi::Errors::HttpError
+(class)”>HttpError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ works if namespace ID is unset
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+58 59 60 61 62 63 64 65</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+
+<span class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_namespace_id'>namespace_id</span> <span
+class='op'>=</span> <span
+class='int'>70721710</span>
+
+<span class='comment'># we expect this to use a namespace ID
+</span><span class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder'>list_folder</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/dropbox_api_fixtures</span><span
+class='tstring_end'>'</span></span>
+
+<span class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_namespace_id'>namespace_id</span> <span
+class='op'>=</span> <span
+class='kw'>nil</span> <span
+class='comment'># we expect the next not to use any namespace ID
+</span><span class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder'>list_folder</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/dropbox_api_fixtures</span><span
+class='tstring_end'>'</span></span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 29</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:list_folder</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+ <span class='symbol'>:recursive</span><span class='comma'>,</span>
+ <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+ <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+ <span class='symbol'>:shared_link</span><span class='comma'>,</span>
+ <span class='symbol'>:include_has_explicit_shared_members</span><span class='comma'>,</span>
+ <span class='symbol'>:limit</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_build_shared_link_param'>build_shared_link_param</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="list_folder_continue-instance_method">
+
+ #<strong>list_folder_continue</strong>(cursor) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Once a cursor has been retrieved from <code>list_folder</code>, use this to paginate
+
+through all files and retrieve updates to the folder.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>cursor</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The cursor returned by your last call to
+
+list_folder or list_folder_continue.</p> </div>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a ListFolderResult
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_continue_spec.rb', line 17</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder_continue'>list_folder_continue</span><span
+class='lparen'>(</span><span
+class='ivar'>@cursor</span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/ListFolderResult.html”
+title=“DropboxApi::Results::ListFolderResult
+(class)”>ListFolderResult</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+17 18 19</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_continue.rb', line 17</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:list_folder_continue</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_cursor'>cursor</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="list_folder_get_latest_cursor-instance_method">
+
+ #<strong>list_folder_get_latest_cursor</strong>(options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>A way to quickly get a cursor for the folder's state. Unlike
+
+<span class='object_link'><a
+href=“#list_folder-instance_method” title=“DropboxApi::Client#list_folder
+(method)”>#list_folder</a></span>, this doesn't
+return any entries. This endpoint is for app which only needs to know about
+new files and modifications and doesn't need to know about files
+that already exist in Dropbox.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">path</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The path to the folder you want to read.</p>
+
+</div>
+
+</li>
+
+<li>
+ <span class="name">recursive</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>, the list folder operation
+
+will be applied recursively to all subfolders and the response will contain
+contents of all subfolders. The default for this field is
+false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">include_media_info</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>, <code>media_info</code> is
+
+set for photo and video. The default for this field is
+false.</p> </div>
+
+</li>
+
+<li>
+ <span class="name">include_deleted</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If <code>true</code>,
+
+<span class='object_link'><a href=“Metadata/Deleted.html”
+title=“DropboxApi::Metadata::Deleted
+(class)”>Metadata::Deleted</a></span> will be returned for
+deleted file or folder, otherwise <span
+class='object_link'><a href=“Errors/LookupError.html”
+title=“DropboxApi::Errors::LookupError
+(class)”>Errors::LookupError</a></span> will be returned.
+The default for this field is false.</p> </div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a ListFolderGetLatestCursorResult
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_get_latest_cursor_spec.rb', line 28</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder_get_latest_cursor'>list_folder_get_latest_cursor</span>
+<span class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/folder</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span>
+
+<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/ListFolderGetLatestCursorResult.html" title="DropboxApi::Results::ListFolderGetLatestCursorResult (class)">ListFolderGetLatestCursorResult</a></span></span><span class='rparen'>)</span></pre>
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+28 29 30 31 32 33 34 35 36 37 38 39 40 41</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb', line 28</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:list_folder_get_latest_cursor</span>
+<span class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+ <span class='symbol'>:path</span><span class='comma'>,</span>
+ <span class='symbol'>:recursive</span><span class='comma'>,</span>
+ <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+ <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+ <span class='symbol'>:include_has_explicit_shared_members</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="list_folder_longpoll-instance_method">
+
+ #<strong>list_folder_longpoll</strong>(cursor, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>A longpoll endpoint to wait for changes on an account. In conjunction
+
+with list_folder, this call gives you a low-latency way to monitor an
+account for file changes. The connection will block until there are changes
+available or a timeout occurs. This endpoint is useful mostly for
+client-side apps. If you're looking for server-side notifications,
+check out our webhooks documentation.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>cursor</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>A cursor as returned by list_folder or
+
+list_folder_continue.</p> </div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">timeout</span>
+ <span class="type">(<tt>Numeric</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>A timeout in seconds. The request will
+
+block for at most this length of time, plus up to 90 seconds of random
+jitter added to avoid the thundering herd problem. Care should be taken
+when using this parameter, as some network infrastructure does not support
+long timeouts. The default for this field is 30.</p> </div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a ListFolderLongpollResult
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+13 14 15</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder_longpoll'>list_folder_longpoll</span>
+<span class='ivar'>@cursor</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/ListFolderLongpollResult.html”
+title=“DropboxApi::Results::ListFolderLongpollResult
+(class)”>ListFolderLongpollResult</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ indicates if there're changes
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+19 20 21</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder_longpoll'>list_folder_longpoll</span>
+<span class='ivar'>@cursor</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_changes'>changes</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_truthy'>be_truthy</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error with an invalid cursor
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+25 26 27</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder_longpoll'>list_folder_longpoll</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>I believe in the blerch</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span> <span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/HttpError.html” title=“DropboxApi::Errors::HttpError
+(class)”>HttpError</a></span></span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+25 26 27 28 29 30 31 32 33 34</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_longpoll.rb', line 25</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:list_folder_longpoll</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_cursor'>cursor</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+ <span class='symbol'>:timeout</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>30</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="list_folder_members-instance_method">
+
+ #<strong>list_folder_members</strong>(folder_id, actions = [], options = {}) ⇒ <tt>SharedFolderMembers</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Returns shared folder membership by its folder ID.</p>
+
+<p>Apps must have full Dropbox access to use this endpoint.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<div class="examples">
+ <p class="tag_title">Examples:</p>
+
+ <p class="example_title"><div class='inline'><p>List folder members.</p>
+
+</div></p>
+
+<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder_members'>list_folder_members</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>"</span></span></code></pre>
+
+ <p class="example_title"><div class='inline'><p>List folder members, with detail of permission to make owner.</p>
+
+</div></p>
+
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder_members'>list_folder_members</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:make_owner</span><span class='rbracket'>]</span></code></pre>
+
+</div>
+
+<p class=“tag_title”>Parameters:</p> <ul class=“param”>
+
+<li>
+
+ <span class='name'>folder_id</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The ID for the shared folder.</p>
+
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>actions</span>
+
+ <span class='type'>(<tt>Array</tt>)</span>
+
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
+
+ —
+ <div class='inline'><p>This is an optional list of actions. The permissions for the actions
+
+requested will be included in the result.</p> </div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">limit</span>
+ <span class="type">(<tt>Numeric</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The maximum number of results that
+
+include members, groups and invitees to return per request. The default for
+this field is 1000.</p> </div>
+
+ </li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>SharedFolderMembers</tt>)</span>
+
+ —
+ <div class='inline'><p>Shared folder user and group membership.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+ <li><span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">Metadata::MemberActionList</a></span></li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ lists folder members
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_folder_members_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder_members'>list_folder_members</span>
+<span class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>1231273663</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/SharedFolderMembers.html”
+title=“DropboxApi::Results::SharedFolderMembers
+(class)”>SharedFolderMembers</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ lists folder members including member actions
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+13 14 15</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_folder_members_spec.rb', line 30</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_folder_members'>list_folder_members</span>
+<span class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>1231273663</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='lbracket'>[</span><span
+class='symbol'>:remove</span><span
+class='comma'>,</span> <span
+class='symbol'>:make_owner</span><span
+class='rbracket'>]</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/SharedFolderMembers.html”
+title=“DropboxApi::Results::SharedFolderMembers
+(class)”>SharedFolderMembers</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+30 31 32 33 34 35 36 37 38</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_folder_members.rb', line 30</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:list_folder_members</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_folder_id'>folder_id</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_actions'>actions</span> <span
+class='op'>=</span> <span
+class='lbracket'>[</span><span
+class='rbracket'>]</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>100</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>shared_folder_id:</span> <span class='id identifier rubyid_folder_id'>folder_id</span><span class='comma'>,</span>
+ <span class='label'>actions:</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Metadata/MemberActionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberActionList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_actions'>actions</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="list_revisions-instance_method">
+
+ #<strong>list_revisions</strong>(path, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Return revisions of a file</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>path</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>The path to file you want to see the revisions of.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">limit</span>
+ <span class="type">(<tt>Numeric</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The maximum number of revision entries
+
+returned. The default for this field is 10.</p> </div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a ListRevisionsResult
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_revisions_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_revisions'>list_revisions</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file.txt</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results.html” title=“DropboxApi::Results
+(module)”>Results</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Results/ListRevisionsResult.html”
+title=“DropboxApi::Results::ListRevisionsResult
+(class)”>ListRevisionsResult</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the file can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+13 14 15</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_revisions_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_revisions'>list_revisions</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/unexisting_file</span><span class='tstring_end'>'</span></span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns all revisions as metadata objects
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+19 20 21 22 23</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_revisions_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_revisions'>list_revisions</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file.txt</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_entries'>entries</span><span
+class='period'>.</span><span class='id identifier
+rubyid_each'>each</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_resource'>resource</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ indicates if the file has been deleted
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+27 28 29</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_revisions_spec.rb', line 16</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_revisions'>list_revisions</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/file.txt</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_is_deleted?'>is_deleted?</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_truthy'>be_truthy</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+16 17 18 19 20 21 22 23 24 25</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_revisions.rb', line 16</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:list_revisions</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_path'>path</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+ <span class='symbol'>:limit</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>10</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="list_shared_links-instance_method">
+
+ #<strong>list_shared_links</strong>(options = {}) ⇒ <tt>ListSharedLinksResult</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>List shared links of this user.</p>
+
+<p>If no path is given or the path is empty, returns a list of all
+shared links for the current user.</p>
+
+<p>If a non-empty path is given, returns a list of all shared links
+that allow access to the given path - direct links to the given path and
+links to parent folders of the given path. Links to parent folders can be
+suppressed by setting direct_only to true.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">path</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+ <li>
+ <span class="name">cursor</span>
+ <span class="type">(<tt>String</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>The cursor returned by your last call.</p>
+
+</div>
+
+ </li>
+
+ <li>
+ <span class="name">direct_only</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ </li>
+
+</ul>
+
+<p class=“tag_title”>Returns:</p> <ul class=“return”>
+
+<li>
+
+ <span class='type'>(<tt>ListSharedLinksResult</tt>)</span>
+
+</li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns a file link
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_shared_links'>list_shared_links</span> <span
+class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/some_folder/file.txt</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_links'>links</span><span
+class='period'>.</span><span class='id identifier
+rubyid_last'>last</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FileLinkMetadata.html”
+title=“DropboxApi::Metadata::FileLinkMetadata
+(class)”>FileLinkMetadata</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ lists all shared links
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16 17 18 19</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_links'>links</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_shared_links'>list_shared_links</span><span
+class='lparen'>(</span><span
+class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/some_folder/file.txt</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_links'>links</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_links'>links</span><span
+class='period'>.</span><span class='id identifier
+rubyid_map'>map</span> <span
+class='op'>&</span><span
+class='symbol'>:url</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_match_array'>match_array</span><span
+class='lparen'>(</span><span
+class='qwords_beg'>%w(</span><span
+class='words_sep'>
+
+</span><span class='tstring_content'>https://www.dropbox.com/sh/5b0bmldpa1qi772/AAAwKkKiTdb1A78bzHCKQLeHa?dl=0</span><span class='words_sep'>
+</span><span class='tstring_content'>https://www.dropbox.com/s/sp5cuhaxfn8126z/file.txt?dl=0</span><span class='words_sep'>
+
+</span><span
+class='tstring_end'>)</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ gets the direct shared link
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+23 24 25 26 27 28 29 30</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_links'>links</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_shared_links'>list_shared_links</span><span
+class='lparen'>(</span><span
+class='lbrace'>{</span>
+
+<span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/some_folder/file.txt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
+<span class='label'>direct_only:</span> <span class='kw'>true</span>
+
+<span class='rbrace'>}</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_links'>links</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_links'>links</span><span
+class='period'>.</span><span class='id identifier
+rubyid_map'>map</span> <span
+class='op'>&</span><span
+class='symbol'>:url</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_match_array'>match_array</span><span
+class='lparen'>(</span><span
+class='qwords_beg'>%w(</span><span
+class='words_sep'>
+
+</span><span class='tstring_content'>https://www.dropbox.com/s/sp5cuhaxfn8126z/file.txt?dl=0</span><span class='words_sep'>
+
+</span><span
+class='tstring_end'>)</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns a folder link
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+36 37 38</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_result'>result</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_shared_links'>list_shared_links</span> <span
+class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/some_folder/another_folder</span><span
+class='tstring_end'>'</span></span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_result'>result</span><span
+class='period'>.</span><span class='id identifier
+rubyid_links'>links</span><span
+class='period'>.</span><span class='id identifier
+rubyid_last'>last</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/FolderLinkMetadata.html”
+title=“DropboxApi::Metadata::FolderLinkMetadata
+(class)”>FolderLinkMetadata</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ lists all shared links
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+42 43 44 45 46 47</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+
+<span class='id identifier rubyid_links'>links</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_list_shared_links'>list_shared_links</span><span
+class='lparen'>(</span><span
+class='label'>path:</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/some_folder/another_folder</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_links'>links</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_links'>links</span><span
+class='period'>.</span><span class='id identifier
+rubyid_map'>map</span> <span
+class='op'>&</span><span
+class='symbol'>:url</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_match_array'>match_array</span><span
+class='lparen'>(</span><span
+class='qwords_beg'>%w(</span><span
+class='words_sep'>
+
+</span><span class='tstring_content'>https://www.dropbox.com/sh/5b0bmldpa1qi772/AAAwKkKiTdb1A78bzHCKQLeHa?dl=0</span><span class='words_sep'>
+</span><span class='tstring_content'>https://www.dropbox.com/sh/h3slcnfcs3w7sdk/AADlUYcssd70EWHX3n9CJCWwa?dl=0</span><span class='words_sep'>
+
+</span><span
+class='tstring_end'>)</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+25 26 27 28 29</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_shared_links.rb', line 25</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:list_shared_links</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='symbol'>:direct_only</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="middleware-instance_method">
+
+ #<strong>middleware</strong> ⇒ <tt>Object</tt>
+
+</h3> <table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+21 22 23</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/client.rb', line 21</span>
+
+<span class='kw'>def</span> <span class='id
+identifier rubyid_middleware'>middleware</span>
+
+<span class='ivar'>@connection_builder</span><span class='period'>.</span><span class='id identifier rubyid_middleware'>middleware</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="move-instance_method">
+
+ #<strong>move</strong>(from, to, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Move a file or folder to a different location in the user's Dropbox.</p>
+
+<p>If the source path is a folder all its contents will be
+moved.</p>
+
+</div>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Parameters:</p>
+
+<ul class=“param”>
+
+<li>
+
+ <span class='name'>from</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Path in the user's Dropbox to be copied or moved.</p>
+
+</div>
+
+</li>
+
+<li>
+
+ <span class='name'>to</span>
+
+ <span class='type'>(<tt>String</tt>)</span>
+
+ —
+ <div class='inline'><p>Path in the user's Dropbox that is the destination.</p>
+
+</div>
+
+</li>
+
+</ul>
+
+<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+ <li>
+ <span class="name">autorename</span>
+ <span class="type">(<tt>Boolean</tt>)</span>
+ <span class="default">
+
+ </span>
+
+ — <div class='inline'><p>If there's a conflict, have the
+
+Dropbox server try to autorename the file to avoid the conflict. The
+default for this field is false.</p> </div>
+
+ </li>
+
+</ul>
+
+</div> <div class=“tags”>
+
+<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+ <li>
+ returns the moved file on success
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+7 8 9 10</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/move_spec.rb', line 20</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_move'>move</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/img.png</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/image.png</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>image.png</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ returns the moved folder on success
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+14 15 16 17</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/move_spec.rb', line 20</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_move'>move</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/folder</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/test/folder</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder
+(class)”>Folder</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>folder</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ renames the moved file if required
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+21 22 23 24</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/move_spec.rb', line 20</span>
+
+<span class='id identifier rubyid_file'>file</span>
+<span class='op'>=</span> <span
+class='ivar'>@client</span><span
+class='period'>.</span><span class='id identifier
+rubyid_move'>move</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/a.jpg</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>/photo.jpg</span><span
+class='tstring_end'>'</span></span><span
+class='comma'>,</span> <span
+class='label'>autorename:</span> <span
+class='kw'>true</span><span
+class='rparen'>)</span>
+
+<span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_be_a'>be_a</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata.html” title=“DropboxApi::Metadata
+(module)”>Metadata</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Metadata/File.html” title=“DropboxApi::Metadata::File
+(class)”>File</a></span></span><span
+class='rparen'>)</span> <span class='id identifier
+rubyid_expect'>expect</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_file'>file</span><span
+class='period'>.</span><span class='id identifier
+rubyid_name'>name</span><span
+class='rparen'>)</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_eq'>eq</span><span
+class='lparen'>(</span><span
+class='tstring'><span
+class='tstring_beg'>'</span><span
+class='tstring_content'>photo (1).jpg</span><span
+class='tstring_end'>'</span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+</li>
+
+<li>
+ raises an error if the file can't be found
+ <table class="source_code test_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+28 29 30</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'spec/endpoints/files/move_spec.rb', line 20</span>
+
+<span class='id identifier rubyid_expect'>expect</span>
+<span class='lbrace'>{</span>
+
+<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_move'>move</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/z.jpg</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/b.jpg</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+
+<span class='rbrace'>}</span><span
+class='period'>.</span><span class='id identifier
+rubyid_to'>to</span> <span class='id identifier
+rubyid_raise_error'>raise_error</span><span
+class='lparen'>(</span><span
+class='const'><span class='object_link'><a
+href=“../DropboxApi.html” title=“DropboxApi
+(module)”>DropboxApi</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors.html” title=“DropboxApi::Errors
+(module)”>Errors</a></span></span><span
+class='op'>::</span><span
+class='const'><span class='object_link'><a
+href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError
+(class)”>NotFoundError</a></span></span><span
+class='rparen'>)</span></pre>
+
+ </td>
+ </tr>
+ </table>
+ </li>
+
+</ul>
+
+</div>
+
+<table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+20 21 22 23 24 25 26 27 28 29 30 31 32</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/move.rb', line 20</span>
+
+<span class='id identifier
+rubyid_add_endpoint'>add_endpoint</span> <span
+class='symbol'>:move</span> <span
+class='kw'>do</span> <span
+class='op'>|</span><span class='id identifier
+rubyid_from'>from</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_to'>to</span><span
+class='comma'>,</span> <span class='id identifier
+rubyid_options'>options</span> <span
+class='op'>=</span> <span
+class='lbrace'>{</span><span
+class='rbrace'>}</span><span
+class='op'>|</span>
+
+<span class='comment'># We're not implementing support for the `allow_shared_folder` option
+
+</span> <span class='comment'># because according to
+Dropbox's documentation: "This field is always
+</span> <span class='comment'># true for
+move". </span> <span class='id identifier
+rubyid_validate_options'>validate_options</span><span
+class='lparen'>(</span><span
+class='lbracket'>[</span>
+
+ <span class='symbol'>:autorename</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+ <span class='label'>from_path:</span> <span class='id identifier rubyid_from'>from</span><span class='comma'>,</span>
+ <span class='label'>to_path:</span> <span class='id identifier rubyid_to'>to</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="namespace_id-instance_method">
+
+ #<strong>namespace_id</strong> ⇒ <tt>Object</tt>
+
+</h3> <table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+29 30 31</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/client.rb', line 29</span>
+
+<span class='kw'>def</span> <span class='id
+identifier rubyid_namespace_id'>namespace_id</span>
+
+<span class='ivar'>@connection_builder</span><span class='period'>.</span><span class='id identifier rubyid_namespace_id'>namespace_id</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="namespace_id=-instance_method">
+
+ #<strong>namespace_id=</strong>(value) ⇒ <tt>Object</tt>
+
+</h3> <table class=“source_code”>
+
+<tr>
+ <td>
+ <pre class="lines">
+
+25 26 27</pre>
+
+</td>
+<td>
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/client.rb', line 25</span>
+
+<span class='kw'>def</span> <span class='id
+identifier rubyid_namespace_id='>namespace_id=</span><span
+class='lparen'>(</span><span class='id identifier
+rubyid_value'>value</span><span
+class='rparen'>)</span>
+
+<span class='ivar'>@connection_builder</span><span class='period'>.</span><span class='id identifier rubyid_namespace_id'>namespace_id</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
+
+<span class='kw'>end</span></pre>
+
+ </td>
+</tr>
+
+</table> </div>
+
+ <div class="method_details ">
+<h3 class="signature " id="permanently_delete-instance_method">
+
+ #<strong>permanently_delete</strong>(path, options = {}) ⇒ <tt>Object</tt>
+
+</h3><div class=“docstring”>
+
+<div class="discussion">
+ <p>Permanently delete the file or folder at a given path.</p>
+
+<p>See <a href=“https://www.dropbox.com/en/help/40
www.dropbox.com/en/help/40”>https://www.dropbox.com/en/help/40