RubyGems - zendesk_api - Versions diffs - 1.3.5 → 1.3.7 - Mend

zendesk_api 1.3.5 → 1.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (203) hide show

checksums.yaml +4 -4
data/.travis.yml +2 -2
data/.yardopts +0 -2
data/Gemfile +4 -30
data/Gemfile.lock +38 -80
data/Rakefile +0 -5
data/lib/zendesk_api/actions.rb +3 -2
data/lib/zendesk_api/client.rb +4 -1
data/lib/zendesk_api/collection.rb +4 -0
data/lib/zendesk_api/configuration.rb +2 -0
data/lib/zendesk_api/middleware/request/upload.rb +1 -1
data/lib/zendesk_api/middleware/request/url_based_access_token.rb +26 -0
data/lib/zendesk_api/resources.rb +25 -1
data/lib/zendesk_api/version.rb +1 -1
data/spec/core/client_spec.rb +1 -0
data/spec/core/middleware/request/upload_spec.rb +26 -27
data/spec/core/spec_helper.rb +27 -1
data/spec/live/user_spec.rb +4 -2
data/spec/live/user_view_spec.rb +16 -0
data/spec/live/voice/phone_number_spec.rb +2 -0
data/zendesk_api.gemspec +1 -4
metadata +9 -191
data/Procfile +0 -1
data/bin/zendesk +0 -27
data/config.ru +0 -6
data/config/mongoid.yml +0 -81
data/config/newrelic.yml +0 -255
data/lib/zendesk_api/console/base.rb +0 -12
data/lib/zendesk_api/console/console.rb +0 -144
data/lib/zendesk_api/console/extensions.rb +0 -202
data/lib/zendesk_api/console/options.rb +0 -41
data/lib/zendesk_api/server/base.rb +0 -123
data/lib/zendesk_api/server/docs/account_settings.md +0 -191
data/lib/zendesk_api/server/docs/activity_stream.md +0 -121
data/lib/zendesk_api/server/docs/attachments.md +0 -142
data/lib/zendesk_api/server/docs/autocomplete.md +0 -29
data/lib/zendesk_api/server/docs/automations.md +0 -256
data/lib/zendesk_api/server/docs/categories.md +0 -193
data/lib/zendesk_api/server/docs/changes_roadmap.md +0 -286
data/lib/zendesk_api/server/docs/custom_roles.md +0 -88
data/lib/zendesk_api/server/docs/forum_subscriptions.md +0 -139
data/lib/zendesk_api/server/docs/forums.md +0 -229
data/lib/zendesk_api/server/docs/group_memberships.md +0 -229
data/lib/zendesk_api/server/docs/groups.md +0 -212
data/lib/zendesk_api/server/docs/introduction.md +0 -165
data/lib/zendesk_api/server/docs/job_statuses.md +0 -86
data/lib/zendesk_api/server/docs/locales.md +0 -124
data/lib/zendesk_api/server/docs/macros.md +0 -289
data/lib/zendesk_api/server/docs/organizations.md +0 -271
data/lib/zendesk_api/server/docs/problems.md +0 -117
data/lib/zendesk_api/server/docs/requests.md +0 -274
data/lib/zendesk_api/server/docs/satisfaction_ratings.md +0 -172
data/lib/zendesk_api/server/docs/search.md +0 -106
data/lib/zendesk_api/server/docs/sharing_agreements.md +0 -57
data/lib/zendesk_api/server/docs/side_loading.md +0 -125
data/lib/zendesk_api/server/docs/suspended_tickets.md +0 -184
data/lib/zendesk_api/server/docs/tags.md +0 -145
data/lib/zendesk_api/server/docs/ticket_audits.md +0 -688
data/lib/zendesk_api/server/docs/ticket_export.md +0 -121
data/lib/zendesk_api/server/docs/ticket_fields.md +0 -277
data/lib/zendesk_api/server/docs/ticket_import.md +0 -65
data/lib/zendesk_api/server/docs/ticket_metrics.md +0 -125
data/lib/zendesk_api/server/docs/tickets.md +0 -696
data/lib/zendesk_api/server/docs/topic_comments.md +0 -221
data/lib/zendesk_api/server/docs/topic_subscriptions.md +0 -140
data/lib/zendesk_api/server/docs/topic_votes.md +0 -153
data/lib/zendesk_api/server/docs/topics.md +0 -335
data/lib/zendesk_api/server/docs/triggers.md +0 -264
data/lib/zendesk_api/server/docs/user_identities.md +0 -279
data/lib/zendesk_api/server/docs/users.md +0 -455
data/lib/zendesk_api/server/docs/views.md +0 -644
data/lib/zendesk_api/server/helper.rb +0 -110
data/lib/zendesk_api/server/html_renderer.rb +0 -98
data/lib/zendesk_api/server/models/user_request.rb +0 -16
data/lib/zendesk_api/server/models/zlib_json.rb +0 -13
data/lib/zendesk_api/server/public/config.rb +0 -26
data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +0 -131
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +0 -592
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +0 -979
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +0 -658
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +0 -805
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +0 -606
data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +0 -592
data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +0 -592
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +0 -825
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +0 -1226
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +0 -2606
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +0 -1302
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +0 -392
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +0 -283
data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +0 -878
data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +0 -592
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +0 -1406
data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +0 -823
data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +0 -815
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +0 -357
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +0 -295
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error.html +0 -115
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/ClientError.html +0 -127
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/NetworkError.html +0 -127
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordInvalid.html +0 -371
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordNotFound.html +0 -127
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +0 -1559
data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +0 -979
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +0 -606
data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +0 -979
data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +0 -598
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +0 -598
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +0 -805
data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +0 -724
data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthClient.html +0 -606
data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthToken.html +0 -810
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +0 -1379
data/lib/zendesk_api/server/public/doc/ZendeskAPI/OrganizationField.html +0 -606
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +0 -341
data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +0 -797
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +0 -1189
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +0 -993
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +0 -1263
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +0 -592
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Rule.html +0 -610
data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +0 -679
data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +0 -1327
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +0 -494
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +0 -411
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +0 -462
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +0 -742
data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +0 -598
data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +0 -610
data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +0 -911
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +0 -3094
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +0 -787
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +0 -1039
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +0 -606
data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +0 -606
data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +0 -782
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +0 -1449
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +0 -1122
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +0 -983
data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +0 -1039
data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +0 -979
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +0 -805
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +0 -392
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +0 -287
data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +0 -878
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +0 -1176
data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +0 -3974
data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +0 -926
data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +0 -656
data/lib/zendesk_api/server/public/doc/ZendeskAPI/UserField.html +0 -606
data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +0 -332
data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +0 -1650
data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +0 -592
data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +0 -1744
data/lib/zendesk_api/server/public/doc/_index.html +0 -799
data/lib/zendesk_api/server/public/doc/class_list.html +0 -53
data/lib/zendesk_api/server/public/doc/css/common.css +0 -1
data/lib/zendesk_api/server/public/doc/css/full_list.css +0 -57
data/lib/zendesk_api/server/public/doc/css/style.css +0 -338
data/lib/zendesk_api/server/public/doc/file.Readme.html +0 -137
data/lib/zendesk_api/server/public/doc/file_list.html +0 -55
data/lib/zendesk_api/server/public/doc/frames.html +0 -28
data/lib/zendesk_api/server/public/doc/index.html +0 -137
data/lib/zendesk_api/server/public/doc/js/app.js +0 -214
data/lib/zendesk_api/server/public/doc/js/full_list.js +0 -173
data/lib/zendesk_api/server/public/doc/js/jquery.js +0 -4
data/lib/zendesk_api/server/public/doc/method_list.html +0 -2332
data/lib/zendesk_api/server/public/doc/top-level-namespace.html +0 -112
data/lib/zendesk_api/server/public/favicon.ico +0 -0
data/lib/zendesk_api/server/public/images/glyphicons-halflings-white.png +0 -0
data/lib/zendesk_api/server/public/images/glyphicons-halflings.png +0 -0
data/lib/zendesk_api/server/public/images/spinner.gif +0 -0
data/lib/zendesk_api/server/public/images/zendesk_developers_bg.png +0 -0
data/lib/zendesk_api/server/public/images/zendesk_developers_header.png +0 -0
data/lib/zendesk_api/server/public/javascripts/application.js +0 -186
data/lib/zendesk_api/server/public/javascripts/bootstrap-alert.js +0 -90
data/lib/zendesk_api/server/public/javascripts/bootstrap-button.js +0 -96
data/lib/zendesk_api/server/public/javascripts/bootstrap-carousel.js +0 -169
data/lib/zendesk_api/server/public/javascripts/bootstrap-collapse.js +0 -157
data/lib/zendesk_api/server/public/javascripts/bootstrap-dropdown.js +0 -100
data/lib/zendesk_api/server/public/javascripts/bootstrap-modal.js +0 -218
data/lib/zendesk_api/server/public/javascripts/bootstrap-popover.js +0 -98
data/lib/zendesk_api/server/public/javascripts/bootstrap-scrollspy.js +0 -151
data/lib/zendesk_api/server/public/javascripts/bootstrap-tab.js +0 -135
data/lib/zendesk_api/server/public/javascripts/bootstrap-tooltip.js +0 -275
data/lib/zendesk_api/server/public/javascripts/bootstrap-transition.js +0 -61
data/lib/zendesk_api/server/public/javascripts/bootstrap-typeahead.js +0 -285
data/lib/zendesk_api/server/public/sass/screen.scss +0 -102
data/lib/zendesk_api/server/public/sass/styles.scss +0 -5
data/lib/zendesk_api/server/public/stylesheets/developer.screen.css +0 -836
data/lib/zendesk_api/server/public/stylesheets/screen.css +0 -129
data/lib/zendesk_api/server/public/stylesheets/styles.css +0 -6208
data/lib/zendesk_api/server/templates/footer.haml +0 -13
data/lib/zendesk_api/server/templates/header.haml +0 -20
data/lib/zendesk_api/server/templates/index.haml +0 -68
data/lib/zendesk_api/server/templates/layout.haml +0 -44
data/lib/zendesk_api/server/templates/param.haml +0 -4
data/lib/zendesk_api/server/templates/search.haml +0 -23
data/lib/zendesk_api/server/templates/sidebar.haml +0 -7
data/spec/server/app_spec.rb +0 -140
data/spec/server/helper_spec.rb +0 -97
data/spec/server/html_renderer_spec.rb +0 -130
data/spec/server/spec_helper.rb +0 -43

