RubyGems - zendesk_api - Versions diffs - 0.2.6 → 0.3.0 - Mend

zendesk_api 0.2.6 → 0.3.0

Files changed (121) hide show

data/lib/zendesk_api/server/public/doc/class_list.html ADDED Viewed

@@ -0,0 +1,53 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+      <link rel="stylesheet" href="css/full_list.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" src="js/jquery.js"></script>
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header">Class List</h1>
+      <div id="nav">
+          <span><a target="_self" href="class_list.html">
+            Classes
+          </a></span>
+          <span><a target="_self" href="method_list.html">
+            Methods
+          </a></span>
+          <span><a target="_self" href="file_list.html">
+            Files
+          </a></span>
+      </div>
+      <div id="search">Search: <input type="text" /></div>
+      <ul id="full_list" class="class">
+        <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
+<li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Ability.html" title="ZendeskAPI::Ability (class)">Ability</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Activity.html" title="ZendeskAPI::Activity (class)">Activity</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Attachment.html" title="ZendeskAPI::Attachment (class)">Attachment</a></span> &lt; Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Automation.html" title="ZendeskAPI::Automation (class)">Automation</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Bookmark.html" title="ZendeskAPI::Bookmark (class)">Bookmark</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CRMData.html" title="ZendeskAPI::CRMData (class)">CRMData</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CRMDataStatus.html" title="ZendeskAPI::CRMDataStatus (class)">CRMDataStatus</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Category.html" title="ZendeskAPI::Category (class)">Category</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Client.html" title="ZendeskAPI::Client (class)">Client</a></span> &lt; Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Collection.html" title="ZendeskAPI::Collection (class)">Collection</a></span> &lt; Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Configuration.html" title="ZendeskAPI::Configuration (class)">Configuration</a></span> &lt; Object<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Console.html" title="ZendeskAPI::Console (module)">Console</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Console/Eval.html" title="ZendeskAPI::Console::Eval (module)">Eval</a></span><small class='search_info'>ZendeskAPI::Console</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Create.html" title="ZendeskAPI::Create (module)">Create</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Create/ClassMethods.html" title="ZendeskAPI::Create::ClassMethods (module)">ClassMethods</a></span><small class='search_info'>ZendeskAPI::Create</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/CreateResource.html" title="ZendeskAPI::CreateResource (class)">CreateResource</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CustomRole.html" title="ZendeskAPI::CustomRole (class)">CustomRole</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Data.html" title="ZendeskAPI::Data (class)">Data</a></span> &lt; Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span> &lt; Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/DeleteResource.html" title="ZendeskAPI::DeleteResource (class)">DeleteResource</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Destroy/ClassMethod.html" title="ZendeskAPI::Destroy::ClassMethod (module)">ClassMethod</a></span><small class='search_info'>ZendeskAPI::Destroy</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/FormatError.html" title="ZendeskAPI::FormatError (class)">FormatError</a></span> &lt; ArgumentError<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Forum.html" title="ZendeskAPI::Forum (class)">Forum</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ForumSubscription.html" title="ZendeskAPI::ForumSubscription (class)">ForumSubscription</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Group.html" title="ZendeskAPI::Group (class)">Group</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/GroupMembership.html" title="ZendeskAPI::GroupMembership (class)">GroupMembership</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/JobStatus.html" title="ZendeskAPI::JobStatus (class)">JobStatus</a></span> &lt; ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Locale.html" title="ZendeskAPI::Locale (class)">Locale</a></span> &lt; ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Macro.html" title="ZendeskAPI::Macro (class)">Macro</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/MobileDevice.html" title="ZendeskAPI::MobileDevice (class)">MobileDevice</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Organization.html" title="ZendeskAPI::Organization (class)">Organization</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Read.html" title="ZendeskAPI::Read (module)">Read</a></span><small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ReadResource.html" title="ZendeskAPI::ReadResource (class)">ReadResource</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Request.html" title="ZendeskAPI::Request (class)">Request</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Request/Comment.html" title="ZendeskAPI::Request::Comment (class)">Comment</a></span> &lt; ReadResource<small class='search_info'>ZendeskAPI::Request</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Role.html" title="ZendeskAPI::Role (class)">Role</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/RuleExecution.html" title="ZendeskAPI::RuleExecution (class)">RuleExecution</a></span> &lt; Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SatisfactionRating.html" title="ZendeskAPI::SatisfactionRating (class)">SatisfactionRating</a></span> &lt; ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Save.html" title="ZendeskAPI::Save (module)">Save</a></span><small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Search.html" title="ZendeskAPI::Search (class)">Search</a></span> &lt; Object<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Search/Result.html" title="ZendeskAPI::Search::Result (class)">Result</a></span> &lt; Data<small class='search_info'>ZendeskAPI::Search</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Server.html" title="ZendeskAPI::Server (module)">Server</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Server/App.html" title="ZendeskAPI::Server::App (class)">App</a></span> &lt; Base<small class='search_info'>ZendeskAPI::Server</small></li><li><span class='object_link'><a href="ZendeskAPI/Server/Helper.html" title="ZendeskAPI::Server::Helper (module)">Helper</a></span><small class='search_info'>ZendeskAPI::Server</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Server/HtmlRenderer.html" title="ZendeskAPI::Server::HtmlRenderer (class)">HtmlRenderer</a></span> &lt; Object<small class='search_info'>ZendeskAPI::Server</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html" title="ZendeskAPI::Server::HtmlRenderer::RedcarpetRenderer (class)">RedcarpetRenderer</a></span> &lt; HTML<small class='search_info'>ZendeskAPI::Server::HtmlRenderer</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Server/UserRequest.html" title="ZendeskAPI::Server::UserRequest (class)">UserRequest</a></span> &lt; Object<small class='search_info'>ZendeskAPI::Server</small></li><li><span class='object_link'><a href="ZendeskAPI/Server/ZlibJSON.html" title="ZendeskAPI::Server::ZlibJSON (class)">ZlibJSON</a></span> &lt; Hash<small class='search_info'>ZendeskAPI::Server</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Setting.html" title="ZendeskAPI::Setting (class)">Setting</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SharingAgreement.html" title="ZendeskAPI::SharingAgreement (class)">SharingAgreement</a></span> &lt; ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SingularResource.html" title="ZendeskAPI::SingularResource (class)">SingularResource</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SuspendedTicket.html" title="ZendeskAPI::SuspendedTicket (class)">SuspendedTicket</a></span> &lt; ReadResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Ticket.html" title="ZendeskAPI::Ticket (class)">Ticket</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Ticket/Audit.html" title="ZendeskAPI::Ticket::Audit (class)">Audit</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI::Ticket</small></li><li><span class='object_link'><a href="ZendeskAPI/Ticket/Comment.html" title="ZendeskAPI::Ticket::Comment (class)">Comment</a></span> &lt; Data<small class='search_info'>ZendeskAPI::Ticket</small></li><li><span class='object_link'><a href="ZendeskAPI/Ticket/Tag.html" title="ZendeskAPI::Ticket::Tag (class)">Tag</a></span> &lt; Resource<small class='search_info'>ZendeskAPI::Ticket</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/TicketField.html" title="ZendeskAPI::TicketField (class)">TicketField</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/TicketMetric.html" title="ZendeskAPI::TicketMetric (class)">TicketMetric</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Topic.html" title="ZendeskAPI::Topic (class)">Topic</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Topic/TopicComment.html" title="ZendeskAPI::Topic::TopicComment (class)">TopicComment</a></span> &lt; TopicComment<small class='search_info'>ZendeskAPI::Topic</small></li><li><span class='object_link'><a href="ZendeskAPI/Topic/TopicVote.html" title="ZendeskAPI::Topic::TopicVote (class)">TopicVote</a></span> &lt; SingularResource<small class='search_info'>ZendeskAPI::Topic</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/TopicComment.html" title="ZendeskAPI::TopicComment (class)">TopicComment</a></span> &lt; Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/TopicSubscription.html" title="ZendeskAPI::TopicSubscription (class)">TopicSubscription</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Trigger.html" title="ZendeskAPI::Trigger (class)">Trigger</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Update.html" title="ZendeskAPI::Update (module)">Update</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Update/ClassMethod.html" title="ZendeskAPI::Update::ClassMethod (module)">ClassMethod</a></span><small class='search_info'>ZendeskAPI::Update</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/UpdateResource.html" title="ZendeskAPI::UpdateResource (class)">UpdateResource</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Upload.html" title="ZendeskAPI::Upload (class)">Upload</a></span> &lt; Data<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/User.html" title="ZendeskAPI::User (class)">User</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/User/Identity.html" title="ZendeskAPI::User::Identity (class)">Identity</a></span> &lt; Resource<small class='search_info'>ZendeskAPI::User</small></li><li><span class='object_link'><a href="ZendeskAPI/User/TopicComment.html" title="ZendeskAPI::User::TopicComment (class)">TopicComment</a></span> &lt; TopicComment<small class='search_info'>ZendeskAPI::User</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span><small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/View.html" title="ZendeskAPI::View (class)">View</a></span> &lt; Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ViewCount.html" title="ZendeskAPI::ViewCount (class)">ViewCount</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ViewRow.html" title="ZendeskAPI::ViewRow (class)">ViewRow</a></span> &lt; DataResource<small class='search_info'>ZendeskAPI</small></li></ul>
+      </ul>
+    </div>
+  </body>
+</html>

