zendesk_api 0.3.14 → 0.4.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. data/.yardopts +6 -2
  2. data/Gemfile +3 -2
  3. data/Gemfile.lock +4 -4
  4. data/Readme.md +3 -268
  5. data/lib/zendesk_api/actions.rb +51 -46
  6. data/lib/zendesk_api/association.rb +1 -1
  7. data/lib/zendesk_api/associations.rb +2 -6
  8. data/lib/zendesk_api/client.rb +8 -9
  9. data/lib/zendesk_api/collection.rb +84 -50
  10. data/lib/zendesk_api/configuration.rb +4 -0
  11. data/lib/zendesk_api/error.rb +22 -0
  12. data/lib/zendesk_api/middleware/request/etag_cache.rb +1 -7
  13. data/lib/zendesk_api/middleware/request/upload.rb +1 -2
  14. data/lib/zendesk_api/middleware/response/raise_error.rb +20 -0
  15. data/lib/zendesk_api/resource.rb +33 -5
  16. data/lib/zendesk_api/resources.rb +36 -11
  17. data/lib/zendesk_api/server/base.rb +1 -1
  18. data/lib/zendesk_api/server/helper.rb +3 -3
  19. data/lib/zendesk_api/server/models/zlib_json.rb +1 -1
  20. data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +7 -7
  21. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +415 -13
  22. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +414 -51
  23. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +321 -25
  24. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +413 -46
  25. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +389 -26
  26. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +415 -13
  27. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +415 -13
  28. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +410 -47
  29. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +98 -362
  30. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +457 -676
  31. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +110 -20
  32. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +264 -6
  33. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +43 -82
  34. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +671 -15
  35. data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +415 -13
  36. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +207 -233
  37. data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +499 -24
  38. data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +614 -15
  39. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +73 -23
  40. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +68 -18
  41. data/lib/zendesk_api/server/public/doc/ZendeskAPI/{FormatError.html → Error.html} +19 -27
  42. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/ClientError.html +127 -0
  43. data/lib/zendesk_api/server/public/doc/ZendeskAPI/{Server/UserRequest.html → Error/NetworkError.html} +18 -16
  44. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordInvalid.html +371 -0
  45. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordNotFound.html +127 -0
  46. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +426 -63
  47. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +414 -51
  48. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +389 -26
  49. data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +414 -51
  50. data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +405 -16
  51. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +405 -16
  52. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +413 -46
  53. data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +404 -41
  54. data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthClient.html +606 -0
  55. data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthToken.html +810 -0
  56. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +422 -59
  57. data/lib/zendesk_api/server/public/doc/ZendeskAPI/OrganizationField.html +606 -0
  58. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +75 -12
  59. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +593 -16
  60. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +418 -55
  61. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +420 -31
  62. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +1025 -20
  63. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +415 -13
  64. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Rule.html +610 -0
  65. data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +317 -21
  66. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +428 -39
  67. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +63 -79
  68. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +34 -26
  69. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +305 -9
  70. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +433 -41
  71. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +405 -16
  72. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +389 -26
  73. data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +600 -31
  74. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +464 -101
  75. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +427 -25
  76. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +435 -32
  77. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +389 -26
  78. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +389 -26
  79. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +592 -15
  80. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +427 -64
  81. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +907 -17
  82. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +414 -55
  83. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +325 -29
  84. data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +414 -51
  85. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +413 -46
  86. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +258 -6
  87. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +62 -12
  88. data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +671 -15
  89. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +800 -28
  90. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +505 -142
  91. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +412 -49
  92. data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +475 -13
  93. data/lib/zendesk_api/server/public/doc/ZendeskAPI/UserField.html +606 -0
  94. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +9 -15
  95. data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +433 -66
  96. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +415 -13
  97. data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +451 -49
  98. data/lib/zendesk_api/server/public/doc/_index.html +72 -72
  99. data/lib/zendesk_api/server/public/doc/class_list.html +1 -1
  100. data/lib/zendesk_api/server/public/doc/css/style.css +10 -0
  101. data/lib/zendesk_api/server/public/doc/file.Readme.html +20 -260
  102. data/lib/zendesk_api/server/public/doc/file_list.html +1 -1
  103. data/lib/zendesk_api/server/public/doc/frames.html +1 -1
  104. data/lib/zendesk_api/server/public/doc/index.html +20 -260
  105. data/lib/zendesk_api/server/public/doc/method_list.html +309 -517
  106. data/lib/zendesk_api/server/public/doc/top-level-namespace.html +3 -35
  107. data/lib/zendesk_api/verbs.rb +0 -4
  108. data/lib/zendesk_api/version.rb +1 -1
  109. data/spec/core/client_spec.rb +53 -13
  110. data/spec/core/collection_spec.rb +32 -4
  111. data/spec/core/create_resource_spec.rb +1 -1
  112. data/spec/core/data_resource_spec.rb +2 -2
  113. data/spec/core/middleware/request/etag_cache_spec.rb +6 -7
  114. data/spec/core/middleware/request/upload_spec.rb +2 -10
  115. data/spec/core/middleware/response/callback_spec.rb +1 -1
  116. data/spec/core/middleware/response/raise_error_spec.rb +40 -0
  117. data/spec/core/read_resource_spec.rb +0 -2
  118. data/spec/core/resource_spec.rb +13 -5
  119. data/spec/core/search_spec.rb +1 -1
  120. data/spec/core/spec_helper.rb +3 -3
  121. data/spec/live/automation_spec.rb +23 -0
  122. data/spec/live/organization_field_spec.rb +12 -0
  123. data/spec/live/ticket_spec.rb +8 -2
  124. data/spec/live/trigger_spec.rb +23 -0
  125. data/spec/live/user_field_spec.rb +12 -0
  126. data/spec/live/user_spec.rb +0 -2
  127. data/spec/live/view_spec.rb +17 -1
  128. data/spec/server/spec_helper.rb +2 -2
  129. data/zendesk_api.gemspec +1 -1
  130. metadata +88 -51
  131. checksums.yaml +0 -7
  132. data/lib/zendesk_api/rescue.rb +0 -63
  133. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console.html +0 -860
  134. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html +0 -190
  135. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html +0 -131
  136. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html +0 -523
  137. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/Helper.html +0 -684
  138. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer.html +0 -303
  139. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html +0 -508
  140. data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/ZlibJSON.html +0 -244
  141. data/spec/core/rescue_spec.rb +0 -151
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: ZendeskAPI::Upload
8
8
 
