Setting.html in zendesk_api-0.4.0.rc1

- old
+ new

@@ -4,11 +4,11 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>
   Class: ZendeskAPI::Setting
   
-    &mdash; Documentation by YARD 0.8.4.1
+    &mdash; Documentation by YARD 0.8.5.2
   
 </title>
 
   <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
 
@@ -111,128 +111,282 @@
   <ul class="summary">
     
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#on-instance_method" title="#on (instance method)">- (Object) <strong>on</strong> </a>
+      <a href="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a>
     
 
     
   </span>
   
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
+    </span>
   
   
+  
     
-      <span class="note title readonly">readonly</span>
     
-    
   
   
   
   
   
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute on.</p>
+<p>The association.</p>
 </div></span>
   
 </li>
 
     
-  </ul>
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#attributes-instance_method" title="#attributes (instance method)">- (Hash) <strong>attributes</strong> </a>
+    
 
-
-
+    
+      (also: #to_param)
+    
+  </span>
   
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
+    </span>
   
-  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">#error</a></span>, <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">#error_message</a></span></p>
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
 
   
+    <span class="summary_desc"><div class='inline'>
+<p>The resource's attributes.</p>
+</div></span>
   
-  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">#association</a></span>, <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">#response</a></span></p>
+</li>
 
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong> </a>
+    
 
+    
+  </span>
   
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span>
+    </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
 
-    <ul class="summary">
-      
-        <li class="public ">
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute error.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Setting) <strong>initialize</strong>(client, attributes = {}) </a>
+      <a href="#error_message-instance_method" title="#error_message (instance method)">- (Object) <strong>error_message</strong> </a>
     
 
     
   </span>
   
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span>
+    </span>
   
-    <span class="note title constructor">constructor</span>
   
   
+    
+    
   
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'>
-<p>A new instance of Setting.</p>
+<p>Returns the value of attribute error_message.</p>
 </div></span>
   
 </li>
 
-      
-    </ul>
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#errors-instance_method" title="#errors (instance method)">- (Array) <strong>errors</strong> </a>
+    
+
+    
+  </span>
   
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
+    </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
 
+  
+    <span class="summary_desc"><div class='inline'>
+<p>The last received errors.</p>
+</div></span>
+  
+</li>
 
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#on-instance_method" title="#on (instance method)">- (Object) <strong>on</strong> </a>
+    
+
+    
+  </span>
   
   
   
+    
+      <span class="note title readonly">readonly</span>
+    
+    
   
   
   
   
   
+
   
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute on.</p>
+</div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
+    
+
+    
+  </span>
   
+    <span class="note title not_defined_here">
+      inherited
+      from <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
+    </span>
   
   
   
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Verbs.html#delete-instance_method" title="ZendeskAPI::Verbs#delete (method)">#delete</a></span>, <span class='object_link'><a href="Verbs.html#post-instance_method" title="ZendeskAPI::Verbs#post (method)">#post</a></span>, <span class='object_link'><a href="Verbs.html#put-instance_method" title="ZendeskAPI::Verbs#put (method)">#put</a></span></p>
+    
+    
+  
+  
+  
+  
+  
 
   
+    <span class="summary_desc"><div class='inline'>
+<p>Place to dump the last response.</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)">- (Setting) <strong>initialize</strong>(client, attributes = {}) </a>
+    
+
+    
+  </span>
   
   
+    <span class="note title constructor">constructor</span>
   
   
   
   
   
   
+
   
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Setting.</p>
+</div></span>
   
+</li>
+
+      
+    </ul>
   
