box-api 0.2.0 → 0.2.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    box-api (0.2.0)
+    box-api (0.2.1)
       httmultiparty (~> 0.3.6)
 
 GEM

data/README.md

@@ -22,6 +22,8 @@ Once you have an API key, you are free to start using the box API! Check out the
 
 ### Documentation ###
 
+You can find documentation for this gem [here](http://rubydoc.info/gems/box-api/frames).
+
 You can find API documentation at [http://developers.box.net/](http://developers.box.net/). Full documentation regarding the Ruby library methods is coming soon.
 
 ### Support ###

data/box-api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "box-api"
-  s.version     = "0.2.0"
+  s.version     = "0.2.1"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Box.net", "Luke Curley"]
   s.email       = ["luke@box.net"]

data/doc/Box.html

@@ -99,7 +99,7 @@
 </div>
     
     <div id="footer">
-  Generated on Tue Nov  8 15:32:23 2011 by 
+  Generated on Wed Nov  9 12:40:36 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.9.3).
 </div>

data/doc/Box/Account.html

@@ -194,6 +194,52 @@ permission from the user to let this application use their account.</p>
 <p>Is the account authorized?.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#file-instance_method" title="#file (instance method)">- (Object) <strong>file</strong>(id) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Gets a file object by id.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#folder-instance_method" title="#folder (instance method)">- (Object) <strong>folder</strong>(id) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Gets a folder object by id.</p>
+</div></span>
+  
 </li>
 
       
@@ -493,19 +539,19 @@ permission from the user to let this application use their account.</p>
       <pre class="lines">
 
 
-184
-185
-186
-187
-188
-189
-190
-191
-192
-193</pre>
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 184</span>
+      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 216</span>
 
 <span class='kw'>def</span> <span class='id method_missing'>method_missing</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='comma'>,</span> <span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id block'>block</span><span class='rparen'>)</span>
   <span class='kw'>super</span> <span class='kw'>unless</span> <span class='id authorized?'>authorized?</span>
@@ -829,12 +875,12 @@ passed url and authorize this app before continuing.</p>
       <pre class="lines">
 
 
-170
-171
-172</pre>
+202
+203
+204</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 170</span>
+      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 202</span>
 
 <span class='kw'>def</span> <span class='id authorized?'>authorized?</span>
   <span class='ivar'>@info</span> <span class='op'>!=</span> <span class='kw'>nil</span>
@@ -842,6 +888,160 @@ passed url and authorize this app before continuing.</p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="file-instance_method">
+  
+    - (<tt>Object</tt>) <strong>file</strong>(id) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+  <div class="note notetag">
+    <strong>Note:</strong> 
+    <div class='inline'>
+<p>This file will not know its parent because of API short-comings. If you
+need the tree above this file, use root.find(:type =&gt; 'file', :id =&gt;
+id).first instead.</p>
+</div>
+  </div>
+
+  <div class="note notetag">
+    <strong>Note:</strong> 
+    <div class='inline'>
+<p>This function will return a file regardless of whether it actually exists.
+You will get exceptions if you try to access any info.</p>
+</div>
+  </div>
+
+
+<p>Gets a file object by id.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>id</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The id of the folder to fetch.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+197
+198
+199</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 197</span>
+
+<span class='kw'>def</span> <span class='id file'>file</span><span class='lparen'>(</span><span class='id id'>id</span><span class='rparen'>)</span>
+  <span class='const'>Box</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='ivar'>@api</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='id id'>id</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="folder-instance_method">
+  
+    - (<tt>Object</tt>) <strong>folder</strong>(id) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+  <div class="note notetag">
+    <strong>Note:</strong> 
+    <div class='inline'>
+<p>This folder will not know its parent because of API short-comings. If you
+need the tree above this folder, use root.find(:type =&gt; 'folder', :id
+=&gt; id).first instead.</p>
+</div>
+  </div>
+
+  <div class="note notetag">
+    <strong>Note:</strong> 
+    <div class='inline'>
+<p>This function will return a folder regardless of whether it actually
+exists. You will get exceptions if you try to access any info.</p>
+</div>
+  </div>
+
+
+<p>Gets a folder object by id.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>id</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The id of the folder to fetch.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+181
+182
+183</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 181</span>
+
+<span class='kw'>def</span> <span class='id folder'>folder</span><span class='lparen'>(</span><span class='id id'>id</span><span class='rparen'>)</span>
+  <span class='const'>Box</span><span class='op'>::</span><span class='const'>Folder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='ivar'>@api</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='id id'>id</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -1194,12 +1394,12 @@ and the auth token will no longer work.</p>
       <pre class="lines">
 
 
-195
-196
-197</pre>
+227
+228
+229</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 195</span>
+      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 227</span>
 
 <span class='kw'>def</span> <span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='rparen'>)</span>
   <span class='ivar'>@info</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='id sym'>sym</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='kw'>super</span>
