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::Trigger
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
 
@@ -73,7 +73,7 @@
73
73
 
74
74
  <dt class="r1">Inherits:</dt>
75
75
  <dd class="r1">
76
- <span class="inheritName"><span class='object_link'><a href="Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span></span>
76
+ <span class="inheritName"><span class='object_link'><a href="Rule.html" title="ZendeskAPI::Rule (class)">Rule</a></span></span>
77
77
 
78
78
  <ul class="fullTree">
79
79
  <li>Object</li>
@@ -84,6 +84,8 @@
84
84
 
85
85
  <li class="next"><span class='object_link'><a href="Resource.html" title="ZendeskAPI::Resource (class)">Resource</a></span></li>
86
86
 
87
+ <li class="next"><span class='object_link'><a href="Rule.html" title="ZendeskAPI::Rule (class)">Rule</a></span></li>
88
+
87
89
  <li class="next">ZendeskAPI::Trigger</li>
88
90
 
89
91
  </ul>
@@ -109,17 +111,208 @@
109
111
 
110
112
 
111
113
 
114
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a>
121
+
112
122
 
123
+
124
+ </span>
125
+
126
+ <span class="note title not_defined_here">
127
+ inherited
128
+ from <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
129
+ </span>
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
113
140
 
114
- <h2>Instance Attribute Summary</h2>
115
141
 
116
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></h3>
117
- <p class="inherited"><span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">#error</a></span>, <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">#error_message</a></span></p>
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>The association.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#attributes-instance_method" title="#attributes (instance method)">- (Hash) <strong>attributes</strong> </a>
153
+
118
154
 
