zendesk_api 1.3.5 → 1.3.7
Sign up to get free protection for your applications and to get access to all the features.
- 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
@@ -1,137 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
-
<head>
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
|
6
|
-
<title>
|
7
|
-
File: Readme
|
8
|
-
|
9
|
-
— Documentation by YARD 0.8.5.2
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
hasFrames = window.top.frames.main ? true : false;
|
19
|
-
relpath = '';
|
20
|
-
framesUrl = "frames.html#!" + escape(window.location.href);
|
21
|
-
</script>
|
22
|
-
|
23
|
-
|
24
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
25
|
-
|
26
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
27
|
-
|
28
|
-
|
29
|
-
</head>
|
30
|
-
<body>
|
31
|
-
<div id="header">
|
32
|
-
<div id="menu">
|
33
|
-
|
34
|
-
<a href="_index.html">Index</a> »
|
35
|
-
<span class="title">File: Readme</span>
|
36
|
-
|
37
|
-
|
38
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
|
-
</div>
|
40
|
-
|
41
|
-
<div id="search">
|
42
|
-
|
43
|
-
<a class="full_list_link" id="class_list_link"
|
44
|
-
href="class_list.html">
|
45
|
-
Class List
|
46
|
-
</a>
|
47
|
-
|
48
|
-
<a class="full_list_link" id="method_list_link"
|
49
|
-
href="method_list.html">
|
50
|
-
Method List
|
51
|
-
</a>
|
52
|
-
|
53
|
-
<a class="full_list_link" id="file_list_link"
|
54
|
-
href="file_list.html">
|
55
|
-
File List
|
56
|
-
</a>
|
57
|
-
|
58
|
-
</div>
|
59
|
-
<div class="clear"></div>
|
60
|
-
</div>
|
61
|
-
|
62
|
-
<iframe id="search_frame"></iframe>
|
63
|
-
|
64
|
-
<div id="content"><div id='filecontents'><h1>Zendesk API Client</h1>
|
65
|
-
|
66
|
-
<h2>API version support</h2>
|
67
|
-
|
68
|
-
<p>This client <strong>only</strong> supports Zendesk's v2 API. Please see our <a href="http://developer.zendesk.com">API documentation</a> for more information.</p>
|
69
|
-
|
70
|
-
<h2>Documentation</h2>
|
71
|
-
|
72
|
-
<p>Please check out the <a href="https://github.com/zendesk/zendesk_api_client_rb/wiki">wiki</a>, <a href="https://zendesk-api.herokuapp.com/doc/index.html">class documentation</a>, and <a href="https://github.com/zendesk/zendesk_api_client_rb/issues">issues</a> before reporting a bug or asking for help.</p>
|
73
|
-
|
74
|
-
<h2>Important Notices</h2>
|
75
|
-
|
76
|
-
<ul>
|
77
|
-
<li>Version 0.0.5 brings with it a change to the top-level namespace. All references to Zendesk should now use ZendeskAPI.</li>
|
78
|
-
<li>Version 0.3.0 changed the license from MIT to Apache Version 2.</li>
|
79
|
-
<li>Version 0.3.2 introduced a regression when side-loading roles on users. This was fixed in 0.3.4.</li>
|
80
|
-
</ul>
|
81
|
-
|
82
|
-
<h2>Installation</h2>
|
83
|
-
|
84
|
-
<p>The Zendesk API client can be installed using Rubygems or Bundler.</p>
|
85
|
-
|
86
|
-
<h3>Rubygems</h3>
|
87
|
-
|
88
|
-
<pre class="code sh"><code class="sh">gem install zendesk_api
|
89
|
-
</code></pre>
|
90
|
-
|
91
|
-
<h3>Bundler</h3>
|
92
|
-
|
93
|
-
<p>Add it to your Gemfile</p>
|
94
|
-
|
95
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>zendesk_api</span><span class='tstring_end'>"</span></span>
|
96
|
-
</code></pre>
|
97
|
-
|
98
|
-
<p>and follow normal <a href="http://gembundler.com/">Bundler</a> installation and execution procedures.</p>
|
99
|
-
|
100
|
-
<h2>Note on Patches/Pull Requests</h2>
|
101
|
-
|
102
|
-
<ol>
|
103
|
-
<li>Fork the project.</li>
|
104
|
-
<li>Make your feature addition or bug fix.</li>
|
105
|
-
<li>Add tests for it. This is important so I don't break it in a future version
|
106
|
-
unintentionally.</li>
|
107
|
-
<li>Commit, do not mess with rakefile, version, or history. (if you want to have
|
108
|
-
your own version, that is fine but bump version in a commit by itself I can
|
109
|
-
ignore when I pull)</li>
|
110
|
-
<li>Send me a pull request. Bonus points for topic branches.</li>
|
111
|
-
</ol>
|
112
|
-
|
113
|
-
<h2>Supported Ruby Versions</h2>
|
114
|
-
|
115
|
-
<p>Tested with Ruby 1.8.7 and 1.9.3
|
116
|
-
<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>
|
117
|
-
|
118
|
-
<h2>Copyright and license</h2>
|
119
|
-
|
120
|
-
<p>Copyright 2013 Zendesk</p>
|
121
|
-
|
122
|
-
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
123
|
-
You may obtain a copy of the License at</p>
|
124
|
-
|
125
|
-
<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
|
126
|
-
|
127
|
-
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p>
|
128
|
-
</div></div>
|
129
|
-
|
130
|
-
<div id="footer">
|
131
|
-
Generated on Wed May 15 18:59:28 2013 by
|
132
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
133
|
-
0.8.5.2 (ruby-1.9.3).
|
134
|
-
</div>
|
135
|
-
|
136
|
-
</body>
|
137
|
-
</html>
|
@@ -1,55 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html>
|
4
|
-
<head>
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
-
|
7
|
-
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
-
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
-
|
15
|
-
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
-
|
17
|
-
|
18
|
-
<base id="base_target" target="_parent" />
|
19
|
-
</head>
|
20
|
-
<body>
|
21
|
-
<script type="text/javascript" charset="utf-8">
|
22
|
-
if (window.top.frames.main) {
|
23
|
-
document.getElementById('base_target').target = 'main';
|
24
|
-
document.body.className = 'frames';
|
25
|
-
}
|
26
|
-
</script>
|
27
|
-
<div id="content">
|
28
|
-
<h1 id="full_list_header">File List</h1>
|
29
|
-
<div id="nav">
|
30
|
-
|
31
|
-
<span><a target="_self" href="class_list.html">
|
32
|
-
Classes
|
33
|
-
</a></span>
|
34
|
-
|
35
|
-
<span><a target="_self" href="method_list.html">
|
36
|
-
Methods
|
37
|
-
</a></span>
|
38
|
-
|
39
|
-
<span><a target="_self" href="file_list.html">
|
40
|
-
Files
|
41
|
-
</a></span>
|
42
|
-
|
43
|
-
</div>
|
44
|
-
<div id="search">Search: <input type="text" /></div>
|
45
|
-
|
46
|
-
<ul id="full_list" class="file">
|
47
|
-
|
48
|
-
|
49
|
-
<li class="r1"><a href="index.html" title="Readme">Readme</a></li>
|
50
|
-
|
51
|
-
|
52
|
-
</ul>
|
53
|
-
</div>
|
54
|
-
</body>
|
55
|
-
</html>
|
@@ -1,28 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
-
<head>
|
6
|
-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
7
|
-
<title>Documentation by YARD 0.8.5.2</title>
|
8
|
-
</head>
|
9
|
-
<script type="text/javascript" charset="utf-8">
|
10
|
-
window.onload = function() {
|
11
|
-
var match = window.location.hash.match(/^#!(.+)/);
|
12
|
-
var name = 'index.html';
|
13
|
-
if (match) {
|
14
|
-
name = unescape(match[1]);
|
15
|
-
}
|
16
|
-
document.writeln('<frameset cols="20%,*">' +
|
17
|
-
'<frame name="list" src="class_list.html" />' +
|
18
|
-
'<frame name="main" src="' + name + '" />' +
|
19
|
-
'</frameset>');
|
20
|
-
}
|
21
|
-
</script>
|
22
|
-
<noscript>
|
23
|
-
<frameset cols="20%,*">
|
24
|
-
<frame name="list" src="class_list.html" />
|
25
|
-
<frame name="main" src="index.html" />
|
26
|
-
</frameset>
|
27
|
-
</noscript>
|
28
|
-
</html>
|
@@ -1,137 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
-
<head>
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
|
6
|
-
<title>
|
7
|
-
File: Readme
|
8
|
-
|
9
|
-
— Documentation by YARD 0.8.5.2
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
hasFrames = window.top.frames.main ? true : false;
|
19
|
-
relpath = '';
|
20
|
-
framesUrl = "frames.html#!" + escape(window.location.href);
|
21
|
-
</script>
|
22
|
-
|
23
|
-
|
24
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
25
|
-
|
26
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
27
|
-
|
28
|
-
|
29
|
-
</head>
|
30
|
-
<body>
|
31
|
-
<div id="header">
|
32
|
-
<div id="menu">
|
33
|
-
|
34
|
-
<a href="_index.html">Index</a> »
|
35
|
-
<span class="title">File: Readme</span>
|
36
|
-
|
37
|
-
|
38
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
|
-
</div>
|
40
|
-
|
41
|
-
<div id="search">
|
42
|
-
|
43
|
-
<a class="full_list_link" id="class_list_link"
|
44
|
-
href="class_list.html">
|
45
|
-
Class List
|
46
|
-
</a>
|
47
|
-
|
48
|
-
<a class="full_list_link" id="method_list_link"
|
49
|
-
href="method_list.html">
|
50
|
-
Method List
|
51
|
-
</a>
|
52
|
-
|
53
|
-
<a class="full_list_link" id="file_list_link"
|
54
|
-
href="file_list.html">
|
55
|
-
File List
|
56
|
-
</a>
|
57
|
-
|
58
|
-
</div>
|
59
|
-
<div class="clear"></div>
|
60
|
-
</div>
|
61
|
-
|
62
|
-
<iframe id="search_frame"></iframe>
|
63
|
-
|
64
|
-
<div id="content"><div id='filecontents'><h1>Zendesk API Client</h1>
|
65
|
-
|
66
|
-
<h2>API version support</h2>
|
67
|
-
|
68
|
-
<p>This client <strong>only</strong> supports Zendesk's v2 API. Please see our <a href="http://developer.zendesk.com">API documentation</a> for more information.</p>
|
69
|
-
|
70
|
-
<h2>Documentation</h2>
|
71
|
-
|
72
|
-
<p>Please check out the <a href="https://github.com/zendesk/zendesk_api_client_rb/wiki">wiki</a>, <a href="https://zendesk-api.herokuapp.com/doc/index.html">class documentation</a>, and <a href="https://github.com/zendesk/zendesk_api_client_rb/issues">issues</a> before reporting a bug or asking for help.</p>
|
73
|
-
|
74
|
-
<h2>Important Notices</h2>
|
75
|
-
|
76
|
-
<ul>
|
77
|
-
<li>Version 0.0.5 brings with it a change to the top-level namespace. All references to Zendesk should now use ZendeskAPI.</li>
|
78
|
-
<li>Version 0.3.0 changed the license from MIT to Apache Version 2.</li>
|
79
|
-
<li>Version 0.3.2 introduced a regression when side-loading roles on users. This was fixed in 0.3.4.</li>
|
80
|
-
</ul>
|
81
|
-
|
82
|
-
<h2>Installation</h2>
|
83
|
-
|
84
|
-
<p>The Zendesk API client can be installed using Rubygems or Bundler.</p>
|
85
|
-
|
86
|
-
<h3>Rubygems</h3>
|
87
|
-
|
88
|
-
<pre class="code sh"><code class="sh">gem install zendesk_api
|
89
|
-
</code></pre>
|
90
|
-
|
91
|
-
<h3>Bundler</h3>
|
92
|
-
|
93
|
-
<p>Add it to your Gemfile</p>
|
94
|
-
|
95
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>zendesk_api</span><span class='tstring_end'>"</span></span>
|
96
|
-
</code></pre>
|
97
|
-
|
98
|
-
<p>and follow normal <a href="http://gembundler.com/">Bundler</a> installation and execution procedures.</p>
|
99
|
-
|
100
|
-
<h2>Note on Patches/Pull Requests</h2>
|
101
|
-
|
102
|
-
<ol>
|
103
|
-
<li>Fork the project.</li>
|
104
|
-
<li>Make your feature addition or bug fix.</li>
|
105
|
-
<li>Add tests for it. This is important so I don't break it in a future version
|
106
|
-
unintentionally.</li>
|
107
|
-
<li>Commit, do not mess with rakefile, version, or history. (if you want to have
|
108
|
-
your own version, that is fine but bump version in a commit by itself I can
|
109
|
-
ignore when I pull)</li>
|
110
|
-
<li>Send me a pull request. Bonus points for topic branches.</li>
|
111
|
-
</ol>
|
112
|
-
|
113
|
-
<h2>Supported Ruby Versions</h2>
|
114
|
-
|
115
|
-
<p>Tested with Ruby 1.8.7 and 1.9.3
|
116
|
-
<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>
|
117
|
-
|
118
|
-
<h2>Copyright and license</h2>
|
119
|
-
|
120
|
-
<p>Copyright 2013 Zendesk</p>
|
121
|
-
|
122
|
-
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
123
|
-
You may obtain a copy of the License at</p>
|
124
|
-
|
125
|
-
<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
|
126
|
-
|
127
|
-
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p>
|
128
|
-
</div></div>
|
129
|
-
|
130
|
-
<div id="footer">
|
131
|
-
Generated on Wed May 15 18:59:28 2013 by
|
132
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
133
|
-
0.8.5.2 (ruby-1.9.3).
|
134
|
-
</div>
|
135
|
-
|
136
|
-
</body>
|
137
|
-
</html>
|
@@ -1,214 +0,0 @@
|
|
1
|
-
function createSourceLinks() {
|
2
|
-
$('.method_details_list .source_code').
|
3
|
-
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
4
|
-
$('.toggleSource').toggle(function() {
|
5
|
-
$(this).parent().nextAll('.source_code').slideDown(100);
|
6
|
-
$(this).text("Hide source");
|
7
|
-
},
|
8
|
-
function() {
|
9
|
-
$(this).parent().nextAll('.source_code').slideUp(100);
|
10
|
-
$(this).text("View source");
|
11
|
-
});
|
12
|
-
}
|
13
|
-
|
14
|
-
function createDefineLinks() {
|
15
|
-
var tHeight = 0;
|
16
|
-
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
17
|
-
$('.toggleDefines').toggle(function() {
|
18
|
-
tHeight = $(this).parent().prev().height();
|
19
|
-
$(this).prev().show();
|
20
|
-
$(this).parent().prev().height($(this).parent().height());
|
21
|
-
$(this).text("(less)");
|
22
|
-
},
|
23
|
-
function() {
|
24
|
-
$(this).prev().hide();
|
25
|
-
$(this).parent().prev().height(tHeight);
|
26
|
-
$(this).text("more...");
|
27
|
-
});
|
28
|
-
}
|
29
|
-
|
30
|
-
function createFullTreeLinks() {
|
31
|
-
var tHeight = 0;
|
32
|
-
$('.inheritanceTree').toggle(function() {
|
33
|
-
tHeight = $(this).parent().prev().height();
|
34
|
-
$(this).parent().toggleClass('showAll');
|
35
|
-
$(this).text("(hide)");
|
36
|
-
$(this).parent().prev().height($(this).parent().height());
|
37
|
-
},
|
38
|
-
function() {
|
39
|
-
$(this).parent().toggleClass('showAll');
|
40
|
-
$(this).parent().prev().height(tHeight);
|
41
|
-
$(this).text("show all");
|
42
|
-
});
|
43
|
-
}
|
44
|
-
|
45
|
-
function fixBoxInfoHeights() {
|
46
|
-
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
47
|
-
$(this).prev().height($(this).height());
|
48
|
-
});
|
49
|
-
}
|
50
|
-
|
51
|
-
function searchFrameLinks() {
|
52
|
-
$('.full_list_link').click(function() {
|
53
|
-
toggleSearchFrame(this, $(this).attr('href'));
|
54
|
-
return false;
|
55
|
-
});
|
56
|
-
}
|
57
|
-
|
58
|
-
function toggleSearchFrame(id, link) {
|
59
|
-
var frame = $('#search_frame');
|
60
|
-
$('#search a').removeClass('active').addClass('inactive');
|
61
|
-
if (frame.attr('src') == link && frame.css('display') != "none") {
|
62
|
-
frame.slideUp(100);
|
63
|
-
$('#search a').removeClass('active inactive');
|
64
|
-
}
|
65
|
-
else {
|
66
|
-
$(id).addClass('active').removeClass('inactive');
|
67
|
-
frame.attr('src', link).slideDown(100);
|
68
|
-
}
|
69
|
-
}
|
70
|
-
|
71
|
-
function linkSummaries() {
|
72
|
-
$('.summary_signature').click(function() {
|
73
|
-
document.location = $(this).find('a').attr('href');
|
74
|
-
});
|
75
|
-
}
|
76
|
-
|
77
|
-
function framesInit() {
|
78
|
-
if (hasFrames) {
|
79
|
-
document.body.className = 'frames';
|
80
|
-
$('#menu .noframes a').attr('href', document.location);
|
81
|
-
window.top.document.title = $('html head title').text();
|
82
|
-
}
|
83
|
-
else {
|
84
|
-
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
85
|
-
}
|
86
|
-
}
|
87
|
-
|
88
|
-
function keyboardShortcuts() {
|
89
|
-
if (window.top.frames.main) return;
|
90
|
-
$(document).keypress(function(evt) {
|
91
|
-
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
92
|
-
if (typeof evt.target !== "undefined" &&
|
93
|
-
(evt.target.nodeName == "INPUT" ||
|
94
|
-
evt.target.nodeName == "TEXTAREA")) return;
|
95
|
-
switch (evt.charCode) {
|
96
|
-
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
97
|
-
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
98
|
-
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
99
|
-
default: break;
|
100
|
-
}
|
101
|
-
});
|
102
|
-
}
|
103
|
-
|
104
|
-
function summaryToggle() {
|
105
|
-
$('.summary_toggle').click(function() {
|
106
|
-
if (localStorage) {
|
107
|
-
localStorage.summaryCollapsed = $(this).text();
|
108
|
-
}
|
109
|
-
$('.summary_toggle').each(function() {
|
110
|
-
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
111
|
-
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
112
|
-
if (next.hasClass('compact')) {
|
113
|
-
next.toggle();
|
114
|
-
next.nextAll('ul.summary').first().toggle();
|
115
|
-
}
|
116
|
-
else if (next.hasClass('summary')) {
|
117
|
-
var list = $('<ul class="summary compact" />');
|
118
|
-
list.html(next.html());
|
119
|
-
list.find('.summary_desc, .note').remove();
|
120
|
-
list.find('a').each(function() {
|
121
|
-
$(this).html($(this).find('strong').html());
|
122
|
-
$(this).parent().html($(this)[0].outerHTML);
|
123
|
-
});
|
124
|
-
next.before(list);
|
125
|
-
next.toggle();
|
126
|
-
}
|
127
|
-
});
|
128
|
-
return false;
|
129
|
-
});
|
130
|
-
if (localStorage) {
|
131
|
-
if (localStorage.summaryCollapsed == "collapse") {
|
132
|
-
$('.summary_toggle').first().click();
|
133
|
-
}
|
134
|
-
else localStorage.summaryCollapsed = "expand";
|
135
|
-
}
|
136
|
-
}
|
137
|
-
|
138
|
-
function fixOutsideWorldLinks() {
|
139
|
-
$('a').each(function() {
|
140
|
-
if (window.location.host != this.host) this.target = '_parent';
|
141
|
-
});
|
142
|
-
}
|
143
|
-
|
144
|
-
function generateTOC() {
|
145
|
-
if ($('#filecontents').length === 0) return;
|
146
|
-
var _toc = $('<ol class="top"></ol>');
|
147
|
-
var show = false;
|
148
|
-
var toc = _toc;
|
149
|
-
var counter = 0;
|
150
|
-
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
151
|
-
var i;
|
152
|
-
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
153
|
-
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
154
|
-
var lastTag = parseInt(tags[0][1], 10);
|
155
|
-
$(tags.join(', ')).each(function() {
|
156
|
-
if ($(this).parents('.method_details .docstring').length != 0) return;
|
157
|
-
if (this.id == "filecontents") return;
|
158
|
-
show = true;
|
159
|
-
var thisTag = parseInt(this.tagName[1], 10);
|
160
|
-
if (this.id.length === 0) {
|
161
|
-
var proposedId = $(this).attr('toc-id');
|
162
|
-
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
163
|
-
else {
|
164
|
-
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
165
|
-
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
166
|
-
this.id = proposedId;
|
167
|
-
}
|
168
|
-
}
|
169
|
-
if (thisTag > lastTag) {
|
170
|
-
for (i = 0; i < thisTag - lastTag; i++) {
|
171
|
-
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
172
|
-
}
|
173
|
-
}
|
174
|
-
if (thisTag < lastTag) {
|
175
|
-
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
176
|
-
}
|
177
|
-
var title = $(this).attr('toc-title');
|
178
|
-
if (typeof(title) == "undefined") title = $(this).text();
|
179
|
-
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
180
|
-
lastTag = thisTag;
|
181
|
-
});
|
182
|
-
if (!show) return;
|
183
|
-
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
184
|
-
$('#content').prepend(html);
|
185
|
-
$('#toc').append(_toc);
|
186
|
-
$('#toc .hide_toc').toggle(function() {
|
187
|
-
$('#toc .top').slideUp('fast');
|
188
|
-
$('#toc').toggleClass('hidden');
|
189
|
-
$('#toc .title small').toggle();
|
190
|
-
}, function() {
|
191
|
-
$('#toc .top').slideDown('fast');
|
192
|
-
$('#toc').toggleClass('hidden');
|
193
|
-
$('#toc .title small').toggle();
|
194
|
-
});
|
195
|
-
$('#toc .float_toc').toggle(function() {
|
196
|
-
$(this).text('float');
|
197
|
-
$('#toc').toggleClass('nofloat');
|
198
|
-
}, function() {
|
199
|
-
$(this).text('left');
|
200
|
-
$('#toc').toggleClass('nofloat');
|
201
|
-
});
|
202
|
-
}
|
203
|
-
|
204
|
-
$(framesInit);
|
205
|
-
$(createSourceLinks);
|
206
|
-
$(createDefineLinks);
|
207
|
-
$(createFullTreeLinks);
|
208
|
-
$(fixBoxInfoHeights);
|
209
|
-
$(searchFrameLinks);
|
210
|
-
$(linkSummaries);
|
211
|
-
$(keyboardShortcuts);
|
212
|
-
$(summaryToggle);
|
213
|
-
$(fixOutsideWorldLinks);
|
214
|
-
$(generateTOC);
|