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
  Module: ZendeskAPI::Create::ClassMethods
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
 
@@ -116,9 +116,7 @@
116
116
 
117
117
 
118
118
 
119
- <span class="summary_desc"><div class='inline'>
120
- <p>Create a resource given the attributes passed in.</p>
121
- </div></span>
119
+ <span class="summary_desc"><div class='inline'></div></span>
122
120
 
123
121
  </li>
124
122
 
@@ -141,7 +139,7 @@
141
139
 
142
140
 
143
141
  <span class="summary_desc"><div class='inline'>
144
- <p>Creates the resource, raising an ArgumentError if it fails.</p>
142
+ <p>Create a resource given the attributes passed in.</p>
145
143
  </div></span>
146
144
 
147
145
  </li>
@@ -151,12 +149,6 @@
151
149
 
152
150
 
153
151
 
154
-
155
-
156
-
157
-
158
-
159
-
160
152
 
161
153
  <div id="instance_method_details" class="method_details_list">
162
154
  <h2>Instance Method Details</h2>
@@ -171,6 +163,40 @@
171
163
 
172
164
 
173
165
 
166
+ </h3><table class="source_code">
167
+ <tr>
168
+ <td>
169
+ <pre class="lines">
170
+
171
+
172
+ 122
173
+ 123
174
+ 124
175
+ 125
176
+ 126</pre>
177
+ </td>
178
+ <td>
179
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 122</span>
180
+
181
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
182
+ <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
183
+ <span class='kw'>rescue</span> <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Error</span><span class='op'>::</span><span class='const'>ClientError</span>
184
+ <span class='kw'>nil</span>
185
+ <span class='kw'>end</span></pre>
186
+ </td>
187
+ </tr>
188
+ </table>
189
+ </div>
190
+
191
+ <div class="method_details ">
192
+ <h3 class="signature " id="create!-instance_method">
193
+
194
+ - (<tt>Object</tt>) <strong>create!</strong>(client, attributes = {})
195
+
196
+
197
+
198
+
199
+
174
200
  </h3><div class="docstring">
175
201
  <div class="discussion">
176
202
 
@@ -226,82 +252,17 @@
226
252
  <pre class="lines">
227
253
 
228
254
 
229
- 116
230
255
  117
231
256
  118
232
257
  119
233
- 120
234
- 121</pre>
258
+ 120</pre>
235
259
  </td>
236
260
  <td>
237
- <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 116</span>
261
+ <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 117</span>
238
262
 
239
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
263
+ <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
240
264
  <span class='const'>ZendeskAPI</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_check_deprecated_namespace_usage'>check_deprecated_namespace_usage</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='comma'>,</span> <span class='id identifier rubyid_singular_resource_name'>singular_resource_name</span>
241
- <span class='id identifier rubyid_resource'>resource</span> <span class='op'>=</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
242
- <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
243
- <span class='id identifier rubyid_resource'>resource</span>
244
- <span class='kw'>end</span></pre>
245
- </td>
246
- </tr>
247
- </table>
248
- </div>
249
-
250
- <div class="method_details ">
251
- <h3 class="signature " id="create!-instance_method">
252
-
253
- - (<tt>Object</tt>) <strong>create!</strong>(client, attributes = {})
254
-
255
-
256
-
257
-
258
-
259
- </h3><div class="docstring">
260
- <div class="discussion">
261
-
262
- <p>Creates the resource, raising an ArgumentError if it fails</p>
263
-
264
-
265
- </div>
266
- </div>
267
- <div class="tags">
268
-
269
- <p class="tag_title">Raises:</p>
270
- <ul class="raise">
271
-
272
- <li>
273
-
274
-
275
- <span class='type'>(<tt>ArgumentError</tt>)</span>
276
-
277
-
278
-
279
- &mdash;
280
- <div class='inline'>
281
- <p>if the creation fails</p>
282
- </div>
283
-
284
- </li>
285
-
286
- </ul>
287
-
288
- </div><table class="source_code">
289
- <tr>
290
- <td>
291
- <pre class="lines">
292
-
293
-
294
- 125
295
- 126
296
- 127
297
- 128</pre>
298
- </td>
299
- <td>
300
- <pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 125</span>
301
-
302
- <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
303
- <span class='id identifier rubyid_c'>c</span> <span class='op'>=</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
304
- <span class='id identifier rubyid_c'>c</span> <span class='op'>||</span> <span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Create failed </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='rbrace'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
265
+ <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:save!</span><span class='rparen'>)</span>
305
266
  <span class='kw'>end</span></pre>