@@ -1263,7 +1463,7 @@ network request will be made if/when the data is requested.</p>
 
 <span class='kw'>def</span> <span class='id root'>root</span>
   <span class='kw'>return</span> <span class='ivar'>@root</span> <span class='kw'>if</span> <span class='ivar'>@root</span>
-  <span class='ivar'>@root</span> <span class='op'>=</span> <span class='const'>Box</span><span class='op'>::</span><span class='const'>Folder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='ivar'>@api</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='int'>0</span><span class='rparen'>)</span>
+  <span class='ivar'>@root</span> <span class='op'>=</span> <span class='id folder'>folder</span><span class='lparen'>(</span><span class='int'>0</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -1312,12 +1512,12 @@ network request will be made if/when the data is requested.</p>
       <pre class="lines">
 
 
-176
-177
-178</pre>
+208
+209
+210</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 176</span>
+      <pre class="code"><span class="info file"># File 'lib/box/account.rb', line 208</span>
 
 <span class='kw'>def</span> <span class='id ticket'>ticket</span>
   <span class='ivar'>@ticket</span> <span class='op'>||=</span> <span class='ivar'>@api</span><span class='period'>.</span><span class='id get_ticket'>get_ticket</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ticket</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
@@ -1332,7 +1532,7 @@ network request will be made if/when the data is requested.</p>
 </div>
     
     <div id="footer">
-  Generated on Tue Nov  8 15:32:23 2011 by 
+  Generated on Wed Nov  9 12:40:37 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.9.3).
 </div>

data/doc/Box/Api.html

@@ -117,7 +117,7 @@ perform. TODO: Link to the site.</p>
     
    
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Api/AccountExceeded.html" title="Box::Api::AccountExceeded (class)">AccountExceeded</a></span>, <span class='object_link'><a href="Api/EmailInvalid.html" title="Box::Api::EmailInvalid (class)">EmailInvalid</a></span>, <span class='object_link'><a href="Api/EmailTaken.html" title="Box::Api::EmailTaken (class)">EmailTaken</a></span>, <span class='object_link'><a href="Api/ErrorStatus.html" title="Box::Api::ErrorStatus (class)">ErrorStatus</a></span>, <span class='object_link'><a href="Api/Exception.html" title="Box::Api::Exception (class)">Exception</a></span>, <span class='object_link'><a href="Api/Generic.html" title="Box::Api::Generic (class)">Generic</a></span>, <span class='object_link'><a href="Api/InvalidFolder.html" title="Box::Api::InvalidFolder (class)">InvalidFolder</a></span>, <span class='object_link'><a href="Api/InvalidInput.html" title="Box::Api::InvalidInput (class)">InvalidInput</a></span>, <span class='object_link'><a href="Api/InvalidName.html" title="Box::Api::InvalidName (class)">InvalidName</a></span>, <span class='object_link'><a href="Api/NameTaken.html" title="Box::Api::NameTaken (class)">NameTaken</a></span>, <span class='object_link'><a href="Api/NoAccess.html" title="Box::Api::NoAccess (class)">NoAccess</a></span>, <span class='object_link'><a href="Api/NoParent.html" title="Box::Api::NoParent (class)">NoParent</a></span>, <span class='object_link'><a href="Api/NotAuthorized.html" title="Box::Api::NotAuthorized (class)">NotAuthorized</a></span>, <span class='object_link'><a href="Api/Restricted.html" title="Box::Api::Restricted (class)">Restricted</a></span>, <span class='object_link'><a href="Api/SizeExceeded.html" title="Box::Api::SizeExceeded (class)">SizeExceeded</a></span>, <span class='object_link'><a href="Api/Unknown.html" title="Box::Api::Unknown (class)">Unknown</a></span>, <span class='object_link'><a href="Api/UnknownResponse.html" title="Box::Api::UnknownResponse (class)">UnknownResponse</a></span>, <span class='object_link'><a href="Api/UploadFailed.html" title="Box::Api::UploadFailed (class)">UploadFailed</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Api/AccountExceeded.html" title="Box::Api::AccountExceeded (class)">AccountExceeded</a></span>, <span class='object_link'><a href="Api/EmailInvalid.html" title="Box::Api::EmailInvalid (class)">EmailInvalid</a></span>, <span class='object_link'><a href="Api/EmailTaken.html" title="Box::Api::EmailTaken (class)">EmailTaken</a></span>, <span class='object_link'><a href="Api/ErrorStatus.html" title="Box::Api::ErrorStatus (class)">ErrorStatus</a></span>, <span class='object_link'><a href="Api/Exception.html" title="Box::Api::Exception (class)">Exception</a></span>, <span class='object_link'><a href="Api/Generic.html" title="Box::Api::Generic (class)">Generic</a></span>, <span class='object_link'><a href="Api/InvalidFolder.html" title="Box::Api::InvalidFolder (class)">InvalidFolder</a></span>, <span class='object_link'><a href="Api/InvalidInput.html" title="Box::Api::InvalidInput (class)">InvalidInput</a></span>, <span class='object_link'><a href="Api/InvalidName.html" title="Box::Api::InvalidName (class)">InvalidName</a></span>, <span class='object_link'><a href="Api/NameTaken.html" title="Box::Api::NameTaken (class)">NameTaken</a></span>, <span class='object_link'><a href="Api/NoAccess.html" title="Box::Api::NoAccess (class)">NoAccess</a></span>, <span class='object_link'><a href="Api/NoParent.html" title="Box::Api::NoParent (class)">NoParent</a></span>, <span class='object_link'><a href="Api/NotAuthorized.html" title="Box::Api::NotAuthorized (class)">NotAuthorized</a></span>, <span class='object_link'><a href="Api/NotShared.html" title="Box::Api::NotShared (class)">NotShared</a></span>, <span class='object_link'><a href="Api/Restricted.html" title="Box::Api::Restricted (class)">Restricted</a></span>, <span class='object_link'><a href="Api/SizeExceeded.html" title="Box::Api::SizeExceeded (class)">SizeExceeded</a></span>, <span class='object_link'><a href="Api/Unknown.html" title="Box::Api::Unknown (class)">Unknown</a></span>, <span class='object_link'><a href="Api/UnknownResponse.html" title="Box::Api::UnknownResponse (class)">UnknownResponse</a></span>, <span class='object_link'><a href="Api/UploadFailed.html" title="Box::Api::UploadFailed (class)">UploadFailed</a></span>
     
   
 </p>
