zendesk_api 0.3.14 → 0.4.0.rc1

data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html

@@ -6,7 +6,7 @@
 <title>
   Module: ZendeskAPI::Destroy
   
-    &mdash; Documentation by YARD 0.8.4.1
+    &mdash; Documentation by YARD 0.8.5.2
   
 </title>
 
@@ -78,7 +78,7 @@
   
   
     <dt class="r1">Included in:</dt>
-    <dd class="r1"><span class='object_link'><a href="DeleteResource.html" title="ZendeskAPI::DeleteResource (class)">DeleteResource</a></span>, <span class='object_link'><a href="Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span>, <span class='object_link'><a href="SuspendedTicket.html" title="ZendeskAPI::SuspendedTicket (class)">SuspendedTicket</a></span>, <span class='object_link'><a href="Topic/TopicComment.html" title="ZendeskAPI::Topic::TopicComment (class)">Topic::TopicComment</a></span></dd>
+    <dd class="r1"><span class='object_link'><a href="DeleteResource.html" title="ZendeskAPI::DeleteResource (class)">DeleteResource</a></span>, <span class='object_link'><a href="OAuthToken.html" title="ZendeskAPI::OAuthToken (class)">OAuthToken</a></span>, <span class='object_link'><a href="Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span>, <span class='object_link'><a href="SuspendedTicket.html" title="ZendeskAPI::SuspendedTicket (class)">SuspendedTicket</a></span>, <span class='object_link'><a href="Topic/TopicComment.html" title="ZendeskAPI::Topic::TopicComment (class)">Topic::TopicComment</a></span>, <span class='object_link'><a href="Upload.html" title="ZendeskAPI::Upload (class)">Upload</a></span></dd>
     
   
   
@@ -116,7 +116,29 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#destroy-instance_method" title="#destroy (instance method)">- (Boolean) <strong>destroy</strong> </a>
+      <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#destroy%21-instance_method" title="#destroy! (instance method)">- (Boolean) <strong>destroy!</strong> </a>
     
 
     
@@ -165,12 +187,6 @@
   
 
 
-  
-  
-  
-  
-  
-  
 
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
@@ -179,7 +195,41 @@
       <div class="method_details first">
   <h3 class="signature first" id="destroy-instance_method">
   
-    - (<tt>Boolean</tt>) <strong>destroy</strong> 
+    - (<tt>Object</tt>) <strong>destroy</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+148
+149
+150
+151
+152</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 148</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
+  <span class='id identifier rubyid_destroy!'>destroy!</span>
+<span class='kw'>rescue</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Error</span><span class='op'>::</span><span class='const'>ClientError</span>
+  <span class='kw'>false</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="destroy!-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>destroy!</strong> 
   
 
   
@@ -220,16 +270,16 @@
       <pre class="lines">
 
 
-148
-149
-150
-151
-152</pre>
+142
+143
+144
+145
+146</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 148</span>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 142</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_destroy!'>destroy!</span>
   <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_destroyed?'>destroyed?</span> <span class='op'>||</span> <span class='id identifier rubyid_new_record?'>new_record?</span>
   <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span> <span class='op'>||</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
   <span class='ivar'>@destroyed</span> <span class='op'>=</span> <span class='kw'>true</span>
@@ -278,12 +328,12 @@
       <pre class="lines">
 
 
-142
-143
-144</pre>
+136
+137
+138</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 142</span>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 136</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_destroyed?'>destroyed?</span>
   <span class='ivar'>@destroyed</span> <span class='op'>||=</span> <span class='kw'>false</span>
@@ -298,9 +348,9 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Feb 11 17:45:36 2013 by
+  Generated on Wed May 15 18:59:28 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.4.1 (ruby-1.9.3).
+  0.8.5.2 (ruby-1.9.3).
 </div>
 
   </body>

data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html

@@ -6,7 +6,7 @@
 <title>
   Module: ZendeskAPI::Destroy::ClassMethod
   
-    &mdash; Documentation by YARD 0.8.4.1
+    &mdash; Documentation by YARD 0.8.5.2
   
 </title>
 
@@ -102,7 +102,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong>(client, opts = {}) </a>
+      <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong>(client, attributes = {}) </a>
     
 
     
@@ -116,17 +116,20 @@
   
 
   
-    <span class="summary_desc"><div class='inline'>
-<p>Deletes a resource given the id passed in.</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'></div></span>
   
 </li>
 
       
-    </ul>
-  
-
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#destroy%21-instance_method" title="#destroy! (instance method)">- (Object) <strong>destroy!</strong>(client, opts = {}) </a>
+    
 
+    
+  </span>
+  
   
   
   
@@ -134,6 +137,19 @@
   
   
 
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Deletes a resource given the id passed in.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
 
@@ -141,7 +157,41 @@
       <div class="method_details first">
   <h3 class="signature first" id="destroy-instance_method">
   