306
267
  </td>
307
268
  </tr>
@@ -313,9 +274,9 @@
313
274
  </div>
314
275
 
315
276
  <div id="footer">
316
- Generated on Mon Feb 11 17:45:36 2013 by
277
+ Generated on Wed May 15 18:59:28 2013 by
317
278
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
318
- 0.8.4.1 (ruby-1.9.3).
279
+ 0.8.5.2 (ruby-1.9.3).
319
280
  </div>
320
281
 
321
282
  </body>
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: ZendeskAPI::CreateResource
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
 
@@ -122,58 +122,231 @@
122
122
 
123
123
 
124
124
 
125
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
126
+ <ul class="summary">
127
+
128
+ <li class="public ">
129
+ <span class="summary_signature">
130
+
131
+ <a href="#association-instance_method" title="#association (instance method)">- (ZendeskAPI::Association) <strong>association</strong> </a>
132
+
125
133
 
134
+
135
+ </span>
136
+
137
+ <span class="note title not_defined_here">
138
+ inherited
139
+ from <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
140
+ </span>
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
126
151
 
127
- <h2>Instance Attribute Summary</h2>
128
152
 
129
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="DataResource.html" title="ZendeskAPI::DataResource (class)">DataResource</a></span></h3>
130
- <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>
153
+ <span class="summary_desc"><div class='inline'>
154
+ <p>The association.</p>
155
+ </div></span>
156
+
157
+ </li>
158
+
159
+
160
+ <li class="public ">
161
+ <span class="summary_signature">
162
+
163
+ <a href="#attributes-instance_method" title="#attributes (instance method)">- (Hash) <strong>attributes</strong> </a>
164
+
131
165
 