155
+
156
+ (also: #to_param)
157
+
158
+ </span>
159
+
160
+ <span class="note title not_defined_here">
161
+ inherited
162
+ from <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
163
+ </span>
164
+
165
+
166
+
167
+
168
+ <span class="note title readonly">readonly</span>
169
+
170
+
171
+
172
+
173
+
119
174
 
120
175
 
121
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
122
- <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>
176
+
177
+
178
+ <span class="summary_desc"><div class='inline'>
179
+ <p>The resource's attributes.</p>
180
+ </div></span>
181
+
182
+ </li>
183
+
184
+
185
+ <li class="public ">
186
+ <span class="summary_signature">
187
+
188
+ <a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong> </a>
189
+
190
+
191
+
192
+ </span>
193
+
194
+ <span class="note title not_defined_here">
195
+ inherited
196
+ from <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span>
197
+ </span>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <span class="summary_desc"><div class='inline'>
211
+ <p>Returns the value of attribute error.</p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#error_message-instance_method" title="#error_message (instance method)">- (Object) <strong>error_message</strong> </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+ <span class="note title not_defined_here">
227
+ inherited
228
+ from <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span>
229
+ </span>
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+ <span class="summary_desc"><div class='inline'>
243
+ <p>Returns the value of attribute error_message.</p>
244
+ </div></span>
245
+
246
+ </li>
247
+
248
+
249
+ <li class="public ">
250
+ <span class="summary_signature">
251
+
252
+ <a href="#errors-instance_method" title="#errors (instance method)">- (Array) <strong>errors</strong> </a>
253
+
254
+
255
+
256
+ </span>
257
+
258
+ <span class="note title not_defined_here">
259
+ inherited
260
+ from <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
261
+ </span>
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+ <span class="summary_desc"><div class='inline'>
275
+ <p>The last received errors.</p>
276
+ </div></span>
277
+
278
+ </li>
279
+
280
+
281
+ <li class="public ">
282
+ <span class="summary_signature">
283
+
284
+ <a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
285
+
286
+
287
+
288
+ </span>
289
+
290
+ <span class="note title not_defined_here">
291
+ inherited
292
+ from <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
293
+ </span>
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+ <span class="summary_desc"><div class='inline'>
307
+ <p>Place to dump the last response.</p>
308
+ </div></span>
309
+
310
+ </li>
311
+
312
+
313
+ </ul>
314
+
315
+
123
316
 
124
317
 
125
318
 
@@ -196,13 +389,6 @@
196
389
 
197
390
 
198
391
 
199
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Read.html" title="ZendeskAPI::Read (module)">Read</a></span></h3>
200
- <p class="inherited"><span class='object_link'><a href="Read.html#find-instance_method" title="ZendeskAPI::Read#find (method)">#find</a></span></p>
201
-
202
-
203
-
204
-
205
-
206
392
 
207
393
 
208
394
 
@@ -210,84 +396,265 @@
210
396
 
211
397
 
212
398
 
399
+ <div id="constructor_details" class="method_details_list">
400
+ <h2>Constructor Details</h2>
213
401
 
402
+ <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>
214
403
 
404
+ </div>
405
+ <div id="method_missing_details" class="method_details_list">
406
+ <h2>Dynamic Method Handling</h2>
407
+ <p class="notice super">
408
+ This class handles dynamic methods through the <tt>method_missing</tt> method
409
+
410
+ 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>
411
+
412
+ </p>
215
413
 
216
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span></h3>
217
- <p class="inherited"><span class='object_link'><a href="Destroy.html#destroy-instance_method" title="ZendeskAPI::Destroy#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="Destroy.html#destroyed%3F-instance_method" title="ZendeskAPI::Destroy#destroyed? (method)">#destroyed?</a></span></p>
414
+ </div>
218
415
 
416
+ <div id="instance_attr_details" class="attr_details">
417
+ <h2>Instance Attribute Details</h2>
418
+
419
+
420
+ <span id="association=-instance_method"></span>
421
+ <div class="method_details first">
422
+ <h3 class="signature first" id="association-instance_method">
219
423
 
424
+ - (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong>
220
425
 
426
+
221
427
 
428
+
222
429
 
430
+ <span class="not_defined_here">
431
+ Originally defined in class
432
+ <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
433
+ </span>
223
434
 
435
+ </h3><div class="docstring">
436
+ <div class="discussion">
437
+
438
+ <p>The association</p>
439
+
440
+
441
+ </div>
442
+ </div>
443
+ <div class="tags">
224
444
 
445
+ <p class="tag_title">Returns:</p>
446
+ <ul class="return">
225
447
 
448
+ <li>
449
+
450
+
451
+ <span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span>
452
+
453
+
454
+
455
+ &mdash;
456
+ <div class='inline'>
457
+ <p>The association</p>
458
+ </div>
459
+
460
+ </li>
226
461
 
462
+ </ul>
463
+
464
+ </div>
465
+ </div>
466
+
467
+
468
+ <span id=""></span>
469
+ <div class="method_details ">
470
+ <h3 class="signature " id="attributes-instance_method">
227
471
 
472
+ - (<tt>Hash</tt>) <strong>attributes</strong> <span class="extras">(readonly)</span>
228
473
 
229
-
230
-
231
-
232
-
233
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Save.html" title="ZendeskAPI::Save (module)">Save</a></span></h3>
234
- <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>
235
474
 
236
475
 
476
+ <span class="aliases">Also known as:
477
+ <span class="names"><span id='to_param-instance_method'>to_param</span></span>
478
+ </span>
237
479
 
480
+
238
481
 
482
+ <span class="not_defined_here">
483
+ Originally defined in class
484
+ <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
485
+ </span>
239
486
 
487
+ </h3><div class="docstring">
488
+ <div class="discussion">
489
+
490
+ <p>The resource's attributes</p>
491
+
492
+
493
+ </div>
494
+ </div>
495
+ <div class="tags">
240
496
 
497
+ <p class="tag_title">Returns:</p>
498
+ <ul class="return">
241
499
 
500
+ <li>
501
+
502
+
503
+ <span class='type'>(<tt>Hash</tt>)</span>
504
+
505
+
506
+
507
+ &mdash;
508
+ <div class='inline'>
509
+ <p>The resource's attributes</p>
510
+ </div>
511
+
512
+ </li>
242
513
 
514
+ </ul>
515
+
516
+ </div>
517
+ </div>
518
+
519
+
520
+ <span id="error=-instance_method"></span>
521
+ <div class="method_details ">
522
+ <h3 class="signature " id="error-instance_method">
243
523
 
524
+ - (<tt>Object</tt>) <strong>error</strong>
244
525
 
526
+
245
527
 
528
+
246
529
 
530
+ <span class="not_defined_here">
531
+ Originally defined in class
532
+ <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span>
533
+ </span>
247
534
 
535
+ </h3><div class="docstring">
536
+ <div class="discussion">
537
+
538
+ <p>Returns the value of attribute error</p>
539
+
540
+
541
+ </div>
542
+ </div>
543
+ <div class="tags">
248
544
 
545
+
546
+ </div>
547
+ </div>
548
+
549
+
550
+ <span id="error_message=-instance_method"></span>
551
+ <div class="method_details ">
552
+ <h3 class="signature " id="error_message-instance_method">
249
553
 
554
+ - (<tt>Object</tt>) <strong>error_message</strong>
250
555
 
556
+
251
557
 
558
+
252
559
 
560
+ <span class="not_defined_here">
561
+ Originally defined in class
562
+ <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span>
563
+ </span>
253
564
 
565
+ </h3><div class="docstring">
566
+ <div class="discussion">
567
+
568
+ <p>Returns the value of attribute error_message</p>
569
+
570
+
571
+ </div>
572
+ </div>
573
+ <div class="tags">
254
574
 
255
-
256
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span></h3>
257
- <p class="inherited"><span class='object_link'><a href="Verbs.html#delete-instance_method" title="ZendeskAPI::Verbs#delete (method)">#delete</a></span>, <span class='object_link'><a href="Verbs.html#post-instance_method" title="ZendeskAPI::Verbs#post (method)">#post</a></span>, <span class='object_link'><a href="Verbs.html#put-instance_method" title="ZendeskAPI::Verbs#put (method)">#put</a></span></p>
258
575
 
576
+ </div>
577
+ </div>
578
+
579
+
580
+ <span id="errors=-instance_method"></span>
581
+ <div class="method_details ">
582
+ <h3 class="signature " id="errors-instance_method">
259
583
 
584
+ - (<tt>Array</tt>) <strong>errors</strong>
260
585
 
586
+
261
587
 
588
+
262
589
 
590
+ <span class="not_defined_here">
591
+ Originally defined in class
592
+ <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
593
+ </span>
263
594
 
595
+ </h3><div class="docstring">
596
+ <div class="discussion">
597
+
598
+ <p>The last received errors</p>
599
+
600
+
601
+ </div>
602
+ </div>
603
+ <div class="tags">
264
604
 
605
+ <p class="tag_title">Returns:</p>
606
+ <ul class="return">
265
607
 
608
+ <li>
609
+
610
+
611
+ <span class='type'>(<tt>Array</tt>)</span>
612
+
613
+
614
+
615
+ &mdash;
616
+ <div class='inline'>
617
+ <p>The last received errors</p>
618
+ </div>
619
+
620
+ </li>
266
621
 
267
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
268
- <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>
622
+ </ul>
269
623
 
624
+ </div>
625
+ </div>
626
+
627
+
628
+ <span id="response=-instance_method"></span>
629
+ <div class="method_details ">
630
+ <h3 class="signature " id="response-instance_method">
270
631
 
632
+ - (<tt>Object</tt>) <strong>response</strong>
271
633
 
634
+
272
635
 
636
+
273
637
 
638
+ <span class="not_defined_here">
639
+ Originally defined in class
640
+ <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
641
+ </span>
274
642
 
275
- <div id="constructor_details" class="method_details_list">
276
- <h2>Constructor Details</h2>
277
-
278
- <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>
279
-
280
- </div>
281
- <div id="method_missing_details" class="method_details_list">
282
- <h2>Dynamic Method Handling</h2>
283
- <p class="notice super">
284
- This class handles dynamic methods through the <tt>method_missing</tt> method
285
-
286
- 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>
643
+ </h3><div class="docstring">
644
+ <div class="discussion">
287
645
 
288
- </p>
646
+ <p>Place to dump the last response</p>
647
+
648
+
649
+ </div>
650
+ </div>
651
+ <div class="tags">
289
652
 
653
+
654
+ </div>
290
655
  </div>
656
+
657
+ </div>
291
658
 
292
659
 
293
660
  <div id="instance_method_details" class="method_details_list">
@@ -338,10 +705,10 @@
338
705
  <pre class="lines">
339
706
 
340
707
 
341
- 299</pre>
708
+ 316</pre>
342
709
  </td>
343
710
  <td>
344
- <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 299</span>
711
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 316</span>
345
712
 
346
713
  <span class='id identifier rubyid_has'>has</span> <span class='symbol'>:execution</span><span class='comma'>,</span> <span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='const'>RuleExecution</span></pre>
347
714
  </td>
@@ -413,10 +780,10 @@
413
780
  <pre class="lines">
414
781
 
415
782
 
416
- 299</pre>
783
+ 316</pre>
417
784
  </td>
418
785
  <td>
419
- <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 299</span>
786
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/resources.rb', line 316</span>
420
787
 
421
788
  <span class='id identifier rubyid_has'>has</span> <span class='symbol'>:execution</span><span class='comma'>,</span> <span class='symbol'>:class</span> <span class='op'>=&gt;</span> <span class='const'>RuleExecution</span></pre>
422
789
  </td>
@@ -429,9 +796,9 @@
429
796
  </div>
430
797
 
431
798
  <div id="footer">
432
- Generated on Mon Feb 11 17:45:40 2013 by
799
+ Generated on Wed May 15 18:59:35 2013 by
433
800
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
434
- 0.8.4.1 (ruby-1.9.3).
801
+ 0.8.5.2 (ruby-1.9.3).
435
802
  </div>
436
803
 
437
804
  </body>