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
data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthToken.html ADDED
@@ -0,0 +1,810 @@
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::OAuthToken
8
+
9
+ &mdash; Documentation by YARD 0.8.5.2
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 (O)</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">OAuthToken</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::OAuthToken
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"><span class='object_link'><a href="ReadResource.html" title="ZendeskAPI::ReadResource (class)">ReadResource</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></li>
82
+
83
+ <li class="next"><span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></li>
84
+
85
+ <li class="next"><span class='object_link'><a href="ReadResource.html" title="ZendeskAPI::ReadResource (class)">ReadResource</a></span></li>
86
+
87
+ <li class="next">ZendeskAPI::OAuthToken</li>
88
+
89
+ </ul>
90
+ <a href="#" class="inheritanceTree">show all</a>
91
+
92
+ </dd>
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dt class="r2">Includes:</dt>
100
+ <dd class="r2"><span class='object_link'><a href="Destroy.html" title="ZendeskAPI::Destroy (module)">Destroy</a></span></dd>
101
+
102
+
103
+
104
+
105
+
106
+ <dt class="r1 last">Defined in:</dt>
107
+ <dd class="r1 last">lib/zendesk_api/resources.rb</dd>
108
+
109
+ </dl>
110
+ <div class="clear"></div>
111
+
112
+
113
+
114
+
115
+
116
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+ <span class="note title not_defined_here">
129
+ inherited
130
+ from <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <span class="summary_desc"><div class='inline'>
145
+ <p>The association.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#attributes-instance_method" title="#attributes (instance method)">- (Hash) <strong>attributes</strong> </a>
155
+
156
+
157
+
158
+ (also: #to_param)
159
+
160
+ </span>
161
+
162
+ <span class="note title not_defined_here">
163
+ inherited
164
+ from <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
165
+ </span>
166
+
167
+
168
+
169
+
170
+ <span class="note title readonly">readonly</span>
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+ <span class="summary_desc"><div class='inline'>
181
+ <p>The resource's attributes.</p>
182
+ </div></span>
183
+
184
+ </li>
185
+
186
+
187
+ <li class="public ">
188
+ <span class="summary_signature">
189
+
190
+ <a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong> </a>
191
+
192
+
193
+
194
+ </span>
195
+
196
+ <span class="note title not_defined_here">
197
+ inherited
198
+ from <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span>
199
+ </span>
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'>
213
+ <p>Returns the value of attribute error.</p>
214
+ </div></span>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="public ">
220
+ <span class="summary_signature">
221
+
222
+ <a href="#error_message-instance_method" title="#error_message (instance method)">- (Object) <strong>error_message</strong> </a>
223
+
224
+
225
+
226
+ </span>
227
+
228
+ <span class="note title not_defined_here">
229
+ inherited
230
+ from <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span>
231
+ </span>
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+ <span class="summary_desc"><div class='inline'>
245
+ <p>Returns the value of attribute error_message.</p>
246
+ </div></span>
247
+
248
+ </li>
249
+
250
+
251
+ <li class="public ">
252
+ <span class="summary_signature">
253
+
254
+ <a href="#errors-instance_method" title="#errors (instance method)">- (Array) <strong>errors</strong> </a>
255
+
256
+
257
+
258
+ </span>
259
+
260
+ <span class="note title not_defined_here">
261
+ inherited
262
+ from <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
263
+ </span>
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+ <span class="summary_desc"><div class='inline'>
277
+ <p>The last received errors.</p>
278
+ </div></span>
279
+
280
+ </li>
281
+
282
+
283
+ <li class="public ">
284
+ <span class="summary_signature">
285
+
286
+ <a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
287
+
288
+
289
+
290
+ </span>
291
+
292
+ <span class="note title not_defined_here">
293
+ inherited
294
+ from <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
295
+ </span>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+ <span class="summary_desc"><div class='inline'>
309
+ <p>Place to dump the last response.</p>
310
+ </div></span>
311
+
312
+ </li>
313
+
314
+
315
+ </ul>
316
+
317
+
318
+
319
+
320
+
321
+ <h2>
322
+ Instance Method Summary
323
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
324
+ </h2>
325
+
326
+ <ul class="summary">
327
+
328
+ <li class="public ">
329
+ <span class="summary_signature">
330
+
331
+ <a href="#destroy-instance_method" title="#destroy (instance method)">- (Object) <strong>destroy</strong> </a>
332
+
333
+
334
+
335
+ </span>
336
+
337
+ <span class="note title not_defined_here">
338
+ included
339
+ from <span class='object_link'><a href="Destroy.html#destroy-instance_method" title="ZendeskAPI::Destroy#destroy (method)">Destroy</a></span>
340
+ </span>
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+ <span class="summary_desc"><div class='inline'></div></span>
351
+
352
+ </li>
353
+
354
+
355
+ <li class="public ">
356
+ <span class="summary_signature">
357
+
358
+ <a href="#destroy%21-instance_method" title="#destroy! (instance method)">- (Boolean) <strong>destroy!</strong> </a>
359
+
360
+
361
+
362
+ </span>
363
+
364
+ <span class="note title not_defined_here">
365
+ included
366
+ from <span class='object_link'><a href="Destroy.html#destroy%21-instance_method" title="ZendeskAPI::Destroy#destroy! (method)">Destroy</a></span>
367
+ </span>
368
+
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+ <span class="summary_desc"><div class='inline'>
378
+ <p>If this resource hasn't already been deleted, then do so.</p>
379
+ </div></span>
380
+
381
+ </li>
382
+
383
+
384
+ <li class="public ">
385
+ <span class="summary_signature">
386
+
387
+ <a href="#destroyed%3F-instance_method" title="#destroyed? (instance method)">- (Boolean) <strong>destroyed?</strong> </a>
388
+
389
+
390
+
391
+ </span>
392
+
393
+ <span class="note title not_defined_here">
394
+ included
395
+ from <span class='object_link'><a href="Destroy.html#destroyed%3F-instance_method" title="ZendeskAPI::Destroy#destroyed? (method)">Destroy</a></span>
396
+ </span>
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+ <span class="summary_desc"><div class='inline'>
407
+ <p>Has this object been deleted?.</p>
408
+ </div></span>
409
+
410
+ </li>
411
+
412
+
413
+ </ul>
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+ <div id="constructor_details" class="method_details_list">
431
+ <h2>Constructor Details</h2>
432
+
433
+ <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>
434
+
435
+ </div>
436
+ <div id="method_missing_details" class="method_details_list">
437
+ <h2>Dynamic Method Handling</h2>
438
+ <p class="notice super">
439
+ This class handles dynamic methods through the <tt>method_missing</tt> method
440
+
441
+ 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>
442
+
443
+ </p>
444
+
445
+ </div>
446
+
447
+ <div id="instance_attr_details" class="attr_details">
448
+ <h2>Instance Attribute Details</h2>
449
+
450
+
451
+ <span id="association=-instance_method"></span>
452
+ <div class="method_details first">
453
+ <h3 class="signature first" id="association-instance_method">
454
+
455
+ - (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong>
456
+
457
+
458
+
459
+
460
+
461
+ <span class="not_defined_here">
462
+ Originally defined in class
463
+ <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
464
+ </span>
465
+
466
+ </h3><div class="docstring">
467
+ <div class="discussion">
468
+
469
+ <p>The association</p>
470
+
471
+
472
+ </div>
473
+ </div>
474
+ <div class="tags">
475
+
476
+ <p class="tag_title">Returns:</p>
477
+ <ul class="return">
478
+
479
+ <li>
480
+
481
+
482
+ <span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span>
483
+
484
+
485
+
486
+ &mdash;
487
+ <div class='inline'>
488
+ <p>The association</p>
489
+ </div>
490
+
491
+ </li>
492
+
493
+ </ul>
494
+
495
+ </div>
496
+ </div>
497
+
498
+
499
+ <span id=""></span>
500
+ <div class="method_details ">
501
+ <h3 class="signature " id="attributes-instance_method">
502
+
503
+ - (<tt>Hash</tt>) <strong>attributes</strong> <span class="extras">(readonly)</span>
504
+
505
+
506
+
507
+ <span class="aliases">Also known as:
508
+ <span class="names"><span id='to_param-instance_method'>to_param</span></span>
509
+ </span>
510
+
511
+
512
+
513
+ <span class="not_defined_here">
514
+ Originally defined in class
515
+ <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
516
+ </span>
517
+
518
+ </h3><div class="docstring">
519
+ <div class="discussion">
520
+
521
+ <p>The resource's attributes</p>
522
+
523
+
524
+ </div>
525
+ </div>
526
+ <div class="tags">
527
+
528
+ <p class="tag_title">Returns:</p>
529
+ <ul class="return">
530
+
531
+ <li>
532
+
533
+
534
+ <span class='type'>(<tt>Hash</tt>)</span>
535
+
536
+
537
+
538
+ &mdash;
539
+ <div class='inline'>
540
+ <p>The resource's attributes</p>
541
+ </div>
542
+
543
+ </li>
544
+
545
+ </ul>
546
+
547
+ </div>
548
+ </div>
549
+
550
+
551
+ <span id="error=-instance_method"></span>
552
+ <div class="method_details ">
553
+ <h3 class="signature " id="error-instance_method">
554
+
555
+ - (<tt>Object</tt>) <strong>error</strong>
556
+
557
+
558
+
559
+
560
+
561
+ <span class="not_defined_here">
562
+ Originally defined in class
563
+ <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span>
564
+ </span>
565
+
566
+ </h3><div class="docstring">
567
+ <div class="discussion">
568
+
569
+ <p>Returns the value of attribute error</p>
570
+
571
+
572
+ </div>
573
+ </div>
574
+ <div class="tags">
575
+
576
+
577
+ </div>
578
+ </div>
579
+
580
+
581
+ <span id="error_message=-instance_method"></span>
582
+ <div class="method_details ">
583
+ <h3 class="signature " id="error_message-instance_method">
584
+
585
+ - (<tt>Object</tt>) <strong>error_message</strong>
586
+
587
+
588
+
589
+
590
+
591
+ <span class="not_defined_here">
592
+ Originally defined in class
593
+ <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span>
594
+ </span>
595
+
596
+ </h3><div class="docstring">
597
+ <div class="discussion">
598
+
599
+ <p>Returns the value of attribute error_message</p>
600
+
601
+
602
+ </div>
603
+ </div>
604
+ <div class="tags">
605
+
606
+
607
+ </div>
608
+ </div>
609
+
610
+
611
+ <span id="errors=-instance_method"></span>
612
+ <div class="method_details ">
613
+ <h3 class="signature " id="errors-instance_method">
614
+
615
+ - (<tt>Array</tt>) <strong>errors</strong>
616
+
617
+
618
+
619
+
620
+
621
+ <span class="not_defined_here">
622
+ Originally defined in class
623
+ <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
624
+ </span>
625
+
626
+ </h3><div class="docstring">
627
+ <div class="discussion">
628
+
629
+ <p>The last received errors</p>
630
+
631
+
632
+ </div>
633
+ </div>
634
+ <div class="tags">
635
+
636
+ <p class="tag_title">Returns:</p>
637
+ <ul class="return">
638
+
639
+ <li>
640
+
641
+
642
+ <span class='type'>(<tt>Array</tt>)</span>
643
+
644
+
645
+
646
+ &mdash;
647
+ <div class='inline'>
648
+ <p>The last received errors</p>
649
+ </div>
650
+
651
+ </li>
652
+
653
+ </ul>
654
+
655
+ </div>
656
+ </div>
657
+
658
+
659
+ <span id="response=-instance_method"></span>
660
+ <div class="method_details ">
661
+ <h3 class="signature " id="response-instance_method">
662
+
663
+ - (<tt>Object</tt>) <strong>response</strong>
664
+
665
+
666
+
667
+
668
+
669
+ <span class="not_defined_here">
670
+ Originally defined in class
671
+ <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
672
+ </span>
673
+
674
+ </h3><div class="docstring">
675
+ <div class="discussion">
676
+
677
+ <p>Place to dump the last response</p>
678
+
679
+
680
+ </div>
681
+ </div>
682
+ <div class="tags">
683
+
684
+
685
+ </div>
686
+ </div>
687
+
688
+ </div>
689
+
690
+
691
+ <div id="instance_method_details" class="method_details_list">
692
+ <h2>Instance Method Details</h2>
693
+
694
+
695
+ <div class="method_details first">
696
+ <h3 class="signature first" id="destroy-instance_method">
697
+
698
+ - (<tt>Object</tt>) <strong>destroy</strong>
699
+
700
+
701
+
702
+
703
+
704
+ <span class="not_defined_here">
705
+ Originally defined in module
706
+ <span class='object_link'><a href="Destroy.html#destroy-instance_method" title="ZendeskAPI::Destroy#destroy (method)">Destroy</a></span>
707
+ </span>
708
+
709
+ </h3>
710
+ </div>
711
+
712
+ <div class="method_details ">
713
+ <h3 class="signature " id="destroy!-instance_method">
714
+
715
+ - (<tt>Boolean</tt>) <strong>destroy!</strong>
716
+
717
+
718
+
719
+
720
+
721
+ <span class="not_defined_here">
722
+ Originally defined in module
723
+ <span class='object_link'><a href="Destroy.html#destroy%21-instance_method" title="ZendeskAPI::Destroy#destroy! (method)">Destroy</a></span>
724
+ </span>
725
+
726
+ </h3><div class="docstring">
727
+ <div class="discussion">
728
+
729
+ <p>If this resource hasn't already been deleted, then do so.</p>
730
+
731
+
732
+ </div>
733
+ </div>
734
+ <div class="tags">
735
+
736
+ <p class="tag_title">Returns:</p>
737
+ <ul class="return">
738
+
739
+ <li>
740
+
741
+
742
+ <span class='type'>(<tt>Boolean</tt>)</span>
743
+
744
+
745
+
746
+ &mdash;
747
+ <div class='inline'>
748
+ <p>Successful?</p>
749
+ </div>
750
+
751
+ </li>
752
+
753
+ </ul>
754
+
755
+ </div>
756
+ </div>
757
+
758
+ <div class="method_details ">
759
+ <h3 class="signature " id="destroyed?-instance_method">
760
+
761
+ - (<tt>Boolean</tt>) <strong>destroyed?</strong>
762
+
763
+
764
+
765
+
766
+
767
+ <span class="not_defined_here">
768
+ Originally defined in module
769
+ <span class='object_link'><a href="Destroy.html#destroyed%3F-instance_method" title="ZendeskAPI::Destroy#destroyed? (method)">Destroy</a></span>
770
+ </span>
771
+
772
+ </h3><div class="docstring">
773
+ <div class="discussion">
774
+
775
+ <p>Has this object been deleted?</p>
776
+
777
+
778
+ </div>
779
+ </div>
780
+ <div class="tags">
781
+
782
+ <p class="tag_title">Returns:</p>
783
+ <ul class="return">
784
+
785
+ <li>
786
+
787
+
788
+ <span class='type'>(<tt>Boolean</tt>)</span>
789
+
790
+
791
+
792
+ </li>
793
+
794
+ </ul>
795
+
796
+ </div>
797
+ </div>
798
+
799
+ </div>
800
+
801
+ </div>
802
+
803
+ <div id="footer">
804
+ Generated on Wed May 15 18:59:36 2013 by
805
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
806
+ 0.8.5.2 (ruby-1.9.3).
807
+ </div>
808
+
809
+ </body>
810
+ </html>