zendesk_api 0.2.6 → 0.3.0
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.
- data/.gitignore +2 -1
- data/Gemfile +7 -0
- data/Gemfile.lock +10 -2
- data/LICENSE +176 -19
- data/Readme.md +13 -5
- data/config/newrelic.yml +255 -0
- data/lib/zendesk_api/association.rb +1 -1
- data/lib/zendesk_api/associations.rb +129 -100
- data/lib/zendesk_api/client.rb +44 -25
- data/lib/zendesk_api/collection.rb +83 -58
- data/lib/zendesk_api/console/extensions.rb +47 -28
- data/lib/zendesk_api/server/base.rb +4 -0
- data/lib/zendesk_api/server/docs/account_settings.md +8 -0
- data/lib/zendesk_api/server/docs/automations.md +6 -0
- data/lib/zendesk_api/server/docs/changes_roadmap.md +76 -1
- data/lib/zendesk_api/server/docs/forum_subscriptions.md +2 -2
- data/lib/zendesk_api/server/docs/introduction.md +4 -2
- data/lib/zendesk_api/server/docs/macros.md +2 -0
- data/lib/zendesk_api/server/docs/organizations.md +3 -4
- data/lib/zendesk_api/server/docs/requests.md +21 -7
- data/lib/zendesk_api/server/docs/tickets.md +64 -8
- data/lib/zendesk_api/server/docs/topic_subscriptions.md +3 -3
- data/lib/zendesk_api/server/docs/topic_votes.md +0 -1
- data/lib/zendesk_api/server/docs/triggers.md +7 -0
- data/lib/zendesk_api/server/docs/users.md +4 -4
- data/lib/zendesk_api/server/docs/views.md +57 -8
- data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +131 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +616 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +362 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +438 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +243 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +462 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +1490 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +2825 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +1212 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console.html +860 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +134 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +322 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +222 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +1432 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +348 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +216 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +307 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +245 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/FormatError.html +123 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +1196 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +616 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +243 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +616 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +209 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +209 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +438 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +361 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +1016 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +278 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +220 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +826 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +604 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +258 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +383 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +938 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +510 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +403 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +166 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html +131 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html +523 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/Helper.html +684 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer.html +303 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html +508 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/UserRequest.html +125 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/ZlibJSON.html +244 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +350 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +209 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +247 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +342 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +2731 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +385 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +636 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +243 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +243 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +205 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +1086 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +232 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +624 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +743 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +616 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +438 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +140 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +237 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +222 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +404 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +3611 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +563 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +194 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +338 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +1283 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +190 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +1342 -0
- data/lib/zendesk_api/server/public/doc/_index.html +799 -0
- data/lib/zendesk_api/server/public/doc/class_list.html +53 -0
- data/lib/zendesk_api/server/public/doc/css/common.css +1 -0
- data/lib/zendesk_api/server/public/doc/css/full_list.css +57 -0
- data/lib/zendesk_api/server/public/doc/css/style.css +328 -0
- data/lib/zendesk_api/server/public/doc/file.Readme.html +377 -0
- data/lib/zendesk_api/server/public/doc/file_list.html +55 -0
- data/lib/zendesk_api/server/public/doc/frames.html +28 -0
- data/lib/zendesk_api/server/public/doc/index.html +377 -0
- data/lib/zendesk_api/server/public/doc/js/app.js +214 -0
- data/lib/zendesk_api/server/public/doc/js/full_list.js +173 -0
- data/lib/zendesk_api/server/public/doc/js/jquery.js +4 -0
- data/lib/zendesk_api/server/public/doc/method_list.html +2540 -0
- data/lib/zendesk_api/server/public/doc/top-level-namespace.html +144 -0
- data/lib/zendesk_api/version.rb +1 -1
- data/zendesk_api.gemspec +1 -1
- metadata +96 -3
|
@@ -0,0 +1,1490 @@
|
|
|
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=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: ZendeskAPI::Client
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.4.1
|
|
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 (C)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">Client</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Class: ZendeskAPI::Client
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">Object</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">ZendeskAPI::Client</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
|
97
|
+
<dd class="r2 last">lib/zendesk_api/client.rb<span class="defines">,<br />
|
|
98
|
+
lib/zendesk_api/console/extensions.rb</span>
|
|
99
|
+
</dd>
|
|
100
|
+
|
|
101
|
+
</dl>
|
|
102
|
+
<div class="clear"></div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>The top-level class that handles configuration and connection to the
|
|
108
|
+
Zendesk API. Can also be used as an accessor to resource collections.</p>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
<div class="tags">
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</div>
|
|
117
|
+
<h2>Constant Summary</h2>
|
|
118
|
+
|
|
119
|
+
<dl class="constants">
|
|
120
|
+
|
|
121
|
+
<dt id="GET_SUBCLASSES-constant" class="">GET_SUBCLASSES =
|
|
122
|
+
|
|
123
|
+
</dt>
|
|
124
|
+
<dd><pre class="code"><span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_ary'>ary</span><span class='op'>|</span>
|
|
125
|
+
<span class='id identifier rubyid_ary'>ary</span><span class='period'>.</span><span class='id identifier rubyid_map!'>map!</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_klass'>klass</span><span class='op'>|</span>
|
|
126
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>Resource$</span><span class='regexp_end'>/</span></span>
|
|
127
|
+
<span class='const'>GET_SUBCLASSES</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_subclasses'>subclasses</span><span class='rparen'>)</span>
|
|
128
|
+
<span class='kw'>else</span>
|
|
129
|
+
<span class='id identifier rubyid_klass'>klass</span>
|
|
130
|
+
<span class='kw'>end</span>
|
|
131
|
+
<span class='kw'>end</span>
|
|
132
|
+
|
|
133
|
+
<span class='id identifier rubyid_ary'>ary</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:flatten!</span><span class='rparen'>)</span>
|
|
134
|
+
<span class='kw'>end</span></pre></dd>
|
|
135
|
+
|
|
136
|
+
</dl>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
143
|
+
<ul class="summary">
|
|
144
|
+
|
|
145
|
+
<li class="public ">
|
|
146
|
+
<span class="summary_signature">
|
|
147
|
+
|
|
148
|
+
<a href="#callbacks-instance_method" title="#callbacks (instance method)">- (Array) <strong>callbacks</strong> </a>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</span>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<span class="note title readonly">readonly</span>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
|
168
|
+
<p>Custom response callbacks.</p>
|
|
169
|
+
</div></span>
|
|
170
|
+
|
|
171
|
+
</li>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<li class="public ">
|
|
175
|
+
<span class="summary_signature">
|
|
176
|
+
|
|
177
|
+
<a href="#config-instance_method" title="#config (instance method)">- (Configuration) <strong>config</strong> </a>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</span>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="note title readonly">readonly</span>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
<span class="summary_desc"><div class='inline'>
|
|
197
|
+
<p>Config instance.</p>
|
|
198
|
+
</div></span>
|
|
199
|
+
|
|
200
|
+
</li>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</ul>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<h2>
|
|
210
|
+
Class Method Summary
|
|
211
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
212
|
+
</h2>
|
|
213
|
+
|
|
214
|
+
<ul class="summary">
|
|
215
|
+
|
|
216
|
+
<li class="public ">
|
|
217
|
+
<span class="summary_signature">
|
|
218
|
+
|
|
219
|
+
<a href="#check_deprecated_namespace_usage-class_method" title="check_deprecated_namespace_usage (class method)">+ (Object) <strong>check_deprecated_namespace_usage</strong>(attributes, name) </a>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
</span>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<span class="summary_desc"><div class='inline'>
|
|
234
|
+
<p>show a nice warning for people using the old style api.</p>
|
|
235
|
+
</div></span>
|
|
236
|
+
|
|
237
|
+
</li>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<li class="public ">
|
|
241
|
+
<span class="summary_signature">
|
|
242
|
+
|
|
243
|
+
<a href="#resources-class_method" title="resources (class method)">+ (Object) <strong>resources</strong> </a>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
</span>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
258
|
+
|
|
259
|
+
</li>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</ul>
|
|
263
|
+
|
|
264
|
+
<h2>
|
|
265
|
+
Instance Method Summary
|
|
266
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
267
|
+
</h2>
|
|
268
|
+
|
|
269
|
+
<ul class="summary">
|
|
270
|
+
|
|
271
|
+
<li class="protected ">
|
|
272
|
+
<span class="summary_signature">
|
|
273
|
+
|
|
274
|
+
<a href="#build_connection-instance_method" title="#build_connection (instance method)">- (Object) <strong>build_connection</strong> </a>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
</span>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<span class="note title protected">protected</span>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<span class="summary_desc"><div class='inline'>
|
|
289
|
+
<p>Called by <span class='object_link'><a href="#connection-instance_method" title="ZendeskAPI::Client#connection (method)">#connection</a></span> to build a connection.</p>
|
|
290
|
+
</div></span>
|
|
291
|
+
|
|
292
|
+
</li>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
<li class="public ">
|
|
296
|
+
<span class="summary_signature">
|
|
297
|
+
|
|
298
|
+
<a href="#connection-instance_method" title="#connection (instance method)">- (Faraday::Connection) <strong>connection</strong> </a>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
</span>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<span class="summary_desc"><div class='inline'>
|
|
313
|
+
<p>Creates a connection if there is none, otherwise returns the existing
|
|
314
|
+
connection.</p>
|
|
315
|
+
</div></span>
|
|
316
|
+
|
|
317
|
+
</li>
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<li class="public ">
|
|
321
|
+
<span class="summary_signature">
|
|
322
|
+
|
|
323
|
+
<a href="#current_account-instance_method" title="#current_account (instance method)">- (Hash) <strong>current_account</strong>(reload = false) </a>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
</span>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<span class="summary_desc"><div class='inline'>
|
|
338
|
+
<p>Returns the current account.</p>
|
|
339
|
+
</div></span>
|
|
340
|
+
|
|
341
|
+
</li>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<li class="public ">
|
|
345
|
+
<span class="summary_signature">
|
|
346
|
+
|
|
347
|
+
<a href="#current_locale-instance_method" title="#current_locale (instance method)">- (ZendeskAPI::Locale) <strong>current_locale</strong>(reload = false) </a>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
</span>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
<span class="summary_desc"><div class='inline'>
|
|
362
|
+
<p>Returns the current locale.</p>
|
|
363
|
+
</div></span>
|
|
364
|
+
|
|
365
|
+
</li>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<li class="public ">
|
|
369
|
+
<span class="summary_signature">
|
|
370
|
+
|
|
371
|
+
<a href="#current_user-instance_method" title="#current_user (instance method)">- (ZendeskAPI::User) <strong>current_user</strong>(reload = false) </a>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
</span>
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<span class="summary_desc"><div class='inline'>
|
|
386
|
+
<p>Returns the current user (aka me).</p>
|
|
387
|
+
</div></span>
|
|
388
|
+
|
|
389
|
+
</li>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<li class="public ">
|
|
393
|
+
<span class="summary_signature">
|
|
394
|
+
|
|
395
|
+
<a href="#format_headers-instance_method" title="#format_headers (instance method)">- (Object) <strong>format_headers</strong> </a>
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
</span>
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
410
|
+
|
|
411
|
+
</li>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
<li class="public ">
|
|
415
|
+
<span class="summary_signature">
|
|
416
|
+
|
|
417
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Client) <strong>initialize</strong> {|config| ... }</a>
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
</span>
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
<span class="note title constructor">constructor</span>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<span class="summary_desc"><div class='inline'>
|
|
434
|
+
<p>Creates a new <span class='object_link'><a href="" title="ZendeskAPI::Client (class)">Client</a></span> instance and yields <span class='object_link'><a href="#config-instance_method" title="ZendeskAPI::Client#config (method)">#config</a></span>.</p>
|
|
435
|
+
</div></span>
|
|
436
|
+
|
|
437
|
+
</li>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<li class="public ">
|
|
441
|
+
<span class="summary_signature">
|
|
442
|
+
|
|
443
|
+
<a href="#insert_callback-instance_method" title="#insert_callback (instance method)">- (Object) <strong>insert_callback</strong>(&block) </a>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</span>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<span class="summary_desc"><div class='inline'>
|
|
458
|
+
<p>Pushes a callback onto the stack.</p>
|
|
459
|
+
</div></span>
|
|
460
|
+
|
|
461
|
+
</li>
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
<li class="public ">
|
|
465
|
+
<span class="summary_signature">
|
|
466
|
+
|
|
467
|
+
<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Collection) <strong>method_missing</strong>(method, *args, &block) </a>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
</span>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
<span class="summary_desc"><div class='inline'>
|
|
482
|
+
<p>Handles resources such as 'tickets'.</p>
|
|
483
|
+
</div></span>
|
|
484
|
+
|
|
485
|
+
</li>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<li class="public ">
|
|
489
|
+
<span class="summary_signature">
|
|
490
|
+
|
|
491
|
+
<a href="#to_a-instance_method" title="#to_a (instance method)">- (Object) <strong>to_a</strong> </a>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
</span>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
506
|
+
|
|
507
|
+
</li>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
<li class="public ">
|
|
511
|
+
<span class="summary_signature">
|
|
512
|
+
|
|
513
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
</span>
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
528
|
+
|
|
529
|
+
</li>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
</ul>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<div id="constructor_details" class="method_details_list">
|
|
542
|
+
<h2>Constructor Details</h2>
|
|
543
|
+
|
|
544
|
+
<div class="method_details first">
|
|
545
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
546
|
+
|
|
547
|
+
- (<tt><span class='object_link'><a href="" title="ZendeskAPI::Client (class)">Client</a></span></tt>) <strong>initialize</strong> {|config| ... }
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
</h3><div class="docstring">
|
|
554
|
+
<div class="discussion">
|
|
555
|
+
|
|
556
|
+
<p>Creates a new <span class='object_link'><a href="" title="ZendeskAPI::Client (class)">ZendeskAPI::Client</a></span> instance and yields <span class='object_link'><a href="#config-instance_method" title="ZendeskAPI::Client#config (method)">#config</a></span>.</p>
|
|
557
|
+
|
|
558
|
+
<p>Requires a block to be given.</p>
|
|
559
|
+
|
|
560
|
+
<p>Does basic configuration constraints:</p>
|
|
561
|
+
<ul><li>
|
|
562
|
+
<p><span class='object_link'><a href="Configuration.html#url-instance_method" title="ZendeskAPI::Configuration#url (method)">ZendeskAPI::Configuration#url</a></span> must be https unless <span class='object_link'><a href="Configuration.html#allow_http-instance_method" title="ZendeskAPI::Configuration#allow_http (method)">ZendeskAPI::Configuration#allow_http</a></span> is set.</p>
|
|
563
|
+
</li></ul>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</div>
|
|
567
|
+
</div>
|
|
568
|
+
<div class="tags">
|
|
569
|
+
|
|
570
|
+
<p class="tag_title">Yields:</p>
|
|
571
|
+
<ul class="yield">
|
|
572
|
+
|
|
573
|
+
<li>
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
<span class='type'>(<tt>config</tt>)</span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
</li>
|
|
581
|
+
|
|
582
|
+
</ul>
|
|
583
|
+
<p class="tag_title">Raises:</p>
|
|
584
|
+
<ul class="raise">
|
|
585
|
+
|
|
586
|
+
<li>
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
</li>
|
|
594
|
+
|
|
595
|
+
</ul>
|
|
596
|
+
|
|
597
|
+
</div><table class="source_code">
|
|
598
|
+
<tr>
|
|
599
|
+
<td>
|
|
600
|
+
<pre class="lines">
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
75
|
|
604
|
+
76
|
|
605
|
+
77
|
|
606
|
+
78
|
|
607
|
+
79
|
|
608
|
+
80
|
|
609
|
+
81
|
|
610
|
+
82
|
|
611
|
+
83
|
|
612
|
+
84
|
|
613
|
+
85
|
|
614
|
+
86
|
|
615
|
+
87
|
|
616
|
+
88
|
|
617
|
+
89
|
|
618
|
+
90
|
|
619
|
+
91
|
|
620
|
+
92
|
|
621
|
+
93
|
|
622
|
+
94
|
|
623
|
+
95
|
|
624
|
+
96
|
|
625
|
+
97
|
|
626
|
+
98
|
|
627
|
+
99
|
|
628
|
+
100
|
|
629
|
+
101
|
|
630
|
+
102
|
|
631
|
+
103
|
|
632
|
+
104
|
|
633
|
+
105
|
|
634
|
+
106
|
|
635
|
+
107
|
|
636
|
+
108
|
|
637
|
+
109</pre>
|
|
638
|
+
</td>
|
|
639
|
+
<td>
|
|
640
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 75</span>
|
|
641
|
+
|
|
642
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
|
643
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>block not given</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
|
|
644
|
+
|
|
645
|
+
<span class='ivar'>@config</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
646
|
+
<span class='kw'>yield</span> <span class='id identifier rubyid_config'>config</span>
|
|
647
|
+
|
|
648
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_allow_http'>allow_http</span> <span class='op'>&&</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='regexp_beg'>/</span><span class='tstring_content'>^https</span><span class='regexp_end'>/</span></span>
|
|
649
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>zendesk_api is ssl only; url must begin with https://</span><span class='tstring_end'>"</span></span>
|
|
650
|
+
<span class='kw'>end</span>
|
|
651
|
+
|
|
652
|
+
<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='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_retry'>retry</span> <span class='comment'># nil -> false
|
|
653
|
+
</span>
|
|
654
|
+
<span class='kw'>if</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='op'>!</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_password'>password</span>
|
|
655
|
+
<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='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span>
|
|
656
|
+
<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'>"</span><span class='tstring_content'>/token</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_username'>username</span><span class='period'>.</span><span class='id identifier rubyid_end_with?'>end_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/token</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
657
|
+
<span class='kw'>end</span>
|
|
658
|
+
|
|
659
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</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='kw'>true</span>
|
|
660
|
+
<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>
|
|
661
|
+
<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='gvar'>$stderr</span><span class='rparen'>)</span>
|
|
662
|
+
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_level'>level</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='op'>::</span><span class='const'>WARN</span>
|
|
663
|
+
<span class='kw'>end</span>
|
|
664
|
+
|
|
665
|
+
<span class='ivar'>@callbacks</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
666
|
+
|
|
667
|
+
<span class='ivar'>@resource_cache</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
668
|
+
|
|
669
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span>
|
|
670
|
+
<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>
|
|
671
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_warning'>warning</span> <span class='op'>=</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='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>X-Zendesk-API-Warn</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
672
|
+
<span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>WARNING: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_warning'>warning</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
|
673
|
+
<span class='kw'>end</span>
|
|
674
|
+
<span class='kw'>end</span>
|
|
675
|
+
<span class='kw'>end</span>
|
|
676
|
+
<span class='kw'>end</span></pre>
|
|
677
|
+
</td>
|
|
678
|
+
</tr>
|
|
679
|
+
</table>
|
|
680
|
+
</div>
|
|
681
|
+
|
|
682
|
+
</div>
|
|
683
|
+
<div id="method_missing_details" class="method_details_list">
|
|
684
|
+
<h2>Dynamic Method Handling</h2>
|
|
685
|
+
<p class="notice this">
|
|
686
|
+
This class handles dynamic methods through the <tt>method_missing</tt> method
|
|
687
|
+
|
|
688
|
+
</p>
|
|
689
|
+
|
|
690
|
+
<div class="method_details first">
|
|
691
|
+
<h3 class="signature first" id="method_missing-instance_method">
|
|
692
|
+
|
|
693
|
+
- (<tt><span class='object_link'><a href="Collection.html" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>method_missing</strong>(method, *args, &block)
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
</h3><div class="docstring">
|
|
700
|
+
<div class="discussion">
|
|
701
|
+
|
|
702
|
+
<p>Handles resources such as 'tickets'. Any options are passed to the
|
|
703
|
+
underlying collection, except reload which disregards memoization and
|
|
704
|
+
creates a new Collection instance.</p>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
</div>
|
|
708
|
+
</div>
|
|
709
|
+
<div class="tags">
|
|
710
|
+
|
|
711
|
+
<p class="tag_title">Returns:</p>
|
|
712
|
+
<ul class="return">
|
|
713
|
+
|
|
714
|
+
<li>
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<span class='type'>(<tt><span class='object_link'><a href="Collection.html" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>)</span>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
—
|
|
722
|
+
<div class='inline'>
|
|
723
|
+
<p>Collection instance for resource</p>
|
|
724
|
+
</div>
|
|
725
|
+
|
|
726
|
+
</li>
|
|
727
|
+
|
|
728
|
+
</ul>
|
|
729
|
+
|
|
730
|
+
</div><table class="source_code">
|
|
731
|
+
<tr>
|
|
732
|
+
<td>
|
|
733
|
+
<pre class="lines">
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
33
|
|
737
|
+
34
|
|
738
|
+
35
|
|
739
|
+
36
|
|
740
|
+
37
|
|
741
|
+
38
|
|
742
|
+
39
|
|
743
|
+
40
|
|
744
|
+
41
|
|
745
|
+
42
|
|
746
|
+
43
|
|
747
|
+
44</pre>
|
|
748
|
+
</td>
|
|
749
|
+
<td>
|
|
750
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 33</span>
|
|
751
|
+
|
|
752
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
753
|
+
<span class='id identifier rubyid_method'>method</span> <span class='op'>=</span> <span class='id identifier rubyid_method'>method</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
754
|
+
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span> <span class='op'>:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
755
|
+
|
|
756
|
+
<span class='ivar'>@resource_cache</span><span class='lbracket'>[</span><span class='id identifier rubyid_method'>method</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
757
|
+
|
|
758
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:reload</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='lparen'>(</span><span class='id identifier rubyid_cached'>cached</span> <span class='op'>=</span> <span class='ivar'>@resource_cache</span><span class='lbracket'>[</span><span class='id identifier rubyid_method'>method</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_hash'>hash</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
759
|
+
<span class='id identifier rubyid_cached'>cached</span>
|
|
760
|
+
<span class='kw'>else</span>
|
|
761
|
+
<span class='ivar'>@resource_cache</span><span class='lbracket'>[</span><span class='id identifier rubyid_method'>method</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_hash'>hash</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Collection</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='const'>ZendeskAPI</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Helpers</span><span class='period'>.</span><span class='id identifier rubyid_modulize_string'>modulize_string</span><span class='lparen'>(</span><span class='const'>Inflection</span><span class='period'>.</span><span class='id identifier rubyid_singular'>singular</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
762
|
+
<span class='kw'>end</span>
|
|
763
|
+
<span class='kw'>end</span></pre>
|
|
764
|
+
</td>
|
|
765
|
+
</tr>
|
|
766
|
+
</table>
|
|
767
|
+
</div>
|
|
768
|
+
|
|
769
|
+
</div>
|
|
770
|
+
|
|
771
|
+
<div id="instance_attr_details" class="attr_details">
|
|
772
|
+
<h2>Instance Attribute Details</h2>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
<span id=""></span>
|
|
776
|
+
<div class="method_details first">
|
|
777
|
+
<h3 class="signature first" id="callbacks-instance_method">
|
|
778
|
+
|
|
779
|
+
- (<tt>Array</tt>) <strong>callbacks</strong> <span class="extras">(readonly)</span>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
</h3><div class="docstring">
|
|
786
|
+
<div class="discussion">
|
|
787
|
+
|
|
788
|
+
<p>Custom response callbacks</p>
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
</div>
|
|
792
|
+
</div>
|
|
793
|
+
<div class="tags">
|
|
794
|
+
|
|
795
|
+
<p class="tag_title">Returns:</p>
|
|
796
|
+
<ul class="return">
|
|
797
|
+
|
|
798
|
+
<li>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
—
|
|
806
|
+
<div class='inline'>
|
|
807
|
+
<p>Custom response callbacks</p>
|
|
808
|
+
</div>
|
|
809
|
+
|
|
810
|
+
</li>
|
|
811
|
+
|
|
812
|
+
</ul>
|
|
813
|
+
|
|
814
|
+
</div><table class="source_code">
|
|
815
|
+
<tr>
|
|
816
|
+
<td>
|
|
817
|
+
<pre class="lines">
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
28
|
|
821
|
+
29
|
|
822
|
+
30</pre>
|
|
823
|
+
</td>
|
|
824
|
+
<td>
|
|
825
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 28</span>
|
|
826
|
+
|
|
827
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_callbacks'>callbacks</span>
|
|
828
|
+
<span class='ivar'>@callbacks</span>
|
|
829
|
+
<span class='kw'>end</span></pre>
|
|
830
|
+
</td>
|
|
831
|
+
</tr>
|
|
832
|
+
</table>
|
|
833
|
+
</div>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
<span id=""></span>
|
|
837
|
+
<div class="method_details ">
|
|
838
|
+
<h3 class="signature " id="config-instance_method">
|
|
839
|
+
|
|
840
|
+
- (<tt><span class='object_link'><a href="Configuration.html" title="ZendeskAPI::Configuration (class)">Configuration</a></span></tt>) <strong>config</strong> <span class="extras">(readonly)</span>
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
</h3><div class="docstring">
|
|
847
|
+
<div class="discussion">
|
|
848
|
+
|
|
849
|
+
<p>Config instance</p>
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
</div>
|
|
853
|
+
</div>
|
|
854
|
+
<div class="tags">
|
|
855
|
+
|
|
856
|
+
<p class="tag_title">Returns:</p>
|
|
857
|
+
<ul class="return">
|
|
858
|
+
|
|
859
|
+
<li>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
<span class='type'>(<tt><span class='object_link'><a href="Configuration.html" title="ZendeskAPI::Configuration (class)">Configuration</a></span></tt>)</span>
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
—
|
|
867
|
+
<div class='inline'>
|
|
868
|
+
<p>Config instance</p>
|
|
869
|
+
</div>
|
|
870
|
+
|
|
871
|
+
</li>
|
|
872
|
+
|
|
873
|
+
</ul>
|
|
874
|
+
|
|
875
|
+
</div><table class="source_code">
|
|
876
|
+
<tr>
|
|
877
|
+
<td>
|
|
878
|
+
<pre class="lines">
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
26
|
|
882
|
+
27
|
|
883
|
+
28</pre>
|
|
884
|
+
</td>
|
|
885
|
+
<td>
|
|
886
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 26</span>
|
|
887
|
+
|
|
888
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
|
|
889
|
+
<span class='ivar'>@config</span>
|
|
890
|
+
<span class='kw'>end</span></pre>
|
|
891
|
+
</td>
|
|
892
|
+
</tr>
|
|
893
|
+
</table>
|
|
894
|
+
</div>
|
|
895
|
+
|
|
896
|
+
</div>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
<div id="class_method_details" class="method_details_list">
|
|
900
|
+
<h2>Class Method Details</h2>
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
<div class="method_details first">
|
|
904
|
+
<h3 class="signature first" id="check_deprecated_namespace_usage-class_method">
|
|
905
|
+
|
|
906
|
+
+ (<tt>Object</tt>) <strong>check_deprecated_namespace_usage</strong>(attributes, name)
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
</h3><div class="docstring">
|
|
913
|
+
<div class="discussion">
|
|
914
|
+
|
|
915
|
+
<p>show a nice warning for people using the old style api</p>
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
</div>
|
|
919
|
+
</div>
|
|
920
|
+
<div class="tags">
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
</div><table class="source_code">
|
|
924
|
+
<tr>
|
|
925
|
+
<td>
|
|
926
|
+
<pre class="lines">
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
126
|
|
930
|
+
127
|
|
931
|
+
128
|
|
932
|
+
129
|
|
933
|
+
130</pre>
|
|
934
|
+
</td>
|
|
935
|
+
<td>
|
|
936
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 126</span>
|
|
937
|
+
|
|
938
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_deprecated_namespace_usage'>check_deprecated_namespace_usage</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
|
|
939
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
940
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>un-nest '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='rbrace'>}</span><span class='tstring_content'>' from the attributes</span><span class='tstring_end'>"</span></span>
|
|
941
|
+
<span class='kw'>end</span>
|
|
942
|
+
<span class='kw'>end</span></pre>
|
|
943
|
+
</td>
|
|
944
|
+
</tr>
|
|
945
|
+
</table>
|
|
946
|
+
</div>
|
|
947
|
+
|
|
948
|
+
<div class="method_details ">
|
|
949
|
+
<h3 class="signature " id="resources-class_method">
|
|
950
|
+
|
|
951
|
+
+ (<tt>Object</tt>) <strong>resources</strong>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
</h3><table class="source_code">
|
|
958
|
+
<tr>
|
|
959
|
+
<td>
|
|
960
|
+
<pre class="lines">
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
59
|
|
964
|
+
60
|
|
965
|
+
61
|
|
966
|
+
62
|
|
967
|
+
63
|
|
968
|
+
64
|
|
969
|
+
65
|
|
970
|
+
66
|
|
971
|
+
67</pre>
|
|
972
|
+
</td>
|
|
973
|
+
<td>
|
|
974
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 59</span>
|
|
975
|
+
|
|
976
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_resources'>resources</span>
|
|
977
|
+
<span class='ivar'>@resources</span> <span class='op'>||=</span> <span class='kw'>begin</span>
|
|
978
|
+
<span class='id identifier rubyid_subclasses'>subclasses</span> <span class='op'>=</span> <span class='const'>GET_SUBCLASSES</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Data</span><span class='period'>.</span><span class='id identifier rubyid_subclasses'>subclasses</span><span class='rparen'>)</span>
|
|
979
|
+
<span class='id identifier rubyid_subclasses'>subclasses</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
|
|
980
|
+
<span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>ZendeskAPI(::.*){2,}</span><span class='regexp_end'>/</span></span>
|
|
981
|
+
<span class='kw'>end</span>
|
|
982
|
+
<span class='id identifier rubyid_subclasses'>subclasses</span><span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:resource_name</span><span class='rparen'>)</span>
|
|
983
|
+
<span class='kw'>end</span>
|
|
984
|
+
<span class='kw'>end</span></pre>
|
|
985
|
+
</td>
|
|
986
|
+
</tr>
|
|
987
|
+
</table>
|
|
988
|
+
</div>
|
|
989
|
+
|
|
990
|
+
</div>
|
|
991
|
+
|
|
992
|
+
<div id="instance_method_details" class="method_details_list">
|
|
993
|
+
<h2>Instance Method Details</h2>
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
<div class="method_details first">
|
|
997
|
+
<h3 class="signature first" id="build_connection-instance_method">
|
|
998
|
+
|
|
999
|
+
- (<tt>Object</tt>) <strong>build_connection</strong> <span class="extras">(protected)</span>
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
</h3><div class="docstring">
|
|
1006
|
+
<div class="discussion">
|
|
1007
|
+
|
|
1008
|
+
<p>Called by <span class='object_link'><a href="#connection-instance_method" title="ZendeskAPI::Client#connection (method)">#connection</a></span> to build a connection. Can be overwritten in a
|
|
1009
|
+
subclass to add additional middleware and make other configuration changes.</p>
|
|
1010
|
+
|
|
1011
|
+
<p>Uses middleware according to configuration options.</p>
|
|
1012
|
+
|
|
1013
|
+
<p>Request logger if logger is not nil</p>
|
|
1014
|
+
|
|
1015
|
+
<p>Retry middleware if retry is true</p>
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
</div>
|
|
1019
|
+
</div>
|
|
1020
|
+
<div class="tags">
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
</div><table class="source_code">
|
|
1024
|
+
<tr>
|
|
1025
|
+
<td>
|
|
1026
|
+
<pre class="lines">
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
143
|
|
1030
|
+
144
|
|
1031
|
+
145
|
|
1032
|
+
146
|
|
1033
|
+
147
|
|
1034
|
+
148
|
|
1035
|
+
149
|
|
1036
|
+
150
|
|
1037
|
+
151
|
|
1038
|
+
152
|
|
1039
|
+
153
|
|
1040
|
+
154
|
|
1041
|
+
155
|
|
1042
|
+
156
|
|
1043
|
+
157
|
|
1044
|
+
158
|
|
1045
|
+
159
|
|
1046
|
+
160
|
|
1047
|
+
161
|
|
1048
|
+
162
|
|
1049
|
+
163
|
|
1050
|
+
164</pre>
|
|
1051
|
+
</td>
|
|
1052
|
+
<td>
|
|
1053
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 143</span>
|
|
1054
|
+
|
|
1055
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_build_connection'>build_connection</span>
|
|
1056
|
+
<span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_builder'>builder</span><span class='op'>|</span>
|
|
1057
|
+
<span class='comment'># response
|
|
1058
|
+
</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>Faraday</span><span class='op'>::</span><span class='const'>Request</span><span class='op'>::</span><span class='const'>BasicAuthentication</span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_username'>username</span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_password'>password</span>
|
|
1059
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>Faraday</span><span class='op'>::</span><span class='const'>Response</span><span class='op'>::</span><span class='const'>RaiseError</span>
|
|
1060
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Response</span><span class='op'>::</span><span class='const'>Callback</span><span class='comma'>,</span> <span class='kw'>self</span>
|
|
1061
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Response</span><span class='op'>::</span><span class='const'>Logger</span><span class='comma'>,</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='kw'>if</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span>
|
|
1062
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Response</span><span class='op'>::</span><span class='const'>ParseIsoDates</span>
|
|
1063
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:json</span><span class='comma'>,</span> <span class='symbol'>:content_type</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
|
1064
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Response</span><span class='op'>::</span><span class='const'>Gzip</span>
|
|
1065
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Response</span><span class='op'>::</span><span class='const'>Deflate</span>
|
|
1066
|
+
|
|
1067
|
+
<span class='comment'># request
|
|
1068
|
+
</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Request</span><span class='op'>::</span><span class='const'>EtagCache</span><span class='comma'>,</span> <span class='symbol'>:cache</span> <span class='op'>=></span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_cache'>cache</span>
|
|
1069
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Request</span><span class='op'>::</span><span class='const'>Upload</span>
|
|
1070
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span> <span class='symbol'>:multipart</span>
|
|
1071
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span> <span class='symbol'>:json</span>
|
|
1072
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>Request</span><span class='op'>::</span><span class='const'>Retry</span><span class='comma'>,</span> <span class='symbol'>:logger</span> <span class='op'>=></span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='kw'>if</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_retry'>retry</span> <span class='comment'># Should always be first in the stack
|
|
1073
|
+
</span>
|
|
1074
|
+
<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='op'>*</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='op'>||</span> <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_default_adapter'>default_adapter</span>
|
|
1075
|
+
<span class='kw'>end</span>
|
|
1076
|
+
<span class='kw'>end</span></pre>
|
|
1077
|
+
</td>
|
|
1078
|
+
</tr>
|
|
1079
|
+
</table>
|
|
1080
|
+
</div>
|
|
1081
|
+
|
|
1082
|
+
<div class="method_details ">
|
|
1083
|
+
<h3 class="signature " id="connection-instance_method">
|
|
1084
|
+
|
|
1085
|
+
- (<tt>Faraday::Connection</tt>) <strong>connection</strong>
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
</h3><div class="docstring">
|
|
1092
|
+
<div class="discussion">
|
|
1093
|
+
|
|
1094
|
+
<p>Creates a connection if there is none, otherwise returns the existing
|
|
1095
|
+
connection.</p>
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
</div>
|
|
1099
|
+
</div>
|
|
1100
|
+
<div class="tags">
|
|
1101
|
+
|
|
1102
|
+
<p class="tag_title">Returns:</p>
|
|
1103
|
+
<ul class="return">
|
|
1104
|
+
|
|
1105
|
+
<li>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
<span class='type'>(<tt>Faraday::Connection</tt>)</span>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
—
|
|
1113
|
+
<div class='inline'>
|
|
1114
|
+
<p>Faraday connection for the client</p>
|
|
1115
|
+
</div>
|
|
1116
|
+
|
|
1117
|
+
</li>
|
|
1118
|
+
|
|
1119
|
+
</ul>
|
|
1120
|
+
|
|
1121
|
+
</div><table class="source_code">
|
|
1122
|
+
<tr>
|
|
1123
|
+
<td>
|
|
1124
|
+
<pre class="lines">
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
114
|
|
1128
|
+
115
|
|
1129
|
+
116
|
|
1130
|
+
117</pre>
|
|
1131
|
+
</td>
|
|
1132
|
+
<td>
|
|
1133
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 114</span>
|
|
1134
|
+
|
|
1135
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_connection'>connection</span>
|
|
1136
|
+
<span class='ivar'>@connection</span> <span class='op'>||=</span> <span class='id identifier rubyid_build_connection'>build_connection</span>
|
|
1137
|
+
<span class='kw'>return</span> <span class='ivar'>@connection</span>
|
|
1138
|
+
<span class='kw'>end</span></pre>
|
|
1139
|
+
</td>
|
|
1140
|
+
</tr>
|
|
1141
|
+
</table>
|
|
1142
|
+
</div>
|
|
1143
|
+
|
|
1144
|
+
<div class="method_details ">
|
|
1145
|
+
<h3 class="signature " id="current_account-instance_method">
|
|
1146
|
+
|
|
1147
|
+
- (<tt>Hash</tt>) <strong>current_account</strong>(reload = false)
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
</h3><div class="docstring">
|
|
1154
|
+
<div class="discussion">
|
|
1155
|
+
|
|
1156
|
+
<p>Returns the current account</p>
|
|
1157
|
+
|
|
1158
|
+
|
|
1159
|
+
</div>
|
|
1160
|
+
</div>
|
|
1161
|
+
<div class="tags">
|
|
1162
|
+
|
|
1163
|
+
<p class="tag_title">Returns:</p>
|
|
1164
|
+
<ul class="return">
|
|
1165
|
+
|
|
1166
|
+
<li>
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
—
|
|
1174
|
+
<div class='inline'>
|
|
1175
|
+
<p>The attributes of the current account or nil</p>
|
|
1176
|
+
</div>
|
|
1177
|
+
|
|
1178
|
+
</li>
|
|
1179
|
+
|
|
1180
|
+
</ul>
|
|
1181
|
+
|
|
1182
|
+
</div><table class="source_code">
|
|
1183
|
+
<tr>
|
|
1184
|
+
<td>
|
|
1185
|
+
<pre class="lines">
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
55
|
|
1189
|
+
56
|
|
1190
|
+
57
|
|
1191
|
+
58</pre>
|
|
1192
|
+
</td>
|
|
1193
|
+
<td>
|
|
1194
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 55</span>
|
|
1195
|
+
|
|
1196
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_current_account'>current_account</span><span class='lparen'>(</span><span class='id identifier rubyid_reload'>reload</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
1197
|
+
<span class='kw'>return</span> <span class='ivar'>@current_account</span> <span class='kw'>if</span> <span class='ivar'>@current_account</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_reload'>reload</span>
|
|
1198
|
+
<span class='ivar'>@current_account</span> <span class='op'>=</span> <span class='const'>Hashie</span><span class='op'>::</span><span class='const'>Mash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</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='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>account/resolve</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
1199
|
+
<span class='kw'>end</span></pre>
|
|
1200
|
+
</td>
|
|
1201
|
+
</tr>
|
|
1202
|
+
</table>
|
|
1203
|
+
</div>
|
|
1204
|
+
|
|
1205
|
+
<div class="method_details ">
|
|
1206
|
+
<h3 class="signature " id="current_locale-instance_method">
|
|
1207
|
+
|
|
1208
|
+
- (<tt><span class='object_link'><a href="Locale.html" title="ZendeskAPI::Locale (class)">ZendeskAPI::Locale</a></span></tt>) <strong>current_locale</strong>(reload = false)
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
</h3><div class="docstring">
|
|
1215
|
+
<div class="discussion">
|
|
1216
|
+
|
|
1217
|
+
<p>Returns the current locale</p>
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
</div>
|
|
1221
|
+
</div>
|
|
1222
|
+
<div class="tags">
|
|
1223
|
+
|
|
1224
|
+
<p class="tag_title">Returns:</p>
|
|
1225
|
+
<ul class="return">
|
|
1226
|
+
|
|
1227
|
+
<li>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
<span class='type'>(<tt><span class='object_link'><a href="Locale.html" title="ZendeskAPI::Locale (class)">ZendeskAPI::Locale</a></span></tt>)</span>
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
—
|
|
1235
|
+
<div class='inline'>
|
|
1236
|
+
<p>Current locale or nil</p>
|
|
1237
|
+
</div>
|
|
1238
|
+
|
|
1239
|
+
</li>
|
|
1240
|
+
|
|
1241
|
+
</ul>
|
|
1242
|
+
|
|
1243
|
+
</div><table class="source_code">
|
|
1244
|
+
<tr>
|
|
1245
|
+
<td>
|
|
1246
|
+
<pre class="lines">
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
64
|
|
1250
|
+
65
|
|
1251
|
+
66
|
|
1252
|
+
67</pre>
|
|
1253
|
+
</td>
|
|
1254
|
+
<td>
|
|
1255
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 64</span>
|
|
1256
|
+
|
|
1257
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_current_locale'>current_locale</span><span class='lparen'>(</span><span class='id identifier rubyid_reload'>reload</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
1258
|
+
<span class='kw'>return</span> <span class='ivar'>@locale</span> <span class='kw'>if</span> <span class='ivar'>@locale</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_reload'>reload</span>
|
|
1259
|
+
<span class='ivar'>@locale</span> <span class='op'>=</span> <span class='id identifier rubyid_locales'>locales</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'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>current</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
1260
|
+
<span class='kw'>end</span></pre>
|
|
1261
|
+
</td>
|
|
1262
|
+
</tr>
|
|
1263
|
+
</table>
|
|
1264
|
+
</div>
|
|
1265
|
+
|
|
1266
|
+
<div class="method_details ">
|
|
1267
|
+
<h3 class="signature " id="current_user-instance_method">
|
|
1268
|
+
|
|
1269
|
+
- (<tt><span class='object_link'><a href="User.html" title="ZendeskAPI::User (class)">ZendeskAPI::User</a></span></tt>) <strong>current_user</strong>(reload = false)
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
</h3><div class="docstring">
|
|
1276
|
+
<div class="discussion">
|
|
1277
|
+
|
|
1278
|
+
<p>Returns the current user (aka me)</p>
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
</div>
|
|
1282
|
+
</div>
|
|
1283
|
+
<div class="tags">
|
|
1284
|
+
|
|
1285
|
+
<p class="tag_title">Returns:</p>
|
|
1286
|
+
<ul class="return">
|
|
1287
|
+
|
|
1288
|
+
<li>
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
<span class='type'>(<tt><span class='object_link'><a href="User.html" title="ZendeskAPI::User (class)">ZendeskAPI::User</a></span></tt>)</span>
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
—
|
|
1296
|
+
<div class='inline'>
|
|
1297
|
+
<p>Current user or nil</p>
|
|
1298
|
+
</div>
|
|
1299
|
+
|
|
1300
|
+
</li>
|
|
1301
|
+
|
|
1302
|
+
</ul>
|
|
1303
|
+
|
|
1304
|
+
</div><table class="source_code">
|
|
1305
|
+
<tr>
|
|
1306
|
+
<td>
|
|
1307
|
+
<pre class="lines">
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
48
|
|
1311
|
+
49
|
|
1312
|
+
50
|
|
1313
|
+
51</pre>
|
|
1314
|
+
</td>
|
|
1315
|
+
<td>
|
|
1316
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 48</span>
|
|
1317
|
+
|
|
1318
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_current_user'>current_user</span><span class='lparen'>(</span><span class='id identifier rubyid_reload'>reload</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
1319
|
+
<span class='kw'>return</span> <span class='ivar'>@current_user</span> <span class='kw'>if</span> <span class='ivar'>@current_user</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_reload'>reload</span>
|
|
1320
|
+
<span class='ivar'>@current_user</span> <span class='op'>=</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'>=></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>
|
|
1321
|
+
<span class='kw'>end</span></pre>
|
|
1322
|
+
</td>
|
|
1323
|
+
</tr>
|
|
1324
|
+
</table>
|
|
1325
|
+
</div>
|
|
1326
|
+
|
|
1327
|
+
<div class="method_details ">
|
|
1328
|
+
<h3 class="signature " id="format_headers-instance_method">
|
|
1329
|
+
|
|
1330
|
+
- (<tt>Object</tt>) <strong>format_headers</strong>
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
</h3><table class="source_code">
|
|
1337
|
+
<tr>
|
|
1338
|
+
<td>
|
|
1339
|
+
<pre class="lines">
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
73
|
|
1343
|
+
74
|
|
1344
|
+
75</pre>
|
|
1345
|
+
</td>
|
|
1346
|
+
<td>
|
|
1347
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 73</span>
|
|
1348
|
+
|
|
1349
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_format_headers'>format_headers</span>
|
|
1350
|
+
<span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>resource name</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
1351
|
+
<span class='kw'>end</span></pre>
|
|
1352
|
+
</td>
|
|
1353
|
+
</tr>
|
|
1354
|
+
</table>
|
|
1355
|
+
</div>
|
|
1356
|
+
|
|
1357
|
+
<div class="method_details ">
|
|
1358
|
+
<h3 class="signature " id="insert_callback-instance_method">
|
|
1359
|
+
|
|
1360
|
+
- (<tt>Object</tt>) <strong>insert_callback</strong>(&block)
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
</h3><div class="docstring">
|
|
1367
|
+
<div class="discussion">
|
|
1368
|
+
|
|
1369
|
+
<p>Pushes a callback onto the stack. Callbacks are executed on responses, last
|
|
1370
|
+
in the Faraday middleware stack.</p>
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
</div>
|
|
1374
|
+
</div>
|
|
1375
|
+
<div class="tags">
|
|
1376
|
+
<p class="tag_title">Parameters:</p>
|
|
1377
|
+
<ul class="param">
|
|
1378
|
+
|
|
1379
|
+
<li>
|
|
1380
|
+
|
|
1381
|
+
<span class='name'>block</span>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
<span class='type'>(<tt>Proc</tt>)</span>
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
—
|
|
1389
|
+
<div class='inline'>
|
|
1390
|
+
<p>The block to execute. Takes one parameter, env.</p>
|
|
1391
|
+
</div>
|
|
1392
|
+
|
|
1393
|
+
</li>
|
|
1394
|
+
|
|
1395
|
+
</ul>
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
</div><table class="source_code">
|
|
1399
|
+
<tr>
|
|
1400
|
+
<td>
|
|
1401
|
+
<pre class="lines">
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
121
|
|
1405
|
+
122
|
|
1406
|
+
123</pre>
|
|
1407
|
+
</td>
|
|
1408
|
+
<td>
|
|
1409
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/client.rb', line 121</span>
|
|
1410
|
+
|
|
1411
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_insert_callback'>insert_callback</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
1412
|
+
<span class='ivar'>@callbacks</span> <span class='op'><<</span> <span class='id identifier rubyid_block'>block</span>
|
|
1413
|
+
<span class='kw'>end</span></pre>
|
|
1414
|
+
</td>
|
|
1415
|
+
</tr>
|
|
1416
|
+
</table>
|
|
1417
|
+
</div>
|
|
1418
|
+
|
|
1419
|
+
<div class="method_details ">
|
|
1420
|
+
<h3 class="signature " id="to_a-instance_method">
|
|
1421
|
+
|
|
1422
|
+
- (<tt>Object</tt>) <strong>to_a</strong>
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
</h3><table class="source_code">
|
|
1429
|
+
<tr>
|
|
1430
|
+
<td>
|
|
1431
|
+
<pre class="lines">
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
69
|
|
1435
|
+
70
|
|
1436
|
+
71</pre>
|
|
1437
|
+
</td>
|
|
1438
|
+
<td>
|
|
1439
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 69</span>
|
|
1440
|
+
|
|
1441
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_a'>to_a</span>
|
|
1442
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_resources'>resources</span>
|
|
1443
|
+
<span class='kw'>end</span></pre>
|
|
1444
|
+
</td>
|
|
1445
|
+
</tr>
|
|
1446
|
+
</table>
|
|
1447
|
+
</div>
|
|
1448
|
+
|
|
1449
|
+
<div class="method_details ">
|
|
1450
|
+
<h3 class="signature " id="to_s-instance_method">
|
|
1451
|
+
|
|
1452
|
+
- (<tt>Object</tt>) <strong>to_s</strong>
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
</h3><table class="source_code">
|
|
1459
|
+
<tr>
|
|
1460
|
+
<td>
|
|
1461
|
+
<pre class="lines">
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
55
|
|
1465
|
+
56
|
|
1466
|
+
57</pre>
|
|
1467
|
+
</td>
|
|
1468
|
+
<td>
|
|
1469
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 55</span>
|
|
1470
|
+
|
|
1471
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
|
1472
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='tstring_end'>"</span></span>
|
|
1473
|
+
<span class='kw'>end</span></pre>
|
|
1474
|
+
</td>
|
|
1475
|
+
</tr>
|
|
1476
|
+
</table>
|
|
1477
|
+
</div>
|
|
1478
|
+
|
|
1479
|
+
</div>
|
|
1480
|
+
|
|
1481
|
+
</div>
|
|
1482
|
+
|
|
1483
|
+
<div id="footer">
|
|
1484
|
+
Generated on Mon Feb 11 17:45:36 2013 by
|
|
1485
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1486
|
+
0.8.4.1 (ruby-1.9.3).
|
|
1487
|
+
</div>
|
|
1488
|
+
|
|
1489
|
+
</body>
|
|
1490
|
+
</html>
|