zendesk_api 0.3.14 → 0.4.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- data/.yardopts +6 -2
- data/Gemfile +3 -2
- data/Gemfile.lock +4 -4
- data/Readme.md +3 -268
- data/lib/zendesk_api/actions.rb +51 -46
- data/lib/zendesk_api/association.rb +1 -1
- data/lib/zendesk_api/associations.rb +2 -6
- data/lib/zendesk_api/client.rb +8 -9
- data/lib/zendesk_api/collection.rb +84 -50
- data/lib/zendesk_api/configuration.rb +4 -0
- data/lib/zendesk_api/error.rb +22 -0
- data/lib/zendesk_api/middleware/request/etag_cache.rb +1 -7
- data/lib/zendesk_api/middleware/request/upload.rb +1 -2
- data/lib/zendesk_api/middleware/response/raise_error.rb +20 -0
- data/lib/zendesk_api/resource.rb +33 -5
- data/lib/zendesk_api/resources.rb +36 -11
- data/lib/zendesk_api/server/base.rb +1 -1
- data/lib/zendesk_api/server/helper.rb +3 -3
- data/lib/zendesk_api/server/models/zlib_json.rb +1 -1
- data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +7 -7
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +414 -51
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +321 -25
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +413 -46
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +410 -47
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +98 -362
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +457 -676
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +110 -20
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +264 -6
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +43 -82
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +671 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +207 -233
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +499 -24
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +614 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +73 -23
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +68 -18
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/{FormatError.html → Error.html} +19 -27
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/ClientError.html +127 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/{Server/UserRequest.html → Error/NetworkError.html} +18 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordInvalid.html +371 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordNotFound.html +127 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +426 -63
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +414 -51
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +414 -51
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +405 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +405 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +413 -46
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +404 -41
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthClient.html +606 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthToken.html +810 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +422 -59
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OrganizationField.html +606 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +75 -12
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +593 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +418 -55
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +420 -31
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +1025 -20
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Rule.html +610 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +317 -21
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +428 -39
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +63 -79
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +34 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +305 -9
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +433 -41
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +405 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +600 -31
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +464 -101
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +427 -25
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +435 -32
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +592 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +427 -64
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +907 -17
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +414 -55
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +325 -29
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +414 -51
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +413 -46
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +258 -6
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +62 -12
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +671 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +800 -28
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +505 -142
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +412 -49
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +475 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/UserField.html +606 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +9 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +433 -66
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +451 -49
- data/lib/zendesk_api/server/public/doc/_index.html +72 -72
- data/lib/zendesk_api/server/public/doc/class_list.html +1 -1
- data/lib/zendesk_api/server/public/doc/css/style.css +10 -0
- data/lib/zendesk_api/server/public/doc/file.Readme.html +20 -260
- data/lib/zendesk_api/server/public/doc/file_list.html +1 -1
- data/lib/zendesk_api/server/public/doc/frames.html +1 -1
- data/lib/zendesk_api/server/public/doc/index.html +20 -260
- data/lib/zendesk_api/server/public/doc/method_list.html +309 -517
- data/lib/zendesk_api/server/public/doc/top-level-namespace.html +3 -35
- data/lib/zendesk_api/verbs.rb +0 -4
- data/lib/zendesk_api/version.rb +1 -1
- data/spec/core/client_spec.rb +53 -13
- data/spec/core/collection_spec.rb +32 -4
- data/spec/core/create_resource_spec.rb +1 -1
- data/spec/core/data_resource_spec.rb +2 -2
- data/spec/core/middleware/request/etag_cache_spec.rb +6 -7
- data/spec/core/middleware/request/upload_spec.rb +2 -10
- data/spec/core/middleware/response/callback_spec.rb +1 -1
- data/spec/core/middleware/response/raise_error_spec.rb +40 -0
- data/spec/core/read_resource_spec.rb +0 -2
- data/spec/core/resource_spec.rb +13 -5
- data/spec/core/search_spec.rb +1 -1
- data/spec/core/spec_helper.rb +3 -3
- data/spec/live/automation_spec.rb +23 -0
- data/spec/live/organization_field_spec.rb +12 -0
- data/spec/live/ticket_spec.rb +8 -2
- data/spec/live/trigger_spec.rb +23 -0
- data/spec/live/user_field_spec.rb +12 -0
- data/spec/live/user_spec.rb +0 -2
- data/spec/live/view_spec.rb +17 -1
- data/spec/server/spec_helper.rb +2 -2
- data/zendesk_api.gemspec +1 -1
- metadata +88 -51
- checksums.yaml +0 -7
- data/lib/zendesk_api/rescue.rb +0 -63
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console.html +0 -860
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html +0 -190
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html +0 -131
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html +0 -523
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/Helper.html +0 -684
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer.html +0 -303
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html +0 -508
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/ZlibJSON.html +0 -244
- data/spec/core/rescue_spec.rb +0 -151
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<head>
|
|
5
5
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
6
|
<title>
|
|
7
|
-
Documentation by YARD 0.8.
|
|
7
|
+
Documentation by YARD 0.8.5.2
|
|
8
8
|
|
|
9
9
|
</title>
|
|
10
10
|
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
|
|
57
57
|
<iframe id="search_frame"></iframe>
|
|
58
58
|
|
|
59
|
-
<div id="content"><h1 class="noborder title">Documentation by YARD 0.8.
|
|
59
|
+
<div id="content"><h1 class="noborder title">Documentation by YARD 0.8.5.2</h1>
|
|
60
60
|
<div id="listing">
|
|
61
61
|
<h1 class="alphaindex">Alphabetic Index</h1>
|
|
62
62
|
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
<ul id="files" class="index_inline_list">
|
|
65
65
|
|
|
66
66
|
|
|
67
|
-
<li class="r1"><a href="
|
|
67
|
+
<li class="r1"><a href="index.html" title="Readme">Readme</a></li>
|
|
68
68
|
|
|
69
69
|
|
|
70
70
|
</ul>
|
|
@@ -98,13 +98,6 @@
|
|
|
98
98
|
|
|
99
99
|
</li>
|
|
100
100
|
|
|
101
|
-
<li>
|
|
102
|
-
<span class='object_link'><a href="ZendeskAPI/Server/App.html" title="ZendeskAPI::Server::App (class)">App</a></span>
|
|
103
|
-
|
|
104
|
-
<small>(ZendeskAPI::Server)</small>
|
|
105
|
-
|
|
106
|
-
</li>
|
|
107
|
-
|
|
108
101
|
<li>
|
|
109
102
|
<span class='object_link'><a href="ZendeskAPI/Attachment.html" title="ZendeskAPI::Attachment (class)">Attachment</a></span>
|
|
110
103
|
|
|
@@ -171,16 +164,16 @@
|
|
|
171
164
|
</li>
|
|
172
165
|
|
|
173
166
|
<li>
|
|
174
|
-
<span class='object_link'><a href="ZendeskAPI/
|
|
167
|
+
<span class='object_link'><a href="ZendeskAPI/Destroy/ClassMethod.html" title="ZendeskAPI::Destroy::ClassMethod (module)">ClassMethod</a></span>
|
|
175
168
|
|
|
176
|
-
<small>(ZendeskAPI::
|
|
169
|
+
<small>(ZendeskAPI::Destroy)</small>
|
|
177
170
|
|
|
178
171
|
</li>
|
|
179
172
|
|
|
180
173
|
<li>
|
|
181
|
-
<span class='object_link'><a href="ZendeskAPI/
|
|
174
|
+
<span class='object_link'><a href="ZendeskAPI/Update/ClassMethod.html" title="ZendeskAPI::Update::ClassMethod (module)">ClassMethod</a></span>
|
|
182
175
|
|
|
183
|
-
<small>(ZendeskAPI::
|
|
176
|
+
<small>(ZendeskAPI::Update)</small>
|
|
184
177
|
|
|
185
178
|
</li>
|
|
186
179
|
|
|
@@ -198,6 +191,13 @@
|
|
|
198
191
|
|
|
199
192
|
</li>
|
|
200
193
|
|
|
194
|
+
<li>
|
|
195
|
+
<span class='object_link'><a href="ZendeskAPI/Error/ClientError.html" title="ZendeskAPI::Error::ClientError (class)">ClientError</a></span>
|
|
196
|
+
|
|
197
|
+
<small>(ZendeskAPI::Error)</small>
|
|
198
|
+
|
|
199
|
+
</li>
|
|
200
|
+
|
|
201
201
|
<li>
|
|
202
202
|
<span class='object_link'><a href="ZendeskAPI/Collection.html" title="ZendeskAPI::Collection (class)">Collection</a></span>
|
|
203
203
|
|
|
@@ -226,13 +226,6 @@
|
|
|
226
226
|
|
|
227
227
|
</li>
|
|
228
228
|
|
|
229
|
-
<li>
|
|
230
|
-
<span class='object_link'><a href="ZendeskAPI/Console.html" title="ZendeskAPI::Console (module)">Console</a></span>
|
|
231
|
-
|
|
232
|
-
<small>(ZendeskAPI)</small>
|
|
233
|
-
|
|
234
|
-
</li>
|
|
235
|
-
|
|
236
229
|
<li>
|
|
237
230
|
<span class='object_link'><a href="ZendeskAPI/Create.html" title="ZendeskAPI::Create (module)">Create</a></span>
|
|
238
231
|
|
|
@@ -299,9 +292,9 @@
|
|
|
299
292
|
<ul>
|
|
300
293
|
|
|
301
294
|
<li>
|
|
302
|
-
<span class='object_link'><a href="ZendeskAPI/
|
|
295
|
+
<span class='object_link'><a href="ZendeskAPI/Error.html" title="ZendeskAPI::Error (module)">Error</a></span>
|
|
303
296
|
|
|
304
|
-
<small>(ZendeskAPI
|
|
297
|
+
<small>(ZendeskAPI)</small>
|
|
305
298
|
|
|
306
299
|
</li>
|
|
307
300
|
|
|
@@ -313,13 +306,6 @@
|
|
|
313
306
|
<li class="letter">F</li>
|
|
314
307
|
<ul>
|
|
315
308
|
|
|
316
|
-
<li>
|
|
317
|
-
<span class='object_link'><a href="ZendeskAPI/FormatError.html" title="ZendeskAPI::FormatError (class)">FormatError</a></span>
|
|
318
|
-
|
|
319
|
-
<small>(ZendeskAPI)</small>
|
|
320
|
-
|
|
321
|
-
</li>
|
|
322
|
-
|
|
323
309
|
<li>
|
|
324
310
|
<span class='object_link'><a href="ZendeskAPI/Forum.html" title="ZendeskAPI::Forum (class)">Forum</a></span>
|
|
325
311
|
|
|
@@ -363,28 +349,6 @@
|
|
|
363
349
|
</td><td valign='top' width="33%">
|
|
364
350
|
|
|
365
351
|
|
|
366
|
-
<ul id="alpha_H" class="alpha">
|
|
367
|
-
<li class="letter">H</li>
|
|
368
|
-
<ul>
|
|
369
|
-
|
|
370
|
-
<li>
|
|
371
|
-
<span class='object_link'><a href="ZendeskAPI/Server/Helper.html" title="ZendeskAPI::Server::Helper (module)">Helper</a></span>
|
|
372
|
-
|
|
373
|
-
<small>(ZendeskAPI::Server)</small>
|
|
374
|
-
|
|
375
|
-
</li>
|
|
376
|
-
|
|
377
|
-
<li>
|
|
378
|
-
<span class='object_link'><a href="ZendeskAPI/Server/HtmlRenderer.html" title="ZendeskAPI::Server::HtmlRenderer (class)">HtmlRenderer</a></span>
|
|
379
|
-
|
|
380
|
-
<small>(ZendeskAPI::Server)</small>
|
|
381
|
-
|
|
382
|
-
</li>
|
|
383
|
-
|
|
384
|
-
</ul>
|
|
385
|
-
</ul>
|
|
386
|
-
|
|
387
|
-
|
|
388
352
|
<ul id="alpha_I" class="alpha">
|
|
389
353
|
<li class="letter">I</li>
|
|
390
354
|
<ul>
|
|
@@ -452,10 +416,39 @@
|
|
|
452
416
|
</ul>
|
|
453
417
|
|
|
454
418
|
|
|
419
|
+
<ul id="alpha_N" class="alpha">
|
|
420
|
+
<li class="letter">N</li>
|
|
421
|
+
<ul>
|
|
422
|
+
|
|
423
|
+
<li>
|
|
424
|
+
<span class='object_link'><a href="ZendeskAPI/Error/NetworkError.html" title="ZendeskAPI::Error::NetworkError (class)">NetworkError</a></span>
|
|
425
|
+
|
|
426
|
+
<small>(ZendeskAPI::Error)</small>
|
|
427
|
+
|
|
428
|
+
</li>
|
|
429
|
+
|
|
430
|
+
</ul>
|
|
431
|
+
</ul>
|
|
432
|
+
|
|
433
|
+
|
|
455
434
|
<ul id="alpha_O" class="alpha">
|
|
456
435
|
<li class="letter">O</li>
|
|
457
436
|
<ul>
|
|
458
437
|
|
|
438
|
+
<li>
|
|
439
|
+
<span class='object_link'><a href="ZendeskAPI/OAuthClient.html" title="ZendeskAPI::OAuthClient (class)">OAuthClient</a></span>
|
|
440
|
+
|
|
441
|
+
<small>(ZendeskAPI)</small>
|
|
442
|
+
|
|
443
|
+
</li>
|
|
444
|
+
|
|
445
|
+
<li>
|
|
446
|
+
<span class='object_link'><a href="ZendeskAPI/OAuthToken.html" title="ZendeskAPI::OAuthToken (class)">OAuthToken</a></span>
|
|
447
|
+
|
|
448
|
+
<small>(ZendeskAPI)</small>
|
|
449
|
+
|
|
450
|
+
</li>
|
|
451
|
+
|
|
459
452
|
<li>
|
|
460
453
|
<span class='object_link'><a href="ZendeskAPI/Organization.html" title="ZendeskAPI::Organization (class)">Organization</a></span>
|
|
461
454
|
|
|
@@ -463,6 +456,13 @@
|
|
|
463
456
|
|
|
464
457
|
</li>
|
|
465
458
|
|
|
459
|
+
<li>
|
|
460
|
+
<span class='object_link'><a href="ZendeskAPI/OrganizationField.html" title="ZendeskAPI::OrganizationField (class)">OrganizationField</a></span>
|
|
461
|
+
|
|
462
|
+
<small>(ZendeskAPI)</small>
|
|
463
|
+
|
|
464
|
+
</li>
|
|
465
|
+
|
|
466
466
|
</ul>
|
|
467
467
|
</ul>
|
|
468
468
|
|
|
@@ -486,9 +486,16 @@
|
|
|
486
486
|
</li>
|
|
487
487
|
|
|
488
488
|
<li>
|
|
489
|
-
<span class='object_link'><a href="ZendeskAPI/
|
|
489
|
+
<span class='object_link'><a href="ZendeskAPI/Error/RecordInvalid.html" title="ZendeskAPI::Error::RecordInvalid (class)">RecordInvalid</a></span>
|
|
490
|
+
|
|
491
|
+
<small>(ZendeskAPI::Error)</small>
|
|
492
|
+
|
|
493
|
+
</li>
|
|
494
|
+
|
|
495
|
+
<li>
|
|
496
|
+
<span class='object_link'><a href="ZendeskAPI/Error/RecordNotFound.html" title="ZendeskAPI::Error::RecordNotFound (class)">RecordNotFound</a></span>
|
|
490
497
|
|
|
491
|
-
<small>(ZendeskAPI::
|
|
498
|
+
<small>(ZendeskAPI::Error)</small>
|
|
492
499
|
|
|
493
500
|
</li>
|
|
494
501
|
|
|
@@ -520,6 +527,13 @@
|
|
|
520
527
|
|
|
521
528
|
</li>
|
|
522
529
|
|
|
530
|
+
<li>
|
|
531
|
+
<span class='object_link'><a href="ZendeskAPI/Rule.html" title="ZendeskAPI::Rule (class)">Rule</a></span>
|
|
532
|
+
|
|
533
|
+
<small>(ZendeskAPI)</small>
|
|
534
|
+
|
|
535
|
+
</li>
|
|
536
|
+
|
|
523
537
|
<li>
|
|
524
538
|
<span class='object_link'><a href="ZendeskAPI/RuleExecution.html" title="ZendeskAPI::RuleExecution (class)">RuleExecution</a></span>
|
|
525
539
|
|
|
@@ -556,13 +570,6 @@
|
|
|
556
570
|
|
|
557
571
|
</li>
|
|
558
572
|
|
|
559
|
-
<li>
|
|
560
|
-
<span class='object_link'><a href="ZendeskAPI/Server.html" title="ZendeskAPI::Server (module)">Server</a></span>
|
|
561
|
-
|
|
562
|
-
<small>(ZendeskAPI)</small>
|
|
563
|
-
|
|
564
|
-
</li>
|
|
565
|
-
|
|
566
573
|
<li>
|
|
567
574
|
<span class='object_link'><a href="ZendeskAPI/Setting.html" title="ZendeskAPI::Setting (class)">Setting</a></span>
|
|
568
575
|
|
|
@@ -716,9 +723,9 @@
|
|
|
716
723
|
</li>
|
|
717
724
|
|
|
718
725
|
<li>
|
|
719
|
-
<span class='object_link'><a href="ZendeskAPI/
|
|
726
|
+
<span class='object_link'><a href="ZendeskAPI/UserField.html" title="ZendeskAPI::UserField (class)">UserField</a></span>
|
|
720
727
|
|
|
721
|
-
<small>(ZendeskAPI
|
|
728
|
+
<small>(ZendeskAPI)</small>
|
|
722
729
|
|
|
723
730
|
</li>
|
|
724
731
|
|
|
@@ -771,13 +778,6 @@
|
|
|
771
778
|
|
|
772
779
|
</li>
|
|
773
780
|
|
|
774
|
-
<li>
|
|
775
|
-
<span class='object_link'><a href="ZendeskAPI/Server/ZlibJSON.html" title="ZendeskAPI::Server::ZlibJSON (class)">ZlibJSON</a></span>
|
|
776
|
-
|
|
777
|
-
<small>(ZendeskAPI::Server)</small>
|
|
778
|
-
|
|
779
|
-
</li>
|
|
780
|
-
|
|
781
781
|
</ul>
|
|
782
782
|
</ul>
|
|
783
783
|
|
|
@@ -790,9 +790,9 @@
|
|
|
790
790
|
</div>
|
|
791
791
|
|
|
792
792
|
<div id="footer">
|
|
793
|
-
Generated on
|
|
793
|
+
Generated on Wed May 15 18:59:28 2013 by
|
|
794
794
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
795
|
-
0.8.
|
|
795
|
+
0.8.5.2 (ruby-1.9.3).
|
|
796
796
|
</div>
|
|
797
797
|
|
|
798
798
|
</body>
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
|
|
46
46
|
<ul id="full_list" class="class">
|
|
47
47
|
<li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
|
|
48
|
-
<li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Ability.html" title="ZendeskAPI::Ability (class)">Ability</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Activity.html" title="ZendeskAPI::Activity (class)">Activity</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Attachment.html" title="ZendeskAPI::Attachment (class)">Attachment</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Automation.html" title="ZendeskAPI::Automation (class)">Automation</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Bookmark.html" title="ZendeskAPI::Bookmark (class)">Bookmark</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CRMData.html" title="ZendeskAPI::CRMData (class)">CRMData</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CRMDataStatus.html" title="ZendeskAPI::CRMDataStatus (class)">CRMDataStatus</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Category.html" title="ZendeskAPI::Category (class)">Category</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Client.html" title="ZendeskAPI::Client (class)">Client</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Collection.html" title="ZendeskAPI::Collection (class)">Collection</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Configuration.html" title="ZendeskAPI::Configuration (class)">Configuration</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Console.html" title="ZendeskAPI::Console (module)">Console</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Console/Eval.html" title="ZendeskAPI::Console::Eval (module)">Eval</a></span><small class='search_info'>ZendeskAPI::Console</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Create.html" title="ZendeskAPI::Create (module)">Create</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Create/ClassMethods.html" title="ZendeskAPI::Create::ClassMethods (module)">ClassMethods</a></span><small class='search_info'>ZendeskAPI::Create</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/CreateResource.html" title="ZendeskAPI::CreateResource (class)">CreateResource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CustomRole.html" title="ZendeskAPI::CustomRole (class)">CustomRole</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Data.html" title="ZendeskAPI::Data (class)">Data</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/DeleteResource.html" title="ZendeskAPI::DeleteResource (class)">DeleteResource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Destroy/ClassMethod.html" title="ZendeskAPI::Destroy::ClassMethod (module)">ClassMethod</a></span><small class='search_info'>ZendeskAPI::Destroy</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/FormatError.html" title="ZendeskAPI::FormatError (class)">FormatError</a></span> < ArgumentError<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Forum.html" title="ZendeskAPI::Forum (class)">Forum</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ForumSubscription.html" title="ZendeskAPI::ForumSubscription (class)">ForumSubscription</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Group.html" title="ZendeskAPI::Group (class)">Group</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/GroupMembership.html" title="ZendeskAPI::GroupMembership (class)">GroupMembership</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/JobStatus.html" title="ZendeskAPI::JobStatus (class)">JobStatus</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Locale.html" title="ZendeskAPI::Locale (class)">Locale</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Macro.html" title="ZendeskAPI::Macro (class)">Macro</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/MobileDevice.html" title="ZendeskAPI::MobileDevice (class)">MobileDevice</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Organization.html" title="ZendeskAPI::Organization (class)">Organization</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Read.html" title="ZendeskAPI::Read (module)">Read</a></span><small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ReadResource.html" title="ZendeskAPI::ReadResource (class)">ReadResource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Request.html" title="ZendeskAPI::Request (class)">Request</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Request/Comment.html" title="ZendeskAPI::Request::Comment (class)">Comment</a></span> < ReadResource<small class='search_info'>ZendeskAPI::Request</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Role.html" title="ZendeskAPI::Role (class)">Role</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/RuleExecution.html" title="ZendeskAPI::RuleExecution (class)">RuleExecution</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SatisfactionRating.html" title="ZendeskAPI::SatisfactionRating (class)">SatisfactionRating</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Save.html" title="ZendeskAPI::Save (module)">Save</a></span><small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Search.html" title="ZendeskAPI::Search (class)">Search</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Search/Result.html" title="ZendeskAPI::Search::Result (class)">Result</a></span> < Data<small class='search_info'>ZendeskAPI::Search</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Server.html" title="ZendeskAPI::Server (module)">Server</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Server/App.html" title="ZendeskAPI::Server::App (class)">App</a></span> < Base<small class='search_info'>ZendeskAPI::Server</small></li><li><span class='object_link'><a href="ZendeskAPI/Server/Helper.html" title="ZendeskAPI::Server::Helper (module)">Helper</a></span><small class='search_info'>ZendeskAPI::Server</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Server/HtmlRenderer.html" title="ZendeskAPI::Server::HtmlRenderer (class)">HtmlRenderer</a></span> < Object<small class='search_info'>ZendeskAPI::Server</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html" title="ZendeskAPI::Server::HtmlRenderer::RedcarpetRenderer (class)">RedcarpetRenderer</a></span> < HTML<small class='search_info'>ZendeskAPI::Server::HtmlRenderer</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Server/UserRequest.html" title="ZendeskAPI::Server::UserRequest (class)">UserRequest</a></span> < Object<small class='search_info'>ZendeskAPI::Server</small></li><li><span class='object_link'><a href="ZendeskAPI/Server/ZlibJSON.html" title="ZendeskAPI::Server::ZlibJSON (class)">ZlibJSON</a></span> < Hash<small class='search_info'>ZendeskAPI::Server</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Setting.html" title="ZendeskAPI::Setting (class)">Setting</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SharingAgreement.html" title="ZendeskAPI::SharingAgreement (class)">SharingAgreement</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SingularResource.html" title="ZendeskAPI::SingularResource (class)">SingularResource</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SuspendedTicket.html" title="ZendeskAPI::SuspendedTicket (class)">SuspendedTicket</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Ticket.html" title="ZendeskAPI::Ticket (class)">Ticket</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Ticket/Audit.html" title="ZendeskAPI::Ticket::Audit (class)">Audit</a></span> < DataResource<small class='search_info'>ZendeskAPI::Ticket</small></li><li><span class='object_link'><a href="ZendeskAPI/Ticket/Comment.html" title="ZendeskAPI::Ticket::Comment (class)">Comment</a></span> < Data<small class='search_info'>ZendeskAPI::Ticket</small></li><li><span class='object_link'><a href="ZendeskAPI/Ticket/Tag.html" title="ZendeskAPI::Ticket::Tag (class)">Tag</a></span> < Resource<small class='search_info'>ZendeskAPI::Ticket</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/TicketField.html" title="ZendeskAPI::TicketField (class)">TicketField</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/TicketMetric.html" title="ZendeskAPI::TicketMetric (class)">TicketMetric</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Topic.html" title="ZendeskAPI::Topic (class)">Topic</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Topic/TopicComment.html" title="ZendeskAPI::Topic::TopicComment (class)">TopicComment</a></span> < TopicComment<small class='search_info'>ZendeskAPI::Topic</small></li><li><span class='object_link'><a href="ZendeskAPI/Topic/TopicVote.html" title="ZendeskAPI::Topic::TopicVote (class)">TopicVote</a></span> < SingularResource<small class='search_info'>ZendeskAPI::Topic</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/TopicComment.html" title="ZendeskAPI::TopicComment (class)">TopicComment</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/TopicSubscription.html" title="ZendeskAPI::TopicSubscription (class)">TopicSubscription</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Trigger.html" title="ZendeskAPI::Trigger (class)">Trigger</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Update.html" title="ZendeskAPI::Update (module)">Update</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Update/ClassMethod.html" title="ZendeskAPI::Update::ClassMethod (module)">ClassMethod</a></span><small class='search_info'>ZendeskAPI::Update</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/UpdateResource.html" title="ZendeskAPI::UpdateResource (class)">UpdateResource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Upload.html" title="ZendeskAPI::Upload (class)">Upload</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/User.html" title="ZendeskAPI::User (class)">User</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/User/Identity.html" title="ZendeskAPI::User::Identity (class)">Identity</a></span> < Resource<small class='search_info'>ZendeskAPI::User</small></li><li><span class='object_link'><a href="ZendeskAPI/User/TopicComment.html" title="ZendeskAPI::User::TopicComment (class)">TopicComment</a></span> < TopicComment<small class='search_info'>ZendeskAPI::User</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span><small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/View.html" title="ZendeskAPI::View (class)">View</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ViewCount.html" title="ZendeskAPI::ViewCount (class)">ViewCount</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ViewRow.html" title="ZendeskAPI::ViewRow (class)">ViewRow</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li></ul>
|
|
48
|
+
<li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Ability.html" title="ZendeskAPI::Ability (class)">Ability</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Activity.html" title="ZendeskAPI::Activity (class)">Activity</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Attachment.html" title="ZendeskAPI::Attachment (class)">Attachment</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Automation.html" title="ZendeskAPI::Automation (class)">Automation</a></span> < Rule<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Bookmark.html" title="ZendeskAPI::Bookmark (class)">Bookmark</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CRMData.html" title="ZendeskAPI::CRMData (class)">CRMData</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CRMDataStatus.html" title="ZendeskAPI::CRMDataStatus (class)">CRMDataStatus</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Category.html" title="ZendeskAPI::Category (class)">Category</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Client.html" title="ZendeskAPI::Client (class)">Client</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Collection.html" title="ZendeskAPI::Collection (class)">Collection</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Configuration.html" title="ZendeskAPI::Configuration (class)">Configuration</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Create.html" title="ZendeskAPI::Create (module)">Create</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Create/ClassMethods.html" title="ZendeskAPI::Create::ClassMethods (module)">ClassMethods</a></span><small class='search_info'>ZendeskAPI::Create</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/CreateResource.html" title="ZendeskAPI::CreateResource (class)">CreateResource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/CustomRole.html" title="ZendeskAPI::CustomRole (class)">CustomRole</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Data.html" title="ZendeskAPI::Data (class)">Data</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/DeleteResource.html" title="ZendeskAPI::DeleteResource (class)">DeleteResource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Destroy/ClassMethod.html" title="ZendeskAPI::Destroy::ClassMethod (module)">ClassMethod</a></span><small class='search_info'>ZendeskAPI::Destroy</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Error.html" title="ZendeskAPI::Error (module)">Error</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Error/ClientError.html" title="ZendeskAPI::Error::ClientError (class)">ClientError</a></span> < ClientError<small class='search_info'>ZendeskAPI::Error</small></li><li><span class='object_link'><a href="ZendeskAPI/Error/NetworkError.html" title="ZendeskAPI::Error::NetworkError (class)">NetworkError</a></span> < ClientError<small class='search_info'>ZendeskAPI::Error</small></li><li><span class='object_link'><a href="ZendeskAPI/Error/RecordInvalid.html" title="ZendeskAPI::Error::RecordInvalid (class)">RecordInvalid</a></span> < ClientError<small class='search_info'>ZendeskAPI::Error</small></li><li><span class='object_link'><a href="ZendeskAPI/Error/RecordNotFound.html" title="ZendeskAPI::Error::RecordNotFound (class)">RecordNotFound</a></span> < ClientError<small class='search_info'>ZendeskAPI::Error</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Forum.html" title="ZendeskAPI::Forum (class)">Forum</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ForumSubscription.html" title="ZendeskAPI::ForumSubscription (class)">ForumSubscription</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Group.html" title="ZendeskAPI::Group (class)">Group</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/GroupMembership.html" title="ZendeskAPI::GroupMembership (class)">GroupMembership</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/JobStatus.html" title="ZendeskAPI::JobStatus (class)">JobStatus</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Locale.html" title="ZendeskAPI::Locale (class)">Locale</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Macro.html" title="ZendeskAPI::Macro (class)">Macro</a></span> < Rule<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/MobileDevice.html" title="ZendeskAPI::MobileDevice (class)">MobileDevice</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/OAuthClient.html" title="ZendeskAPI::OAuthClient (class)">OAuthClient</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/OAuthToken.html" title="ZendeskAPI::OAuthToken (class)">OAuthToken</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Organization.html" title="ZendeskAPI::Organization (class)">Organization</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/OrganizationField.html" title="ZendeskAPI::OrganizationField (class)">OrganizationField</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Read.html" title="ZendeskAPI::Read (module)">Read</a></span><small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ReadResource.html" title="ZendeskAPI::ReadResource (class)">ReadResource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Request.html" title="ZendeskAPI::Request (class)">Request</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Request/Comment.html" title="ZendeskAPI::Request::Comment (class)">Comment</a></span> < ReadResource<small class='search_info'>ZendeskAPI::Request</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Role.html" title="ZendeskAPI::Role (class)">Role</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Rule.html" title="ZendeskAPI::Rule (class)">Rule</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/RuleExecution.html" title="ZendeskAPI::RuleExecution (class)">RuleExecution</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SatisfactionRating.html" title="ZendeskAPI::SatisfactionRating (class)">SatisfactionRating</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Save.html" title="ZendeskAPI::Save (module)">Save</a></span><small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Search.html" title="ZendeskAPI::Search (class)">Search</a></span> < Object<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Search/Result.html" title="ZendeskAPI::Search::Result (class)">Result</a></span> < Data<small class='search_info'>ZendeskAPI::Search</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/Setting.html" title="ZendeskAPI::Setting (class)">Setting</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SharingAgreement.html" title="ZendeskAPI::SharingAgreement (class)">SharingAgreement</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SingularResource.html" title="ZendeskAPI::SingularResource (class)">SingularResource</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/SuspendedTicket.html" title="ZendeskAPI::SuspendedTicket (class)">SuspendedTicket</a></span> < ReadResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Ticket.html" title="ZendeskAPI::Ticket (class)">Ticket</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Ticket/Audit.html" title="ZendeskAPI::Ticket::Audit (class)">Audit</a></span> < DataResource<small class='search_info'>ZendeskAPI::Ticket</small></li><li><span class='object_link'><a href="ZendeskAPI/Ticket/Comment.html" title="ZendeskAPI::Ticket::Comment (class)">Comment</a></span> < Data<small class='search_info'>ZendeskAPI::Ticket</small></li><li><span class='object_link'><a href="ZendeskAPI/Ticket/Tag.html" title="ZendeskAPI::Ticket::Tag (class)">Tag</a></span> < Resource<small class='search_info'>ZendeskAPI::Ticket</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/TicketField.html" title="ZendeskAPI::TicketField (class)">TicketField</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/TicketMetric.html" title="ZendeskAPI::TicketMetric (class)">TicketMetric</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Topic.html" title="ZendeskAPI::Topic (class)">Topic</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Topic/TopicComment.html" title="ZendeskAPI::Topic::TopicComment (class)">TopicComment</a></span> < TopicComment<small class='search_info'>ZendeskAPI::Topic</small></li><li><span class='object_link'><a href="ZendeskAPI/Topic/TopicVote.html" title="ZendeskAPI::Topic::TopicVote (class)">TopicVote</a></span> < SingularResource<small class='search_info'>ZendeskAPI::Topic</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/TopicComment.html" title="ZendeskAPI::TopicComment (class)">TopicComment</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/TopicSubscription.html" title="ZendeskAPI::TopicSubscription (class)">TopicSubscription</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Trigger.html" title="ZendeskAPI::Trigger (class)">Trigger</a></span> < Rule<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/Update.html" title="ZendeskAPI::Update (module)">Update</a></span><small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/Update/ClassMethod.html" title="ZendeskAPI::Update::ClassMethod (module)">ClassMethod</a></span><small class='search_info'>ZendeskAPI::Update</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/UpdateResource.html" title="ZendeskAPI::UpdateResource (class)">UpdateResource</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Upload.html" title="ZendeskAPI::Upload (class)">Upload</a></span> < Data<small class='search_info'>ZendeskAPI</small></li><li><a class='toggle'></a> <span class='object_link'><a href="ZendeskAPI/User.html" title="ZendeskAPI::User (class)">User</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><ul><li><span class='object_link'><a href="ZendeskAPI/User/Identity.html" title="ZendeskAPI::User::Identity (class)">Identity</a></span> < Resource<small class='search_info'>ZendeskAPI::User</small></li><li><span class='object_link'><a href="ZendeskAPI/User/TopicComment.html" title="ZendeskAPI::User::TopicComment (class)">TopicComment</a></span> < TopicComment<small class='search_info'>ZendeskAPI::User</small></li></ul><li><span class='object_link'><a href="ZendeskAPI/UserField.html" title="ZendeskAPI::UserField (class)">UserField</a></span> < Resource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span><small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/View.html" title="ZendeskAPI::View (class)">View</a></span> < Rule<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ViewCount.html" title="ZendeskAPI::ViewCount (class)">ViewCount</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li><li><span class='object_link'><a href="ZendeskAPI/ViewRow.html" title="ZendeskAPI::ViewRow (class)">ViewRow</a></span> < DataResource<small class='search_info'>ZendeskAPI</small></li></ul>
|
|
49
49
|
|
|
50
50
|
</ul>
|
|
51
51
|
</div>
|
|
@@ -27,6 +27,16 @@ h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right;
|
|
|
27
27
|
.rdoc-term { padding-right: 25px; font-weight: bold; }
|
|
28
28
|
.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
|
|
29
29
|
|
|
30
|
+
/* style for <table> */
|
|
31
|
+
#filecontents table, .docstring table { border-collapse: collapse; }
|
|
32
|
+
#filecontents table th, #filecontents table td,
|
|
33
|
+
.docstring table th, .docstring table td { border: 1px solid #ccc; padding: 8px; padding-right: 17px; }
|
|
34
|
+
#filecontents table tr:nth-child(odd),
|
|
35
|
+
.docstring table tr:nth-child(odd) { background: #eee; }
|
|
36
|
+
#filecontents table tr:nth-child(even),
|
|
37
|
+
.docstring table tr:nth-child(even) { background: #fff; }
|
|
38
|
+
#filecontents table th, .docstring table th { background: #fff; }
|
|
39
|
+
|
|
30
40
|
/* style for <ul> */
|
|
31
41
|
#filecontents li > p, .docstring li > p { margin: 0px; }
|
|
32
42
|
#filecontents ul, .docstring ul { padding-left: 20px; }
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
File: Readme
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.8.
|
|
9
|
+
— Documentation by YARD 0.8.5.2
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -67,13 +67,17 @@
|
|
|
67
67
|
|
|
68
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
69
|
|
|
70
|
-
<h2>
|
|
70
|
+
<h2>Documentation</h2>
|
|
71
71
|
|
|
72
|
-
<p>
|
|
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
73
|
|
|
74
|
-
<h2>Important
|
|
74
|
+
<h2>Important Notices</h2>
|
|
75
75
|
|
|
76
|
-
<
|
|
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>
|
|
77
81
|
|
|
78
82
|
<h2>Installation</h2>
|
|
79
83
|
|
|
@@ -93,257 +97,6 @@
|
|
|
93
97
|
|
|
94
98
|
<p>and follow normal <a href="http://gembundler.com/">Bundler</a> installation and execution procedures.</p>
|
|
95
99
|
|
|
96
|
-
<h2>Configuration</h2>
|
|
97
|
-
|
|
98
|
-
<p>Configuration is done through a block returning an instance of ZendeskAPI::Client.
|
|
99
|
-
The block is mandatory and if not passed, an ArgumentError will be thrown.</p>
|
|
100
|
-
|
|
101
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>zendesk_api</span><span class='tstring_end'>'</span></span>
|
|
102
|
-
|
|
103
|
-
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
|
|
104
|
-
<span class='comment'># Mandatory:
|
|
105
|
-
</span>
|
|
106
|
-
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'><- your-zendesk-url -></span><span class='tstring_end'>"</span></span> <span class='comment'># e.g. https://mydesk.zendesk.com/api/v2
|
|
107
|
-
</span>
|
|
108
|
-
<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'>login.email@zendesk.com</span><span class='tstring_end'>"</span></span>
|
|
109
|
-
|
|
110
|
-
<span class='comment'># Choose one of the following depending on your authentication choice
|
|
111
|
-
</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>your zendesk token</span><span class='tstring_end'>"</span></span>
|
|
112
|
-
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_password'>password</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>your zendesk password</span><span class='tstring_end'>"</span></span>
|
|
113
|
-
|
|
114
|
-
<span class='comment'># Optional:
|
|
115
|
-
</span>
|
|
116
|
-
<span class='comment'># Retry uses middleware to notify the user
|
|
117
|
-
</span> <span class='comment'># when hitting the rate limit, sleep automatically,
|
|
118
|
-
</span> <span class='comment'># then retry the request.
|
|
119
|
-
</span> <span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_retry'>retry</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
120
|
-
|
|
121
|
-
<span class='comment'># Logger prints to STDERR by default, to e.g. print to stdout:
|
|
122
|
-
</span> <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>logger</span><span class='tstring_end'>'</span></span>
|
|
123
|
-
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>=</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>STDOUT</span><span class='rparen'>)</span>
|
|
124
|
-
|
|
125
|
-
<span class='comment'># Changes Faraday adapter
|
|
126
|
-
</span> <span class='comment'># config.adapter = :patron
|
|
127
|
-
</span>
|
|
128
|
-
<span class='comment'># Merged with the default client options hash
|
|
129
|
-
</span> <span class='comment'># config.client_options = { :ssl => false }
|
|
130
|
-
</span>
|
|
131
|
-
<span class='comment'># When getting the error 'hostname does not match the server certificate'
|
|
132
|
-
</span> <span class='comment'># use the API at https://yoursubdomain.zendesk.com/api/v2
|
|
133
|
-
</span><span class='kw'>end</span>
|
|
134
|
-
</code></pre>
|
|
135
|
-
|
|
136
|
-
<p>Note: This ZendeskAPI API client only supports basic authentication at the moment.</p>
|
|
137
|
-
|
|
138
|
-
<h2>Usage</h2>
|
|
139
|
-
|
|
140
|
-
<p>The result of configuration is an instance of ZendeskAPI::Client which can then be used in two different methods.</p>
|
|
141
|
-
|
|
142
|
-
<p>One way to use the client is to pass it in as an argument to individual classes.</p>
|
|
143
|
-
|
|
144
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=></span> <span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:priority</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>urgent</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='comment'># doesn't actually send a request, must explicitly call #save
|
|
145
|
-
</span><span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:subject</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Test Ticket</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:comment</span> <span class='op'>=></span> <span class='lbrace'>{</span> <span class='symbol'>:value</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>This is a test</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:submitter_id</span> <span class='op'>=></span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_current_user'>current_user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='symbol'>:priority</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>urgent</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
146
|
-
<span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=></span> <span class='int'>1</span><span class='rparen'>)</span>
|
|
147
|
-
<span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:id</span> <span class='op'>=></span> <span class='int'>1</span><span class='rparen'>)</span>
|
|
148
|
-
</code></pre>
|
|
149
|
-
|
|
150
|
-
<p>Another way is to use the instance methods under client.</p>
|
|
151
|
-
|
|
152
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
153
|
-
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=></span> <span class='int'>1</span><span class='rparen'>)</span>
|
|
154
|
-
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='symbol'>:subject</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Test Ticket</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:comment</span> <span class='op'>=></span> <span class='lbrace'>{</span> <span class='symbol'>:value</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>This is a test</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='symbol'>:submitter_id</span> <span class='op'>=></span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_current_user'>current_user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='symbol'>:priority</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>urgent</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
155
|
-
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=></span> <span class='int'>1</span><span class='rparen'>)</span>
|
|
156
|
-
</code></pre>
|
|
157
|
-
|
|
158
|
-
<p>The methods under ZendeskAPI::Client (such as .tickets) return an instance of ZendeskAPI::Collection a lazy-loaded list of that resource.
|
|
159
|
-
Actual requests may not be sent until an explicit ZendeskAPI::Collection#fetch, ZendeskAPI::Collection#to_a, or an applicable methods such
|
|
160
|
-
as #each.</p>
|
|
161
|
-
|
|
162
|
-
<h3>Caveats</h3>
|
|
163
|
-
|
|
164
|
-
<p>Resource updating is implemented by sending only the <code>changed?</code> attributes to the server (see <code>ZendeskAPI::TrackChanges</code>).
|
|
165
|
-
Unfortunately, this module only hooks into <code>Hash</code> meaning any changes to an <code>Array</code>not resulting in a new instance will not be tracked and sent.</p>
|
|
166
|
-
|
|
167
|
-
<pre class="code ruby"><code class="ruby">zendesk_api_client_rb $ bundle console
|
|
168
|
-
> a = ZendeskAPI::Trackie.new(:tags => []).tap(&:clear_changes)
|
|
169
|
-
> a.changed?(:tags)
|
|
170
|
-
=> false
|
|
171
|
-
> a.tags << "my_new_tag"
|
|
172
|
-
=> ["my_new_tag"]
|
|
173
|
-
> a.changed?(:tags)
|
|
174
|
-
=> false
|
|
175
|
-
> a.tags += %w{my_other_tag}
|
|
176
|
-
=> ["my_new_tag", "my_other_tag"]
|
|
177
|
-
> a.changed?(:tags)
|
|
178
|
-
=> true
|
|
179
|
-
</code></pre>
|
|
180
|
-
|
|
181
|
-
<h3>Pagination</h3>
|
|
182
|
-
|
|
183
|
-
<p>ZendeskAPI::Collections can be paginated:</p>
|
|
184
|
-
|
|
185
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_tickets'>tickets</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_per_page'>per_page</span><span class='lparen'>(</span><span class='int'>3</span><span class='rparen'>)</span>
|
|
186
|
-
<span class='id identifier rubyid_next_page'>next_page</span> <span class='op'>=</span> <span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
|
|
187
|
-
<span class='id identifier rubyid_previous_page'>previous_page</span> <span class='op'>=</span> <span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_prev'>prev</span>
|
|
188
|
-
</code></pre>
|
|
189
|
-
|
|
190
|
-
<p>Iteration over all resources and pages is handled by Collection#page_page</p>
|
|
191
|
-
|
|
192
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_each_page'>each_page</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
|
|
193
|
-
<span class='comment'># all resources will be yielded
|
|
194
|
-
</span><span class='kw'>end</span>
|
|
195
|
-
</code></pre>
|
|
196
|
-
|
|
197
|
-
<p>If given a block with two arguments, the page is also passed in.</p>
|
|
198
|
-
|
|
199
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_each_page'>each_page</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_page'>page</span><span class='op'>|</span>
|
|
200
|
-
<span class='comment'># all resources will be yielded along with the page
|
|
201
|
-
</span><span class='kw'>end</span>
|
|
202
|
-
</code></pre>
|
|
203
|
-
|
|
204
|
-
<h3>Callbacks</h3>
|
|
205
|
-
|
|
206
|
-
<p>Callbacks can be added to the ZendeskAPI::Client instance and will be called (with the response env) after all response middleware on a successful request.</p>
|
|
207
|
-
|
|
208
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_insert_callback'>insert_callback</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_env'>env</span><span class='op'>|</span>
|
|
209
|
-
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span>
|
|
210
|
-
<span class='kw'>end</span>
|
|
211
|
-
</code></pre>
|
|
212
|
-
|
|
213
|
-
<h3>Resource management</h3>
|
|
214
|
-
|
|
215
|
-
<p>Individual resources can be created, modified, saved, and destroyed.</p>
|
|
216
|
-
|
|
217
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ticket'>ticket</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='comment'># ZendeskAPI::Ticket.find(client, :id => 1)
|
|
218
|
-
</span><span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>urgent</span><span class='tstring_end'>"</span></span>
|
|
219
|
-
<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span> <span class='comment'># => { "priority" => "urgent" }
|
|
220
|
-
</span><span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># Will PUT => true
|
|
221
|
-
</span><span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span> <span class='comment'># => true
|
|
222
|
-
</span>
|
|
223
|
-
<span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:priority</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>urgent</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
224
|
-
<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_new_record?'>new_record?</span> <span class='comment'># => true
|
|
225
|
-
</span><span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># Will POST
|
|
226
|
-
</span></code></pre>
|
|
227
|
-
|
|
228
|
-
<h3>Side-loading</h3>
|
|
229
|
-
|
|
230
|
-
<p><strong>Warning: this is an experimental feature. Abuse it and lose it.</strong></p>
|
|
231
|
-
|
|
232
|
-
<p>To facilitate a smaller number of requests and easier manipulation of associated data we allow "side-loading", or inclusion, of selected resources.</p>
|
|
233
|
-
|
|
234
|
-
<p>For example:
|
|
235
|
-
A ZendeskAPI::Ticket is associated with ZendeskAPI::User through the requester_id field.
|
|
236
|
-
API requests for that ticket return a structure similar to this:
|
|
237
|
-
<code>json
|
|
238
|
-
"ticket": {
|
|
239
|
-
"id": 1,
|
|
240
|
-
"url": "http.....",
|
|
241
|
-
"requester_id": 7,
|
|
242
|
-
...
|
|
243
|
-
}
|
|
244
|
-
</code></p>
|
|
245
|
-
|
|
246
|
-
<p>Calling ZendeskAPI::Ticket#requester automatically fetches and loads the user referenced above (<code>/api/v2/users/7</code>).
|
|
247
|
-
Using side-loading, however, the user can be partially loaded in the same request as the ticket.</p>
|
|
248
|
-
|
|
249
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_tickets'>tickets</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='symbol'>:users</span><span class='rparen'>)</span>
|
|
250
|
-
<span class='comment'># Or client.tickets(include: :users)
|
|
251
|
-
</span><span class='comment'># Does *NOT* make a request to the server since it is already loaded
|
|
252
|
-
</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_requester'>requester</span> <span class='comment'># => #<ZendeskAPI::User id=...>
|
|
253
|
-
</span></code></pre>
|
|
254
|
-
|
|
255
|
-
<p>OR</p>
|
|
256
|
-
|
|
257
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ticket'>ticket</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=></span> <span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:include</span> <span class='op'>=></span> <span class='symbol'>:users</span><span class='rparen'>)</span>
|
|
258
|
-
<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_requester'>requester</span> <span class='comment'># => #<ZendeskAPI::User id=...>
|
|
259
|
-
</span></code></pre>
|
|
260
|
-
|
|
261
|
-
<p>Currently, this feature is limited to only a few resources and their associations.
|
|
262
|
-
They are documented on <a href="http://developer.zendesk.com/documentation/rest_api/introduction.html#side-loading-(beta)">developer.zendesk.com</a>.</p>
|
|
263
|
-
|
|
264
|
-
<h3>Search</h3>
|
|
265
|
-
|
|
266
|
-
<p>Searching is done through the client. Returned is an instance of ZendeskAPI::Collection:</p>
|
|
267
|
-
|
|
268
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='symbol'>:query</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>my search query</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='comment'># /api/v2/search.json?query=...
|
|
269
|
-
</span><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span><span class='period'>.</span><span class='id identifier rubyid_search'>search</span><span class='lparen'>(</span><span class='symbol'>:query</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>my new query</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='comment'># /api/v2/users/search.json?query=...
|
|
270
|
-
</span></code></pre>
|
|
271
|
-
|
|
272
|
-
<h3>Special case: Custom resources paths</h3>
|
|
273
|
-
|
|
274
|
-
<p>API endpoints such as tickets/recent or topics/show_many can be accessed through chaining.
|
|
275
|
-
They will too return an instance of ZendeskAPI::Collection.</p>
|
|
276
|
-
|
|
277
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_tickets'>tickets</span><span class='period'>.</span><span class='id identifier rubyid_recent'>recent</span>
|
|
278
|
-
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_topics'>topics</span><span class='period'>.</span><span class='id identifier rubyid_show_many'>show_many</span><span class='lparen'>(</span><span class='symbol'>:verb</span> <span class='op'>=></span> <span class='symbol'>:post</span><span class='comma'>,</span> <span class='symbol'>:ids</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
279
|
-
</code></pre>
|
|
280
|
-
|
|
281
|
-
<h3>Special Case: Current user</h3>
|
|
282
|
-
|
|
283
|
-
<p>Use either of the following to obtain the current user instance:</p>
|
|
284
|
-
|
|
285
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_users'>users</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=></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>
|
|
286
|
-
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_current_user'>current_user</span>
|
|
287
|
-
</code></pre>
|
|
288
|
-
|
|
289
|
-
<h3>Special Case: Importing a ticket</h3>
|
|
290
|
-
|
|
291
|
-
<p>Bulk importing tickets allows you to move large amounts of data into Zendesk.</p>
|
|
292
|
-
|
|
293
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ticket'>ticket</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_import'>import</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:subject</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Help</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:comments</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='lbrace'>{</span> <span class='symbol'>:author_id</span> <span class='op'>=></span> <span class='int'>19</span><span class='comma'>,</span> <span class='symbol'>:value</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>This is a comment</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
294
|
-
</code></pre>
|
|
295
|
-
|
|
296
|
-
<p><a href="http://developer.zendesk.com/documentation/rest_api/ticket_import.html">http://developer.zendesk.com/documentation/rest_api/ticket_import.html</a></p>
|
|
297
|
-
|
|
298
|
-
<h3>Attaching files</h3>
|
|
299
|
-
|
|
300
|
-
<p>Files can be attached to ticket comments using either a path or the File class and will
|
|
301
|
-
be automatically uploaded and attached.</p>
|
|
302
|
-
|
|
303
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_ticket'>ticket</span> <span class='op'>=</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Ticket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='symbol'>:comment</span> <span class='op'>=></span> <span class='lbrace'>{</span> <span class='symbol'>:value</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>attachments</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
304
|
-
<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_comment'>comment</span><span class='period'>.</span><span class='id identifier rubyid_uploads'>uploads</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>img.jpg</span><span class='tstring_end'>"</span></span>
|
|
305
|
-
<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_comment'>comment</span><span class='period'>.</span><span class='id identifier rubyid_uploads'>uploads</span> <span class='op'><<</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>img.jpg</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
306
|
-
<span class='id identifier rubyid_ticket'>ticket</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
|
|
307
|
-
</code></pre>
|
|
308
|
-
|
|
309
|
-
<h2>Extras</h2>
|
|
310
|
-
|
|
311
|
-
<p>The following projects are still works in progress and require checking out the repository,
|
|
312
|
-
using ruby 1.9.3, and running <code>bundle install</code>.</p>
|
|
313
|
-
|
|
314
|
-
<h3>Zendesk API Test Server</h3>
|
|
315
|
-
|
|
316
|
-
<p>Included in this repository is the code for the <a href="https://zendesk-api.herokuapp.com/">Zendesk API Tester</a> website.</p>
|
|
317
|
-
|
|
318
|
-
<pre class="code sh"><code class="sh">bin/zendesk server --help
|
|
319
|
-
</code></pre>
|
|
320
|
-
|
|
321
|
-
<p>Additional Dependencies:</p>
|
|
322
|
-
|
|
323
|
-
<ul>
|
|
324
|
-
<li>sinatra</li>
|
|
325
|
-
<li>sinatra-contrib</li>
|
|
326
|
-
<li>haml</li>
|
|
327
|
-
<li>compass</li>
|
|
328
|
-
<li>coderay</li>
|
|
329
|
-
<li>coderay_bash</li>
|
|
330
|
-
<li>redcarpet</li>
|
|
331
|
-
<li>mongoid (and a working MongoDB instance)</li>
|
|
332
|
-
</ul>
|
|
333
|
-
|
|
334
|
-
<h3>Zendesk Console</h3>
|
|
335
|
-
|
|
336
|
-
<p>WIP</p>
|
|
337
|
-
|
|
338
|
-
<pre class="code sh"><code class="sh">bin/zendesk console --help
|
|
339
|
-
</code></pre>
|
|
340
|
-
|
|
341
|
-
<p>Additional Dependencies:</p>
|
|
342
|
-
|
|
343
|
-
<ul>
|
|
344
|
-
<li>ripl</li>
|
|
345
|
-
</ul>
|
|
346
|
-
|
|
347
100
|
<h2>Note on Patches/Pull Requests</h2>
|
|
348
101
|
|
|
349
102
|
<ol>
|
|
@@ -362,15 +115,22 @@ ignore when I pull)</li>
|
|
|
362
115
|
<p>Tested with Ruby 1.8.7 and 1.9.3
|
|
363
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>
|
|
364
117
|
|
|
365
|
-
<h2>Copyright</h2>
|
|
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>
|
|
366
126
|
|
|
367
|
-
<p>See
|
|
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>
|
|
368
128
|
</div></div>
|
|
369
129
|
|
|
370
130
|
<div id="footer">
|
|
371
|
-
Generated on
|
|
131
|
+
Generated on Wed May 15 18:59:28 2013 by
|
|
372
132
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
373
|
-
0.8.
|
|
133
|
+
0.8.5.2 (ruby-1.9.3).
|
|
374
134
|
</div>
|
|
375
135
|
|
|
376
136
|
</body>
|