data/lib/zendesk_api/server/public/doc/css/common.css ADDED Viewed

	@@ -0,0 +1 @@
1	+ /* Override this file with custom rules */

data/lib/zendesk_api/server/public/doc/css/full_list.css ADDED Viewed

@@ -0,0 +1,57 @@
+body {
+  margin: 0;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+  font-size: 13px;
+  height: 101%;
+  overflow-x: hidden;
+}
+h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
+.clear { clear: both; }
+#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
+#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
+#full_list { padding: 0; list-style: none; margin-left: 0; }
+#full_list ul { padding: 0; }
+#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; }
+#noresults { padding: 7px 12px; }
+#content.insearch #noresults { margin-left: 7px; }
+ul.collapsed ul, ul.collapsed li { display: none; }
+ul.collapsed.search_uncollapsed { display: block; }
+ul.collapsed.search_uncollapsed li { display: list-item; }
+li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
+li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
+li { color: #888; cursor: pointer; }
+li.deprecated { text-decoration: line-through; font-style: italic; }
+li.r1 { background: #f0f0f0; }
+li.r2 { background: #fafafa; }
+li:hover { background: #ddd; }
+li small:before { content: "("; }
+li small:after { content: ")"; }
+li small.search_info { display: none; }
+a:link, a:visited { text-decoration: none; color: #05a; }
+li.clicked { background: #05a; color: #ccc; }
+li.clicked a:link, li.clicked a:visited { color: #eee; }
+li.clicked a.toggle { opacity: 0.5; background-position: bottom right; }
+li.collapsed.clicked a.toggle { background-position: top right; }
+#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
+#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; }
+#nav a:link, #nav a:visited { color: #358; }
+#nav a:hover { background: transparent; color: #5af; }
+.frames #nav span:after { content: ' | '; }
+.frames #nav span:last-child:after { content: ''; }
+.frames #content h1 { margin-top: 0; }
+.frames li { white-space: nowrap; cursor: normal; }
+.frames li small { display: block; font-size: 0.8em; }
+.frames li small:before { content: ""; }
+.frames li small:after { content: ""; }
+.frames li small.search_info { display: none; }
+.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
+.frames #content.insearch #search { background-position: center right; }
+.frames #search input { width: 110px; }
+.frames #nav { display: block; }
+#full_list.insearch li { display: none; }
+#full_list.insearch li.found { display: list-item; padding-left: 10px; }
+#full_list.insearch li a.toggle { display: none; }
+#full_list.insearch li small.search_info { display: block; }

data/lib/zendesk_api/server/public/doc/css/style.css ADDED Viewed

@@ -0,0 +1,328 @@
+body {
+  padding: 0 20px;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+  font-size: 13px;
+}
+body.frames { padding: 0 5px; }
+h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
+h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
+h1.title { margin-bottom: 10px; }
+h1.alphaindex { margin-top: 0; font-size: 22px; }
+h2 {
+  padding: 0;
+  padding-bottom: 3px;
+  border-bottom: 1px #aaa solid;
+  font-size: 1.4em;
+  margin: 1.8em 0 0.5em;
+}
+h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; }
+.clear { clear: both; }
+.inline { display: inline; }
+.inline p:first-child { display: inline; }
+.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
+.docstring h1 { font-size: 1.2em; }
+.docstring h2 { font-size: 1.1em; }
+.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
+.summary_desc .object_link, .docstring .object_link { font-family: monospace; }
+.rdoc-term { padding-right: 25px; font-weight: bold; }
+.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
+/* style for <ul> */
+#filecontents li > p, .docstring li > p { margin: 0px; }
+#filecontents ul, .docstring ul { padding-left: 20px; }
+/* style for <dl> */
+#filecontents dl, .docstring dl { border: 1px solid #ccc; }
+#filecontents dt, .docstring dt { background: #ddd; font-weight: bold; padding: 3px 5px; }
+#filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; }
+#filecontents dd > p, .docstring dd > p { margin: 0px; }
+.note {
+  color: #222;
+  -moz-border-radius: 3px; -webkit-border-radius: 3px;
+  background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
+  display: block;
+}
+.note.todo { background: #ffffc5; border-color: #ececaa; }
+.note.returns_void { background: #efefef; }
+.note.deprecated { background: #ffe5e5; border-color: #e9dada; }
+.note.private { background: #ffffc5; border-color: #ececaa; }
+.note.title { padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
+.summary_signature + .note.title { margin-left: 7px; }
+h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
+.note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; }
+.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; }
+.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; }
+.note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
+.note.title.not_defined_here { background: transparent; border: none; font-style: italic; }
+.discussion .note { margin-top: 6px; }
+.discussion .note:first-child { margin-top: 0; }
+h3.inherited {
+  font-style: italic;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+  font-weight: normal;
+  padding: 0;
+  margin: 0;
+  margin-top: 12px;
+  margin-bottom: 3px;
+  font-size: 13px;
+}
+p.inherited {
+  padding: 0;
+  margin: 0;
+  margin-left: 25px;
+}
+#filecontents dl.box, dl.box {
+  border: 0;
+  width: 520px;
+  font-size: 1em;
+}
+#filecontents dl.box dt, dl.box dt {
+  float: left;
+  display: block;
+  width: 100px;
+  margin: 0;
+  text-align: right;
+  font-weight: bold;
+  background: transparent;
+  border: 1px solid #aaa;
+  border-width: 1px 0px 0px 1px;
+  padding: 6px 0;
+  padding-right: 10px;
+}
+#filecontents dl.box dd, dl.box dd {
+  float: left;
+  display: block;
+  width: 380px;
+  margin: 0;
+  padding: 6px 0;
+  padding-right: 20px;
+  border: 1px solid #aaa;
+  border-width: 1px 1px 0 0;
+}
+#filecontents dl.box .last, dl.box .last {
+  border-bottom: 1px solid #aaa;
+}
+#filecontents dl.box .r1, dl.box .r1 { background: #eee; }
+ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
+.index_inline_list { padding-left: 0; font-size: 1.1em; }
+.index_inline_list li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+dl.constants { margin-left: 40px; }
+dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
+dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
+.summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
+.summary_desc tt { font-size: 0.9em; }
+dl.constants .note { padding: 2px 6px; padding-right: 12px; margin-top: 6px; }
+dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
+dl.constants .tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; }
+dl.constants .discussion *:first-child { margin-top: 0; }
+dl.constants .discussion *:last-child { margin-bottom: 0; }
+.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
+.method_details.first { border: 0; }
+p.signature, h3.signature {
+  font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
+  padding: 6px 10px; margin-top: 18px;
+  background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+p.signature tt,
+h3.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
+p.signature .overload,
+h3.signature .overload { display: block; }
+p.signature .extras,
+h3.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
+p.signature .not_defined_here,
+h3.signature .not_defined_here,
+p.signature .aliases,
+h3.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
+p.signature .aliases .names,
+h3.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
+.tags .tag_title { font-size: 1em; margin-bottom: 0; font-weight: bold; }
+.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
+.tags ul li { margin-bottom: 3px; }
+.tags ul .name { font-family: monospace; font-weight: bold; }
+.tags ul .note { padding: 3px 6px; }
+.tags { margin-bottom: 12px; }
+.tags .examples .tag_title { margin-bottom: 10px; font-weight: bold; }
+.tags .examples .inline p { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
+.tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
+.tags .overload .overload_item .signature {
+  padding: 2px 8px;
+  background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
+.tags .overload .docstring { margin-top: 15px; }
+.defines { display: none; }
+#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
+.showSource { font-size: 0.9em; }
+.showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
+#content a:link, #content a:visited { text-decoration: none; color: #05a; }
+#content a:hover { background: #ffffa5; }
+div.docstring, p.docstring { margin-right: 6em; }
+ul.summary {
+  list-style: none;
+  font-family: monospace;
+  font-size: 1em;
+  line-height: 1.5em;
+}
+ul.summary a:link, ul.summary a:visited {
+  text-decoration: none; font-size: 1.1em;
+}
+ul.summary li { margin-bottom: 5px; }
+.summary .summary_signature {
+  padding: 1px 10px;
+  background: #eaeaff; border: 1px solid #dfdfe5;
+  -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+.summary_signature:hover { background: #eeeeff; cursor: pointer; }
+ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
+ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
+#content .summary_signature:hover a:link,
+#content .summary_signature:hover a:visited {
+  background: transparent;
+  color: #48f;
+}
+p.inherited a { font-family: monospace; font-size: 0.9em; }
+p.inherited { word-spacing: 5px; font-size: 1.2em; }
+p.children { font-size: 1.2em; }
+p.children a { font-size: 0.9em; }
+p.children strong { font-size: 0.8em; }
+p.children strong.modules { padding-left: 5px; }
+ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
+ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
+ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; }
+ul.fullTree li:first-child { padding-top: 0; background: transparent; }
+ul.fullTree li:last-child { padding-bottom: 0; }
+.showAll ul.fullTree { display: block; }
+.showAll .inheritName { display: none; }
+#search { position: absolute; right: 14px; top: 0px; }
+#search a:link, #search a:visited {
+  display: block; float: left; margin-right: 4px;
+  padding: 8px 10px; text-decoration: none; color: #05a;
+  border: 1px solid #d8d8e5;
+  -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px;
+  -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
+  background: #eaf0ff;
+  -webkit-box-shadow: -1px 1px 3px #ddd;
+}
+#search a:hover { background: #f5faff; color: #06b; }
+#search a.active {
+  background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457;
+  -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
+  -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
+}
+#search a.inactive { color: #999; }
+.frames #search { display: none; }
+.inheritanceTree, .toggleDefines { float: right; }
+#menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
+#menu .title, #menu a { font-size: 0.7em; }
+#menu .title a { font-size: 1em; }
+#menu .title { color: #555; }
+#menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
+#menu a:hover { color: #05a; }
+#menu .noframes { display: inline; }
+.frames #menu .noframes { display: inline; float: right; }
+#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
+#footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
+#footer a:hover { color: #05a; }
+#listing ul.alpha { font-size: 1.1em; }
+#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
+#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
+#listing ul.alpha ul { margin: 0; padding-left: 15px; }
+#listing ul small { color: #666; font-size: 0.7em; }
+li.r1 { background: #f0f0f0; }
+li.r2 { background: #fafafa; }
+#search_frame {
+  z-index: 9999;
+  background: #fff;
+  display: none;
+  position: absolute;
+  top: 36px;
+  right: 18px;
+  width: 500px;
+  height: 80%;
+  overflow-y: scroll;
+  border: 1px solid #999;
+  border-collapse: collapse;
+  -webkit-box-shadow: -7px 5px 25px #aaa;
+  -moz-box-shadow: -7px 5px 25px #aaa;
+  -moz-border-radius: 2px;
+  -webkit-border-radius: 2px;
+}
+#content ul.summary li.deprecated .summary_signature a:link,
+#content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
+#toc {
+  padding: 20px; padding-right: 30px; border: 1px solid #ddd; float: right; background: #fff; margin-left: 20px; margin-bottom: 20px;
+  max-width: 300px;
+  -webkit-box-shadow: -2px 2px 6px #bbb;
+  -moz-box-shadow: -2px 2px 6px #bbb;
+  z-index: 5000;
+  position: relative;
+}
+#toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; }
+#toc.nofloat.hidden { padding: 0; background: 0; margin-bottom: 5px; }
+#toc .title { margin: 0; }
+#toc ol { padding-left: 1.8em; }
+#toc li { font-size: 1.1em; line-height: 1.7em; }
+#toc > ol > li { font-size: 1.1em; font-weight: bold; }
+#toc ol > ol { font-size: 0.9em; }
+#toc ol ol > ol { padding-left: 2.3em; }
+#toc ol + li { margin-top: 0.3em; }
+#toc.hidden { padding: 10px; background: #f6f6f6; -webkit-box-shadow: none; -moz-box-shadow: none; }
+#filecontents h1 + #toc.nofloat { margin-top: 0; }
+/* syntax highlighting */
+.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
+#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
+#filecontents pre.code, .docstring pre.code { display: block; }
+.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
+#filecontents pre.code, .docstring pre.code,
+.tags pre.example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
+pre.code { color: #000; }
+pre.code .info.file { color: #555; }
+pre.code .val { color: #036A07; }
+pre.code .tstring_content,
+pre.code .heredoc_beg, pre.code .heredoc_end,
+pre.code .qwords_beg, pre.code .qwords_end,
+pre.code .tstring, pre.code .dstring { color: #036A07; }
+pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s,
+pre.code .rubyid_to_sym, pre.code .rubyid_to_f,
+pre.code .dot + pre.code .id,
+pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
+pre.code .comment { color: #0066FF; }
+pre.code .const, pre.code .constant { color: #585CF6; }
+pre.code .symbol { color: #C5060B; }
+pre.code .kw,
+pre.code .label,
+pre.code .rubyid_require,
+pre.code .rubyid_extend,
+pre.code .rubyid_include { color: #0000FF; }
+pre.code .ivar { color: #318495; }
+pre.code .gvar,
+pre.code .rubyid_backref,
+pre.code .rubyid_nth_ref { color: #6D79DE; }
+pre.code .regexp, .dregexp { color: #036A07; }
+pre.code a { border-bottom: 1px dotted #bbf; }

data/lib/zendesk_api/server/public/doc/file.Readme.html ADDED Viewed

@@ -0,0 +1,377 @@
+<!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=US-ASCII" />
+<title>
+  File: Readme
+    &mdash; Documentation by YARD 0.8.4.1
+</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</a> &raquo;
+    <span class="title">File: Readme</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"><div id='filecontents'><h1>Zendesk API Client</h1>
+<h2>API version support</h2>
+<p>This client <strong>only</strong> supports Zendesk&#39;s v2 API.  Please see our <a href="http://developer.zendesk.com">API documentation</a> for more information.</p>
+<h2>Additional Documentation</h2>
+<p>Additional documentation can be found on <a href="http://rubydoc.info/gems/zendesk_api/frames">rubydoc.info</a></p>
+<h2>Important Notice</h2>
+<p>Version 0.0.5 brings with it a change to the top-level namespace. All references to Zendesk should now use ZendeskAPI.</p>
+<h2>Installation</h2>
+<p>The Zendesk API client can be installed using Rubygems or Bundler.</p>
+<h3>Rubygems</h3>
+<pre class="code sh"><code class="sh">gem install zendesk_api
+</code></pre>
+<h3>Bundler</h3>
+<p>Add it to your Gemfile</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>zendesk_api</span><span class='tstring_end'>&quot;</span></span>
+</code></pre>
+<p>and follow normal <a href="http://gembundler.com/">Bundler</a> installation and execution procedures.</p>
+<h2>Configuration</h2>
+<p>Configuration is done through a block returning an instance of ZendeskAPI::Client.
+The block is mandatory and if not passed, an ArgumentError will be thrown.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>zendesk_api</span><span class='tstring_end'>'</span></span>
+<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
+  <span class='comment'># Mandatory:
+</span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;- your-zendesk-url -&gt;</span><span class='tstring_end'>&quot;</span></span> <span class='comment'># e.g. https://mydesk.zendesk.com/api/v2
+</span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_username'>username</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>login.email@zendesk.com</span><span class='tstring_end'>&quot;</span></span>
+  <span class='comment'># Choose one of the following depending on your authentication choice
+</span>  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your zendesk token</span><span class='tstring_end'>&quot;</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_password'>password</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your zendesk password</span><span class='tstring_end'>&quot;</span></span>
+  <span class='comment'># Optional:
+</span>
+  <span class='comment'># Retry uses middleware to notify the user
+</span>  <span class='comment'># when hitting the rate limit, sleep automatically,
+</span>  <span class='comment'># then retry the request.
+</span>  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_retry'>retry</span> <span class='op'>=</span> <span class='kw'>true</span>
+  <span class='comment'># Logger prints to STDERR by default, to e.g. print to stdout:
+</span>  <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>logger</span><span class='tstring_end'>'</span></span>
+  <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>STDOUT</span><span class='rparen'>)</span>
+  <span class='comment'># Changes Faraday adapter
+</span>  <span class='comment'># config.adapter = :patron
+</span>
+  <span class='comment'># Merged with the default client options hash
+</span>  <span class='comment'># config.client_options = { :ssl =&gt; false }
+</span>
+  <span class='comment'># When getting the error 'hostname does not match the server certificate'
+</span>  <span class='comment'># use the API at https://yoursubdomain.zendesk.com/api/v2
+</span><span class='kw'>end</span>
+</code></pre>
+<p>Note: This ZendeskAPI API client only supports basic authentication at the moment.</p>
+<h2>Usage</h2>
+<p>The result of configuration is an instance of ZendeskAPI::Client which can then be used in two different methods.</p>
+<p>One way to use the client is to pass it in as an argument to individual classes.</p>
+<pre class="code ruby"><code class="ruby"><span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:priority</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>urgent</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># doesn't actually send a request, must explicitly call #save
+</span><span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:subject</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Test Ticket</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:comment</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='symbol'>:value</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>This is a test</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:submitter_id</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_current_user'>current_user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='symbol'>:priority</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>urgent</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='rparen'>)</span>
+<span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='rparen'>)</span>
+</code></pre>
+<p>Another way is to use the instance methods under client.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='symbol'>:subject</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Test Ticket</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:comment</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='symbol'>:value</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>This is a test</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:submitter_id</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_current_user'>current_user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='symbol'>:priority</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>urgent</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='rparen'>)</span>
+</code></pre>
+<p>The methods under ZendeskAPI::Client (such as .tickets) return an instance of ZendeskAPI::Collection a lazy-loaded list of that resource.
+Actual requests may not be sent until an explicit ZendeskAPI::Collection#fetch, ZendeskAPI::Collection#to_a, or an applicable methods such
+as #each.</p>
+<h3>Caveats</h3>
+<p>Resource updating is implemented by sending only the <code>changed?</code> attributes to the server (see <code>ZendeskAPI::TrackChanges</code>).
+Unfortunately, this module only hooks into <code>Hash</code> meaning any changes to an <code>Array</code>not resulting in a new instance will not be tracked and sent.</p>
+<pre class="code ruby"><code class="ruby">zendesk_api_client_rb $ bundle console
+&gt; a = ZendeskAPI::Trackie.new(:tags =&gt; []).tap(&amp;:clear_changes)
+&gt; a.changed?(:tags)
+ =&gt; false
+&gt; a.tags &lt;&lt; &quot;my_new_tag&quot;
+ =&gt; [&quot;my_new_tag&quot;]
+&gt; a.changed?(:tags)
+ =&gt; false
+&gt; a.tags += %w{my_other_tag}
+ =&gt; [&quot;my_new_tag&quot;, &quot;my_other_tag&quot;]
+&gt; a.changed?(:tags)
+ =&gt; true
+</code></pre>
+<h3>Pagination</h3>
+<p>ZendeskAPI::Collections can be paginated:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_tickets'>tickets</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_per_page'>per_page</span><span class='lparen'>(</span><span class='int'>3</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_next_page'>next_page</span> <span class='op'>=</span> <span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
+<span class='id identifier rubyid_previous_page'>previous_page</span> <span class='op'>=</span> <span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_prev'>prev</span>
+</code></pre>
+<p>Iteration over all resources and pages is handled by Collection#page_page</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_each_page'>each_page</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
+  <span class='comment'># all resources will be yielded
+</span><span class='kw'>end</span>
+</code></pre>
+<p>If given a block with two arguments, the page is also passed in.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_each_page'>each_page</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_page'>page</span><span class='op'>|</span>
+  <span class='comment'># all resources will be yielded along with the page
+</span><span class='kw'>end</span>
+</code></pre>
+<h3>Callbacks</h3>
+<p>Callbacks can be added to the ZendeskAPI::Client instance and will be called (with the response env) after all response middleware on a successful request.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_insert_callback'>insert_callback</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_env'>env</span><span class='op'>|</span>
+  <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span>
+<span class='kw'>end</span>
+</code></pre>
+<h3>Resource management</h3>
+<p>Individual resources can be created, modified, saved, and destroyed.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ticket'>ticket</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='comment'># ZendeskAPI::Ticket.find(client, :id =&gt; 1)
+</span><span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>urgent</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span> <span class='comment'># =&gt; { &quot;priority&quot; =&gt; &quot;urgent&quot; }
+</span><span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># Will PUT =&gt; true
+</span><span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span> <span class='comment'># =&gt; true
+</span>
+<span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:priority</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>urgent</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_new_record?'>new_record?</span> <span class='comment'># =&gt; true
+</span><span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># Will POST
+</span></code></pre>
+<h3>Side-loading</h3>
+<p><strong>Warning: this is an experimental feature. Abuse it and lose it.</strong></p>
+<p>To facilitate a smaller number of requests and easier manipulation of associated data we allow &quot;side-loading&quot;, or inclusion, of selected resources.</p>
+<p>For example:
+A ZendeskAPI::Ticket is associated with ZendeskAPI::User through the requester_id field.
+API requests for that ticket return a structure similar to this:
+<code>json
+&quot;ticket&quot;: {
+  &quot;id&quot;: 1,
+  &quot;url&quot;: &quot;http.....&quot;,
+  &quot;requester_id&quot;: 7,
+  ...
+}
+</code></p>
+<p>Calling ZendeskAPI::Ticket#requester automatically fetches and loads the user referenced above (<code>/api/v2/users/7</code>).
+Using side-loading, however, the user can be partially loaded in the same request as the ticket.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_tickets'>tickets</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='symbol'>:users</span><span class='rparen'>)</span>
+<span class='comment'># Or client.tickets(include: :users)
+</span><span class='comment'># Does *NOT* make a request to the server since it is already loaded
+</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_requester'>requester</span> <span class='comment'># =&gt; #&lt;ZendeskAPI::User id=...&gt;
+</span></code></pre>
+<p>OR</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ticket'>ticket</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:include</span> <span class='op'>=&gt;</span> <span class='symbol'>:users</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_requester'>requester</span> <span class='comment'># =&gt; #&lt;ZendeskAPI::User id=...&gt;
+</span></code></pre>
+<p>Currently, this feature is limited to only a few resources and their associations.
+They are documented on <a href="http://developer.zendesk.com/documentation/rest_api/introduction.html#side-loading-(beta)">developer.zendesk.com</a>.</p>
+<h3>Search</h3>
+<p>Searching is done through the client. Returned is an instance of ZendeskAPI::Collection:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='symbol'>:query</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>my search query</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># /api/v2/search.json?query=...
+</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='symbol'>:query</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>my new query</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>  <span class='comment'># /api/v2/users/search.json?query=...
+</span></code></pre>
+<h3>Special case: Custom resources paths</h3>
+<p>API endpoints such as tickets/recent or topics/show_many can be accessed through chaining.
+They will too return an instance of ZendeskAPI::Collection.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_recent'>recent</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_topics'>topics</span><span class='period'>.</span><span class='id identifier rubyid_show_many'>show_many</span><span class='lparen'>(</span><span class='symbol'>:verb</span> <span class='op'>=&gt;</span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='symbol'>:ids</span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+</code></pre>
+<h3>Special Case: Current user</h3>
+<p>Use either of the following to obtain the current user instance:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>me</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_current_user'>current_user</span>
+</code></pre>
+<h3>Special Case: Importing a ticket</h3>
+<p>Bulk importing tickets allows you to move large amounts of data into Zendesk.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ticket'>ticket</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_import'>import</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:subject</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Help</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:comments</span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='lbrace'>{</span> <span class='symbol'>:author_id</span> <span class='op'>=&gt;</span> <span class='int'>19</span><span class='comma'>,</span> <span class='symbol'>:value</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>This is a comment</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+</code></pre>
+<p><a href="http://developer.zendesk.com/documentation/rest_api/ticket_import.html">http://developer.zendesk.com/documentation/rest_api/ticket_import.html</a></p>
+<h3>Attaching files</h3>
+<p>Files can be attached to ticket comments using either a path or the File class and will
+be automatically uploaded and attached.</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ticket'>ticket</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:comment</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='symbol'>:value</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>attachments</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_comment'>comment</span><span class='period'>.</span><span class='id identifier rubyid_uploads'>uploads</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>img.jpg</span><span class='tstring_end'>&quot;</span></span>
+<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_comment'>comment</span><span class='period'>.</span><span class='id identifier rubyid_uploads'>uploads</span> <span class='op'>&lt;&lt;</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>img.jpg</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
+</code></pre>
+<h2>Extras</h2>
+<p>The following projects are still works in progress and require checking out the repository,
+using ruby 1.9.3, and running <code>bundle install</code>.</p>
+<h3>Zendesk API Test Server</h3>
+<p>Included in this repository is the code for the <a href="https://zendesk-api.herokuapp.com/">Zendesk API Tester</a> website.</p>
+<pre class="code sh"><code class="sh">bin/zendesk server --help
+</code></pre>
+<p>Additional Dependencies:</p>
+<ul>
+<li>sinatra</li>
+<li>sinatra-contrib</li>
+<li>haml</li>
+<li>compass</li>
+<li>coderay</li>
+<li>coderay_bash</li>
+<li>redcarpet</li>
+<li>mongoid (and a working MongoDB instance)</li>
+</ul>
+<h3>Zendesk Console</h3>
+<p>WIP</p>
+<pre class="code sh"><code class="sh">bin/zendesk console --help
+</code></pre>
+<p>Additional Dependencies:</p>
+<ul>
+<li>ripl</li>
+</ul>
+<h2>Note on Patches/Pull Requests</h2>
+<ol>
+<li>Fork the project.</li>
+<li>Make your feature addition or bug fix.</li>
+<li>Add tests for it. This is important so I don&#39;t break it in a future version
+unintentionally.</li>
+<li>Commit, do not mess with rakefile, version, or history. (if you want to have
+your own version, that is fine but bump version in a commit by itself I can
+ignore when I pull)</li>
+<li>Send me a pull request. Bonus points for topic branches.</li>
+</ol>
+<h2>Supported Ruby Versions</h2>
+<p>Tested with Ruby 1.8.7 and 1.9.3
+<a href="http://travis-ci.org/zendesk/zendesk_api_client_rb"><img src="https://secure.travis-ci.org/zendesk/zendesk_api_client_rb.png?branch=master" alt="Build Status"></a></p>
+<h2>Copyright</h2>
+<p>See <a href="https://github.com/zendesk/zendesk_api_client_rb/blob/master/LICENSE">LICENSE</a></p>
+</div></div>
+    <div id="footer">
+  Generated on Mon Feb 11 17:45:36 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).
+</div>
+  </body>
+</html>