9
- &mdash; Documentation by YARD 0.8.4.1
9
+ &mdash; Documentation by YARD 0.8.5.2
10
10
 
11
11
  </title>
12
12
 
@@ -93,7 +93,7 @@
93
93
 
94
94
 
95
95
  <dt class="r2">Includes:</dt>
96
- <dd class="r2"><span class='object_link'><a href="Create.html" title="ZendeskAPI::Create (module)">Create</a></span></dd>
96
+ <dd class="r2"><span class='object_link'><a href="Create.html" title="ZendeskAPI::Create (module)">Create</a></span>, <span class='object_link'><a href="Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span></dd>
97
97
 
98
98
 
99
99
 
@@ -109,12 +109,144 @@
109
109
 
110
110
 
111
111
 
112
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
113
+ <ul class="summary">
114
+
115
+ <li class="public ">
116
+ <span class="summary_signature">
117
+
118
+ <a href="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a>
119
+
120
+
121
+
122
+ </span>
123
+
124
+ <span class="note title not_defined_here">
125
+ inherited
126
+ from <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
127
+ </span>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+ <span class="summary_desc"><div class='inline'>
141
+ <p>The association.</p>
142
+ </div></span>
143
+
144
+ </li>
145
+
146
+
147
+ <li class="public ">
148
+ <span class="summary_signature">
149
+
150
+ <a href="#attributes-instance_method" title="#attributes (instance method)">- (Hash) <strong>attributes</strong> </a>
151
+
152
+
153
+
154
+ (also: #to_param)
155
+
156
+ </span>
157
+
158
+ <span class="note title not_defined_here">
159
+ inherited
160
+ from <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
161
+ </span>
162
+
163
+
164
+
165
+
166
+ <span class="note title readonly">readonly</span>
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <span class="summary_desc"><div class='inline'>
177
+ <p>The resource's attributes.</p>
178
+ </div></span>
179
+
180
+ </li>
181
+
182
+
183
+ <li class="public ">
184
+ <span class="summary_signature">
185
+
186
+ <a href="#errors-instance_method" title="#errors (instance method)">- (Array) <strong>errors</strong> </a>
187
+
112
188
 
189
+
190
+ </span>
191
+
192
+ <span class="note title not_defined_here">
193
+ inherited
194
+ from <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
195
+ </span>
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
113
206
 
114
- <h2>Instance Attribute Summary</h2>
115
207
 
116
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
117
- <p class="inherited"><span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">#association</a></span>, <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">#response</a></span></p>
208
+ <span class="summary_desc"><div class='inline'>
209
+ <p>The last received errors.</p>
210
+ </div></span>
211
+
212
+ </li>
213
+
214
+
215
+ <li class="public ">
216
+ <span class="summary_signature">
217
+
218
+ <a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
219
+
220
+
221
+
222
+ </span>
223
+
224
+ <span class="note title not_defined_here">
225
+ inherited
226
+ from <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
227
+ </span>
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+ <span class="summary_desc"><div class='inline'>
241
+ <p>Place to dump the last response.</p>
242
+ </div></span>
243
+
244
+ </li>
245
+
246
+
247
+ </ul>
248
+
249
+
118
250
 
119
251
 
120
252
 
@@ -170,6 +302,230 @@
170
302
  <p>The associated object.</p>
171
303
  </div></span>
172
304
 
305
+ </li>
306
+
307
+
308
+ <li class="public ">
309
+ <span class="summary_signature">
310
+
311
+ <a href="#clear_associations-instance_method" title="#clear_associations (instance method)">- (Object) <strong>clear_associations</strong> </a>
312
+
313
+
314
+
315
+ </span>
316
+
317
+ <span class="note title not_defined_here">
318
+ included
319
+ from <span class='object_link'><a href="Save.html#clear_associations-instance_method" title="ZendeskAPI::Save#clear_associations (method)">Save</a></span>
320
+ </span>
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+ <span class="summary_desc"><div class='inline'>
331
+ <p>Removes all cached associations.</p>
332
+ </div></span>
333
+
334
+ </li>
335
+
336
+
337
+ <li class="public ">
338
+ <span class="summary_signature">
339
+
340
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong> </a>
341
+
342
+
343
+
344
+ </span>
345
+
346
+ <span class="note title not_defined_here">
347
+ included
348
+ from <span class='object_link'><a href="Destroy.html#destroy-instance_method" title="ZendeskAPI::Destroy#destroy (method)">Destroy</a></span>
349
+ </span>
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+ <span class="summary_desc"><div class='inline'></div></span>
360
+
361
+ </li>
362
+
363
+
364
+ <li class="public ">
365
+ <span class="summary_signature">
366
+
367
+ <a href="#destroy%21-instance_method" title="#destroy! (instance method)">- (Boolean) <strong>destroy!</strong> </a>
368
+
369
+
370
+
371
+ </span>
372
+
373
+ <span class="note title not_defined_here">
374
+ included
375
+ from <span class='object_link'><a href="Destroy.html#destroy%21-instance_method" title="ZendeskAPI::Destroy#destroy! (method)">Destroy</a></span>
376
+ </span>
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+ <span class="summary_desc"><div class='inline'>
387
+ <p>If this resource hasn't already been deleted, then do so.</p>
388
+ </div></span>
389
+
390
+ </li>
391
+
392
+
393
+ <li class="public ">
394
+ <span class="summary_signature">
395
+
396
+ <a href="#destroyed%3F-instance_method" title="#destroyed? (instance method)">- (Boolean) <strong>destroyed?</strong> </a>
397
+
398
+
399
+
400
+ </span>
401
+
402
+ <span class="note title not_defined_here">
403
+ included
404
+ from <span class='object_link'><a href="Destroy.html#destroyed%3F-instance_method" title="ZendeskAPI::Destroy#destroyed? (method)">Destroy</a></span>
405
+ </span>
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+ <span class="summary_desc"><div class='inline'>
416
+ <p>Has this object been deleted?.</p>
417
+ </div></span>
418
+
419
+ </li>
420
+
421
+
422
+ <li class="public ">
423
+ <span class="summary_signature">
424
+
425
+ <a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </a>
426
+
427
+
428
+
429
+ </span>
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+ <span class="summary_desc"><div class='inline'></div></span>
440
+
441
+ </li>
442
+
443
+
444
+ <li class="public ">
445
+ <span class="summary_signature">
446
+
447
+ <a href="#save-instance_method" title="#save (instance method)">- (Object) <strong>save</strong>(options = {}) </a>
448
+
449
+
450
+
451
+ </span>
452
+
453
+ <span class="note title not_defined_here">
454
+ included
455
+ from <span class='object_link'><a href="Save.html#save-instance_method" title="ZendeskAPI::Save#save (method)">Save</a></span>
456
+ </span>
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+ <span class="summary_desc"><div class='inline'>
467
+ <p>Saves, returning false if it fails and attaching the errors.</p>
468
+ </div></span>
469
+
470
+ </li>
471
+
472
+
473
+ <li class="public ">
474
+ <span class="summary_signature">
475
+
476
+ <a href="#save%21-instance_method" title="#save! (instance method)">- (Boolean) <strong>save!</strong>(options = {}) </a>
477
+
478
+
479
+
480
+ </span>
481
+
482
+ <span class="note title not_defined_here">
483
+ included
484
+ from <span class='object_link'><a href="Save.html#save%21-instance_method" title="ZendeskAPI::Save#save! (method)">Save</a></span>
485
+ </span>
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+ <span class="summary_desc"><div class='inline'>
496
+ <p>If this resource hasn't been deleted, then create or save it.</p>
497
+ </div></span>
498
+
499
+ </li>
500
+
501
+
502
+ <li class="public ">
503
+ <span class="summary_signature">
504
+
505
+ <a href="#save_associations-instance_method" title="#save_associations (instance method)">- (Object) <strong>save_associations</strong> </a>
506
+
507
+
508
+
509
+ </span>
510
+
511
+ <span class="note title not_defined_here">
512
+ included
513
+ from <span class='object_link'><a href="Save.html#save_associations-instance_method" title="ZendeskAPI::Save#save_associations (method)">Save</a></span>
514
+ </span>
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+ <span class="summary_desc"><div class='inline'>
525
+ <p>Saves associations Takes into account inlining, collections, and id setting
526
+ on the parent resource.</p>
527
+ </div></span>
528
+
173
529
  </li>
174
530
 
175
531
 
@@ -186,52 +542,205 @@
186
542
 
187
543
 
188
544
 
545
+ <div id="constructor_details" class="method_details_list">
546
+ <h2>Constructor Details</h2>
189
547
 
548
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Data.html#initialize-instance_method" title="ZendeskAPI::Data#initialize (method)">ZendeskAPI::Data</a></span></p>
190
549
 
550
+ </div>
551
+ <div id="method_missing_details" class="method_details_list">
552
+ <h2>Dynamic Method Handling</h2>
553
+ <p class="notice super">
554
+ This class handles dynamic methods through the <tt>method_missing</tt> method
555
+
556
+ in the class <span class='object_link'><a href="Data.html#method_missing-instance_method" title="ZendeskAPI::Data#method_missing (method)">ZendeskAPI::Data</a></span>
557
+
558
+ </p>
191
559
 
560
+ </div>
561
+
562
+ <div id="instance_attr_details" class="attr_details">
563
+ <h2>Instance Attribute Details</h2>
564
+
565
+
566
+ <span id="association=-instance_method"></span>
567
+ <div class="method_details first">
568
+ <h3 class="signature first" id="association-instance_method">
192
569
 
570
+ - (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong>
193
571
 
194
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Save.html" title="ZendeskAPI::Save (module)">Save</a></span></h3>
195
- <p class="inherited"><span class='object_link'><a href="Save.html#clear_associations-instance_method" title="ZendeskAPI::Save#clear_associations (method)">#clear_associations</a></span>, <span class='object_link'><a href="Save.html#save-instance_method" title="ZendeskAPI::Save#save (method)">#save</a></span>, <span class='object_link'><a href="Save.html#save%21-instance_method" title="ZendeskAPI::Save#save! (method)">#save!</a></span>, <span class='object_link'><a href="Save.html#save_associations-instance_method" title="ZendeskAPI::Save#save_associations (method)">#save_associations</a></span></p>
196
572
 
197
573
 
574
+
198
575
 
576
+ <span class="not_defined_here">
577
+ Originally defined in class
578
+ <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
579
+ </span>
199
580
 
581
+ </h3><div class="docstring">
582
+ <div class="discussion">
583
+
584
+ <p>The association</p>
585
+
586
+
587
+ </div>
588
+ </div>
589
+ <div class="tags">
200
590
 
591
+ <p class="tag_title">Returns:</p>
592
+ <ul class="return">
201
593
 
594
+ <li>
595
+
596
+
597
+ <span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span>
598
+
599
+
600
+
601
+ &mdash;
602
+ <div class='inline'>
603
+ <p>The association</p>
604
+ </div>
605
+
606
+ </li>
202
607
 
608
+ </ul>
609
+
610
+ </div>
611
+ </div>
612
+
613
+
614
+ <span id=""></span>
615
+ <div class="method_details ">
616
+ <h3 class="signature " id="attributes-instance_method">
617
+
618
+ - (<tt>Hash</tt>) <strong>attributes</strong> <span class="extras">(readonly)</span>
619
+
620
+
621
+
622
+ <span class="aliases">Also known as:
623
+ <span class="names"><span id='to_param-instance_method'>to_param</span></span>
624
+ </span>
625
+
626
+
627
+
628
+ <span class="not_defined_here">
629
+ Originally defined in class
630
+ <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
631
+ </span>
632
+
633
+ </h3><div class="docstring">
634
+ <div class="discussion">
635
+
636
+ <p>The resource's attributes</p>
637
+
638
+
639
+ </div>
640
+ </div>
641
+ <div class="tags">
642
+
643
+ <p class="tag_title">Returns:</p>
644
+ <ul class="return">
645
+
646
+ <li>
647
+
648
+
649
+ <span class='type'>(<tt>Hash</tt>)</span>
650
+
651
+
652
+
653
+ &mdash;
654
+ <div class='inline'>
655
+ <p>The resource's attributes</p>
656
+ </div>
657
+
658
+ </li>
659
+
660
+ </ul>
661
+
662
+ </div>
663
+ </div>
664
+
665
+
666
+ <span id="errors=-instance_method"></span>
667
+ <div class="method_details ">
668
+ <h3 class="signature " id="errors-instance_method">
203
669
 
670
+ - (<tt>Array</tt>) <strong>errors</strong>
204
671
 
205
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
206
- <p class="inherited"><span class='object_link'><a href="Data.html#%2F-instance_method" title="ZendeskAPI::Data#/ (method)">#/</a></span>, <span class='object_link'><a href="Data.html#%3D%3D-instance_method" title="ZendeskAPI::Data#== (method)">#==</a></span>, <span class='object_link'><a href="Data.html#format-class_method" title="ZendeskAPI::Data.format (method)">format</a></span>, <span class='object_link'><a href="Data.html#id-instance_method" title="ZendeskAPI::Data#id (method)">#id</a></span>, <span class='object_link'><a href="Data.html#initialize-instance_method" title="ZendeskAPI::Data#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Data.html#method_missing-instance_method" title="ZendeskAPI::Data#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="Data.html#new_record%3F-instance_method" title="ZendeskAPI::Data#new_record? (method)">#new_record?</a></span>, <span class='object_link'><a href="Data.html#path-instance_method" title="ZendeskAPI::Data#path (method)">#path</a></span>, <span class='object_link'><a href="Data.html#resource_name-class_method" title="ZendeskAPI::Data.resource_name (method)">resource_name</a></span>, <span class='object_link'><a href="Data.html#singular_resource_name-class_method" title="ZendeskAPI::Data.singular_resource_name (method)">singular_resource_name</a></span>, <span class='object_link'><a href="Data.html#subclasses-class_method" title="ZendeskAPI::Data.subclasses (method)">subclasses</a></span>, <span class='object_link'><a href="Data.html#to_json-instance_method" title="ZendeskAPI::Data#to_json (method)">#to_json</a></span></p>
207
672
 
208
673
 
674
+
209
675
 
676
+ <span class="not_defined_here">
677
+ Originally defined in class
678
+ <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
679
+ </span>
210
680
 
681
+ </h3><div class="docstring">
682
+ <div class="discussion">
683
+
684
+ <p>The last received errors</p>
685
+
686
+
687
+ </div>
688
+ </div>
689
+ <div class="tags">
211
690
 
691
+ <p class="tag_title">Returns:</p>
692
+ <ul class="return">
212
693
 
694
+ <li>
695
+
696
+
697
+ <span class='type'>(<tt>Array</tt>)</span>
698
+
699
+
700
+
701
+ &mdash;
702
+ <div class='inline'>
703
+ <p>The last received errors</p>
704
+ </div>
705
+
706
+ </li>
213
707
 
708
+ </ul>
709
+
710
+ </div>
711
+ </div>
712
+
713
+
714
+ <span id="response=-instance_method"></span>
715
+ <div class="method_details ">
716
+ <h3 class="signature " id="response-instance_method">
214
717
 
718
+ - (<tt>Object</tt>) <strong>response</strong>
215
719
 
720
+
216
721
 
722
+
217
723
 
724
+ <span class="not_defined_here">
725
+ Originally defined in class
726
+ <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
727
+ </span>
218
728
 
219
- <div id="constructor_details" class="method_details_list">
220
- <h2>Constructor Details</h2>
221
-
222
- <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Data.html#initialize-instance_method" title="ZendeskAPI::Data#initialize (method)">ZendeskAPI::Data</a></span></p>
223
-
224
- </div>
225
- <div id="method_missing_details" class="method_details_list">
226
- <h2>Dynamic Method Handling</h2>
227
- <p class="notice super">
228
- This class handles dynamic methods through the <tt>method_missing</tt> method
229
-
230
- in the class <span class='object_link'><a href="Data.html#method_missing-instance_method" title="ZendeskAPI::Data#method_missing (method)">ZendeskAPI::Data</a></span>
729
+ </h3><div class="docstring">
730
+ <div class="discussion">
231
731
 
232
- </p>
732
+ <p>Place to dump the last response</p>
733
+
734
+
735
+ </div>
736
+ </div>
737
+ <div class="tags">
233
738
 
739
+
740
+ </div>
234
741
  </div>
742
+
743
+ </div>
235
744
 
236
745
 
237
746
  <div id="instance_method_details" class="method_details_list">
@@ -304,10 +813,10 @@
304
813
  <pre class="lines">
305
814
 
306
815
 
307
- 54</pre>
816
+ 57</pre>
308
817
  </td>
309
818
  <td>
310
- <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 54</span>
819
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 57</span>
311
820
 
312
821
  <span class='id identifier rubyid_has_many'>has_many</span> <span class='const'>Attachment</span></pre>
313
822
  </td>
@@ -379,15 +888,278 @@
379
888
  <pre class="lines">
380
889
 
381
890
 
382
- 54</pre>
891
+ 57</pre>
383
892
  </td>
384
893
  <td>
385
- <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 54</span>
894
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 57</span>
386
895
 
387
896
  <span class='id identifier rubyid_has_many'>has_many</span> <span class='const'>Attachment</span></pre>
388
897
  </td>
389
898
  </tr>
390
899
  </table>
900
+ </div>
901
+
902
+ <div class="method_details ">
903
+ <h3 class="signature " id="clear_associations-instance_method">
904
+
905
+ - (<tt>Object</tt>) <strong>clear_associations</strong>
906
+
907
+
908
+
909
+
910
+
911
+ <span class="not_defined_here">
912
+ Originally defined in module
913
+ <span class='object_link'><a href="Save.html#clear_associations-instance_method" title="ZendeskAPI::Save#clear_associations (method)">Save</a></span>
914
+ </span>
915
+
916
+ </h3><div class="docstring">
917
+ <div class="discussion">
918
+
919
+ <p>Removes all cached associations</p>
920
+
921
+
922
+ </div>
923
+ </div>
924
+ <div class="tags">
925
+
926
+
927
+ </div>
928
+ </div>
929
+
930
+ <div class="method_details ">
931
+ <h3 class="signature " id="destroy-instance_method">
932
+
933
+ - (<tt>Object</tt>) <strong>destroy</strong>
934
+
935
+
936
+
937
+
938
+
939
+ <span class="not_defined_here">
940
+ Originally defined in module
941
+ <span class='object_link'><a href="Destroy.html#destroy-instance_method" title="ZendeskAPI::Destroy#destroy (method)">Destroy</a></span>
942
+ </span>
943
+
944
+ </h3>
945
+ </div>
946
+
947
+ <div class="method_details ">
948
+ <h3 class="signature " id="destroy!-instance_method">
949
+
950
+ - (<tt>Boolean</tt>) <strong>destroy!</strong>
951
+
952
+
953
+
954
+
955
+
956
+ <span class="not_defined_here">
957
+ Originally defined in module
958
+ <span class='object_link'><a href="Destroy.html#destroy%21-instance_method" title="ZendeskAPI::Destroy#destroy! (method)">Destroy</a></span>
959
+ </span>
960
+
961
+ </h3><div class="docstring">
962
+ <div class="discussion">
963
+
964
+ <p>If this resource hasn't already been deleted, then do so.</p>
965
+
966
+
967
+ </div>
968
+ </div>
969
+ <div class="tags">
970
+
971
+ <p class="tag_title">Returns:</p>
972
+ <ul class="return">
973
+
974
+ <li>
975
+
976
+
977
+ <span class='type'>(<tt>Boolean</tt>)</span>
978
+
979
+
980
+
981
+ &mdash;
982
+ <div class='inline'>
983
+ <p>Successful?</p>
984
+ </div>
985
+
986
+ </li>
987
+
988
+ </ul>
989
+
990
+ </div>
991
+ </div>
992
+
993
+ <div class="method_details ">
994
+ <h3 class="signature " id="destroyed?-instance_method">
995
+
996
+ - (<tt>Boolean</tt>) <strong>destroyed?</strong>
997
+
998
+
999
+
1000
+
1001
+
1002
+ <span class="not_defined_here">
1003
+ Originally defined in module
1004
+ <span class='object_link'><a href="Destroy.html#destroyed%3F-instance_method" title="ZendeskAPI::Destroy#destroyed? (method)">Destroy</a></span>
1005
+ </span>
1006
+
1007
+ </h3><div class="docstring">
1008
+ <div class="discussion">
1009
+
1010
+ <p>Has this object been deleted?</p>
1011
+
1012
+
1013
+ </div>
1014
+ </div>
1015
+ <div class="tags">
1016
+
1017
+ <p class="tag_title">Returns:</p>
1018
+ <ul class="return">
1019
+
1020
+ <li>
1021
+
1022
+
1023
+ <span class='type'>(<tt>Boolean</tt>)</span>
1024
+
1025
+
1026
+
1027
+ </li>
1028
+
1029
+ </ul>
1030
+
1031
+ </div>
1032
+ </div>
1033
+
1034
+ <div class="method_details ">
1035
+ <h3 class="signature " id="id-instance_method">
1036
+
1037
+ - (<tt>Object</tt>) <strong>id</strong>
1038
+
1039
+
1040
+
1041
+
1042
+
1043
+ </h3><table class="source_code">
1044
+ <tr>
1045
+ <td>
1046
+ <pre class="lines">
1047
+
1048
+
1049
+ 53</pre>
1050
+ </td>
1051
+ <td>
1052
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 53</span>
1053
+
1054
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span><span class='semicolon'>;</span> <span class='id identifier rubyid_token'>token</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
1055
+ </td>
1056
+ </tr>
1057
+ </table>
1058
+ </div>
1059
+
1060
+ <div class="method_details ">
1061
+ <h3 class="signature " id="save-instance_method">
1062
+
1063
+ - (<tt>Object</tt>) <strong>save</strong>(options = {})
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+ <span class="not_defined_here">
1070
+ Originally defined in module
1071
+ <span class='object_link'><a href="Save.html#save-instance_method" title="ZendeskAPI::Save#save (method)">Save</a></span>
1072
+ </span>
1073
+
1074
+ </h3><div class="docstring">
1075
+ <div class="discussion">
1076
+
1077
+ <p>Saves, returning false if it fails and attaching the errors</p>
1078
+
1079
+
1080
+ </div>
1081
+ </div>
1082
+ <div class="tags">
1083
+
1084
+
1085
+ </div>
1086
+ </div>
1087
+
1088
+ <div class="method_details ">
1089
+ <h3 class="signature " id="save!-instance_method">
1090
+
1091
+ - (<tt>Boolean</tt>) <strong>save!</strong>(options = {})
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+ <span class="not_defined_here">
1098
+ Originally defined in module
1099
+ <span class='object_link'><a href="Save.html#save%21-instance_method" title="ZendeskAPI::Save#save! (method)">Save</a></span>
1100
+ </span>
1101
+
1102
+ </h3><div class="docstring">
1103
+ <div class="discussion">
1104
+
1105
+ <p>If this resource hasn't been deleted, then create or save it. Executes a
1106
+ POST if it is a <span class='object_link'><a href="Data.html#new_record%3F-instance_method" title="ZendeskAPI::Data#new_record? (method)">Data#new_record?</a></span>, otherwise a PUT. Merges returned
1107
+ attributes on success.</p>
1108
+
1109
+
1110
+ </div>
1111
+ </div>
1112
+ <div class="tags">
1113
+
1114
+ <p class="tag_title">Returns:</p>
1115
+ <ul class="return">
1116
+
1117
+ <li>
1118
+
1119
+
1120
+ <span class='type'>(<tt>Boolean</tt>)</span>
1121
+
1122
+
1123
+
1124
+ &mdash;
1125
+ <div class='inline'>
1126
+ <p>Success?</p>
1127
+ </div>
1128
+
1129
+ </li>
1130
+
1131
+ </ul>
1132
+
1133
+ </div>
1134
+ </div>
1135
+
1136
+ <div class="method_details ">
1137
+ <h3 class="signature " id="save_associations-instance_method">
1138
+
1139
+ - (<tt>Object</tt>) <strong>save_associations</strong>
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+ <span class="not_defined_here">
1146
+ Originally defined in module
1147
+ <span class='object_link'><a href="Save.html#save_associations-instance_method" title="ZendeskAPI::Save#save_associations (method)">Save</a></span>
1148
+ </span>
1149
+
1150
+ </h3><div class="docstring">
1151
+ <div class="discussion">
1152
+
1153
+ <p>Saves associations Takes into account inlining, collections, and id setting
1154
+ on the parent resource.</p>
1155
+
1156
+
1157
+ </div>
1158
+ </div>
1159
+ <div class="tags">
1160
+
1161
+
1162
+ </div>
391
1163
  </div>
392
1164
 
393
1165
  </div>
@@ -395,9 +1167,9 @@
395
1167
  </div>
396
1168
 
397
1169
  <div id="footer">
398
- Generated on Mon Feb 11 17:45:38 2013 by
1170
+ Generated on Wed May 15 18:59:32 2013 by
399
1171
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
400
- 0.8.4.1 (ruby-1.9.3).
1172
+ 0.8.5.2 (ruby-1.9.3).
401
1173
  </div>
402
1174
 
403
1175
  </body>