@@ -845,6 +845,75 @@ perform. TODO: Link to the site.</p>
 <p>Set the item description.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#share_private-instance_method" title="#share_private (instance method)">- (Object) <strong>share_private</strong>(target, target_id, emails, options = Hash.new) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Share an item privately, making it accessible only via email.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#share_public-instance_method" title="#share_public (instance method)">- (Object) <strong>share_public</strong>(target, target_id, options = Hash.new) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Share an item publically, making it accessible via a share link.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#unshare_public-instance_method" title="#unshare_public (instance method)">- (Object) <strong>unshare_public</strong>(target, target_id) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Stop sharing an item publically.</p>
+</div></span>
+  
 </li>
 
       
@@ -1226,9 +1295,6 @@ is passed instead, its key is used.</p>
       <pre class="lines">
 
 
-36
-37
-38
 39
 40
 41
@@ -1270,10 +1336,22 @@ is passed instead, its key is used.</p>
 77
 78
 79
-80</pre>
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/box/api/exceptions.rb', line 36</span>
+      <pre class="code"><span class="info file"># File 'lib/box/api/exceptions.rb', line 39</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id get_exception'>get_exception</span><span class='lparen'>(</span><span class='id status'>status</span><span class='rparen'>)</span>
   <span class='kw'>case</span> <span class='id status'>status</span>
@@ -1294,7 +1372,9 @@ is passed instead, its key is used.</p>
   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>get_auth_token_error</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>e_register</span><span class='tstring_end'>&quot;</span></span>
     <span class='const'>Generic</span>
   <span class='comment'># Folder/File specific responses
-</span>  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>e_folder_id</span><span class='tstring_end'>&quot;</span></span>
+</span>  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong_node</span><span class='tstring_end'>&quot;</span></span>
+    <span class='const'>InvalidItem</span>
+  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>e_folder_id</span><span class='tstring_end'>&quot;</span></span>
     <span class='const'>InvalidFolder</span>
   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>no_parent</span><span class='tstring_end'>&quot;</span></span>
     <span class='const'>NoParent</span>
@@ -1316,6 +1396,13 @@ is passed instead, its key is used.</p>
   <span class='comment'># Comment specific responses
 </span>  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>get_comments_error</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>add_comment_error</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>delete_comment_error</span><span class='tstring_end'>&quot;</span></span>
     <span class='const'>Generic</span>
