dropbox_api 0.1.16 → 0.1.17

data/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html

@@ -6,7 +6,7 @@
 <title>
   Class: DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -91,6 +91,11 @@
   
   
   
+  <dl>
+      <dt>Includes:</dt>
+      <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+  </dl>
+  
   
 
   
@@ -184,6 +189,17 @@
   
   
   
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+  
+  
+  
+  
+  
+  
+  
+  
   <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
   <p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
 
@@ -225,6 +241,9 @@ 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 <code>settings</code> parameter will only work for pro, business or
+enterprise accounts. It will return no permission error otherwise.</p>
+
 
   </div>
 </div>
@@ -267,6 +286,58 @@ created shared link This field is optional.</p>
   
 </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>
+          
+            &mdash; <div class='inline'><p>The requested access for this
+shared link. This field is optional. Must be one of &quot;public&quot;,
+&quot;team_only&quot; or &quot;password&quot;.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">link_password</span>
+          <span class="type">(<tt>Object</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>If requested_visibility is
+&quot;password&quot; 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>
+          
+            &mdash; <div class='inline'><p>Expiration time of the shared link. By default
+the link won&#39;t expire. This field is optional.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
 <p class="tag_title">Returns:</p>
 <ul class="return">
   
@@ -288,19 +359,39 @@ created shared link This field is optional.</p>
       <pre class="lines">
 
 
-17
-18
-19
-20
-21</pre>
+31
+32
+33
+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/create_shared_link_with_settings.rb', line 17</span>
+      <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 31</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='comment'># NOTE: This endpoint accepts an additional option `settings` which
-</span>  <span class='comment'>#       has been implemented but will work only for pro users and it will return no permission error for basic users.
-</span>  <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</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'>&#39;</span><span class='tstring_content'>public</span><span class='tstring_end'>&#39;</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='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+    <span class='symbol'>:settings</span><span class='op'>=&gt;</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>
@@ -312,9 +403,9 @@ created shared link This field is optional.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:07 2018 by
+  Generated on Sat Feb 16 18:39:24 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html

@@ -6,7 +6,7 @@
 <title>
   Class: DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -334,9 +334,9 @@ a password, this parameter can be used.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:07 2018 by
+  Generated on Sat Feb 16 18:39:23 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html

@@ -6,7 +6,7 @@
 <title>
   Class: DropboxApi::Endpoints::Sharing::ListFileMembers
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -411,9 +411,9 @@ for this field is 100.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:07 2018 by
+  Generated on Sat Feb 16 18:39:23 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html

@@ -6,7 +6,7 @@
 <title>
   Class: DropboxApi::Endpoints::Sharing::ListFolderMembers
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -390,9 +390,9 @@ for this field is 1000.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:07 2018 by
+  Generated on Sat Feb 16 18:39:23 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html

@@ -6,7 +6,7 @@
 <title>
   Class: DropboxApi::Endpoints::Sharing::ListSharedLinks
   
-    &mdash; Documentation by YARD 0.9.15
+    &mdash; Documentation by YARD 0.9.16
   
 </title>
 
@@ -335,9 +335,9 @@ be suppressed by setting direct_only to true.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Nov 16 09:02:07 2018 by
+  Generated on Sat Feb 16 18:39:23 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.15 (ruby-2.3.3).
+  0.9.16 (ruby-2.3.3).
 </div>
 
     </div>

data/docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html

@@ -0,0 +1,293 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: DropboxApi::Endpoints::Sharing::RevokeSharedLink
+  
+    &mdash; Documentation by YARD 0.9.16
+  
+</title>
+
+  <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "DropboxApi::Endpoints::Sharing::RevokeSharedLink";
+  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 (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+     &raquo; 
+    <span class="title">RevokeSharedLink</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::Endpoints::Sharing::RevokeSharedLink
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+          
+            <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+          
+            <li class="next">DropboxApi::Endpoints::Sharing::RevokeSharedLink</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb</dd>
+  </dl>
+  
+</div>
+
+
+  
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      
+        <dt id="Method-constant" class="">Method =
+          
+        </dt>
+        <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+      
+        <dt id="Path-constant" class="">Path =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/2/sharing/revoke_shared_link</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+      
+        <dt id="ResultType-constant" class="">ResultType =
+          
+        </dt>
+        <dd><pre class="code"><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/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span></span></pre></dd>
+      
+        <dt id="ErrorType-constant" class="">ErrorType =
+          
+        </dt>
+        <dd><pre class="code"><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/RevokeSharedLinkError.html" title="DropboxApi::Errors::RevokeSharedLinkError (class)">RevokeSharedLinkError</a></span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+  
+    <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="#revoke_shared_link-instance_method" title="#revoke_shared_link (instance method)">#<strong>revoke_shared_link</strong>(url)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Revoke a shared link.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">DropboxApi::Endpoints::Rpc</a></span></p>
+  
+</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="revoke_shared_link-instance_method">
+  
+    #<strong>revoke_shared_link</strong>(url)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Revoke a shared link.</p>
+
+<p>Note that even after revoking a shared link to a file, the file may be accessible
+if there are shared links leading to any of the file parent folders. </p>
+
+<p>A successful response indicates that the shared link was revoked.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>url</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>shared url which needs to be revoked.</p>
+</div>
+      
+    </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/sharing/revoke_shared_link.rb', line 17</span>
+
+<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:revoke_shared_link</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_url'>url</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='symbol'>:url</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_url'>url</span>
+  <span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Sat Feb 16 18:39:23 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.3.3).
+</div>
+
+    </div>
+  </body>
+</html>