data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html DELETED Viewed

@@ -1,341 +0,0 @@
-<!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::Read
-    &mdash; Documentation by YARD 0.8.5.2
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
-  relpath = '../';
-  framesUrl = "../frames.html#!" + escape(window.location.href);
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (R)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
-     &raquo;
-    <span class="title">Read</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::Read
-</h1>
-<dl class="box">
-    <dt class="r1">Included in:</dt>
-    <dd class="r1"><span class='object_link'><a href="ReadResource.html" title="ZendeskAPI::ReadResource (class)">ReadResource</a></span>, <span class='object_link'><a href="Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span>, <span class='object_link'><a href="TicketMetric.html" title="ZendeskAPI::TicketMetric (class)">TicketMetric</a></span>, <span class='object_link'><a href="Topic/TopicComment.html" title="ZendeskAPI::Topic::TopicComment (class)">Topic::TopicComment</a></span>, <span class='object_link'><a href="User/TopicComment.html" title="ZendeskAPI::User::TopicComment (class)">User::TopicComment</a></span></dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/zendesk_api/actions.rb</dd>
-</dl>
-<div class="clear"></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="#find-instance_method" title="#find (instance method)">- (Object) <strong>find</strong>(client, options = {}) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Finds, returning nil if it fails.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#find%21-instance_method" title="#find! (instance method)">- (Object) <strong>find!</strong>(client, options = {}) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Finds a resource by an id and any options passed in.</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="find-instance_method">
-    - (<tt>Object</tt>) <strong>find</strong>(client, options = {})
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Finds, returning nil if it fails</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-99
-100
-101
-102
-103</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 99</span>
-<span class='kw'>def</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='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</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='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-<span class='kw'>rescue</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Error</span><span class='op'>::</span><span class='const'>ClientError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
-  <span class='kw'>nil</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="find!-instance_method">
-    - (<tt>Object</tt>) <strong>find!</strong>(client, options = {})
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Finds a resource by an id and any options passed in. A custom path to
-search at can be passed into opts. It defaults to the <span class='object_link'><a href="Data.html#resource_name-class_method" title="ZendeskAPI::Data.resource_name (method)">Data.resource_name</a></span>
-of the class.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>client</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">Client</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The <span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">Client</a></span> object to be used</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>options</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>Any additional GET parameters to be added</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt>ArgumentError</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-80
-81
-82
-83
-84
-85
-86
-87
-88
-89
-90
-91
-92
-93
-94
-95
-96</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 80</span>
-<span class='kw'>def</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='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span> <span class='comment'># so we can use client.logger in rescue
-</span>
-  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>No :id given</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>id</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_ancestors'>ancestors</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='const'>SingularResource</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_association'>association</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:association</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='const'>Association</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='kw'>self</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_includes'>includes</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='rbracket'>]</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_includes'>includes</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_includes'>includes</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
-  <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_generate_path'>generate_path</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
-    <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
-  <span class='kw'>end</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='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='lbracket'>[</span><span class='id identifier rubyid_singular_resource_name'>singular_resource_name</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
-    <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_set_includes'>set_includes</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_includes'>includes</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</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>