-    - (<tt>Object</tt>) <strong>destroy</strong>(client, opts = {}) 
+    - (<tt>Object</tt>) <strong>destroy</strong>(client, attributes = {}) 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+169
+170
+171
+172
+173</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 169</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_destroy!'>destroy!</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
+<span class='kw'>rescue</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Error</span><span class='op'>::</span><span class='const'>ClientError</span>
+  <span class='kw'>false</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="destroy!-instance_method">
+  
+    - (<tt>Object</tt>) <strong>destroy!</strong>(client, opts = {}) 
   
 
   
@@ -202,21 +252,21 @@
       <pre class="lines">
 
 
+158
+159
+160
+161
 162
 163
 164
 165
 166
-167
-168
-169
-170
-171</pre>
+167</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 162</span>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 158</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_destroy!'>destroy!</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> <span class='comment'># so we can use client.logger in rescue
 </span>  <span class='id identifier rubyid_association'>association</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:association</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='const'>Association</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='kw'>self</span><span class='rparen'>)</span>
 
@@ -236,9 +286,9 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Feb 11 17:45:36 2013 by
+  Generated on Wed May 15 18:59:28 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.4.1 (ruby-1.9.3).
+  0.8.5.2 (ruby-1.9.3).
 </div>
 
   </body>

data/lib/zendesk_api/server/public/doc/ZendeskAPI/{FormatError.html → Error.html}

@@ -4,9 +4,9 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>
-  Exception: ZendeskAPI::FormatError
+  Module: ZendeskAPI::Error
   
-    &mdash; Documentation by YARD 0.8.4.1
+    &mdash; Documentation by YARD 0.8.5.2
   
 </title>
 
@@ -31,10 +31,10 @@
     <div id="header">
       <div id="menu">
   
-    <a href="../_index.html">Index (F)</a> &raquo;
+    <a href="../_index.html">Index (E)</a> &raquo;
     <span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
      &raquo; 
-    <span class="title">FormatError</span>
+    <span class="title">Error</span>
   
 
   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
@@ -63,7 +63,7 @@
 
     <iframe id="search_frame"></iframe>
 
-    <div id="content"><h1>Exception: ZendeskAPI::FormatError
+    <div id="content"><h1>Module: ZendeskAPI::Error
   
   
   
@@ -71,23 +71,6 @@
 
 <dl class="box">
   
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">ArgumentError</span>
-      
-        <ul class="fullTree">
-          <li>Object</li>
-          
-            <li class="next">ArgumentError</li>
-          
-            <li class="next">ZendeskAPI::FormatError</li>
-          
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      
-      </dd>
-    
-  
   
     
   
@@ -95,12 +78,22 @@
   
   
   
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/zendesk_api/console/extensions.rb</dd>
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/zendesk_api/error.rb</dd>
   
 </dl>
 <div class="clear"></div>
 
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Error/ClientError.html" title="ZendeskAPI::Error::ClientError (class)">ClientError</a></span>, <span class='object_link'><a href="Error/NetworkError.html" title="ZendeskAPI::Error::NetworkError (class)">NetworkError</a></span>, <span class='object_link'><a href="Error/RecordInvalid.html" title="ZendeskAPI::Error::RecordInvalid (class)">RecordInvalid</a></span>, <span class='object_link'><a href="Error/RecordNotFound.html" title="ZendeskAPI::Error::RecordNotFound (class)">RecordNotFound</a></span>
+    
+  
+</p>
 
 
 
@@ -109,14 +102,13 @@
 
 
 
-  
 
 </div>
 
     <div id="footer">
-  Generated on Mon Feb 11 17:45:41 2013 by
+  Generated on Wed May 15 18:59:28 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.4.1 (ruby-1.9.3).
+  0.8.5.2 (ruby-1.9.3).
 </div>
 
   </body>

data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/ClientError.html

@@ -0,0 +1,127 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: ZendeskAPI::Error::ClientError
+  
+    &mdash; Documentation by YARD 0.8.5.2
+  
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../';
+  framesUrl = "../../frames.html#!" + escape(window.location.href);
+</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 id="header">
+      <div id="menu">
+  
+    <a href="../../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Error.html" title="ZendeskAPI::Error (module)">Error</a></span></span>
+     &raquo; 
+    <span class="title">ClientError</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: ZendeskAPI::Error::ClientError
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Faraday::Error::ClientError</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Faraday::Error::ClientError</li>
+          
+            <li class="next">ZendeskAPI::Error::ClientError</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/zendesk_api/error.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="NetworkError.html" title="ZendeskAPI::Error::NetworkError (class)">NetworkError</a></span>, <span class='object_link'><a href="RecordInvalid.html" title="ZendeskAPI::Error::RecordInvalid (class)">RecordInvalid</a></span>, <span class='object_link'><a href="RecordNotFound.html" title="ZendeskAPI::Error::RecordNotFound (class)">RecordNotFound</a></span></p>
+</div>
+
+
+
+
+
+
+
+
+  
+
+</div>
+
+    <div id="footer">
+  Generated on Wed May 15 18:59:28 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.5.2 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>