zendesk_api 0.2.6 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (121) hide show
  1. data/.gitignore +2 -1
  2. data/Gemfile +7 -0
  3. data/Gemfile.lock +10 -2
  4. data/LICENSE +176 -19
  5. data/Readme.md +13 -5
  6. data/config/newrelic.yml +255 -0
  7. data/lib/zendesk_api/association.rb +1 -1
  8. data/lib/zendesk_api/associations.rb +129 -100
  9. data/lib/zendesk_api/client.rb +44 -25
  10. data/lib/zendesk_api/collection.rb +83 -58
  11. data/lib/zendesk_api/console/extensions.rb +47 -28
  12. data/lib/zendesk_api/server/base.rb +4 -0
  13. data/lib/zendesk_api/server/docs/account_settings.md +8 -0
  14. data/lib/zendesk_api/server/docs/automations.md +6 -0
  15. data/lib/zendesk_api/server/docs/changes_roadmap.md +76 -1
  16. data/lib/zendesk_api/server/docs/forum_subscriptions.md +2 -2
  17. data/lib/zendesk_api/server/docs/introduction.md +4 -2
  18. data/lib/zendesk_api/server/docs/macros.md +2 -0
  19. data/lib/zendesk_api/server/docs/organizations.md +3 -4
  20. data/lib/zendesk_api/server/docs/requests.md +21 -7
  21. data/lib/zendesk_api/server/docs/tickets.md +64 -8
  22. data/lib/zendesk_api/server/docs/topic_subscriptions.md +3 -3
  23. data/lib/zendesk_api/server/docs/topic_votes.md +0 -1
  24. data/lib/zendesk_api/server/docs/triggers.md +7 -0
  25. data/lib/zendesk_api/server/docs/users.md +4 -4
  26. data/lib/zendesk_api/server/docs/views.md +57 -8
  27. data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +131 -0
  28. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +190 -0
  29. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +616 -0
  30. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +362 -0
  31. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +438 -0
  32. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +243 -0
  33. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +190 -0
  34. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +190 -0
  35. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +462 -0
  36. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +1490 -0
  37. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +2825 -0
  38. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +1212 -0
  39. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console.html +860 -0
  40. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html +190 -0
  41. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +134 -0
  42. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +322 -0
  43. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +222 -0
  44. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +190 -0
  45. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +1432 -0
  46. data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +348 -0
  47. data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +216 -0
  48. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +307 -0
  49. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +245 -0
  50. data/lib/zendesk_api/server/public/doc/ZendeskAPI/FormatError.html +123 -0
  51. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +1196 -0
  52. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +616 -0
  53. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +243 -0
  54. data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +616 -0
  55. data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +209 -0
  56. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +209 -0
  57. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +438 -0
  58. data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +361 -0
  59. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +1016 -0
  60. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +278 -0
  61. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +220 -0
  62. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +826 -0
  63. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +604 -0
  64. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +258 -0
  65. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +190 -0
  66. data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +383 -0
  67. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +938 -0
  68. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +510 -0
  69. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +403 -0
  70. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +166 -0
  71. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html +131 -0
  72. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html +523 -0
  73. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/Helper.html +684 -0
  74. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer.html +303 -0
  75. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html +508 -0
  76. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/UserRequest.html +125 -0
  77. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/ZlibJSON.html +244 -0
  78. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +350 -0
  79. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +209 -0
  80. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +247 -0
  81. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +342 -0
  82. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +2731 -0
  83. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +385 -0
  84. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +636 -0
  85. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +243 -0
  86. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +243 -0
  87. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +205 -0
  88. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +1086 -0
  89. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +232 -0
  90. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +624 -0
  91. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +743 -0
  92. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +616 -0
  93. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +438 -0
  94. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +140 -0
  95. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +237 -0
  96. data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +222 -0
  97. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +404 -0
  98. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +3611 -0
  99. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +563 -0
  100. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +194 -0
  101. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +338 -0
  102. data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +1283 -0
  103. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +190 -0
  104. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +1342 -0
  105. data/lib/zendesk_api/server/public/doc/_index.html +799 -0
  106. data/lib/zendesk_api/server/public/doc/class_list.html +53 -0
  107. data/lib/zendesk_api/server/public/doc/css/common.css +1 -0
  108. data/lib/zendesk_api/server/public/doc/css/full_list.css +57 -0
  109. data/lib/zendesk_api/server/public/doc/css/style.css +328 -0
  110. data/lib/zendesk_api/server/public/doc/file.Readme.html +377 -0
  111. data/lib/zendesk_api/server/public/doc/file_list.html +55 -0
  112. data/lib/zendesk_api/server/public/doc/frames.html +28 -0
  113. data/lib/zendesk_api/server/public/doc/index.html +377 -0
  114. data/lib/zendesk_api/server/public/doc/js/app.js +214 -0
  115. data/lib/zendesk_api/server/public/doc/js/full_list.js +173 -0
  116. data/lib/zendesk_api/server/public/doc/js/jquery.js +4 -0
  117. data/lib/zendesk_api/server/public/doc/method_list.html +2540 -0
  118. data/lib/zendesk_api/server/public/doc/top-level-namespace.html +144 -0
  119. data/lib/zendesk_api/version.rb +1 -1
  120. data/zendesk_api.gemspec +1 -1
  121. metadata +96 -3
