<!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>
Module: ZendeskAPI::Verbs
— 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 (V)</a> »
<span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
»
<span class="title">Verbs</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>Module: ZendeskAPI::Verbs
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/zendesk_api/verbs.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Creates put, post, delete class methods for custom resource methods.</p>
</div>
</div>
<div class="tags">
</div>
<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="#delete-instance_method" title="#delete (instance method)">- (Object) <strong>delete</strong>(method) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Executes a delete using the passed in method as a path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#post-instance_method" title="#post (instance method)">- (Object) <strong>post</strong>(method) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Executes a post using the passed in method as a path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#put-instance_method" title="#put (instance method)">- (Object) <strong>put</strong>(method) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Executes a put using the passed in method as a path.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="delete-instance_method">
- (<tt>Object</tt>) <strong>delete</strong>(method)
</h3><div class="docstring">
<div class="discussion">
<p>Executes a delete using the passed in method as a path. Reloads the
resource's attributes if any are in the response body.</p>
<p>Created method takes an optional options hash. Valid options to be passed
in to the created method: reload (for caching, default: false)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/verbs.rb', line 37</span>
<span class='id identifier rubyid_create_verb'>create_verb</span> <span class='symbol'>:delete</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="post-instance_method">
- (<tt>Object</tt>) <strong>post</strong>(method)
</h3><div class="docstring">
<div class="discussion">
<p>Executes a post using the passed in method as a path. Reloads the
resource's attributes if any are in the response body.</p>
<p>Created method takes an optional options hash. Valid options to be passed
in to the created method: reload (for caching, default: false)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/verbs.rb', line 36</span>
<span class='id identifier rubyid_create_verb'>create_verb</span> <span class='symbol'>:post</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="put-instance_method">
- (<tt>Object</tt>) <strong>put</strong>(method)
</h3><div class="docstring">
<div class="discussion">
<p>Executes a put using the passed in method as a path. Reloads the resource's
attributes if any are in the response body.</p>
<p>Created method takes an optional options hash. Valid options to be passed
in to the created method: reload (for caching, default: false)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/zendesk_api/verbs.rb', line 35</span>
<span class='id identifier rubyid_create_verb'>create_verb</span> <span class='symbol'>:put</span></pre>
</td>
</tr>
</table>
</div>
</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>