166
+
167
+ (also: #to_param)
168
+
169
+ </span>
170
+
171
+ <span class="note title not_defined_here">
172
+ inherited
173
+ from <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
174
+ </span>
175
+
176
+
177
+
178
+
179
+ <span class="note title readonly">readonly</span>
180
+
181
+
182
+
183
+
184
+
132
185
 
133
186
 
134
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
135
- <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>
136
187
 
188
+
189
+ <span class="summary_desc"><div class='inline'>
190
+ <p>The resource's attributes.</p>
191
+ </div></span>
192
+
193
+ </li>
137
194
 
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#error-instance_method" title="#error (instance method)">- (Object) <strong>error</strong> </a>
200
+
138
201
 
202
+
203
+ </span>
139
204
 
205
+ <span class="note title not_defined_here">
206
+ inherited
207
+ from <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span>
208
+ </span>
140
209
 
141
210
 
142
211
 
212
+
213
+
214
+
143
215
 
144
216
 
145
217
 
146
218
 
219
+
220
+
221
+ <span class="summary_desc"><div class='inline'>
222
+ <p>Returns the value of attribute error.</p>
223
+ </div></span>
224
+
225
+ </li>
226
+
227
+
228
+ <li class="public ">
229
+ <span class="summary_signature">
230
+
231
+ <a href="#error_message-instance_method" title="#error_message (instance method)">- (Object) <strong>error_message</strong> </a>
232
+
233
+
234
+
235
+ </span>
236
+
237
+ <span class="note title not_defined_here">
238
+ inherited
239
+ from <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span>
240
+ </span>
241
+
242
+
243
+
244
+
245
+
147
246
 
148
247
 
149
248
 
150
249
 
151
- <h2>Method Summary</h2>
152
250
 
153
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Save.html" title="ZendeskAPI::Save (module)">Save</a></span></h3>
154
- <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>
155
251
 
156
252
 
253
+ <span class="summary_desc"><div class='inline'>
254
+ <p>Returns the value of attribute error_message.</p>
255
+ </div></span>
157
256
 
257
+ </li>
258
+
259
+
260
+ <li class="public ">
261
+ <span class="summary_signature">
262
+
263
+ <a href="#errors-instance_method" title="#errors (instance method)">- (Array) <strong>errors</strong> </a>
264
+
265
+
266
+
267
+ </span>
158
268
 
269
+ <span class="note title not_defined_here">
270
+ inherited
271
+ from <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
272
+ </span>
159
273
 
160
274
 
161
275
 
276
+
277
+
278
+
279
+
162
280
 
163
281
 
164
282
 
283
+
284
+
285
+ <span class="summary_desc"><div class='inline'>
286
+ <p>The last received errors.</p>
287
+ </div></span>
288
+
289
+ </li>
290
+
291
+
292
+ <li class="public ">
293
+ <span class="summary_signature">
294
+
295
+ <a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
296
+
297
+
298
+
299
+ </span>
300
+
301
+ <span class="note title not_defined_here">
302
+ inherited
303
+ from <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
304
+ </span>
305
+
306
+
307
+
308
+
309
+
165
310
 
166
311
 
167
312
 
168
313
 
169
314
 
170
- <h3 class="inherited">Methods included from <span class='object_link'><a href="Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span></h3>
171
- <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>
172
315
 
173
316
 
317
+ <span class="summary_desc"><div class='inline'>
318
+ <p>Place to dump the last response.</p>
319
+ </div></span>
174
320
 
321
+ </li>
322
+
323
+
324
+ </ul>
325
+
326
+
327
+
328
+
175
329
 
330
+ <h2>
331
+ Instance Method Summary
332
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
333
+ </h2>
334
+
335
+ <ul class="summary">
336
+
337
+ <li class="public ">
338
+ <span class="summary_signature">
339
+
340
+ <a href="#clear_associations-instance_method" title="#clear_associations (instance method)">- (Object) <strong>clear_associations</strong> </a>
341
+
342
+
343
+
344
+ </span>
176
345
 
346
+ <span class="note title not_defined_here">
347
+ included
348
+ from <span class='object_link'><a href="Save.html#clear_associations-instance_method" title="ZendeskAPI::Save#clear_associations (method)">Save</a></span>
349
+ </span>
177
350
 
178
351
 
179
352
 
@@ -181,17 +354,118 @@
181
354
 
182
355
 
183
356
 
357
+
358
+
359
+ <span class="summary_desc"><div class='inline'>
360
+ <p>Removes all cached associations.</p>
361
+ </div></span>
362
+
363
+ </li>
364
+
365
+
366
+ <li class="public ">
367
+ <span class="summary_signature">
368
+
369
+ <a href="#save-instance_method" title="#save (instance method)">- (Object) <strong>save</strong>(options = {}) </a>
370
+
371
+
372
+
373
+ </span>
374
+
375
+ <span class="note title not_defined_here">
376
+ included
377
+ from <span class='object_link'><a href="Save.html#save-instance_method" title="ZendeskAPI::Save#save (method)">Save</a></span>
378
+ </span>
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+ <span class="summary_desc"><div class='inline'>
389
+ <p>Saves, returning false if it fails and attaching the errors.</p>
390
+ </div></span>
391
+
392
+ </li>
393
+
394
+
395
+ <li class="public ">
396
+ <span class="summary_signature">
397
+
398
+ <a href="#save%21-instance_method" title="#save! (instance method)">- (Boolean) <strong>save!</strong>(options = {}) </a>
399
+
400
+
401
+
402
+ </span>
403
+
404
+ <span class="note title not_defined_here">
405
+ included
406
+ from <span class='object_link'><a href="Save.html#save%21-instance_method" title="ZendeskAPI::Save#save! (method)">Save</a></span>
407
+ </span>
408
+
409
+
410
+
411
+
184
412
 
185
413
 
186
414
 
187
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Data.html" title="ZendeskAPI::Data (class)">Data</a></span></h3>
188
- <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>
415
+
416
+
417
+ <span class="summary_desc"><div class='inline'>
418
+ <p>If this resource hasn't been deleted, then create or save it.</p>
419
+ </div></span>
420
+
421
+ </li>
422
+
423
+
424
+ <li class="public ">
425
+ <span class="summary_signature">
426
+
427
+ <a href="#save_associations-instance_method" title="#save_associations (instance method)">- (Object) <strong>save_associations</strong> </a>
428
+
429
+
430
+
431
+ </span>
432
+
433
+ <span class="note title not_defined_here">
434
+ included
435
+ from <span class='object_link'><a href="Save.html#save_associations-instance_method" title="ZendeskAPI::Save#save_associations (method)">Save</a></span>
436
+ </span>
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+ <span class="summary_desc"><div class='inline'>
447
+ <p>Saves associations Takes into account inlining, collections, and id setting
448
+ on the parent resource.</p>
449
+ </div></span>
450
+
451
+ </li>
452
+
453
+
454
+ </ul>
455
+
456
+
189
457
 
190
458
 
191
459
 
192
460
 
193
461
 
194
462
 
463
+
464
+
465
+
466
+
467
+
468
+
195
469
  <div id="constructor_details" class="method_details_list">
196
470
  <h2>Constructor Details</h2>
197
471
 
@@ -209,13 +483,395 @@
209
483
 
210
484
  </div>
211
485
 
486
+ <div id="instance_attr_details" class="attr_details">
487
+ <h2>Instance Attribute Details</h2>
488
+
489
+
490
+ <span id="association=-instance_method"></span>
491
+ <div class="method_details first">
492
+ <h3 class="signature first" id="association-instance_method">
493
+
494
+ - (<tt><span class='object_link'>ZendeskAPI::Association</span></tt>) <strong>association</strong>
495
+
496
+
497
+
498
+
499
+
500
+ <span class="not_defined_here">
501
+ Originally defined in class
502
+ <span class='object_link'><a href="Data.html#association-instance_method" title="ZendeskAPI::Data#association (method)">Data</a></span>
503
+ </span>
504
+
505
+ </h3><div class="docstring">
506
+ <div class="discussion">
507
+
508
+ <p>The association</p>
509
+
510
+
511
+ </div>
512
+ </div>
513
+ <div class="tags">
514
+
515
+ <p class="tag_title">Returns:</p>
516
+ <ul class="return">
517
+
518
+ <li>
519
+
520
+
521
+ <span class='type'>(<tt><span class='object_link'>ZendeskAPI::Association</span></tt>)</span>
522
+
523
+
524
+
525
+ &mdash;
526
+ <div class='inline'>
527
+ <p>The association</p>
528
+ </div>
529
+
530
+ </li>
531
+
532
+ </ul>
533
+
534
+ </div>
535
+ </div>
536
+
537
+
538
+ <span id=""></span>
539
+ <div class="method_details ">
540
+ <h3 class="signature " id="attributes-instance_method">
541
+
542
+ - (<tt>Hash</tt>) <strong>attributes</strong> <span class="extras">(readonly)</span>
543
+
544
+
545
+
546
+ <span class="aliases">Also known as:
547
+ <span class="names"><span id='to_param-instance_method'>to_param</span></span>
548
+ </span>
549
+
550
+
551
+
552
+ <span class="not_defined_here">
553
+ Originally defined in class
554
+ <span class='object_link'><a href="Data.html#attributes-instance_method" title="ZendeskAPI::Data#attributes (method)">Data</a></span>
555
+ </span>
556
+
557
+ </h3><div class="docstring">
558
+ <div class="discussion">
559
+
560
+ <p>The resource's attributes</p>
561
+
562
+
563
+ </div>
564
+ </div>
565
+ <div class="tags">
566
+
567
+ <p class="tag_title">Returns:</p>
568
+ <ul class="return">
569
+
570
+ <li>
571
+
572
+
573
+ <span class='type'>(<tt>Hash</tt>)</span>
574
+
575
+
576
+
577
+ &mdash;
578
+ <div class='inline'>
579
+ <p>The resource's attributes</p>
580
+ </div>
581
+
582
+ </li>
583
+
584
+ </ul>
585
+
586
+ </div>
587
+ </div>
588
+
589
+
590
+ <span id="error=-instance_method"></span>
591
+ <div class="method_details ">
592
+ <h3 class="signature " id="error-instance_method">
593
+
594
+ - (<tt>Object</tt>) <strong>error</strong>
595
+
596
+
597
+
598
+
599
+
600
+ <span class="not_defined_here">
601
+ Originally defined in class
602
+ <span class='object_link'><a href="DataResource.html#error-instance_method" title="ZendeskAPI::DataResource#error (method)">DataResource</a></span>
603
+ </span>
604
+
605
+ </h3><div class="docstring">
606
+ <div class="discussion">
607
+
608
+ <p>Returns the value of attribute error</p>
609
+
610
+
611
+ </div>
612
+ </div>
613
+ <div class="tags">
614
+
615
+
616
+ </div>
617
+ </div>
618
+
619
+
620
+ <span id="error_message=-instance_method"></span>
621
+ <div class="method_details ">
622
+ <h3 class="signature " id="error_message-instance_method">
623
+
624
+ - (<tt>Object</tt>) <strong>error_message</strong>
625
+
626
+
627
+
628
+
629
+
630
+ <span class="not_defined_here">
631
+ Originally defined in class
632
+ <span class='object_link'><a href="DataResource.html#error_message-instance_method" title="ZendeskAPI::DataResource#error_message (method)">DataResource</a></span>
633
+ </span>
634
+
635
+ </h3><div class="docstring">
636
+ <div class="discussion">
637
+
638
+ <p>Returns the value of attribute error_message</p>
639
+
640
+
641
+ </div>
642
+ </div>
643
+ <div class="tags">
644
+
645
+
646
+ </div>
647
+ </div>
648
+
649
+
650
+ <span id="errors=-instance_method"></span>
651
+ <div class="method_details ">
652
+ <h3 class="signature " id="errors-instance_method">
653
+
654
+ - (<tt>Array</tt>) <strong>errors</strong>
655
+
656
+
657
+
658
+
659
+
660
+ <span class="not_defined_here">
661
+ Originally defined in class
662
+ <span class='object_link'><a href="Data.html#errors-instance_method" title="ZendeskAPI::Data#errors (method)">Data</a></span>
663
+ </span>
664
+
665
+ </h3><div class="docstring">
666
+ <div class="discussion">
667
+
668
+ <p>The last received errors</p>
669
+
670
+
671
+ </div>
672
+ </div>
673
+ <div class="tags">
674
+
675
+ <p class="tag_title">Returns:</p>
676
+ <ul class="return">
677
+
678
+ <li>
679
+
680
+
681
+ <span class='type'>(<tt>Array</tt>)</span>
682
+
683
+
684
+
685
+ &mdash;
686
+ <div class='inline'>
687
+ <p>The last received errors</p>
688
+ </div>
689
+
690
+ </li>
691
+
692
+ </ul>
693
+
694
+ </div>
695
+ </div>
696
+
697
+
698
+ <span id="response=-instance_method"></span>
699
+ <div class="method_details ">
700
+ <h3 class="signature " id="response-instance_method">
701
+
702
+ - (<tt>Object</tt>) <strong>response</strong>
703
+
704
+
705
+
706
+
707
+
708
+ <span class="not_defined_here">
709
+ Originally defined in class
710
+ <span class='object_link'><a href="Data.html#response-instance_method" title="ZendeskAPI::Data#response (method)">Data</a></span>
711
+ </span>
712
+
713
+ </h3><div class="docstring">
714
+ <div class="discussion">
715
+
716
+ <p>Place to dump the last response</p>
717
+
718
+
719
+ </div>
720
+ </div>
721
+ <div class="tags">
722
+
723
+
724
+ </div>
725
+ </div>
726
+
727
+ </div>
728
+
729
+
730
+ <div id="instance_method_details" class="method_details_list">
731
+ <h2>Instance Method Details</h2>
732
+
733
+
734
+ <div class="method_details first">
735
+ <h3 class="signature first" id="clear_associations-instance_method">
736
+
737
+ - (<tt>Object</tt>) <strong>clear_associations</strong>
738
+
739
+
740
+
741
+
742
+
743
+ <span class="not_defined_here">
744
+ Originally defined in module
745
+ <span class='object_link'><a href="Save.html#clear_associations-instance_method" title="ZendeskAPI::Save#clear_associations (method)">Save</a></span>
746
+ </span>
747
+
748
+ </h3><div class="docstring">
749
+ <div class="discussion">
750
+
751
+ <p>Removes all cached associations</p>
752
+
753
+
754
+ </div>
755
+ </div>
756
+ <div class="tags">
757
+
758
+
759
+ </div>
760
+ </div>
761
+
762
+ <div class="method_details ">
763
+ <h3 class="signature " id="save-instance_method">
764
+
765
+ - (<tt>Object</tt>) <strong>save</strong>(options = {})
766
+
767
+
768
+
769
+
770
+
771
+ <span class="not_defined_here">
772
+ Originally defined in module
773
+ <span class='object_link'><a href="Save.html#save-instance_method" title="ZendeskAPI::Save#save (method)">Save</a></span>
774
+ </span>
775
+
776
+ </h3><div class="docstring">
777
+ <div class="discussion">
778
+
779
+ <p>Saves, returning false if it fails and attaching the errors</p>
780
+
781
+
782
+ </div>
783
+ </div>
784
+ <div class="tags">
785
+
786
+
787
+ </div>
788
+ </div>
789
+
790
+ <div class="method_details ">
791
+ <h3 class="signature " id="save!-instance_method">
792
+
793
+ - (<tt>Boolean</tt>) <strong>save!</strong>(options = {})
794
+
795
+
796
+
797
+
798
+
799
+ <span class="not_defined_here">
800
+ Originally defined in module
801
+ <span class='object_link'><a href="Save.html#save%21-instance_method" title="ZendeskAPI::Save#save! (method)">Save</a></span>
802
+ </span>
803
+
804
+ </h3><div class="docstring">
805
+ <div class="discussion">
806
+
807
+ <p>If this resource hasn't been deleted, then create or save it. Executes a
808
+ 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
809
+ attributes on success.</p>
810
+
811
+
812
+ </div>
813
+ </div>
814
+ <div class="tags">
815
+
816
+ <p class="tag_title">Returns:</p>
817
+ <ul class="return">
818
+
819
+ <li>
820
+
821
+
822
+ <span class='type'>(<tt>Boolean</tt>)</span>
823
+
824
+
825
+
826
+ &mdash;
827
+ <div class='inline'>
828
+ <p>Success?</p>
829
+ </div>
830
+
831
+ </li>
832
+
833
+ </ul>
834
+
835
+ </div>
836
+ </div>
837
+
838
+ <div class="method_details ">
839
+ <h3 class="signature " id="save_associations-instance_method">
840
+
841
+ - (<tt>Object</tt>) <strong>save_associations</strong>
842
+
843
+
844
+
845
+
846
+
847
+ <span class="not_defined_here">
848
+ Originally defined in module
849
+ <span class='object_link'><a href="Save.html#save_associations-instance_method" title="ZendeskAPI::Save#save_associations (method)">Save</a></span>
850
+ </span>
851
+
852
+ </h3><div class="docstring">
853
+ <div class="discussion">
854
+
855
+ <p>Saves associations Takes into account inlining, collections, and id setting
856
+ on the parent resource.</p>
857
+
858
+
859
+ </div>
860
+ </div>
861
+ <div class="tags">
862
+
863
+
864
+ </div>
865
+ </div>
866
+
867
+ </div>
212
868
 
213
869
  </div>
214
870
 
215
871
  <div id="footer">
216
- Generated on Mon Feb 11 17:45:36 2013 by
872
+ Generated on Wed May 15 18:59:29 2013 by
217
873
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
218
- 0.8.4.1 (ruby-1.9.3).
874
+ 0.8.5.2 (ruby-1.9.3).
219
875
  </div>
220
876
 
221
877
  </body>