@@ -0,0 +1,2825 @@
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::Collection
8
+
9
+ &mdash; 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> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../ZendeskAPI.html" title="ZendeskAPI (module)">ZendeskAPI</a></span></span>
36
+ &raquo;
37
+ <span class="title">Collection</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::Collection
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::Collection</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/collection.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>Represents a collection of resources. Lazily loaded, resources aren't
108
+ actually fetched until explicitly needed (e.g. #each, <span class='object_link'><a href="#fetch-instance_method" title="ZendeskAPI::Collection#fetch (method)">#fetch</a></span>).</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="SPECIALLY_JOINED_PARAMS-constant" class="">SPECIALLY_JOINED_PARAMS =
122
+ <div class="docstring">
123
+ <div class="discussion">
124
+
125
+ <p>Options passed in that are automatically converted from an array to a
126
+ comma-separated list.</p>
127
+
128
+
129
+ </div>
130
+ </div>
131
+ <div class="tags">
132
+
133
+
134
+ </div>
135
+ </dt>
136
+ <dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:ids</span><span class='comma'>,</span> <span class='symbol'>:only</span><span class='rbracket'>]</span></pre></dd>
137
+
138
+ </dl>
139
+
140
+
141
+
142
+
143
+
144
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
145
+ <ul class="summary">
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a>
151
+
152
+
153
+
154
+ </span>
155
+
156
+
157
+
158
+
159
+ <span class="note title readonly">readonly</span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'>
170
+ <p>The class association.</p>
171
+ </div></span>
172
+
173
+ </li>
174
+
175
+
176
+ <li class="public ">
177
+ <span class="summary_signature">
178
+
179
+ <a href="#options-instance_method" title="#options (instance method)">- (Hash) <strong>options</strong> </a>
180
+
181
+
182
+
183
+ </span>
184
+
185
+
186
+
187
+
188
+ <span class="note title readonly">readonly</span>
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <span class="summary_desc"><div class='inline'>
199
+ <p>Query options.</p>
200
+ </div></span>
201
+
202
+ </li>
203
+
204
+
205
+ <li class="public ">
206
+ <span class="summary_signature">
207
+
208
+ <a href="#response-instance_method" title="#response (instance method)">- (Faraday::Response) <strong>response</strong> </a>
209
+
210
+
211
+
212
+ </span>
213
+
214
+
215
+
216
+
217
+ <span class="note title readonly">readonly</span>
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+ <span class="summary_desc"><div class='inline'>
228
+ <p>The last response.</p>
229
+ </div></span>
230
+
231
+ </li>
232
+
233
+
234
+ </ul>
235
+
236
+
237
+
238
+
239
+
240
+ <h2>
241
+ Instance Method Summary
242
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
243
+ </h2>
244
+
245
+ <ul class="summary">
246
+
247
+ <li class="public ">
248
+ <span class="summary_signature">
249
+
250
+ <a href="#%2F-instance_method" title="#/ (instance method)">- (Object) <strong>/</strong>(id) </a>
251
+
252
+
253
+
254
+ </span>
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+ <span class="summary_desc"><div class='inline'></div></span>
265
+
266
+ </li>
267
+
268
+
269
+ <li class="public ">
270
+ <span class="summary_signature">
271
+
272
+ <a href="#%3C%3C-instance_method" title="#&lt;&lt; (instance method)">- (Object) <strong>&lt;&lt;</strong>(item) </a>
273
+
274
+
275
+
276
+ </span>
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+ <span class="summary_desc"><div class='inline'>
287
+ <p>Adds an item to this collection.</p>
288
+ </div></span>
289
+
290
+ </li>
291
+
292
+
293
+ <li class="public ">
294
+ <span class="summary_signature">
295
+
296
+ <a href="#clear_cache-instance_method" title="#clear_cache (instance method)">- (Object) <strong>clear_cache</strong> </a>
297
+
298
+
299
+
300
+ </span>
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+ <span class="summary_desc"><div class='inline'>
311
+ <p>Clears all cached resources and associated values.</p>
312
+ </div></span>
313
+
314
+ </li>
315
+
316
+
317
+ <li class="public ">
318
+ <span class="summary_signature">
319
+
320
+ <a href="#count-instance_method" title="#count (instance method)">- (Number) <strong>count</strong> </a>
321
+
322
+
323
+
324
+ </span>
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+ <span class="summary_desc"><div class='inline'>
335
+ <p>The total number of resources server-side (disregarding pagination).</p>
336
+ </div></span>
337
+
338
+ </li>
339
+
340
+
341
+ <li class="public ">
342
+ <span class="summary_signature">
343
+
344
+ <a href="#create-instance_method" title="#create (instance method)">- (Object) <strong>create</strong>(attributes = {}) </a>
345
+
346
+
347
+
348
+ </span>
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+ <span class="summary_desc"><div class='inline'>
359
+ <p>Passes arguments and the proper path to the resource class method.</p>
360
+ </div></span>
361
+
362
+ </li>
363
+
364
+
365
+ <li class="public ">
366
+ <span class="summary_signature">
367
+
368
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong>(opts = {}) </a>
369
+
370
+
371
+
372
+ </span>
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+ <span class="summary_desc"><div class='inline'></div></span>
383
+
384
+ </li>
385
+
386
+
387
+ <li class="public ">
388
+ <span class="summary_signature">
389
+
390
+ <a href="#each_page-instance_method" title="#each_page (instance method)">- (Object) <strong>each_page</strong>(&amp;block) </a>
391
+
392
+
393
+
394
+ </span>
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+ <span class="summary_desc"><div class='inline'>
405
+ <p>Calls #each on every page with the passed in block.</p>
406
+ </div></span>
407
+
408
+ </li>
409
+
410
+
411
+ <li class="public ">
412
+ <span class="summary_signature">
413
+
414
+ <a href="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong>(reload = false) </a>
415
+
416
+
417
+
418
+ </span>
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+ <span class="summary_desc"><div class='inline'>
429
+ <p>Executes actual GET from API and loads resources into proper class.</p>
430
+ </div></span>
431
+
432
+ </li>
433
+
434
+
435
+ <li class="public ">
436
+ <span class="summary_signature">
437
+
438
+ <a href="#find-instance_method" title="#find (instance method)">- (Object) <strong>find</strong>(opts = {}) </a>
439
+
440
+
441
+
442
+ </span>
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+ <span class="summary_desc"><div class='inline'></div></span>
453
+
454
+ </li>
455
+
456
+
457
+ <li class="public ">
458
+ <span class="summary_signature">
459
+
460
+ <a href="#first_page%3F-instance_method" title="#first_page? (instance method)">- (Boolean) <strong>first_page?</strong> </a>
461
+
462
+
463
+
464
+ </span>
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+ <span class="summary_desc"><div class='inline'></div></span>
475
+
476
+ </li>
477
+
478
+
479
+ <li class="public ">
480
+ <span class="summary_signature">
481
+
482
+ <a href="#format_headers-instance_method" title="#format_headers (instance method)">- (Object) <strong>format_headers</strong> </a>
483
+
484
+
485
+
486
+ </span>
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+ <span class="summary_desc"><div class='inline'></div></span>
497
+
498
+ </li>
499
+
500
+
501
+ <li class="public ">
502
+ <span class="summary_signature">
503
+
504
+ <a href="#include-instance_method" title="#include (instance method)">- (Object) <strong>include</strong>(*sideloads) </a>
505
+
506
+
507
+
508
+ </span>
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+ <span class="summary_desc"><div class='inline'>
519
+ <p>Adds an item (or items) to the list of side-loaded resources to request.</p>
520
+ </div></span>
521
+
522
+ </li>
523
+
524
+
525
+ <li class="public ">
526
+ <span class="summary_signature">
527
+
528
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Collection) <strong>initialize</strong>(client, resource, options = {}) </a>
529
+
530
+
531
+
532
+ </span>
533
+
534
+
535
+ <span class="note title constructor">constructor</span>
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+ <span class="summary_desc"><div class='inline'>
545
+ <p>Creates a new Collection instance.</p>
546
+ </div></span>
547
+
548
+ </li>
549
+
550
+
551
+ <li class="public ">
552
+ <span class="summary_signature">
553
+
554
+ <a href="#last_page%3F-instance_method" title="#last_page? (instance method)">- (Boolean) <strong>last_page?</strong> </a>
555
+
556
+
557
+
558
+ </span>
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+ <span class="summary_desc"><div class='inline'></div></span>
569
+
570
+ </li>
571
+
572
+
573
+ <li class="public ">
574
+ <span class="summary_signature">
575
+
576
+ <a href="#loaded%3F-instance_method" title="#loaded? (instance method)">- (Boolean) <strong>loaded?</strong> </a>
577
+
578
+
579
+
580
+ </span>
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+ <span class="summary_desc"><div class='inline'></div></span>
591
+
592
+ </li>
593
+
594
+
595
+ <li class="public ">
596
+ <span class="summary_signature">
597
+
598
+ <a href="#log_error-instance_method" title="#log_error (instance method)">- (Object) <strong>log_error</strong>(e, _) </a>
599
+
600
+
601
+
602
+ </span>
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+ <span class="summary_desc"><div class='inline'></div></span>
613
+
614
+ </li>
615
+
616
+
617
+ <li class="public ">
618
+ <span class="summary_signature">
619
+
620
+ <a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(name, *args, &amp;block) </a>
621
+
622
+
623
+
624
+ </span>
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+ <span class="summary_desc"><div class='inline'>
635
+ <p>Sends methods to underlying array of resources.</p>
636
+ </div></span>
637
+
638
+ </li>
639
+
640
+
641
+ <li class="public ">
642
+ <span class="summary_signature">
643
+
644
+ <a href="#next-instance_method" title="#next (instance method)">- (Object) <strong>next</strong> </a>
645
+
646
+
647
+
648
+ </span>
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+ <span class="summary_desc"><div class='inline'>
659
+ <p>Find the next page.</p>
660
+ </div></span>
661
+
662
+ </li>
663
+
664
+
665
+ <li class="public ">
666
+ <span class="summary_signature">
667
+
668
+ <a href="#orig_log_error-instance_method" title="#orig_log_error (instance method)">- (Object) <strong>orig_log_error</strong> </a>
669
+
670
+
671
+
672
+ </span>
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+ <span class="summary_desc"><div class='inline'></div></span>
683
+
684
+ </li>
685
+
686
+
687
+ <li class="public ">
688
+ <span class="summary_signature">
689
+
690
+ <a href="#page-instance_method" title="#page (instance method)">- (Collection) <strong>page</strong>(number) </a>
691
+
692
+
693
+
694
+ </span>
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+ <span class="summary_desc"><div class='inline'>
705
+ <p>Changes the page option.</p>
706
+ </div></span>
707
+
708
+ </li>
709
+
710
+
711
+ <li class="public ">
712
+ <span class="summary_signature">
713
+
714
+ <a href="#path-instance_method" title="#path (instance method)">- (Object) <strong>path</strong> </a>
715
+
716
+
717
+
718
+ </span>
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+ <span class="summary_desc"><div class='inline'>
729
+ <p>The API path to this collection.</p>
730
+ </div></span>
731
+
732
+ </li>
733
+
734
+
735
+ <li class="public ">
736
+ <span class="summary_signature">
737
+
738
+ <a href="#per_page-instance_method" title="#per_page (instance method)">- (Collection) <strong>per_page</strong>(count) </a>
739
+
740
+
741
+
742
+ </span>
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+ <span class="summary_desc"><div class='inline'>
753
+ <p>Changes the per_page option.</p>
754
+ </div></span>
755
+
756
+ </li>
757
+
758
+
759
+ <li class="public ">
760
+ <span class="summary_signature">
761
+
762
+ <a href="#prev-instance_method" title="#prev (instance method)">- (Object) <strong>prev</strong> </a>
763
+
764
+
765
+
766
+ </span>
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+ <span class="summary_desc"><div class='inline'>
777
+ <p>Find the previous page.</p>
778
+ </div></span>
779
+
780
+ </li>
781
+
782
+
783
+ <li class="public ">
784
+ <span class="summary_signature">
785
+
786
+ <a href="#replace-instance_method" title="#replace (instance method)">- (Object) <strong>replace</strong>(collection) </a>
787
+
788
+
789
+
790
+ </span>
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+ <span class="summary_desc"><div class='inline'>
801
+ <p>Replaces the current (loaded or not) resources with the passed in
802
+ collection.</p>
803
+ </div></span>
804
+
805
+ </li>
806
+
807
+
808
+ <li class="public ">
809
+ <span class="summary_signature">
810
+
811
+ <a href="#save-instance_method" title="#save (instance method)">- (Collection) <strong>save</strong> </a>
812
+
813
+
814
+
815
+ </span>
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+
825
+ <span class="summary_desc"><div class='inline'>
826
+ <p>Saves all newly created resources stored in this collection.</p>
827
+ </div></span>
828
+
829
+ </li>
830
+
831
+
832
+ <li class="public ">
833
+ <span class="summary_signature">
834
+
835
+ <a href="#to_a-instance_method" title="#to_a (instance method)">- (Object) <strong>to_a</strong> </a>
836
+
837
+
838
+
839
+ </span>
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+ <span class="summary_desc"><div class='inline'>
850
+ <p>Alias for fetch(false).</p>
851
+ </div></span>
852
+
853
+ </li>
854
+
855
+
856
+ <li class="public ">
857
+ <span class="summary_signature">
858
+
859
+ <a href="#update-instance_method" title="#update (instance method)">- (Object) <strong>update</strong>(opts = {}) </a>
860
+
861
+
862
+
863
+ </span>
864
+
865
+
866
+
867
+
868
+
869
+
870
+
871
+
872
+
873
+ <span class="summary_desc"><div class='inline'></div></span>
874
+
875
+ </li>
876
+
877
+
878
+ </ul>
879
+
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+
893
+ <div id="constructor_details" class="method_details_list">
894
+ <h2>Constructor Details</h2>
895
+
896
+ <div class="method_details first">
897
+ <h3 class="signature first" id="initialize-instance_method">
898
+
899
+ - (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>initialize</strong>(client, resource, options = {})
900
+
901
+
902
+
903
+
904
+
905
+ </h3><div class="docstring">
906
+ <div class="discussion">
907
+
908
+ <p>Creates a new Collection instance. Does not fetch resources. Additional
909
+ options are: verb (default: GET), path (default: resource param), page,
910
+ per_page.</p>
911
+
912
+
913
+ </div>
914
+ </div>
915
+ <div class="tags">
916
+ <p class="tag_title">Parameters:</p>
917
+ <ul class="param">
918
+
919
+ <li>
920
+
921
+ <span class='name'>client</span>
922
+
923
+
924
+ <span class='type'>(<tt><span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">Client</a></span></tt>)</span>
925
+
926
+
927
+
928
+ &mdash;
929
+ <div class='inline'>
930
+ <p>The <span class='object_link'><a href="Client.html" title="ZendeskAPI::Client (class)">ZendeskAPI::Client</a></span> to use.</p>
931
+ </div>
932
+
933
+ </li>
934
+
935
+ <li>
936
+
937
+ <span class='name'>resource</span>
938
+
939
+
940
+ <span class='type'>(<tt>String</tt>)</span>
941
+
942
+
943
+
944
+ &mdash;
945
+ <div class='inline'>
946
+ <p>The resource being collected.</p>
947
+ </div>
948
+
949
+ </li>
950
+
951
+ <li>
952
+
953
+ <span class='name'>options</span>
954
+
955
+
956
+ <span class='type'>(<tt>Hash</tt>)</span>
957
+
958
+
959
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
960
+
961
+
962
+ &mdash;
963
+ <div class='inline'>
964
+ <p>Any additional options to be passed in.</p>
965
+ </div>
966
+
967
+ </li>
968
+
969
+ </ul>
970
+
971
+
972
+ </div><table class="source_code">
973
+ <tr>
974
+ <td>
975
+ <pre class="lines">
976
+
977
+
978
+ 29
979
+ 30
980
+ 31
981
+ 32
982
+ 33
983
+ 34
984
+ 35
985
+ 36
986
+ 37
987
+ 38
988
+ 39
989
+ 40
990
+ 41
991
+ 42
992
+ 43
993
+ 44
994
+ 45
995
+ 46
996
+ 47
997
+ 48
998
+ 49
999
+ 50
1000
+ 51
1001
+ 52
1002
+ 53
1003
+ 54
1004
+ 55
1005
+ 56
1006
+ 57</pre>
1007
+ </td>
1008
+ <td>
1009
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 29</span>
1010
+
1011
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1012
+ <span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@resource</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_resource_name'>resource_name</span>
1013
+ <span class='ivar'>@options</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_options'>options</span><span class='rparen'>)</span>
1014
+
1015
+ <span class='ivar'>@verb</span> <span class='op'>=</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:verb</span><span class='rparen'>)</span>
1016
+ <span class='ivar'>@collection_path</span> <span class='op'>=</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:collection_path</span><span class='rparen'>)</span>
1017
+
1018
+ <span class='id identifier rubyid_association_options'>association_options</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:path</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
1019
+ <span class='id identifier rubyid_association_options'>association_options</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='ivar'>@collection_path</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@collection_path</span>
1020
+ <span class='ivar'>@association</span> <span class='op'>=</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:association</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='const'>Association</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_association_options'>association_options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='rparen'>)</span>
1021
+
1022
+ <span class='comment'># some params use comma-joined strings instead of query-based arrays for multiple values
1023
+ </span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
1024
+ <span class='kw'>if</span> <span class='const'>SPECIALLY_JOINED_PARAMS</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
1025
+ <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
1026
+ <span class='kw'>end</span>
1027
+ <span class='kw'>end</span>
1028
+
1029
+ <span class='ivar'>@collection_path</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='ivar'>@resource</span><span class='rbracket'>]</span>
1030
+ <span class='ivar'>@resource_class</span> <span class='op'>=</span> <span class='id identifier rubyid_resource'>resource</span>
1031
+ <span class='ivar'>@fetchable</span> <span class='op'>=</span> <span class='kw'>true</span>
1032
+ <span class='ivar'>@includes</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:include</span><span class='rparen'>)</span><span class='rparen'>)</span>
1033
+
1034
+ <span class='comment'># Used for Attachments, TicketComment
1035
+ </span> <span class='kw'>if</span> <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Class</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_superclass'>superclass</span> <span class='op'>==</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Data</span>
1036
+ <span class='ivar'>@resources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
1037
+ <span class='ivar'>@fetchable</span> <span class='op'>=</span> <span class='kw'>false</span>
1038
+ <span class='kw'>end</span>
1039
+ <span class='kw'>end</span></pre>
1040
+ </td>
1041
+ </tr>
1042
+ </table>
1043
+ </div>
1044
+
1045
+ </div>
1046
+ <div id="method_missing_details" class="method_details_list">
1047
+ <h2>Dynamic Method Handling</h2>
1048
+ <p class="notice this">
1049
+ This class handles dynamic methods through the <tt>method_missing</tt> method
1050
+
1051
+ </p>
1052
+
1053
+ <div class="method_details first">
1054
+ <h3 class="signature first" id="method_missing-instance_method">
1055
+
1056
+ - (<tt>Object</tt>) <strong>method_missing</strong>(name, *args, &amp;block)
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+ </h3><div class="docstring">
1063
+ <div class="discussion">
1064
+
1065
+ <p>Sends methods to underlying array of resources.</p>
1066
+
1067
+
1068
+ </div>
1069
+ </div>
1070
+ <div class="tags">
1071
+
1072
+
1073
+ </div><table class="source_code">
1074
+ <tr>
1075
+ <td>
1076
+ <pre class="lines">
1077
+
1078
+
1079
+ 279
1080
+ 280
1081
+ 281
1082
+ 282
1083
+ 283
1084
+ 284
1085
+ 285
1086
+ 286
1087
+ 287
1088
+ 288
1089
+ 289
1090
+ 290
1091
+ 291</pre>
1092
+ </td>
1093
+ <td>
1094
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 279</span>
1095
+
1096
+ <span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
1097
+ <span class='id identifier rubyid_methods'>methods</span> <span class='op'>=</span> <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_singleton_methods'>singleton_methods</span><span class='lparen'>(</span><span class='kw'>false</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_sym</span><span class='rparen'>)</span>
1098
+
1099
+ <span class='kw'>if</span> <span class='id identifier rubyid_methods'>methods</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
1100
+ <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='ivar'>@client</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
1101
+ <span class='kw'>elsif</span> <span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
1102
+ <span class='id identifier rubyid_to_a'>to_a</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
1103
+ <span class='kw'>else</span>
1104
+ <span class='id identifier rubyid_opts'>opts</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_last'>last</span> <span class='op'>:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1105
+ <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='symbol'>:collection_path</span> <span class='op'>=&gt;</span> <span class='ivar'>@collection_path</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='rparen'>)</span>
1106
+ <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_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@resource_class</span><span class='comma'>,</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span><span class='rparen'>)</span>
1107
+ <span class='kw'>end</span>
1108
+ <span class='kw'>end</span></pre>
1109
+ </td>
1110
+ </tr>
1111
+ </table>
1112
+ </div>
1113
+
1114
+ </div>
1115
+
1116
+ <div id="instance_attr_details" class="attr_details">
1117
+ <h2>Instance Attribute Details</h2>
1118
+
1119
+
1120
+ <span id=""></span>
1121
+ <div class="method_details first">
1122
+ <h3 class="signature first" id="association-instance_method">
1123
+
1124
+ - (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong> <span class="extras">(readonly)</span>
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+ </h3><div class="docstring">
1131
+ <div class="discussion">
1132
+
1133
+ <p>The class association</p>
1134
+
1135
+
1136
+ </div>
1137
+ </div>
1138
+ <div class="tags">
1139
+
1140
+ <p class="tag_title">Returns:</p>
1141
+ <ul class="return">
1142
+
1143
+ <li>
1144
+
1145
+
1146
+ <span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span>
1147
+
1148
+
1149
+
1150
+ &mdash;
1151
+ <div class='inline'>
1152
+ <p>The class association</p>
1153
+ </div>
1154
+
1155
+ </li>
1156
+
1157
+ </ul>
1158
+
1159
+ </div><table class="source_code">
1160
+ <tr>
1161
+ <td>
1162
+ <pre class="lines">
1163
+
1164
+
1165
+ 16
1166
+ 17
1167
+ 18</pre>
1168
+ </td>
1169
+ <td>
1170
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 16</span>
1171
+
1172
+ <span class='kw'>def</span> <span class='id identifier rubyid_association'>association</span>
1173
+ <span class='ivar'>@association</span>
1174
+ <span class='kw'>end</span></pre>
1175
+ </td>
1176
+ </tr>
1177
+ </table>
1178
+ </div>
1179
+
1180
+
1181
+ <span id=""></span>
1182
+ <div class="method_details ">
1183
+ <h3 class="signature " id="options-instance_method">
1184
+
1185
+ - (<tt>Hash</tt>) <strong>options</strong> <span class="extras">(readonly)</span>
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+ </h3><div class="docstring">
1192
+ <div class="discussion">
1193
+
1194
+ <p>Query options</p>
1195
+
1196
+
1197
+ </div>
1198
+ </div>
1199
+ <div class="tags">
1200
+
1201
+ <p class="tag_title">Returns:</p>
1202
+ <ul class="return">
1203
+
1204
+ <li>
1205
+
1206
+
1207
+ <span class='type'>(<tt>Hash</tt>)</span>
1208
+
1209
+
1210
+
1211
+ &mdash;
1212
+ <div class='inline'>
1213
+ <p>query options</p>
1214
+ </div>
1215
+
1216
+ </li>
1217
+
1218
+ </ul>
1219
+
1220
+ </div><table class="source_code">
1221
+ <tr>
1222
+ <td>
1223
+ <pre class="lines">
1224
+
1225
+
1226
+ 22
1227
+ 23
1228
+ 24</pre>
1229
+ </td>
1230
+ <td>
1231
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 22</span>
1232
+
1233
+ <span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
1234
+ <span class='ivar'>@options</span>
1235
+ <span class='kw'>end</span></pre>
1236
+ </td>
1237
+ </tr>
1238
+ </table>
1239
+ </div>
1240
+
1241
+
1242
+ <span id=""></span>
1243
+ <div class="method_details ">
1244
+ <h3 class="signature " id="response-instance_method">
1245
+
1246
+ - (<tt>Faraday::Response</tt>) <strong>response</strong> <span class="extras">(readonly)</span>
1247
+
1248
+
1249
+
1250
+
1251
+
1252
+ </h3><div class="docstring">
1253
+ <div class="discussion">
1254
+
1255
+ <p>The last response</p>
1256
+
1257
+
1258
+ </div>
1259
+ </div>
1260
+ <div class="tags">
1261
+
1262
+ <p class="tag_title">Returns:</p>
1263
+ <ul class="return">
1264
+
1265
+ <li>
1266
+
1267
+
1268
+ <span class='type'>(<tt>Faraday::Response</tt>)</span>
1269
+
1270
+
1271
+
1272
+ &mdash;
1273
+ <div class='inline'>
1274
+ <p>The last response</p>
1275
+ </div>
1276
+
1277
+ </li>
1278
+
1279
+ </ul>
1280
+
1281
+ </div><table class="source_code">
1282
+ <tr>
1283
+ <td>
1284
+ <pre class="lines">
1285
+
1286
+
1287
+ 19
1288
+ 20
1289
+ 21</pre>
1290
+ </td>
1291
+ <td>
1292
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 19</span>
1293
+
1294
+ <span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
1295
+ <span class='ivar'>@response</span>
1296
+ <span class='kw'>end</span></pre>
1297
+ </td>
1298
+ </tr>
1299
+ </table>
1300
+ </div>
1301
+
1302
+ </div>
1303
+
1304
+
1305
+ <div id="instance_method_details" class="method_details_list">
1306
+ <h2>Instance Method Details</h2>
1307
+
1308
+
1309
+ <div class="method_details first">
1310
+ <h3 class="signature first" id="/-instance_method">
1311
+
1312
+ - (<tt>Object</tt>) <strong>/</strong>(id)
1313
+
1314
+
1315
+
1316
+
1317
+
1318
+ </h3><table class="source_code">
1319
+ <tr>
1320
+ <td>
1321
+ <pre class="lines">
1322
+
1323
+
1324
+ 4
1325
+ 5
1326
+ 6
1327
+ 7
1328
+ 8
1329
+ 9
1330
+ 10
1331
+ 11
1332
+ 12
1333
+ 13
1334
+ 14
1335
+ 15
1336
+ 16
1337
+ 17
1338
+ 18
1339
+ 19
1340
+ 20
1341
+ 21</pre>
1342
+ </td>
1343
+ <td>
1344
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 4</span>
1345
+
1346
+ <span class='kw'>def</span> <span class='op'>/</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1347
+ <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span> <span class='op'>==</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Console</span><span class='op'>::</span><span class='const'>ZD_DIRUP</span>
1348
+ <span class='kw'>if</span> <span class='ivar'>@collection_path</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>==</span> <span class='int'>1</span>
1349
+ <span class='ivar'>@client</span>
1350
+ <span class='kw'>else</span>
1351
+ <span class='ivar'>@collection_path</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
1352
+ <span class='kw'>self</span>
1353
+ <span class='kw'>end</span>
1354
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span>
1355
+ <span class='kw'>if</span> <span class='id identifier rubyid_loaded?'>loaded?</span>
1356
+ <span class='id identifier rubyid_detect'>detect</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_obj'>obj</span><span class='op'>|</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='op'>==</span> <span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span>
1357
+ <span class='kw'>else</span>
1358
+ <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='symbol'>:id</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1359
+ <span class='kw'>end</span>
1360
+ <span class='kw'>elsif</span> <span class='op'>!</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Collection</span><span class='rparen'>)</span>
1361
+ <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1362
+ <span class='kw'>end</span>
1363
+ <span class='kw'>end</span></pre>
1364
+ </td>
1365
+ </tr>
1366
+ </table>
1367
+ </div>
1368
+
1369
+ <div class="method_details ">
1370
+ <h3 class="signature " id="<<-instance_method">
1371
+
1372
+ - (<tt>Object</tt>) <strong>&lt;&lt;</strong>(item)
1373
+
1374
+
1375
+
1376
+
1377
+
1378
+ </h3><div class="docstring">
1379
+ <div class="discussion">
1380
+
1381
+ <p>Adds an item to this collection</p>
1382
+
1383
+
1384
+ </div>
1385
+ </div>
1386
+ <div class="tags">
1387
+ <p class="tag_title">Parameters:</p>
1388
+ <ul class="param">
1389
+
1390
+ <li>
1391
+
1392
+ <span class='name'>item</span>
1393
+
1394
+
1395
+ <span class='type'>(<tt>Hash</tt>)</span>
1396
+
1397
+
1398
+
1399
+ &mdash;
1400
+ <div class='inline'>
1401
+ <p>a customizable set of options</p>
1402
+ </div>
1403
+
1404
+ </li>
1405
+
1406
+ </ul>
1407
+
1408
+
1409
+
1410
+
1411
+ <p class="tag_title">Options Hash (<tt>item</tt>):</p>
1412
+ <ul class="option">
1413
+
1414
+ <li>
1415
+ <span class="name">the</span>
1416
+ <span class="type">(<tt><span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">ZendeskAPI::Data</a></span></tt>)</span>
1417
+ <span class="default">
1418
+
1419
+ </span>
1420
+
1421
+ &mdash; <div class='inline'>
1422
+ <p>resource to add</p>
1423
+ </div>
1424
+
1425
+ </li>
1426
+
1427
+ </ul>
1428
+
1429
+
1430
+ <p class="tag_title">Raises:</p>
1431
+ <ul class="raise">
1432
+
1433
+ <li>
1434
+
1435
+
1436
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
1437
+
1438
+
1439
+
1440
+ &mdash;
1441
+ <div class='inline'>
1442
+ <p>if the resource doesn't belong in this collection</p>
1443
+ </div>
1444
+
1445
+ </li>
1446
+
1447
+ </ul>
1448
+
1449
+ </div><table class="source_code">
1450
+ <tr>
1451
+ <td>
1452
+ <pre class="lines">
1453
+
1454
+
1455
+ 139
1456
+ 140
1457
+ 141
1458
+ 142
1459
+ 143
1460
+ 144
1461
+ 145
1462
+ 146
1463
+ 147
1464
+ 148
1465
+ 149
1466
+ 150
1467
+ 151</pre>
1468
+ </td>
1469
+ <td>
1470
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 139</span>
1471
+
1472
+ <span class='kw'>def</span> <span class='op'>&lt;&lt;</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
1473
+ <span class='id identifier rubyid_fetch'>fetch</span>
1474
+ <span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Resource</span><span class='rparen'>)</span>
1475
+ <span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='ivar'>@resource_class</span><span class='rparen'>)</span>
1476
+ <span class='ivar'>@resources</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_item'>item</span>
1477
+ <span class='kw'>else</span>
1478
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>this collection is for </span><span class='embexpr_beg'>#{</span><span class='ivar'>@resource_class</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
1479
+ <span class='kw'>end</span>
1480
+ <span class='kw'>else</span>
1481
+ <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='symbol'>:association</span> <span class='op'>=&gt;</span> <span class='ivar'>@association</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_item'>item</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>
1482
+ <span class='ivar'>@resources</span> <span class='op'>&lt;&lt;</span> <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
1483
+ <span class='kw'>end</span>
1484
+ <span class='kw'>end</span></pre>
1485
+ </td>
1486
+ </tr>
1487
+ </table>
1488
+ </div>
1489
+
1490
+ <div class="method_details ">
1491
+ <h3 class="signature " id="clear_cache-instance_method">
1492
+
1493
+ - (<tt>Object</tt>) <strong>clear_cache</strong>
1494
+
1495
+
1496
+
1497
+
1498
+
1499
+ </h3><div class="docstring">
1500
+ <div class="discussion">
1501
+
1502
+ <p>Clears all cached resources and associated values.</p>
1503
+
1504
+
1505
+ </div>
1506
+ </div>
1507
+ <div class="tags">
1508
+
1509
+
1510
+ </div><table class="source_code">
1511
+ <tr>
1512
+ <td>
1513
+ <pre class="lines">
1514
+
1515
+
1516
+ 268
1517
+ 269
1518
+ 270
1519
+ 271
1520
+ 272
1521
+ 273</pre>
1522
+ </td>
1523
+ <td>
1524
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 268</span>
1525
+
1526
+ <span class='kw'>def</span> <span class='id identifier rubyid_clear_cache'>clear_cache</span>
1527
+ <span class='ivar'>@resources</span> <span class='op'>=</span> <span class='kw'>nil</span>
1528
+ <span class='ivar'>@count</span> <span class='op'>=</span> <span class='kw'>nil</span>
1529
+ <span class='ivar'>@next_page</span> <span class='op'>=</span> <span class='kw'>nil</span>
1530
+ <span class='ivar'>@prev_page</span> <span class='op'>=</span> <span class='kw'>nil</span>
1531
+ <span class='kw'>end</span></pre>
1532
+ </td>
1533
+ </tr>
1534
+ </table>
1535
+ </div>
1536
+
1537
+ <div class="method_details ">
1538
+ <h3 class="signature " id="count-instance_method">
1539
+
1540
+ - (<tt>Number</tt>) <strong>count</strong>
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+ </h3><div class="docstring">
1547
+ <div class="discussion">
1548
+
1549
+ <p>The total number of resources server-side (disregarding pagination).</p>
1550
+
1551
+
1552
+ </div>
1553
+ </div>
1554
+ <div class="tags">
1555
+
1556
+ <p class="tag_title">Returns:</p>
1557
+ <ul class="return">
1558
+
1559
+ <li>
1560
+
1561
+
1562
+ <span class='type'>(<tt>Number</tt>)</span>
1563
+
1564
+
1565
+
1566
+ &mdash;
1567
+ <div class='inline'>
1568
+ <p>The total number of resources server-side (disregarding pagination).</p>
1569
+ </div>
1570
+
1571
+ </li>
1572
+
1573
+ </ul>
1574
+
1575
+ </div><table class="source_code">
1576
+ <tr>
1577
+ <td>
1578
+ <pre class="lines">
1579
+
1580
+
1581
+ 85
1582
+ 86
1583
+ 87
1584
+ 88</pre>
1585
+ </td>
1586
+ <td>
1587
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 85</span>
1588
+
1589
+ <span class='kw'>def</span> <span class='id identifier rubyid_count'>count</span>
1590
+ <span class='id identifier rubyid_fetch'>fetch</span>
1591
+ <span class='ivar'>@count</span> <span class='op'>||</span> <span class='op'>-</span><span class='int'>1</span>
1592
+ <span class='kw'>end</span></pre>
1593
+ </td>
1594
+ </tr>
1595
+ </table>
1596
+ </div>
1597
+
1598
+ <div class="method_details ">
1599
+ <h3 class="signature " id="create-instance_method">
1600
+
1601
+ - (<tt>Object</tt>) <strong>create</strong>(attributes = {})
1602
+
1603
+
1604
+
1605
+
1606
+
1607
+ </h3><div class="docstring">
1608
+ <div class="discussion">
1609
+
1610
+ <p>Passes arguments and the proper path to the resource class method.</p>
1611
+
1612
+
1613
+ </div>
1614
+ </div>
1615
+ <div class="tags">
1616
+ <p class="tag_title">Parameters:</p>
1617
+ <ul class="param">
1618
+
1619
+ <li>
1620
+
1621
+ <span class='name'>attributes</span>
1622
+
1623
+
1624
+ <span class='type'>(<tt>Hash</tt>)</span>
1625
+
1626
+
1627
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1628
+
1629
+
1630
+ &mdash;
1631
+ <div class='inline'>
1632
+ <p>Attributes to pass to Create#create</p>
1633
+ </div>
1634
+
1635
+ </li>
1636
+
1637
+ </ul>
1638
+
1639
+
1640
+ </div><table class="source_code">
1641
+ <tr>
1642
+ <td>
1643
+ <pre class="lines">
1644
+
1645
+
1646
+ 61
1647
+ 62
1648
+ 63
1649
+ 64</pre>
1650
+ </td>
1651
+ <td>
1652
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 61</span>
1653
+
1654
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1655
+ <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='symbol'>:association</span> <span class='op'>=&gt;</span> <span class='ivar'>@association</span><span class='rparen'>)</span>
1656
+ <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span><span class='rparen'>)</span>
1657
+ <span class='kw'>end</span></pre>
1658
+ </td>
1659
+ </tr>
1660
+ </table>
1661
+ </div>
1662
+
1663
+ <div class="method_details ">
1664
+ <h3 class="signature " id="destroy-instance_method">
1665
+
1666
+ - (<tt>Object</tt>) <strong>destroy</strong>(opts = {})
1667
+
1668
+
1669
+
1670
+
1671
+
1672
+ </h3><table class="source_code">
1673
+ <tr>
1674
+ <td>
1675
+ <pre class="lines">
1676
+
1677
+
1678
+ 79
1679
+ 80
1680
+ 81
1681
+ 82</pre>
1682
+ </td>
1683
+ <td>
1684
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 79</span>
1685
+
1686
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1687
+ <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='symbol'>:association</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_association'>association</span><span class='rparen'>)</span>
1688
+ <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span><span class='rparen'>)</span>
1689
+ <span class='kw'>end</span></pre>
1690
+ </td>
1691
+ </tr>
1692
+ </table>
1693
+ </div>
1694
+
1695
+ <div class="method_details ">
1696
+ <h3 class="signature " id="each_page-instance_method">
1697
+
1698
+ - (<tt>Object</tt>) <strong>each_page</strong>(&amp;block)
1699
+
1700
+
1701
+
1702
+
1703
+
1704
+ </h3><div class="docstring">
1705
+ <div class="discussion">
1706
+
1707
+ <p>Calls #each on every page with the passed in block</p>
1708
+
1709
+
1710
+ </div>
1711
+ </div>
1712
+ <div class="tags">
1713
+ <p class="tag_title">Parameters:</p>
1714
+ <ul class="param">
1715
+
1716
+ <li>
1717
+
1718
+ <span class='name'>block</span>
1719
+
1720
+
1721
+ <span class='type'>(<tt>Block</tt>)</span>
1722
+
1723
+
1724
+
1725
+ &mdash;
1726
+ <div class='inline'>
1727
+ <p>Passed to #each</p>
1728
+ </div>
1729
+
1730
+ </li>
1731
+
1732
+ </ul>
1733
+
1734
+
1735
+ </div><table class="source_code">
1736
+ <tr>
1737
+ <td>
1738
+ <pre class="lines">
1739
+
1740
+
1741
+ 206
1742
+ 207
1743
+ 208
1744
+ 209
1745
+ 210
1746
+ 211
1747
+ 212
1748
+ 213
1749
+ 214
1750
+ 215
1751
+ 216
1752
+ 217
1753
+ 218
1754
+ 219
1755
+ 220
1756
+ 221
1757
+ 222
1758
+ 223</pre>
1759
+ </td>
1760
+ <td>
1761
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 206</span>
1762
+
1763
+ <span class='kw'>def</span> <span class='id identifier rubyid_each_page'>each_page</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
1764
+ <span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span>
1765
+ <span class='id identifier rubyid_clear_cache'>clear_cache</span>
1766
+
1767
+ <span class='kw'>while</span> <span class='op'>!</span><span class='id identifier rubyid_empty?'>empty?</span>
1768
+ <span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
1769
+ <span class='id identifier rubyid_arguments'>arguments</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>1</span><span class='rbracket'>]</span>
1770
+
1771
+ <span class='kw'>if</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_arity'>arity</span> <span class='op'>&gt;=</span> <span class='int'>0</span>
1772
+ <span class='id identifier rubyid_arguments'>arguments</span> <span class='op'>=</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_take'>take</span><span class='lparen'>(</span><span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_arity'>arity</span><span class='rparen'>)</span>
1773
+ <span class='kw'>end</span>
1774
+
1775
+ <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span>
1776
+ <span class='kw'>end</span>
1777
+
1778
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_next'>next</span>
1779
+ <span class='kw'>end</span>
1780
+ <span class='kw'>end</span></pre>
1781
+ </td>
1782
+ </tr>
1783
+ </table>
1784
+ </div>
1785
+
1786
+ <div class="method_details ">
1787
+ <h3 class="signature " id="fetch-instance_method">
1788
+
1789
+ - (<tt>Object</tt>) <strong>fetch</strong>(reload = false)
1790
+
1791
+
1792
+
1793
+
1794
+
1795
+ </h3><div class="docstring">
1796
+ <div class="discussion">
1797
+
1798
+ <p>Executes actual GET from API and loads resources into proper class.</p>
1799
+
1800
+
1801
+ </div>
1802
+ </div>
1803
+ <div class="tags">
1804
+ <p class="tag_title">Parameters:</p>
1805
+ <ul class="param">
1806
+
1807
+ <li>
1808
+
1809
+ <span class='name'>reload</span>
1810
+
1811
+
1812
+ <span class='type'>(<tt>Boolean</tt>)</span>
1813
+
1814
+
1815
+ <em class="default">(defaults to: <tt>false</tt>)</em>
1816
+
1817
+
1818
+ &mdash;
1819
+ <div class='inline'>
1820
+ <p>Whether to disregard cache</p>
1821
+ </div>
1822
+
1823
+ </li>
1824
+
1825
+ </ul>
1826
+
1827
+
1828
+ </div><table class="source_code">
1829
+ <tr>
1830
+ <td>
1831
+ <pre class="lines">
1832
+
1833
+
1834
+ 160
1835
+ 161
1836
+ 162
1837
+ 163
1838
+ 164
1839
+ 165
1840
+ 166
1841
+ 167
1842
+ 168
1843
+ 169
1844
+ 170
1845
+ 171
1846
+ 172
1847
+ 173
1848
+ 174
1849
+ 175
1850
+ 176
1851
+ 177
1852
+ 178
1853
+ 179
1854
+ 180
1855
+ 181
1856
+ 182
1857
+ 183
1858
+ 184
1859
+ 185
1860
+ 186
1861
+ 187
1862
+ 188
1863
+ 189
1864
+ 190
1865
+ 191
1866
+ 192
1867
+ 193
1868
+ 194
1869
+ 195</pre>
1870
+ </td>
1871
+ <td>
1872
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 160</span>
1873
+
1874
+ <span class='kw'>def</span> <span class='id identifier rubyid_fetch'>fetch</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>
1875
+ <span class='kw'>return</span> <span class='ivar'>@resources</span> <span class='kw'>if</span> <span class='ivar'>@resources</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='op'>!</span><span class='ivar'>@fetchable</span> <span class='op'>||</span> <span class='op'>!</span><span class='id identifier rubyid_reload'>reload</span><span class='rparen'>)</span>
1876
+
1877
+ <span class='kw'>if</span> <span class='id identifier rubyid_association'>association</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_association'>association</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_new_record?'>new_record?</span>
1878
+ <span class='kw'>return</span> <span class='ivar'>@resources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
1879
+ <span class='kw'>end</span>
1880
+
1881
+ <span class='kw'>if</span> <span class='ivar'>@query</span>
1882
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='ivar'>@query</span>
1883
+ <span class='ivar'>@query</span> <span class='op'>=</span> <span class='kw'>nil</span>
1884
+ <span class='kw'>else</span>
1885
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span>
1886
+ <span class='kw'>end</span>
1887
+
1888
+ <span class='ivar'>@response</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='ivar'>@verb</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>get</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
1889
+ <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_delete_if'>delete_if</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span><span class='rbrace'>}</span>
1890
+
1891
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='symbol'>:include</span> <span class='op'>=&gt;</span> <span class='ivar'>@includes</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>,</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@includes</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
1892
+
1893
+ <span class='kw'>if</span> <span class='qwords_beg'>%w{</span><span class='tstring_content'>put</span><span class='words_sep'> </span><span class='tstring_content'>post</span><span class='words_sep'>}</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='ivar'>@verb</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
1894
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span>
1895
+ <span class='kw'>else</span>
1896
+ <span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
1897
+ <span class='kw'>end</span>
1898
+ <span class='kw'>end</span>
1899
+
1900
+ <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='ivar'>@response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
1901
+
1902
+ <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_model_key'>model_key</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>results</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1903
+ <span class='ivar'>@resources</span> <span class='op'>=</span> <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_res'>res</span><span class='op'>|</span> <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_res'>res</span><span class='rparen'>)</span><span class='rbrace'>}</span>
1904
+
1905
+ <span class='id identifier rubyid_set_page_and_count'>set_page_and_count</span><span class='lparen'>(</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
1906
+ <span class='id identifier rubyid_set_includes'>set_includes</span><span class='lparen'>(</span><span class='ivar'>@resources</span><span class='comma'>,</span> <span class='ivar'>@includes</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
1907
+
1908
+ <span class='ivar'>@resources</span>
1909
+ <span class='kw'>end</span></pre>
1910
+ </td>
1911
+ </tr>
1912
+ </table>
1913
+ </div>
1914
+
1915
+ <div class="method_details ">
1916
+ <h3 class="signature " id="find-instance_method">
1917
+
1918
+ - (<tt>Object</tt>) <strong>find</strong>(opts = {})
1919
+
1920
+
1921
+
1922
+
1923
+
1924
+ </h3><table class="source_code">
1925
+ <tr>
1926
+ <td>
1927
+ <pre class="lines">
1928
+
1929
+
1930
+ 67
1931
+ 68
1932
+ 69
1933
+ 70</pre>
1934
+ </td>
1935
+ <td>
1936
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 67</span>
1937
+
1938
+ <span class='kw'>def</span> <span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1939
+ <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='symbol'>:association</span> <span class='op'>=&gt;</span> <span class='ivar'>@association</span><span class='rparen'>)</span>
1940
+ <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span><span class='rparen'>)</span>
1941
+ <span class='kw'>end</span></pre>
1942
+ </td>
1943
+ </tr>
1944
+ </table>
1945
+ </div>
1946
+
1947
+ <div class="method_details ">
1948
+ <h3 class="signature " id="first_page?-instance_method">
1949
+
1950
+ - (<tt>Boolean</tt>) <strong>first_page?</strong>
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+ </h3><div class="docstring">
1957
+ <div class="discussion">
1958
+
1959
+
1960
+ </div>
1961
+ </div>
1962
+ <div class="tags">
1963
+
1964
+ <p class="tag_title">Returns:</p>
1965
+ <ul class="return">
1966
+
1967
+ <li>
1968
+
1969
+
1970
+ <span class='type'>(<tt>Boolean</tt>)</span>
1971
+
1972
+
1973
+
1974
+ </li>
1975
+
1976
+ </ul>
1977
+
1978
+ </div><table class="source_code">
1979
+ <tr>
1980
+ <td>
1981
+ <pre class="lines">
1982
+
1983
+
1984
+ 106
1985
+ 107
1986
+ 108</pre>
1987
+ </td>
1988
+ <td>
1989
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 106</span>
1990
+
1991
+ <span class='kw'>def</span> <span class='id identifier rubyid_first_page?'>first_page?</span>
1992
+ <span class='op'>!</span><span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>&lt;=</span> <span class='int'>1</span>
1993
+ <span class='kw'>end</span></pre>
1994
+ </td>
1995
+ </tr>
1996
+ </table>
1997
+ </div>
1998
+
1999
+ <div class="method_details ">
2000
+ <h3 class="signature " id="format_headers-instance_method">
2001
+
2002
+ - (<tt>Object</tt>) <strong>format_headers</strong>
2003
+
2004
+
2005
+
2006
+
2007
+
2008
+ </h3><table class="source_code">
2009
+ <tr>
2010
+ <td>
2011
+ <pre class="lines">
2012
+
2013
+
2014
+ 37
2015
+ 38
2016
+ 39</pre>
2017
+ </td>
2018
+ <td>
2019
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 37</span>
2020
+
2021
+ <span class='kw'>def</span> <span class='id identifier rubyid_format_headers'>format_headers</span>
2022
+ <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_format_headers'>format_headers</span>
2023
+ <span class='kw'>end</span></pre>
2024
+ </td>
2025
+ </tr>
2026
+ </table>
2027
+ </div>
2028
+
2029
+ <div class="method_details ">
2030
+ <h3 class="signature " id="include-instance_method">
2031
+
2032
+ - (<tt>Object</tt>) <strong>include</strong>(*sideloads)
2033
+
2034
+
2035
+
2036
+
2037
+
2038
+ </h3><div class="docstring">
2039
+ <div class="discussion">
2040
+
2041
+ <p>Adds an item (or items) to the list of side-loaded resources to request</p>
2042
+
2043
+
2044
+ </div>
2045
+ </div>
2046
+ <div class="tags">
2047
+ <p class="tag_title">Parameters:</p>
2048
+ <ul class="param">
2049
+
2050
+ <li>
2051
+
2052
+ <span class='name'>sideloads</span>
2053
+
2054
+
2055
+ <span class='type'>(<tt>Hash</tt>)</span>
2056
+
2057
+
2058
+
2059
+ &mdash;
2060
+ <div class='inline'>
2061
+ <p>a customizable set of options</p>
2062
+ </div>
2063
+
2064
+ </li>
2065
+
2066
+ </ul>
2067
+
2068
+
2069
+
2070
+
2071
+
2072
+
2073
+ </div><table class="source_code">
2074
+ <tr>
2075
+ <td>
2076
+ <pre class="lines">
2077
+
2078
+
2079
+ 132
2080
+ 133
2081
+ 134</pre>
2082
+ </td>
2083
+ <td>
2084
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 132</span>
2085
+
2086
+ <span class='kw'>def</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_sideloads'>sideloads</span><span class='rparen'>)</span>
2087
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='lbrace'>{</span> <span class='ivar'>@includes</span><span class='period'>.</span><span class='id identifier rubyid_concat'>concat</span><span class='lparen'>(</span><span class='id identifier rubyid_sideloads'>sideloads</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_s</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
2088
+ <span class='kw'>end</span></pre>
2089
+ </td>
2090
+ </tr>
2091
+ </table>
2092
+ </div>
2093
+
2094
+ <div class="method_details ">
2095
+ <h3 class="signature " id="last_page?-instance_method">
2096
+
2097
+ - (<tt>Boolean</tt>) <strong>last_page?</strong>
2098
+
2099
+
2100
+
2101
+
2102
+
2103
+ </h3><div class="docstring">
2104
+ <div class="discussion">
2105
+
2106
+
2107
+ </div>
2108
+ </div>
2109
+ <div class="tags">
2110
+
2111
+ <p class="tag_title">Returns:</p>
2112
+ <ul class="return">
2113
+
2114
+ <li>
2115
+
2116
+
2117
+ <span class='type'>(<tt>Boolean</tt>)</span>
2118
+
2119
+
2120
+
2121
+ </li>
2122
+
2123
+ </ul>
2124
+
2125
+ </div><table class="source_code">
2126
+ <tr>
2127
+ <td>
2128
+ <pre class="lines">
2129
+
2130
+
2131
+ 110
2132
+ 111
2133
+ 112</pre>
2134
+ </td>
2135
+ <td>
2136
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 110</span>
2137
+
2138
+ <span class='kw'>def</span> <span class='id identifier rubyid_last_page?'>last_page?</span>
2139
+ <span class='op'>!</span><span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>*</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>per_page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='op'>&gt;=</span> <span class='id identifier rubyid_count'>count</span>
2140
+ <span class='kw'>end</span></pre>
2141
+ </td>
2142
+ </tr>
2143
+ </table>
2144
+ </div>
2145
+
2146
+ <div class="method_details ">
2147
+ <h3 class="signature " id="loaded?-instance_method">
2148
+
2149
+ - (<tt>Boolean</tt>) <strong>loaded?</strong>
2150
+
2151
+
2152
+
2153
+
2154
+
2155
+ </h3><div class="docstring">
2156
+ <div class="discussion">
2157
+
2158
+
2159
+ </div>
2160
+ </div>
2161
+ <div class="tags">
2162
+
2163
+ <p class="tag_title">Returns:</p>
2164
+ <ul class="return">
2165
+
2166
+ <li>
2167
+
2168
+
2169
+ <span class='type'>(<tt>Boolean</tt>)</span>
2170
+
2171
+
2172
+
2173
+ </li>
2174
+
2175
+ </ul>
2176
+
2177
+ </div><table class="source_code">
2178
+ <tr>
2179
+ <td>
2180
+ <pre class="lines">
2181
+
2182
+
2183
+ 29
2184
+ 30
2185
+ 31</pre>
2186
+ </td>
2187
+ <td>
2188
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 29</span>
2189
+
2190
+ <span class='kw'>def</span> <span class='id identifier rubyid_loaded?'>loaded?</span>
2191
+ <span class='ivar'>@resources</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@resources</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
2192
+ <span class='kw'>end</span></pre>
2193
+ </td>
2194
+ </tr>
2195
+ </table>
2196
+ </div>
2197
+
2198
+ <div class="method_details ">
2199
+ <h3 class="signature " id="log_error-instance_method">
2200
+
2201
+ - (<tt>Object</tt>) <strong>log_error</strong>(e, _)
2202
+
2203
+
2204
+
2205
+
2206
+
2207
+ </h3><table class="source_code">
2208
+ <tr>
2209
+ <td>
2210
+ <pre class="lines">
2211
+
2212
+
2213
+ 25
2214
+ 26
2215
+ 27</pre>
2216
+ </td>
2217
+ <td>
2218
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 25</span>
2219
+
2220
+ <span class='kw'>def</span> <span class='id identifier rubyid_log_error'>log_error</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='id identifier rubyid__'>_</span><span class='rparen'>)</span>
2221
+ <span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_e'>e</span>
2222
+ <span class='kw'>end</span></pre>
2223
+ </td>
2224
+ </tr>
2225
+ </table>
2226
+ </div>
2227
+
2228
+ <div class="method_details ">
2229
+ <h3 class="signature " id="next-instance_method">
2230
+
2231
+ - (<tt>Object</tt>) <strong>next</strong>
2232
+
2233
+
2234
+
2235
+
2236
+
2237
+ </h3><div class="docstring">
2238
+ <div class="discussion">
2239
+
2240
+ <p>Find the next page. Does one of three things:</p>
2241
+ <ul><li>
2242
+ <p>If there is already a page number in the options hash, it increases it and
2243
+ invalidates the cache, returning the new page number.</p>
2244
+ </li><li>
2245
+ <p>If there is a next_page url cached, it executes a fetch on that url and
2246
+ returns the results.</p>
2247
+ </li><li>
2248
+ <p>Otherwise, returns an empty array.</p>
2249
+ </li></ul>
2250
+
2251
+
2252
+ </div>
2253
+ </div>
2254
+ <div class="tags">
2255
+
2256
+
2257
+ </div><table class="source_code">
2258
+ <tr>
2259
+ <td>
2260
+ <pre class="lines">
2261
+
2262
+
2263
+ 237
2264
+ 238
2265
+ 239
2266
+ 240
2267
+ 241
2268
+ 242
2269
+ 243
2270
+ 244
2271
+ 245
2272
+ 246
2273
+ 247
2274
+ 248</pre>
2275
+ </td>
2276
+ <td>
2277
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 237</span>
2278
+
2279
+ <span class='kw'>def</span> <span class='kw'>next</span>
2280
+ <span class='kw'>if</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
2281
+ <span class='id identifier rubyid_clear_cache'>clear_cache</span>
2282
+ <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>+=</span> <span class='int'>1</span>
2283
+ <span class='kw'>elsif</span> <span class='ivar'>@next_page</span>
2284
+ <span class='ivar'>@query</span> <span class='op'>=</span> <span class='ivar'>@next_page</span>
2285
+ <span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span>
2286
+ <span class='kw'>else</span>
2287
+ <span class='id identifier rubyid_clear_cache'>clear_cache</span>
2288
+ <span class='ivar'>@resources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
2289
+ <span class='kw'>end</span>
2290
+ <span class='kw'>end</span></pre>
2291
+ </td>
2292
+ </tr>
2293
+ </table>
2294
+ </div>
2295
+
2296
+ <div class="method_details ">
2297
+ <h3 class="signature " id="orig_log_error-instance_method">
2298
+
2299
+ - (<tt>Object</tt>) <strong>orig_log_error</strong>
2300
+
2301
+
2302
+
2303
+
2304
+
2305
+ </h3><table class="source_code">
2306
+ <tr>
2307
+ <td>
2308
+ <pre class="lines">
2309
+
2310
+
2311
+ 23</pre>
2312
+ </td>
2313
+ <td>
2314
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/console/extensions.rb', line 23</span>
2315
+
2316
+ <span class='kw'>alias</span> <span class='symbol'>:orig_log_error</span> <span class='symbol'>:log_error</span></pre>
2317
+ </td>
2318
+ </tr>
2319
+ </table>
2320
+ </div>
2321
+
2322
+ <div class="method_details ">
2323
+ <h3 class="signature " id="page-instance_method">
2324
+
2325
+ - (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>page</strong>(number)
2326
+
2327
+
2328
+
2329
+
2330
+
2331
+ </h3><div class="docstring">
2332
+ <div class="discussion">
2333
+
2334
+ <p>Changes the page option. Returns self, so it can be chained. No execution.</p>
2335
+
2336
+
2337
+ </div>
2338
+ </div>
2339
+ <div class="tags">
2340
+
2341
+ <p class="tag_title">Returns:</p>
2342
+ <ul class="return">
2343
+
2344
+ <li>
2345
+
2346
+
2347
+ <span class='type'>(<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>)</span>
2348
+
2349
+
2350
+
2351
+ &mdash;
2352
+ <div class='inline'>
2353
+ <p>self</p>
2354
+ </div>
2355
+
2356
+ </li>
2357
+
2358
+ </ul>
2359
+
2360
+ </div><table class="source_code">
2361
+ <tr>
2362
+ <td>
2363
+ <pre class="lines">
2364
+
2365
+
2366
+ 100
2367
+ 101
2368
+ 102
2369
+ 103
2370
+ 104</pre>
2371
+ </td>
2372
+ <td>
2373
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 100</span>
2374
+
2375
+ <span class='kw'>def</span> <span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='id identifier rubyid_number'>number</span><span class='rparen'>)</span>
2376
+ <span class='id identifier rubyid_clear_cache'>clear_cache</span> <span class='kw'>if</span> <span class='id identifier rubyid_number'>number</span>
2377
+ <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_number'>number</span>
2378
+ <span class='kw'>self</span>
2379
+ <span class='kw'>end</span></pre>
2380
+ </td>
2381
+ </tr>
2382
+ </table>
2383
+ </div>
2384
+
2385
+ <div class="method_details ">
2386
+ <h3 class="signature " id="path-instance_method">
2387
+
2388
+ - (<tt>Object</tt>) <strong>path</strong>
2389
+
2390
+
2391
+
2392
+
2393
+
2394
+ </h3><div class="docstring">
2395
+ <div class="discussion">
2396
+
2397
+ <p>The API path to this collection</p>
2398
+
2399
+
2400
+ </div>
2401
+ </div>
2402
+ <div class="tags">
2403
+
2404
+
2405
+ </div><table class="source_code">
2406
+ <tr>
2407
+ <td>
2408
+ <pre class="lines">
2409
+
2410
+
2411
+ 154
2412
+ 155
2413
+ 156</pre>
2414
+ </td>
2415
+ <td>
2416
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 154</span>
2417
+
2418
+ <span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span>
2419
+ <span class='ivar'>@association</span><span class='period'>.</span><span class='id identifier rubyid_generate_path'>generate_path</span><span class='lparen'>(</span><span class='symbol'>:with_parent</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='rparen'>)</span>
2420
+ <span class='kw'>end</span></pre>
2421
+ </td>
2422
+ </tr>
2423
+ </table>
2424
+ </div>
2425
+
2426
+ <div class="method_details ">
2427
+ <h3 class="signature " id="per_page-instance_method">
2428
+
2429
+ - (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>per_page</strong>(count)
2430
+
2431
+
2432
+
2433
+
2434
+
2435
+ </h3><div class="docstring">
2436
+ <div class="discussion">
2437
+
2438
+ <p>Changes the per_page option. Returns self, so it can be chained. No
2439
+ execution.</p>
2440
+
2441
+
2442
+ </div>
2443
+ </div>
2444
+ <div class="tags">
2445
+
2446
+ <p class="tag_title">Returns:</p>
2447
+ <ul class="return">
2448
+
2449
+ <li>
2450
+
2451
+
2452
+ <span class='type'>(<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>)</span>
2453
+
2454
+
2455
+
2456
+ &mdash;
2457
+ <div class='inline'>
2458
+ <p>self</p>
2459
+ </div>
2460
+
2461
+ </li>
2462
+
2463
+ </ul>
2464
+
2465
+ </div><table class="source_code">
2466
+ <tr>
2467
+ <td>
2468
+ <pre class="lines">
2469
+
2470
+
2471
+ 92
2472
+ 93
2473
+ 94
2474
+ 95
2475
+ 96</pre>
2476
+ </td>
2477
+ <td>
2478
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 92</span>
2479
+
2480
+ <span class='kw'>def</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='lparen'>(</span><span class='id identifier rubyid_count'>count</span><span class='rparen'>)</span>
2481
+ <span class='id identifier rubyid_clear_cache'>clear_cache</span> <span class='kw'>if</span> <span class='id identifier rubyid_count'>count</span>
2482
+ <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>per_page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_count'>count</span>
2483
+ <span class='kw'>self</span>
2484
+ <span class='kw'>end</span></pre>
2485
+ </td>
2486
+ </tr>
2487
+ </table>
2488
+ </div>
2489
+
2490
+ <div class="method_details ">
2491
+ <h3 class="signature " id="prev-instance_method">
2492
+
2493
+ - (<tt>Object</tt>) <strong>prev</strong>
2494
+
2495
+
2496
+
2497
+
2498
+
2499
+ </h3><div class="docstring">
2500
+ <div class="discussion">
2501
+
2502
+ <p>Find the previous page. Does one of three things:</p>
2503
+ <ul><li>
2504
+ <p>If there is already a page number in the options hash, it increases it and
2505
+ invalidates the cache, returning the new page number.</p>
2506
+ </li><li>
2507
+ <p>If there is a prev_page url cached, it executes a fetch on that url and
2508
+ returns the results.</p>
2509
+ </li><li>
2510
+ <p>Otherwise, returns an empty array.</p>
2511
+ </li></ul>
2512
+
2513
+
2514
+ </div>
2515
+ </div>
2516
+ <div class="tags">
2517
+
2518
+
2519
+ </div><table class="source_code">
2520
+ <tr>
2521
+ <td>
2522
+ <pre class="lines">
2523
+
2524
+
2525
+ 254
2526
+ 255
2527
+ 256
2528
+ 257
2529
+ 258
2530
+ 259
2531
+ 260
2532
+ 261
2533
+ 262
2534
+ 263
2535
+ 264
2536
+ 265</pre>
2537
+ </td>
2538
+ <td>
2539
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 254</span>
2540
+
2541
+ <span class='kw'>def</span> <span class='id identifier rubyid_prev'>prev</span>
2542
+ <span class='kw'>if</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>&gt;</span> <span class='int'>1</span>
2543
+ <span class='id identifier rubyid_clear_cache'>clear_cache</span>
2544
+ <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>page</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>-=</span> <span class='int'>1</span>
2545
+ <span class='kw'>elsif</span> <span class='ivar'>@prev_page</span>
2546
+ <span class='ivar'>@query</span> <span class='op'>=</span> <span class='ivar'>@prev_page</span>
2547
+ <span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span>
2548
+ <span class='kw'>else</span>
2549
+ <span class='id identifier rubyid_clear_cache'>clear_cache</span>
2550
+ <span class='ivar'>@resources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
2551
+ <span class='kw'>end</span>
2552
+ <span class='kw'>end</span></pre>
2553
+ </td>
2554
+ </tr>
2555
+ </table>
2556
+ </div>
2557
+
2558
+ <div class="method_details ">
2559
+ <h3 class="signature " id="replace-instance_method">
2560
+
2561
+ - (<tt>Object</tt>) <strong>replace</strong>(collection)
2562
+
2563
+
2564
+
2565
+
2566
+
2567
+ </h3><div class="docstring">
2568
+ <div class="discussion">
2569
+
2570
+ <p>Replaces the current (loaded or not) resources with the passed in
2571
+ collection</p>
2572
+
2573
+
2574
+ </div>
2575
+ </div>
2576
+ <div class="tags">
2577
+ <p class="tag_title">Parameters:</p>
2578
+ <ul class="param">
2579
+
2580
+ <li>
2581
+
2582
+ <span class='name'>collection</span>
2583
+
2584
+
2585
+ <span class='type'>(<tt>Hash</tt>)</span>
2586
+
2587
+
2588
+
2589
+ &mdash;
2590
+ <div class='inline'>
2591
+ <p>a customizable set of options</p>
2592
+ </div>
2593
+
2594
+ </li>
2595
+
2596
+ </ul>
2597
+
2598
+
2599
+
2600
+
2601
+ <p class="tag_title">Options Hash (<tt>collection</tt>):</p>
2602
+ <ul class="option">
2603
+
2604
+ <li>
2605
+ <span class="name">The</span>
2606
+ <span class="type">(<tt>Array</tt>)</span>
2607
+ <span class="default">
2608
+
2609
+ </span>
2610
+
2611
+ &mdash; <div class='inline'>
2612
+ <p>collection to replace this one with</p>
2613
+ </div>
2614
+
2615
+ </li>
2616
+
2617
+ </ul>
2618
+
2619
+
2620
+ <p class="tag_title">Raises:</p>
2621
+ <ul class="raise">
2622
+
2623
+ <li>
2624
+
2625
+
2626
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
2627
+
2628
+
2629
+
2630
+ &mdash;
2631
+ <div class='inline'>
2632
+ <p>if any resources passed in don't belong in this collection</p>
2633
+ </div>
2634
+
2635
+ </li>
2636
+
2637
+ </ul>
2638
+
2639
+ </div><table class="source_code">
2640
+ <tr>
2641
+ <td>
2642
+ <pre class="lines">
2643
+
2644
+
2645
+ 228
2646
+ 229
2647
+ 230
2648
+ 231</pre>
2649
+ </td>
2650
+ <td>
2651
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 228</span>
2652
+
2653
+ <span class='kw'>def</span> <span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='id identifier rubyid_collection'>collection</span><span class='rparen'>)</span>
2654
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>this collection is for </span><span class='embexpr_beg'>#{</span><span class='ivar'>@resource_class</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_collection'>collection</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='op'>!</span><span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='ivar'>@resource_class</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
2655
+ <span class='ivar'>@resources</span> <span class='op'>=</span> <span class='id identifier rubyid_collection'>collection</span>
2656
+ <span class='kw'>end</span></pre>
2657
+ </td>
2658
+ </tr>
2659
+ </table>
2660
+ </div>
2661
+
2662
+ <div class="method_details ">
2663
+ <h3 class="signature " id="save-instance_method">
2664
+
2665
+ - (<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>) <strong>save</strong>
2666
+
2667
+
2668
+
2669
+
2670
+
2671
+ </h3><div class="docstring">
2672
+ <div class="discussion">
2673
+
2674
+ <p>Saves all newly created resources stored in this collection.</p>
2675
+
2676
+
2677
+ </div>
2678
+ </div>
2679
+ <div class="tags">
2680
+
2681
+ <p class="tag_title">Returns:</p>
2682
+ <ul class="return">
2683
+
2684
+ <li>
2685
+
2686
+
2687
+ <span class='type'>(<tt><span class='object_link'><a href="" title="ZendeskAPI::Collection (class)">Collection</a></span></tt>)</span>
2688
+
2689
+
2690
+
2691
+ &mdash;
2692
+ <div class='inline'>
2693
+ <p>self</p>
2694
+ </div>
2695
+
2696
+ </li>
2697
+
2698
+ </ul>
2699
+
2700
+ </div><table class="source_code">
2701
+ <tr>
2702
+ <td>
2703
+ <pre class="lines">
2704
+
2705
+
2706
+ 116
2707
+ 117
2708
+ 118
2709
+ 119
2710
+ 120
2711
+ 121
2712
+ 122
2713
+ 123
2714
+ 124
2715
+ 125
2716
+ 126
2717
+ 127
2718
+ 128</pre>
2719
+ </td>
2720
+ <td>
2721
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 116</span>
2722
+
2723
+ <span class='kw'>def</span> <span class='id identifier rubyid_save'>save</span>
2724
+ <span class='kw'>if</span> <span class='ivar'>@resources</span>
2725
+ <span class='ivar'>@resources</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_item'>item</span><span class='op'>|</span>
2726
+ <span class='kw'>unless</span> <span class='op'>!</span><span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:save</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_changes'>changes</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
2727
+ <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
2728
+ <span class='kw'>end</span>
2729
+
2730
+ <span class='id identifier rubyid_item'>item</span>
2731
+ <span class='kw'>end</span>
2732
+ <span class='kw'>end</span>
2733
+
2734
+ <span class='kw'>self</span>
2735
+ <span class='kw'>end</span></pre>
2736
+ </td>
2737
+ </tr>
2738
+ </table>
2739
+ </div>
2740
+
2741
+ <div class="method_details ">
2742
+ <h3 class="signature " id="to_a-instance_method">
2743
+
2744
+ - (<tt>Object</tt>) <strong>to_a</strong>
2745
+
2746
+
2747
+
2748
+
2749
+
2750
+ </h3><div class="docstring">
2751
+ <div class="discussion">
2752
+
2753
+ <p>Alias for fetch(false)</p>
2754
+
2755
+
2756
+ </div>
2757
+ </div>
2758
+ <div class="tags">
2759
+
2760
+
2761
+ </div><table class="source_code">
2762
+ <tr>
2763
+ <td>
2764
+ <pre class="lines">
2765
+
2766
+
2767
+ 200
2768
+ 201
2769
+ 202</pre>
2770
+ </td>
2771
+ <td>
2772
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 200</span>
2773
+
2774
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_a'>to_a</span>
2775
+ <span class='id identifier rubyid_fetch'>fetch</span>
2776
+ <span class='kw'>end</span></pre>
2777
+ </td>
2778
+ </tr>
2779
+ </table>
2780
+ </div>
2781
+
2782
+ <div class="method_details ">
2783
+ <h3 class="signature " id="update-instance_method">
2784
+
2785
+ - (<tt>Object</tt>) <strong>update</strong>(opts = {})
2786
+
2787
+
2788
+
2789
+
2790
+
2791
+ </h3><table class="source_code">
2792
+ <tr>
2793
+ <td>
2794
+ <pre class="lines">
2795
+
2796
+
2797
+ 73
2798
+ 74
2799
+ 75
2800
+ 76</pre>
2801
+ </td>
2802
+ <td>
2803
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/collection.rb', line 73</span>
2804
+
2805
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
2806
+ <span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='symbol'>:association</span> <span class='op'>=&gt;</span> <span class='ivar'>@association</span><span class='rparen'>)</span>
2807
+ <span class='ivar'>@resource_class</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span><span class='rparen'>)</span>
2808
+ <span class='kw'>end</span></pre>
2809
+ </td>
2810
+ </tr>
2811
+ </table>
2812
+ </div>
2813
+
2814
+ </div>
2815
+
2816
+ </div>
2817
+
2818
+ <div id="footer">
2819
+ Generated on Mon Feb 11 17:45:41 2013 by
2820
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2821
+ 0.8.4.1 (ruby-1.9.3).
2822
+ </div>
2823
+
2824
+ </body>
2825
+ </html>