-  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Data.html#%2F-instance_method" title="ZendeskAPI::Data#/ (method)">#/</a></span>, <span class='object_link'><a href="Data.html#%3D%3D-instance_method" title="ZendeskAPI::Data#== (method)">#==</a></span>, <span class='object_link'><a href="Data.html#format-class_method" title="ZendeskAPI::Data.format (method)">format</a></span>, <span class='object_link'><a href="Data.html#id-instance_method" title="ZendeskAPI::Data#id (method)">#id</a></span>, <span class='object_link'><a href="Data.html#method_missing-instance_method" title="ZendeskAPI::Data#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="Data.html#new_record%3F-instance_method" title="ZendeskAPI::Data#new_record? (method)">#new_record?</a></span>, <span class='object_link'><a href="Data.html#path-instance_method" title="ZendeskAPI::Data#path (method)">#path</a></span>, <span class='object_link'><a href="Data.html#resource_name-class_method" title="ZendeskAPI::Data.resource_name (method)">resource_name</a></span>, <span class='object_link'><a href="Data.html#singular_resource_name-class_method" title="ZendeskAPI::Data.singular_resource_name (method)">singular_resource_name</a></span>, <span class='object_link'><a href="Data.html#subclasses-class_method" title="ZendeskAPI::Data.subclasses (method)">subclasses</a></span>, <span class='object_link'><a href="Data.html#to_json-instance_method" title="ZendeskAPI::Data#to_json (method)">#to_json</a></span></p>
 
+
   
   
   
   
   
+  
+  
   <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">
@@ -258,17 +412,17 @@
   <tr>
     <td>
       <pre class="lines">
 
 
-137
-138
-139
-140</pre>
+140
+141
+142
+143</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 137</span>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 140</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</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='ivar'>@on</span> <span class='op'>=</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
   <span class='kw'>super</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='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
@@ -291,14 +445,222 @@
 
   <div id="instance_attr_details" class="attr_details">
     <h2>Instance Attribute Details</h2>
     
       
-      <span id=""></span>
+      <span id="association=-instance_method"></span>
       <div class="method_details first">
-  <h3 class="signature first" id="on-instance_method">
+  <h3 class="signature first" id="association-instance_method">
   
+    - (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong> 
+  
+
+  
+
+  
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
+    </span>
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>The association</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The association</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="attributes-instance_method">
+  
+    - (<tt>Hash</tt>) <strong>attributes</strong>  <span class="extras">(readonly)</span>
+  
+
+  
+    <span class="aliases">Also known as:
+    <span class="names"><span id='to_param-instance_method'>to_param</span></span>
+    </span>
+  
+
+  
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
+    </span>
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>The resource's attributes</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The resource's attributes</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="error=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="error-instance_method">
+  
+    - (<tt>Object</tt>) <strong>error</strong> 
+  
+
+  
+
+  
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span>
+    </span>
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute error</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+</div>
+    
+      
+      <span id="error_message=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="error_message-instance_method">
+  
+    - (<tt>Object</tt>) <strong>error_message</strong> 
+  
+
+  
+
+  
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span>
+    </span>
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute error_message</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+</div>
+    
+      
+      <span id="errors=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="errors-instance_method">
+  
+    - (<tt>Array</tt>) <strong>errors</strong> 
+  
+
+  
+
+  
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
+    </span>
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>The last received errors</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The last received errors</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="on-instance_method">
+  
     - (<tt>Object</tt>) <strong>on</strong>  <span class="extras">(readonly)</span>
   
 
   
 
@@ -318,33 +680,63 @@
   <tr>
     <td>
       <pre class="lines">
 
 
-135
-136
-137</pre>
+138
+139
+140</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 135</span>
+      <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 138</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_on'>on</span>
   <span class='ivar'>@on</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>
     
+      
+      <span id="response=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="response-instance_method">
+  
+    - (<tt>Object</tt>) <strong>response</strong> 
+  
+
+  
+
+  
+    <span class="not_defined_here">
+      Originally defined in class
+        <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
+    </span>
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Place to dump the last response</p>
+
+
   </div>
+</div>
+<div class="tags">
+  
 
+</div>
+</div>
+    
+  </div>
 
+
 </div>
 
     <div id="footer">
-  Generated on Mon Feb 11 17:45:39 2013 by
+  Generated on Wed May 15 18:59:33 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>
 </html>
\ No newline at end of file