+  <span class='comment'># Sharing specific responses
+</span>  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>file_not_shared</span><span class='tstring_end'>&quot;</span></span>
+    <span class='const'>NotShared</span>
+  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong input params</span><span class='tstring_end'>&quot;</span></span>
+    <span class='const'>InvalidInput</span>
+  <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>share_error</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>unshare_error</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>private_share_error</span><span class='tstring_end'>&quot;</span></span>
+    <span class='const'>Generic</span>
   <span class='kw'>else</span>
     <span class='const'>Unknown</span>
   <span class='kw'>end</span>
@@ -3561,6 +3648,285 @@ key and auth token.</p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="share_private-instance_method">
+  
+    - (<tt>Object</tt>) <strong>share_private</strong>(target, target_id, emails, options = Hash.new) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>Share an item privately, making it accessible only via email.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>target</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The type of item.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>target_id</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The id of the item to share.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>emails</span>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The email addresses of the individuals to share with.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>Hash.new</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Extra options related to notifications. Please read the developer
+documentation for more details.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+353
+354
+355</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/box/api.rb', line 353</span>
+
+<span class='kw'>def</span> <span class='id share_private'>share_private</span><span class='lparen'>(</span><span class='id target'>target</span><span class='comma'>,</span> <span class='id target_id'>target_id</span><span class='comma'>,</span> <span class='id emails'>emails</span><span class='comma'>,</span> <span class='id options'>options</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id new'>new</span><span class='rparen'>)</span>
+  <span class='id query_rest'>query_rest</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>private_share_ok</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:action</span> <span class='op'>=&gt;</span> <span class='symbol'>:private_share</span><span class='comma'>,</span> <span class='symbol'>:target</span> <span class='op'>=&gt;</span> <span class='id target'>target</span><span class='comma'>,</span> <span class='symbol'>:target_id</span> <span class='op'>=&gt;</span> <span class='id target_id'>target_id</span><span class='comma'>,</span> <span class='symbol'>:emails</span> <span class='op'>=&gt;</span> <span class='id emails'>emails</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id merge'>merge</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="share_public-instance_method">
+  
+    - (<tt>Object</tt>) <strong>share_public</strong>(target, target_id, options = Hash.new) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>Share an item publically, making it accessible via a share link.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>target</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The type of item.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>target_id</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The id of the item to share.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>options</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>Hash.new</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Extra options related to notifications. Please read the developer
+documentation for more details.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+341
+342
+343</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/box/api.rb', line 341</span>
+
+<span class='kw'>def</span> <span class='id share_public'>share_public</span><span class='lparen'>(</span><span class='id target'>target</span><span class='comma'>,</span> <span class='id target_id'>target_id</span><span class='comma'>,</span> <span class='id options'>options</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id new'>new</span><span class='rparen'>)</span>
+  <span class='id query_rest'>query_rest</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>share_ok</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:action</span> <span class='op'>=&gt;</span> <span class='symbol'>:public_share</span><span class='comma'>,</span> <span class='symbol'>:target</span> <span class='op'>=&gt;</span> <span class='id target'>target</span><span class='comma'>,</span> <span class='symbol'>:target_id</span> <span class='op'>=&gt;</span> <span class='id target_id'>target_id</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id merge'>merge</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="unshare_public-instance_method">
+  
+    - (<tt>Object</tt>) <strong>unshare_public</strong>(target, target_id) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+<p>Stop sharing an item publically.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>target</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The type of item.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>target_id</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The id of the item to unshare.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+361
+362
+363</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/box/api.rb', line 361</span>
+
+<span class='kw'>def</span> <span class='id unshare_public'>unshare_public</span><span class='lparen'>(</span><span class='id target'>target</span><span class='comma'>,</span> <span class='id target_id'>target_id</span><span class='rparen'>)</span>
+  <span class='id query_rest'>query_rest</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>unshare_ok</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:action</span> <span class='op'>=&gt;</span> <span class='symbol'>:public_unshare</span><span class='comma'>,</span> <span class='symbol'>:target</span> <span class='op'>=&gt;</span> <span class='id target'>target</span><span class='comma'>,</span> <span class='symbol'>:target_id</span> <span class='op'>=&gt;</span> <span class='id target_id'>target_id</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -3722,7 +4088,7 @@ key and auth token.</p>
 </div>
     
     <div id="footer">
-  Generated on Tue Nov  8 15:32:23 2011 by 
+  Generated on Wed Nov  9 12:40:36 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.9.3).
 </div>