data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html DELETED Viewed

@@ -1,797 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Class: ZendeskAPI::ReadResource
-    &mdash; Documentation by YARD 0.8.5.2
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
-  relpath = '../';
-  framesUrl = "../frames.html#!" + escape(window.location.href);
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (R)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
-     &raquo;
-    <span class="title">ReadResource</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-      Class List
-    </a>
-    <a class="full_list_link" id="method_list_link"
-        href="../method_list.html">
-      Method List
-    </a>
-    <a class="full_list_link" id="file_list_link"
-        href="../file_list.html">
-      File List
-    </a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: ZendeskAPI::ReadResource
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName"><span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next"><span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></li>
-            <li class="next"><span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></li>
-            <li class="next">ZendeskAPI::ReadResource</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-      <dt class="r2">Extended by:</dt>
-      <dd class="r2"><span class='object_link'><a href="Read.html" title="ZendeskAPI::Read (module)">Read</a></span></dd>
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/zendesk_api/resource.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>Represents a resource that can only GET</p>
-  </div>
-</div>
-<div class="tags">
-</div><div id="subclasses">
-  <h2>Direct Known Subclasses</h2>
-  <p class="children"><span class='object_link'><a href="JobStatus.html" title="ZendeskAPI::JobStatus (class)">JobStatus</a></span>, <span class='object_link'><a href="Locale.html" title="ZendeskAPI::Locale (class)">Locale</a></span>, <span class='object_link'><a href="OAuthToken.html" title="ZendeskAPI::OAuthToken (class)">OAuthToken</a></span>, <span class='object_link'><a href="Request/Comment.html" title="ZendeskAPI::Request::Comment (class)">ZendeskAPI::Request::Comment</a></span>, <span class='object_link'><a href="SatisfactionRating.html" title="ZendeskAPI::SatisfactionRating (class)">SatisfactionRating</a></span>, <span class='object_link'><a href="SharingAgreement.html" title="ZendeskAPI::SharingAgreement (class)">SharingAgreement</a></span>, <span class='object_link'><a href="SuspendedTicket.html" title="ZendeskAPI::SuspendedTicket (class)">SuspendedTicket</a></span></p>
-</div>
-  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <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="summary_desc"><div class='inline'>
-<p>The association.</p>
-</div></span>
-</li>
-      <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>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>
-<p>The resource's attributes.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong> </a>
-  </span>
-    <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>
-    <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="#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="summary_desc"><div class='inline'>
-<p>Returns the value of attribute error_message.</p>
-</div></span>
-</li>
-      <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="#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>
-    <span class="summary_desc"><div class='inline'>
-<p>Place to dump the last response.</p>
-</div></span>
-</li>
-  </ul>
-    <h2>
-      Class Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#find-class_method" title="#find (class method)">+ (Object) <strong>find</strong>(client, options = {}) </a>
-  </span>
-    <span class="note title not_defined_here">
-      extended
-      from <span class='object_link'><a href="Read.html#find-class_method" title="ZendeskAPI::Read#find (method)">Read</a></span>
-    </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Finds, returning nil if it fails.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#find%21-class_method" title="#find! (class method)">+ (Object) <strong>find!</strong>(client, options = {}) </a>
-  </span>
-    <span class="note title not_defined_here">
-      extended
-      from <span class='object_link'><a href="Read.html#find%21-class_method" title="ZendeskAPI::Read#find! (method)">Read</a></span>
-    </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Finds a resource by an id and any options passed in.</p>
-</div></span>
-</li>
-    </ul>
-  <div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Data.html#initialize-instance_method" title="ZendeskAPI::Data#initialize (method)">ZendeskAPI::Data</a></span></p>
-</div>
-<div id="method_missing_details" class="method_details_list">
-  <h2>Dynamic Method Handling</h2>
-  <p class="notice super">
-    This class handles dynamic methods through the <tt>method_missing</tt> method
-      in the class <span class='object_link'><a href="Data.html#method_missing-instance_method" title="ZendeskAPI::Data#method_missing (method)">ZendeskAPI::Data</a></span>
-  </p>
-</div>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id="association=-instance_method"></span>
-      <div class="method_details first">
-  <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="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 id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="find-class_method">
-    + (<tt>Object</tt>) <strong>find</strong>(client, options = {})
-    <span class="not_defined_here">
-      Originally defined in module
-        <span class='object_link'><a href="Read.html#find-class_method" title="ZendeskAPI::Read#find (method)">Read</a></span>
-    </span>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Finds, returning nil if it fails</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="find!-class_method">
-    + (<tt>Object</tt>) <strong>find!</strong>(client, options = {})
-    <span class="not_defined_here">
-      Originally defined in module
-        <span class='object_link'><a href="Read.html#find%21-class_method" title="ZendeskAPI::Read#find! (method)">Read</a></span>
-    </span>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Finds a resource by an id and any options passed in. A custom path to
-search at can be passed into opts. It defaults to the <span class='object_link'><a href="Data.html#resource_name-class_method" title="ZendeskAPI::Data.resource_name (method)">Data.resource_name</a></span>
-of the class.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>client</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">Client</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The <span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">Client</a></span> object to be used</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>options</span>
-        <span class='type'>(<tt>Hash</tt>)</span>
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>Any additional GET parameters to be added</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt>ArgumentError</tt>)</span>
-    </li>
-</ul>
-</div>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed May 15 18:59:29 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>