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.
- data/.yardopts +6 -2
- data/Gemfile +3 -2
- data/Gemfile.lock +4 -4
- data/Readme.md +3 -268
- data/lib/zendesk_api/actions.rb +51 -46
- data/lib/zendesk_api/association.rb +1 -1
- data/lib/zendesk_api/associations.rb +2 -6
- data/lib/zendesk_api/client.rb +8 -9
- data/lib/zendesk_api/collection.rb +84 -50
- data/lib/zendesk_api/configuration.rb +4 -0
- data/lib/zendesk_api/error.rb +22 -0
- data/lib/zendesk_api/middleware/request/etag_cache.rb +1 -7
- data/lib/zendesk_api/middleware/request/upload.rb +1 -2
- data/lib/zendesk_api/middleware/response/raise_error.rb +20 -0
- data/lib/zendesk_api/resource.rb +33 -5
- data/lib/zendesk_api/resources.rb +36 -11
- data/lib/zendesk_api/server/base.rb +1 -1
- data/lib/zendesk_api/server/helper.rb +3 -3
- data/lib/zendesk_api/server/models/zlib_json.rb +1 -1
- data/lib/zendesk_api/server/public/doc/ZendeskAPI.html +7 -7
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ability.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Activity.html +414 -51
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Attachment.html +321 -25
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Automation.html +413 -46
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Bookmark.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMData.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CRMDataStatus.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Category.html +410 -47
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Client.html +98 -362
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Collection.html +457 -676
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Configuration.html +110 -20
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create.html +264 -6
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Create/ClassMethods.html +43 -82
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CreateResource.html +671 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/CustomRole.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Data.html +207 -233
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DataResource.html +499 -24
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/DeleteResource.html +614 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy.html +73 -23
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Destroy/ClassMethod.html +68 -18
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/{FormatError.html → Error.html} +19 -27
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/ClientError.html +127 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/{Server/UserRequest.html → Error/NetworkError.html} +18 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordInvalid.html +371 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Error/RecordNotFound.html +127 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Forum.html +426 -63
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ForumSubscription.html +414 -51
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Group.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/GroupMembership.html +414 -51
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/JobStatus.html +405 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Locale.html +405 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Macro.html +413 -46
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/MobileDevice.html +404 -41
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthClient.html +606 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OAuthToken.html +810 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Organization.html +422 -59
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/OrganizationField.html +606 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Read.html +75 -12
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ReadResource.html +593 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request.html +418 -55
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Request/Comment.html +420 -31
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Resource.html +1025 -20
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Role.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Rule.html +610 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/RuleExecution.html +317 -21
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SatisfactionRating.html +428 -39
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Save.html +63 -79
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search.html +34 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Search/Result.html +305 -9
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Setting.html +433 -41
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SharingAgreement.html +405 -16
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SingularResource.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/SuspendedTicket.html +600 -31
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket.html +464 -101
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Audit.html +427 -25
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Comment.html +435 -32
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Ticket/Tag.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketField.html +389 -26
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TicketMetric.html +592 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic.html +427 -64
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicComment.html +907 -17
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Topic/TopicVote.html +414 -55
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicComment.html +325 -29
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/TopicSubscription.html +414 -51
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Trigger.html +413 -46
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update.html +258 -6
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Update/ClassMethod.html +62 -12
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/UpdateResource.html +671 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Upload.html +800 -28
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User.html +505 -142
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/Identity.html +412 -49
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/User/TopicComment.html +475 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/UserField.html +606 -0
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Verbs.html +9 -15
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/View.html +433 -66
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewCount.html +415 -13
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/ViewRow.html +451 -49
- data/lib/zendesk_api/server/public/doc/_index.html +72 -72
- data/lib/zendesk_api/server/public/doc/class_list.html +1 -1
- data/lib/zendesk_api/server/public/doc/css/style.css +10 -0
- data/lib/zendesk_api/server/public/doc/file.Readme.html +20 -260
- data/lib/zendesk_api/server/public/doc/file_list.html +1 -1
- data/lib/zendesk_api/server/public/doc/frames.html +1 -1
- data/lib/zendesk_api/server/public/doc/index.html +20 -260
- data/lib/zendesk_api/server/public/doc/method_list.html +309 -517
- data/lib/zendesk_api/server/public/doc/top-level-namespace.html +3 -35
- data/lib/zendesk_api/verbs.rb +0 -4
- data/lib/zendesk_api/version.rb +1 -1
- data/spec/core/client_spec.rb +53 -13
- data/spec/core/collection_spec.rb +32 -4
- data/spec/core/create_resource_spec.rb +1 -1
- data/spec/core/data_resource_spec.rb +2 -2
- data/spec/core/middleware/request/etag_cache_spec.rb +6 -7
- data/spec/core/middleware/request/upload_spec.rb +2 -10
- data/spec/core/middleware/response/callback_spec.rb +1 -1
- data/spec/core/middleware/response/raise_error_spec.rb +40 -0
- data/spec/core/read_resource_spec.rb +0 -2
- data/spec/core/resource_spec.rb +13 -5
- data/spec/core/search_spec.rb +1 -1
- data/spec/core/spec_helper.rb +3 -3
- data/spec/live/automation_spec.rb +23 -0
- data/spec/live/organization_field_spec.rb +12 -0
- data/spec/live/ticket_spec.rb +8 -2
- data/spec/live/trigger_spec.rb +23 -0
- data/spec/live/user_field_spec.rb +12 -0
- data/spec/live/user_spec.rb +0 -2
- data/spec/live/view_spec.rb +17 -1
- data/spec/server/spec_helper.rb +2 -2
- data/zendesk_api.gemspec +1 -1
- metadata +88 -51
- checksums.yaml +0 -7
- data/lib/zendesk_api/rescue.rb +0 -63
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console.html +0 -860
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Console/Eval.html +0 -190
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server.html +0 -131
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/App.html +0 -523
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/Helper.html +0 -684
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer.html +0 -303
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/HtmlRenderer/RedcarpetRenderer.html +0 -508
- data/lib/zendesk_api/server/public/doc/ZendeskAPI/Server/ZlibJSON.html +0 -244
- data/spec/core/rescue_spec.rb +0 -151
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Module: ZendeskAPI::Update
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.5.2
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -109,31 +109,283 @@
|
|
109
109
|
|
110
110
|
|
111
111
|
|
112
|
+
|
113
|
+
<h2>
|
114
|
+
Instance Method Summary
|
115
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
116
|
+
</h2>
|
117
|
+
|
118
|
+
<ul class="summary">
|
119
|
+
|
120
|
+
<li class="public ">
|
121
|
+
<span class="summary_signature">
|
122
|
+
|
123
|
+
<a href="#clear_associations-instance_method" title="#clear_associations (instance method)">- (Object) <strong>clear_associations</strong> </a>
|
124
|
+
|
112
125
|
|
126
|
+
|
127
|
+
</span>
|
128
|
+
|
129
|
+
<span class="note title not_defined_here">
|
130
|
+
included
|
131
|
+
from <span class='object_link'><a href="Save.html#clear_associations-instance_method" title="ZendeskAPI::Save#clear_associations (method)">Save</a></span>
|
132
|
+
</span>
|
133
|
+
|
134
|
+
|
113
135
|
|
114
136
|
|
115
137
|
|
116
138
|
|
117
139
|
|
140
|
+
|
118
141
|
|
119
|
-
|
142
|
+
<span class="summary_desc"><div class='inline'>
|
143
|
+
<p>Removes all cached associations.</p>
|
144
|
+
</div></span>
|
120
145
|
|
121
|
-
|
122
|
-
|
146
|
+
</li>
|
147
|
+
|
148
|
+
|
149
|
+
<li class="public ">
|
150
|
+
<span class="summary_signature">
|
151
|
+
|
152
|
+
<a href="#save-instance_method" title="#save (instance method)">- (Object) <strong>save</strong>(options = {}) </a>
|
153
|
+
|
123
154
|
|
155
|
+
|
156
|
+
</span>
|
157
|
+
|
158
|
+
<span class="note title not_defined_here">
|
159
|
+
included
|
160
|
+
from <span class='object_link'><a href="Save.html#save-instance_method" title="ZendeskAPI::Save#save (method)">Save</a></span>
|
161
|
+
</span>
|
124
162
|
|
125
163
|
|
126
164
|
|
127
165
|
|
128
166
|
|
129
167
|
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
<span class="summary_desc"><div class='inline'>
|
172
|
+
<p>Saves, returning false if it fails and attaching the errors.</p>
|
173
|
+
</div></span>
|
174
|
+
|
175
|
+
</li>
|
176
|
+
|
177
|
+
|
178
|
+
<li class="public ">
|
179
|
+
<span class="summary_signature">
|
180
|
+
|
181
|
+
<a href="#save%21-instance_method" title="#save! (instance method)">- (Boolean) <strong>save!</strong>(options = {}) </a>
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
</span>
|
186
|
+
|
187
|
+
<span class="note title not_defined_here">
|
188
|
+
included
|
189
|
+
from <span class='object_link'><a href="Save.html#save%21-instance_method" title="ZendeskAPI::Save#save! (method)">Save</a></span>
|
190
|
+
</span>
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
<span class="summary_desc"><div class='inline'>
|
201
|
+
<p>If this resource hasn't been deleted, then create or save it.</p>
|
202
|
+
</div></span>
|
203
|
+
|
204
|
+
</li>
|
205
|
+
|
206
|
+
|
207
|
+
<li class="public ">
|
208
|
+
<span class="summary_signature">
|
209
|
+
|
210
|
+
<a href="#save_associations-instance_method" title="#save_associations (instance method)">- (Object) <strong>save_associations</strong> </a>
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
</span>
|
215
|
+
|
216
|
+
<span class="note title not_defined_here">
|
217
|
+
included
|
218
|
+
from <span class='object_link'><a href="Save.html#save_associations-instance_method" title="ZendeskAPI::Save#save_associations (method)">Save</a></span>
|
219
|
+
</span>
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
<span class="summary_desc"><div class='inline'>
|
230
|
+
<p>Saves associations Takes into account inlining, collections, and id setting
|
231
|
+
on the parent resource.</p>
|
232
|
+
</div></span>
|
233
|
+
|
234
|
+
</li>
|
235
|
+
|
236
|
+
|
237
|
+
</ul>
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
<div id="instance_method_details" class="method_details_list">
|
245
|
+
<h2>Instance Method Details</h2>
|
246
|
+
|
247
|
+
|
248
|
+
<div class="method_details first">
|
249
|
+
<h3 class="signature first" id="clear_associations-instance_method">
|
250
|
+
|
251
|
+
- (<tt>Object</tt>) <strong>clear_associations</strong>
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
|
257
|
+
<span class="not_defined_here">
|
258
|
+
Originally defined in module
|
259
|
+
<span class='object_link'><a href="Save.html#clear_associations-instance_method" title="ZendeskAPI::Save#clear_associations (method)">Save</a></span>
|
260
|
+
</span>
|
261
|
+
|
262
|
+
</h3><div class="docstring">
|
263
|
+
<div class="discussion">
|
264
|
+
|
265
|
+
<p>Removes all cached associations</p>
|
266
|
+
|
267
|
+
|
268
|
+
</div>
|
269
|
+
</div>
|
270
|
+
<div class="tags">
|
271
|
+
|
272
|
+
|
273
|
+
</div>
|
274
|
+
</div>
|
275
|
+
|
276
|
+
<div class="method_details ">
|
277
|
+
<h3 class="signature " id="save-instance_method">
|
278
|
+
|
279
|
+
- (<tt>Object</tt>) <strong>save</strong>(options = {})
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
<span class="not_defined_here">
|
286
|
+
Originally defined in module
|
287
|
+
<span class='object_link'><a href="Save.html#save-instance_method" title="ZendeskAPI::Save#save (method)">Save</a></span>
|
288
|
+
</span>
|
289
|
+
|
290
|
+
</h3><div class="docstring">
|
291
|
+
<div class="discussion">
|
292
|
+
|
293
|
+
<p>Saves, returning false if it fails and attaching the errors</p>
|
294
|
+
|
295
|
+
|
296
|
+
</div>
|
297
|
+
</div>
|
298
|
+
<div class="tags">
|
299
|
+
|
300
|
+
|
301
|
+
</div>
|
302
|
+
</div>
|
303
|
+
|
304
|
+
<div class="method_details ">
|
305
|
+
<h3 class="signature " id="save!-instance_method">
|
306
|
+
|
307
|
+
- (<tt>Boolean</tt>) <strong>save!</strong>(options = {})
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
<span class="not_defined_here">
|
314
|
+
Originally defined in module
|
315
|
+
<span class='object_link'><a href="Save.html#save%21-instance_method" title="ZendeskAPI::Save#save! (method)">Save</a></span>
|
316
|
+
</span>
|
317
|
+
|
318
|
+
</h3><div class="docstring">
|
319
|
+
<div class="discussion">
|
320
|
+
|
321
|
+
<p>If this resource hasn't been deleted, then create or save it. Executes a
|
322
|
+
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
|
323
|
+
attributes on success.</p>
|
324
|
+
|
325
|
+
|
326
|
+
</div>
|
327
|
+
</div>
|
328
|
+
<div class="tags">
|
329
|
+
|
330
|
+
<p class="tag_title">Returns:</p>
|
331
|
+
<ul class="return">
|
332
|
+
|
333
|
+
<li>
|
334
|
+
|
335
|
+
|
336
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
—
|
341
|
+
<div class='inline'>
|
342
|
+
<p>Success?</p>
|
343
|
+
</div>
|
344
|
+
|
345
|
+
</li>
|
346
|
+
|
347
|
+
</ul>
|
348
|
+
|
349
|
+
</div>
|
350
|
+
</div>
|
351
|
+
|
352
|
+
<div class="method_details ">
|
353
|
+
<h3 class="signature " id="save_associations-instance_method">
|
354
|
+
|
355
|
+
- (<tt>Object</tt>) <strong>save_associations</strong>
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
<span class="not_defined_here">
|
362
|
+
Originally defined in module
|
363
|
+
<span class='object_link'><a href="Save.html#save_associations-instance_method" title="ZendeskAPI::Save#save_associations (method)">Save</a></span>
|
364
|
+
</span>
|
365
|
+
|
366
|
+
</h3><div class="docstring">
|
367
|
+
<div class="discussion">
|
368
|
+
|
369
|
+
<p>Saves associations Takes into account inlining, collections, and id setting
|
370
|
+
on the parent resource.</p>
|
371
|
+
|
372
|
+
|
373
|
+
</div>
|
374
|
+
</div>
|
375
|
+
<div class="tags">
|
376
|
+
|
377
|
+
|
378
|
+
</div>
|
379
|
+
</div>
|
380
|
+
|
381
|
+
</div>
|
130
382
|
|
131
383
|
</div>
|
132
384
|
|
133
385
|
<div id="footer">
|
134
|
-
Generated on
|
386
|
+
Generated on Wed May 15 18:59:28 2013 by
|
135
387
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
136
|
-
0.8.
|
388
|
+
0.8.5.2 (ruby-1.9.3).
|
137
389
|
</div>
|
138
390
|
|
139
391
|
</body>
|
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Module: ZendeskAPI::Update::ClassMethod
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.5.2
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -123,10 +123,15 @@
|
|
123
123
|
</li>
|
124
124
|
|
125
125
|
|
126
|
-
|
127
|
-
|
128
|
-
|
126
|
+
<li class="public ">
|
127
|
+
<span class="summary_signature">
|
128
|
+
|
129
|
+
<a href="#update%21-instance_method" title="#update! (instance method)">- (Object) <strong>update!</strong>(client, attributes = {}) </a>
|
130
|
+
|
129
131
|
|
132
|
+
|
133
|
+
</span>
|
134
|
+
|
130
135
|
|
131
136
|
|
132
137
|
|
@@ -134,6 +139,17 @@
|
|
134
139
|
|
135
140
|
|
136
141
|
|
142
|
+
|
143
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
144
|
+
|
145
|
+
</li>
|
146
|
+
|
147
|
+
|
148
|
+
</ul>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
137
153
|
<div id="instance_method_details" class="method_details_list">
|
138
154
|
<h2>Instance Method Details</h2>
|
139
155
|
|
@@ -202,21 +218,55 @@
|
|
202
218
|
<pre class="lines">
|
203
219
|
|
204
220
|
|
205
|
-
|
221
|
+
188
|
222
|
+
189
|
223
|
+
190
|
224
|
+
191
|
225
|
+
192</pre>
|
226
|
+
</td>
|
227
|
+
<td>
|
228
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 188</span>
|
229
|
+
|
230
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</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>
|
231
|
+
<span class='id identifier rubyid_update!'>update!</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>
|
232
|
+
<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>
|
233
|
+
<span class='kw'>false</span>
|
234
|
+
<span class='kw'>end</span></pre>
|
235
|
+
</td>
|
236
|
+
</tr>
|
237
|
+
</table>
|
238
|
+
</div>
|
239
|
+
|
240
|
+
<div class="method_details ">
|
241
|
+
<h3 class="signature " id="update!-instance_method">
|
242
|
+
|
243
|
+
- (<tt>Object</tt>) <strong>update!</strong>(client, attributes = {})
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
</h3><table class="source_code">
|
250
|
+
<tr>
|
251
|
+
<td>
|
252
|
+
<pre class="lines">
|
253
|
+
|
254
|
+
|
206
255
|
194
|
207
256
|
195
|
208
257
|
196
|
209
258
|
197
|
210
|
-
198
|
259
|
+
198
|
260
|
+
199</pre>
|
211
261
|
</td>
|
212
262
|
<td>
|
213
|
-
<pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line
|
263
|
+
<pre class="code"><span class="info file"># File 'lib/zendesk_api/actions.rb', line 194</span>
|
214
264
|
|
215
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update
|
265
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</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>
|
216
266
|
<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>
|
217
|
-
<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='symbol'>:id</span> <span class='op'>=></span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
267
|
+
<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='lbrace'>{</span> <span class='symbol'>:id</span> <span class='op'>=></span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='symbol'>:global</span> <span class='op'>=></span> <span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:global</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
218
268
|
<span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
219
|
-
<span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier
|
269
|
+
<span class='id identifier rubyid_resource'>resource</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:save!</span><span class='rparen'>)</span>
|
220
270
|
<span class='kw'>end</span></pre>
|
221
271
|
</td>
|
222
272
|
</tr>
|
@@ -228,9 +278,9 @@
|
|
228
278
|
</div>
|
229
279
|
|
230
280
|
<div id="footer">
|
231
|
-
Generated on
|
281
|
+
Generated on Wed May 15 18:59:28 2013 by
|
232
282
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
233
|
-
0.8.
|
283
|
+
0.8.5.2 (ruby-1.9.3).
|
234
284
|
</div>
|
235
285
|
|
236
286
|
</body>
|
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: ZendeskAPI::UpdateResource
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.5.2
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -122,61 +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
|
-
|
130
|
-
|
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
|
+
|
165
284
|
|
285
|
+
<span class="summary_desc"><div class='inline'>
|
286
|
+
<p>The last received errors.</p>
|
287
|
+
</div></span>
|
166
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>
|
167
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>
|
168
305
|
|
169
306
|
|
170
307
|
|
308
|
+
|
309
|
+
|
171
310
|
|
172
311
|
|
173
312
|
|
174
313
|
|
175
314
|
|
176
|
-
<h3 class="inherited">Methods included from <span class='object_link'><a href="Verbs.html" title="ZendeskAPI::Verbs (module)">Verbs</a></span></h3>
|
177
|
-
<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>
|
178
315
|
|
179
316
|
|
317
|
+
<span class="summary_desc"><div class='inline'>
|
318
|
+
<p>Place to dump the last response.</p>
|
319
|
+
</div></span>
|
320
|
+
|
321
|
+
</li>
|
322
|
+
|
323
|
+
|
324
|
+
</ul>
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
|
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>
|
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>
|
180
350
|
|
181
351
|
|
182
352
|
|
@@ -184,10 +354,114 @@
|
|
184
354
|
|
185
355
|
|
186
356
|
|
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>
|
189
357
|
|
190
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
|
+
|
412
|
+
|
413
|
+
|
414
|
+
|
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
|
+
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
191
465
|
|
192
466
|
|
193
467
|
|
@@ -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
|
+
—
|
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
|
+
—
|
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
|
+
—
|
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
|
+
—
|
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
|
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.
|
874
|
+
0.8.5.2 (ruby-1.9.3).
|
219
875
|
</div>
|
220
876
|
|
221
877
|
</body>
|