basecamp3 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +12 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +5 -0
  5. data/Gemfile +2 -0
  6. data/LICENSE.txt +21 -0
  7. data/README.md +65 -0
  8. data/Rakefile +6 -0
  9. data/basecamp3.gemspec +38 -0
  10. data/bin/console +14 -0
  11. data/bin/setup +8 -0
  12. data/docs/Basecamp3.html +367 -0
  13. data/docs/Basecamp3/Campfire.html +901 -0
  14. data/docs/Basecamp3/CampfireLine.html +1025 -0
  15. data/docs/Basecamp3/Comment.html +1284 -0
  16. data/docs/Basecamp3/Concerns.html +117 -0
  17. data/docs/Basecamp3/Concerns/Bucketable.html +211 -0
  18. data/docs/Basecamp3/Concerns/Commentable.html +285 -0
  19. data/docs/Basecamp3/Concerns/Creatorable.html +209 -0
  20. data/docs/Basecamp3/Concerns/Parentable.html +211 -0
  21. data/docs/Basecamp3/Concerns/Recordingable.html +189 -0
  22. data/docs/Basecamp3/Concerns/Recordingable/ClassMethods.html +236 -0
  23. data/docs/Basecamp3/Document.html +1262 -0
  24. data/docs/Basecamp3/Forward.html +1070 -0
  25. data/docs/Basecamp3/Inbox.html +840 -0
  26. data/docs/Basecamp3/Message.html +1262 -0
  27. data/docs/Basecamp3/MessageBoard.html +840 -0
  28. data/docs/Basecamp3/MessageType.html +1160 -0
  29. data/docs/Basecamp3/Model.html +236 -0
  30. data/docs/Basecamp3/Person.html +1288 -0
  31. data/docs/Basecamp3/Project.html +1280 -0
  32. data/docs/Basecamp3/Question.html +1050 -0
  33. data/docs/Basecamp3/QuestionAnswer.html +887 -0
  34. data/docs/Basecamp3/Questionnaire.html +840 -0
  35. data/docs/Basecamp3/Request.html +933 -0
  36. data/docs/Basecamp3/ResponseParser.html +303 -0
  37. data/docs/Basecamp3/Schedule.html +840 -0
  38. data/docs/Basecamp3/ScheduleEntry.html +1560 -0
  39. data/docs/Basecamp3/Todo.html +1726 -0
  40. data/docs/Basecamp3/TodoList.html +1480 -0
  41. data/docs/Basecamp3/TodoSet.html +980 -0
  42. data/docs/Basecamp3/TypeMapper.html +329 -0
  43. data/docs/Basecamp3/Vault.html +1514 -0
  44. data/docs/_index.html +415 -0
  45. data/docs/class_list.html +51 -0
  46. data/docs/css/common.css +1 -0
  47. data/docs/css/full_list.css +58 -0
  48. data/docs/css/style.css +492 -0
  49. data/docs/file.README.html +157 -0
  50. data/docs/file_list.html +56 -0
  51. data/docs/frames.html +17 -0
  52. data/docs/index.html +157 -0
  53. data/docs/js/app.js +248 -0
  54. data/docs/js/full_list.js +216 -0
  55. data/docs/js/jquery.js +4 -0
  56. data/docs/method_list.html +1875 -0
  57. data/docs/top-level-namespace.html +110 -0
  58. data/lib/basecamp3.rb +61 -0
  59. data/lib/basecamp3/concerns/bucketable.rb +17 -0
  60. data/lib/basecamp3/concerns/commentable.rb +15 -0
  61. data/lib/basecamp3/concerns/creatorable.rb +16 -0
  62. data/lib/basecamp3/concerns/parentable.rb +17 -0
  63. data/lib/basecamp3/concerns/recordingable.rb +22 -0
  64. data/lib/basecamp3/model.rb +23 -0
  65. data/lib/basecamp3/models/campfire.rb +42 -0
  66. data/lib/basecamp3/models/campfire_line.rb +52 -0
  67. data/lib/basecamp3/models/comment.rb +65 -0
  68. data/lib/basecamp3/models/document.rb +71 -0
  69. data/lib/basecamp3/models/forward.rb +40 -0
  70. data/lib/basecamp3/models/inbox.rb +31 -0
  71. data/lib/basecamp3/models/message.rb +73 -0
  72. data/lib/basecamp3/models/message_board.rb +31 -0
  73. data/lib/basecamp3/models/message_type.rb +68 -0
  74. data/lib/basecamp3/models/person.rb +46 -0
  75. data/lib/basecamp3/models/project.rb +70 -0
  76. data/lib/basecamp3/models/question.rb +43 -0
  77. data/lib/basecamp3/models/question_answer.rb +35 -0
  78. data/lib/basecamp3/models/questionnaire.rb +31 -0
  79. data/lib/basecamp3/models/schedule.rb +31 -0
  80. data/lib/basecamp3/models/schedule_entry.rb +93 -0
  81. data/lib/basecamp3/models/todo.rb +108 -0
  82. data/lib/basecamp3/models/todo_list.rb +77 -0
  83. data/lib/basecamp3/models/todo_set.rb +33 -0
  84. data/lib/basecamp3/models/vault.rb +79 -0
  85. data/lib/basecamp3/request.rb +163 -0
  86. data/lib/basecamp3/response_parser.rb +44 -0
  87. data/lib/basecamp3/type_mapper.rb +53 -0
  88. data/lib/basecamp3/version.rb +3 -0
  89. metadata +202 -0
data/docs/Basecamp3/Concerns/Recordingable/ClassMethods.html ADDED
@@ -0,0 +1,236 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: Basecamp3::Concerns::Recordingable::ClassMethods
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Basecamp3::Concerns::Recordingable::ClassMethods";
19
+ relpath = '../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Concerns.html" title="Basecamp3::Concerns (module)">Concerns</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Recordingable.html" title="Basecamp3::Concerns::Recordingable (module)">Recordingable</a></span></span>
41
+ &raquo;
42
+ <span class="title">ClassMethods</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: Basecamp3::Concerns::Recordingable::ClassMethods
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/basecamp3/concerns/recordingable.rb</dd>
82
+ </dl>
83
+
84
+ </div>
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+ <h2>
95
+ Instance Method Summary
96
+ <small><a href="#" class="summary_toggle">collapse</a></small>
97
+ </h2>
98
+
99
+ <ul class="summary">
100
+
101
+ <li class="public ">
102
+ <span class="summary_signature">
103
+
104
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(bucket_id, id) &#x21d2; Boolean </a>
105
+
106
+
107
+
108
+ </span>
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+ <span class="summary_desc"><div class='inline'>
119
+ <p>Deletes the record.</p>
120
+ </div></span>
121
+
122
+ </li>
123
+
124
+
125
+ </ul>
126
+
127
+
128
+
129
+
130
+ <div id="instance_method_details" class="method_details_list">
131
+ <h2>Instance Method Details</h2>
132
+
133
+
134
+ <div class="method_details first">
135
+ <h3 class="signature first" id="delete-instance_method">
136
+
137
+ #<strong>delete</strong>(bucket_id, id) &#x21d2; <tt>Boolean</tt>
138
+
139
+
140
+
141
+
142
+
143
+ </h3><div class="docstring">
144
+ <div class="discussion">
145
+
146
+ <p>Deletes the record.</p>
147
+
148
+
149
+ </div>
150
+ </div>
151
+ <div class="tags">
152
+ <p class="tag_title">Parameters:</p>
153
+ <ul class="param">
154
+
155
+ <li>
156
+
157
+ <span class='name'>bucket_id</span>
158
+
159
+
160
+ <span class='type'>(<tt>Integer</tt>)</span>
161
+
162
+
163
+
164
+ &mdash;
165
+ <div class='inline'>
166
+ <p>the id of the bucket</p>
167
+ </div>
168
+
169
+ </li>
170
+
171
+ <li>
172
+
173
+ <span class='name'>id</span>
174
+
175
+
176
+ <span class='type'>(<tt>Integer</tt>)</span>
177
+
178
+
179
+
180
+ &mdash;
181
+ <div class='inline'>
182
+ <p>the id of the record</p>
183
+ </div>
184
+
185
+ </li>
186
+
187
+ </ul>
188
+
189
+ <p class="tag_title">Returns:</p>
190
+ <ul class="return">
191
+
192
+ <li>
193
+
194
+
195
+ <span class='type'>(<tt>Boolean</tt>)</span>
196
+
197
+
198
+
199
+ </li>
200
+
201
+ </ul>
202
+
203
+ </div><table class="source_code">
204
+ <tr>
205
+ <td>
206
+ <pre class="lines">
207
+
208
+
209
+ 16
210
+ 17
211
+ 18</pre>
212
+ </td>
213
+ <td>
214
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/concerns/recordingable.rb', line 16</span>
215
+
216
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
217
+ <span class='const'><span class='object_link'><a href="../../../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../../../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_put'><span class='object_link'><a href="../../Request.html#put-instance_method" title="Basecamp3::Request#put (method)">put</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/recordings/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/status/trashed</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
218
+ <span class='kw'>end</span></pre>
219
+ </td>
220
+ </tr>
221
+ </table>
222
+ </div>
223
+
224
+ </div>
225
+
226
+ </div>
227
+
228
+ <div id="footer">
229
+ Generated on Tue May 9 15:32:16 2017 by
230
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
231
+ 0.9.9 (ruby-2.2.2).
232
+ </div>
233
+
234
+ </div>
235
+ </body>
236
+ </html>
data/docs/Basecamp3/Document.html ADDED
@@ -0,0 +1,1262 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Basecamp3::Document
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Basecamp3::Document";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (D)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span>
41
+ &raquo;
42
+ <span class="title">Document</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Basecamp3::Document
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></li>
78
+
79
+ <li class="next">Basecamp3::Document</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+ <dl>
93
+ <dt>Includes:</dt>
94
+ <dd><span class='object_link'><a href="Concerns/Bucketable.html" title="Basecamp3::Concerns::Bucketable (module)">Concerns::Bucketable</a></span>, <span class='object_link'><a href="Concerns/Commentable.html" title="Basecamp3::Concerns::Commentable (module)">Concerns::Commentable</a></span>, <span class='object_link'><a href="Concerns/Creatorable.html" title="Basecamp3::Concerns::Creatorable (module)">Concerns::Creatorable</a></span>, <span class='object_link'><a href="Concerns/Parentable.html" title="Basecamp3::Concerns::Parentable (module)">Concerns::Parentable</a></span>, <span class='object_link'><a href="Concerns/Recordingable.html" title="Basecamp3::Concerns::Recordingable (module)">Concerns::Recordingable</a></span></dd>
95
+ </dl>
96
+
97
+
98
+
99
+
100
+
101
+
102
+ <dl>
103
+ <dt>Defined in:</dt>
104
+ <dd>lib/basecamp3/models/document.rb</dd>
105
+ </dl>
106
+
107
+ </div>
108
+
109
+ <h2>Overview</h2><div class="docstring">
110
+ <div class="discussion">
111
+
112
+ <p>A model for Basecamp&#39;s Document</p>
113
+
114
+ <p><a href="https://github.com/basecamp/bc3-api/blob/master/sections/documents.md#documents" target="_parent" title="For more information, see the official Basecamp3 API documentation for Documents">For more information, see the official Basecamp3 API documentation for Documents</a></p>
115
+
116
+
117
+ </div>
118
+ </div>
119
+ <div class="tags">
120
+
121
+
122
+ </div>
123
+ <h2>Constant Summary</h2>
124
+ <dl class="constants">
125
+
126
+ <dt id="REQUIRED_FIELDS-constant" class="">REQUIRED_FIELDS =
127
+
128
+ </dt>
129
+ <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>title</span><span class='words_sep'> </span><span class='tstring_content'>content</span><span class='words_sep'>)</span></pre></dd>
130
+
131
+ </dl>
132
+
133
+
134
+
135
+
136
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
137
+ <ul class="summary">
138
+
139
+ <li class="public ">
140
+ <span class="summary_signature">
141
+
142
+ <a href="#content-instance_method" title="#content (instance method)">#<strong>content</strong> &#x21d2; Object </a>
143
+
144
+
145
+
146
+ </span>
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'>
160
+ <p>Returns the value of attribute content.</p>
161
+ </div></span>
162
+
163
+ </li>
164
+
165
+
166
+ <li class="public ">
167
+ <span class="summary_signature">
168
+
169
+ <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; Object </a>
170
+
171
+
172
+
173
+ </span>
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+ <span class="summary_desc"><div class='inline'>
187
+ <p>Returns the value of attribute created_at.</p>
188
+ </div></span>
189
+
190
+ </li>
191
+
192
+
193
+ <li class="public ">
194
+ <span class="summary_signature">
195
+
196
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
197
+
198
+
199
+
200
+ </span>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+ <span class="summary_desc"><div class='inline'>
214
+ <p>Returns the value of attribute id.</p>
215
+ </div></span>
216
+
217
+ </li>
218
+
219
+
220
+ <li class="public ">
221
+ <span class="summary_signature">
222
+
223
+ <a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong> &#x21d2; Object </a>
224
+
225
+
226
+
227
+ </span>
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+ <span class="summary_desc"><div class='inline'>
241
+ <p>Returns the value of attribute status.</p>
242
+ </div></span>
243
+
244
+ </li>
245
+
246
+
247
+ <li class="public ">
248
+ <span class="summary_signature">
249
+
250
+ <a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> &#x21d2; Object </a>
251
+
252
+
253
+
254
+ </span>
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+ <span class="summary_desc"><div class='inline'>
268
+ <p>Returns the value of attribute title.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> &#x21d2; Object </a>
278
+
279
+
280
+
281
+ </span>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+ <span class="summary_desc"><div class='inline'>
295
+ <p>Returns the value of attribute updated_at.</p>
296
+ </div></span>
297
+
298
+ </li>
299
+
300
+
301
+ </ul>
302
+
303
+
304
+
305
+
306
+
307
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="Concerns/Commentable.html" title="Basecamp3::Concerns::Commentable (module)">Concerns::Commentable</a></span></h3>
308
+ <p class="inherited"><span class='object_link'><a href="Concerns/Commentable.html#comments_count-instance_method" title="Basecamp3::Concerns::Commentable#comments_count (method)">#comments_count</a></span></p>
309
+
310
+
311
+
312
+ <h2>
313
+ Class Method Summary
314
+ <small><a href="#" class="summary_toggle">collapse</a></small>
315
+ </h2>
316
+
317
+ <ul class="summary">
318
+
319
+ <li class="public ">
320
+ <span class="summary_signature">
321
+
322
+ <a href="#all-class_method" title="all (class method)">.<strong>all</strong>(bucket_id, parent_id, params = {}) &#x21d2; Array&lt;Basecamp3::Document&gt; </a>
323
+
324
+
325
+
326
+ </span>
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+ <span class="summary_desc"><div class='inline'>
337
+ <p>Returns a paginated list of active documents.</p>
338
+ </div></span>
339
+
340
+ </li>
341
+
342
+
343
+ <li class="public ">
344
+ <span class="summary_signature">
345
+
346
+ <a href="#create-class_method" title="create (class method)">.<strong>create</strong>(bucket_id, parent_id, data) &#x21d2; Basecamp3::Document </a>
347
+
348
+
349
+
350
+ </span>
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+ <span class="summary_desc"><div class='inline'>
361
+ <p>Creates a document.</p>
362
+ </div></span>
363
+
364
+ </li>
365
+
366
+
367
+ <li class="public ">
368
+ <span class="summary_signature">
369
+
370
+ <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(bucket_id, id) &#x21d2; Basecamp3::Document </a>
371
+
372
+
373
+
374
+ </span>
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+ <span class="summary_desc"><div class='inline'>
385
+ <p>Returns the document.</p>
386
+ </div></span>
387
+
388
+ </li>
389
+
390
+
391
+ <li class="public ">
392
+ <span class="summary_signature">
393
+
394
+ <a href="#update-class_method" title="update (class method)">.<strong>update</strong>(bucket_id, id, data) &#x21d2; Basecamp3::Document </a>
395
+
396
+
397
+
398
+ </span>
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+ <span class="summary_desc"><div class='inline'>
409
+ <p>Updates the document.</p>
410
+ </div></span>
411
+
412
+ </li>
413
+
414
+
415
+ </ul>
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Commentable.html" title="Basecamp3::Concerns::Commentable (module)">Concerns::Commentable</a></span></h3>
428
+ <p class="inherited"><span class='object_link'><a href="Concerns/Commentable.html#comments-instance_method" title="Basecamp3::Concerns::Commentable#comments (method)">#comments</a></span></p>
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Recordingable.html" title="Basecamp3::Concerns::Recordingable (module)">Concerns::Recordingable</a></span></h3>
439
+ <p class="inherited"><span class='object_link'><a href="Concerns/Recordingable.html#included-class_method" title="Basecamp3::Concerns::Recordingable.included (method)">included</a></span></p>
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Parentable.html" title="Basecamp3::Concerns::Parentable (module)">Concerns::Parentable</a></span></h3>
450
+ <p class="inherited"><span class='object_link'><a href="Concerns/Parentable.html#parent-instance_method" title="Basecamp3::Concerns::Parentable#parent (method)">#parent</a></span></p>
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Bucketable.html" title="Basecamp3::Concerns::Bucketable (module)">Concerns::Bucketable</a></span></h3>
461
+ <p class="inherited"><span class='object_link'><a href="Concerns/Bucketable.html#bucket-instance_method" title="Basecamp3::Concerns::Bucketable#bucket (method)">#bucket</a></span></p>
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Concerns/Creatorable.html" title="Basecamp3::Concerns::Creatorable (module)">Concerns::Creatorable</a></span></h3>
472
+ <p class="inherited"><span class='object_link'><a href="Concerns/Creatorable.html#creator-instance_method" title="Basecamp3::Concerns::Creatorable#creator (method)">#creator</a></span></p>
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
483
+ <p class="inherited"><span class='object_link'><a href="Model.html#initialize-instance_method" title="Basecamp3::Model#initialize (method)">#initialize</a></span></p>
484
+ <div id="constructor_details" class="method_details_list">
485
+ <h2>Constructor Details</h2>
486
+
487
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Model.html#initialize-instance_method" title="Basecamp3::Model#initialize (method)">Basecamp3::Model</a></span></p>
488
+
489
+ </div>
490
+
491
+ <div id="instance_attr_details" class="attr_details">
492
+ <h2>Instance Attribute Details</h2>
493
+
494
+
495
+ <span id="content=-instance_method"></span>
496
+ <div class="method_details first">
497
+ <h3 class="signature first" id="content-instance_method">
498
+
499
+ #<strong>content</strong> &#x21d2; <tt>Object</tt>
500
+
501
+
502
+
503
+
504
+
505
+ </h3><div class="docstring">
506
+ <div class="discussion">
507
+
508
+ <p>Returns the value of attribute content</p>
509
+
510
+
511
+ </div>
512
+ </div>
513
+ <div class="tags">
514
+
515
+
516
+ </div><table class="source_code">
517
+ <tr>
518
+ <td>
519
+ <pre class="lines">
520
+
521
+
522
+ 11
523
+ 12
524
+ 13</pre>
525
+ </td>
526
+ <td>
527
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 11</span>
528
+
529
+ <span class='kw'>def</span> <span class='id identifier rubyid_content'>content</span>
530
+ <span class='ivar'>@content</span>
531
+ <span class='kw'>end</span></pre>
532
+ </td>
533
+ </tr>
534
+ </table>
535
+ </div>
536
+
537
+
538
+ <span id="created_at=-instance_method"></span>
539
+ <div class="method_details ">
540
+ <h3 class="signature " id="created_at-instance_method">
541
+
542
+ #<strong>created_at</strong> &#x21d2; <tt>Object</tt>
543
+
544
+
545
+
546
+
547
+
548
+ </h3><div class="docstring">
549
+ <div class="discussion">
550
+
551
+ <p>Returns the value of attribute created_at</p>
552
+
553
+
554
+ </div>
555
+ </div>
556
+ <div class="tags">
557
+
558
+
559
+ </div><table class="source_code">
560
+ <tr>
561
+ <td>
562
+ <pre class="lines">
563
+
564
+
565
+ 11
566
+ 12
567
+ 13</pre>
568
+ </td>
569
+ <td>
570
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 11</span>
571
+
572
+ <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
573
+ <span class='ivar'>@created_at</span>
574
+ <span class='kw'>end</span></pre>
575
+ </td>
576
+ </tr>
577
+ </table>
578
+ </div>
579
+
580
+
581
+ <span id="id=-instance_method"></span>
582
+ <div class="method_details ">
583
+ <h3 class="signature " id="id-instance_method">
584
+
585
+ #<strong>id</strong> &#x21d2; <tt>Object</tt>
586
+
587
+
588
+
589
+
590
+
591
+ </h3><div class="docstring">
592
+ <div class="discussion">
593
+
594
+ <p>Returns the value of attribute id</p>
595
+
596
+
597
+ </div>
598
+ </div>
599
+ <div class="tags">
600
+
601
+
602
+ </div><table class="source_code">
603
+ <tr>
604
+ <td>
605
+ <pre class="lines">
606
+
607
+
608
+ 11
609
+ 12
610
+ 13</pre>
611
+ </td>
612
+ <td>
613
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 11</span>
614
+
615
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
616
+ <span class='ivar'>@id</span>
617
+ <span class='kw'>end</span></pre>
618
+ </td>
619
+ </tr>
620
+ </table>
621
+ </div>
622
+
623
+
624
+ <span id="status=-instance_method"></span>
625
+ <div class="method_details ">
626
+ <h3 class="signature " id="status-instance_method">
627
+
628
+ #<strong>status</strong> &#x21d2; <tt>Object</tt>
629
+
630
+
631
+
632
+
633
+
634
+ </h3><div class="docstring">
635
+ <div class="discussion">
636
+
637
+ <p>Returns the value of attribute status</p>
638
+
639
+
640
+ </div>
641
+ </div>
642
+ <div class="tags">
643
+
644
+
645
+ </div><table class="source_code">
646
+ <tr>
647
+ <td>
648
+ <pre class="lines">
649
+
650
+
651
+ 11
652
+ 12
653
+ 13</pre>
654
+ </td>
655
+ <td>
656
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 11</span>
657
+
658
+ <span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
659
+ <span class='ivar'>@status</span>
660
+ <span class='kw'>end</span></pre>
661
+ </td>
662
+ </tr>
663
+ </table>
664
+ </div>
665
+
666
+
667
+ <span id="title=-instance_method"></span>
668
+ <div class="method_details ">
669
+ <h3 class="signature " id="title-instance_method">
670
+
671
+ #<strong>title</strong> &#x21d2; <tt>Object</tt>
672
+
673
+
674
+
675
+
676
+
677
+ </h3><div class="docstring">
678
+ <div class="discussion">
679
+
680
+ <p>Returns the value of attribute title</p>
681
+
682
+
683
+ </div>
684
+ </div>
685
+ <div class="tags">
686
+
687
+
688
+ </div><table class="source_code">
689
+ <tr>
690
+ <td>
691
+ <pre class="lines">
692
+
693
+
694
+ 11
695
+ 12
696
+ 13</pre>
697
+ </td>
698
+ <td>
699
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 11</span>
700
+
701
+ <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
702
+ <span class='ivar'>@title</span>
703
+ <span class='kw'>end</span></pre>
704
+ </td>
705
+ </tr>
706
+ </table>
707
+ </div>
708
+
709
+
710
+ <span id="updated_at=-instance_method"></span>
711
+ <div class="method_details ">
712
+ <h3 class="signature " id="updated_at-instance_method">
713
+
714
+ #<strong>updated_at</strong> &#x21d2; <tt>Object</tt>
715
+
716
+
717
+
718
+
719
+
720
+ </h3><div class="docstring">
721
+ <div class="discussion">
722
+
723
+ <p>Returns the value of attribute updated_at</p>
724
+
725
+
726
+ </div>
727
+ </div>
728
+ <div class="tags">
729
+
730
+
731
+ </div><table class="source_code">
732
+ <tr>
733
+ <td>
734
+ <pre class="lines">
735
+
736
+
737
+ 11
738
+ 12
739
+ 13</pre>
740
+ </td>
741
+ <td>
742
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 11</span>
743
+
744
+ <span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
745
+ <span class='ivar'>@updated_at</span>
746
+ <span class='kw'>end</span></pre>
747
+ </td>
748
+ </tr>
749
+ </table>
750
+ </div>
751
+
752
+ </div>
753
+
754
+
755
+ <div id="class_method_details" class="method_details_list">
756
+ <h2>Class Method Details</h2>
757
+
758
+
759
+ <div class="method_details first">
760
+ <h3 class="signature first" id="all-class_method">
761
+
762
+ .<strong>all</strong>(bucket_id, parent_id, params = {}) &#x21d2; <tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::Document (class)">Basecamp3::Document</a></span>&gt;</tt>
763
+
764
+
765
+
766
+
767
+
768
+ </h3><div class="docstring">
769
+ <div class="discussion">
770
+
771
+ <p>Returns a paginated list of active documents.</p>
772
+
773
+
774
+ </div>
775
+ </div>
776
+ <div class="tags">
777
+ <p class="tag_title">Parameters:</p>
778
+ <ul class="param">
779
+
780
+ <li>
781
+
782
+ <span class='name'>bucket_id</span>
783
+
784
+
785
+ <span class='type'>(<tt>Integer</tt>)</span>
786
+
787
+
788
+
789
+ &mdash;
790
+ <div class='inline'>
791
+ <p>the id of the bucket</p>
792
+ </div>
793
+
794
+ </li>
795
+
796
+ <li>
797
+
798
+ <span class='name'>parent_id</span>
799
+
800
+
801
+ <span class='type'>(<tt>Integer</tt>)</span>
802
+
803
+
804
+
805
+ &mdash;
806
+ <div class='inline'>
807
+ <p>the id of the parent</p>
808
+ </div>
809
+
810
+ </li>
811
+
812
+ <li>
813
+
814
+ <span class='name'>params</span>
815
+
816
+
817
+ <span class='type'>(<tt>Hash</tt>)</span>
818
+
819
+
820
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
821
+
822
+
823
+ &mdash;
824
+ <div class='inline'>
825
+ <p>additional parameters</p>
826
+ </div>
827
+
828
+ </li>
829
+
830
+ </ul>
831
+
832
+
833
+
834
+
835
+
836
+
837
+
838
+
839
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
840
+ <ul class="option">
841
+
842
+ <li>
843
+ <span class="name">:page</span>
844
+ <span class="type">(<tt>Integer</tt>)</span>
845
+ <span class="default">
846
+
847
+ &mdash; default:
848
+ <tt>optional</tt>
849
+
850
+ </span>
851
+
852
+ &mdash; <div class='inline'>
853
+ <p>to paginate results</p>
854
+ </div>
855
+
856
+ </li>
857
+
858
+ </ul>
859
+
860
+
861
+ <p class="tag_title">Returns:</p>
862
+ <ul class="return">
863
+
864
+ <li>
865
+
866
+
867
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::Document (class)">Basecamp3::Document</a></span>&gt;</tt>)</span>
868
+
869
+
870
+
871
+ </li>
872
+
873
+ </ul>
874
+
875
+ </div><table class="source_code">
876
+ <tr>
877
+ <td>
878
+ <pre class="lines">
879
+
880
+
881
+ 28
882
+ 29
883
+ 30</pre>
884
+ </td>
885
+ <td>
886
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 28</span>
887
+
888
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_id'>parent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
889
+ <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Basecamp3::Request#get (method)">get</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_parent_id'>parent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/documents</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Document (class)">Document</a></span></span><span class='rparen'>)</span>
890
+ <span class='kw'>end</span></pre>
891
+ </td>
892
+ </tr>
893
+ </table>
894
+ </div>
895
+
896
+ <div class="method_details ">
897
+ <h3 class="signature " id="create-class_method">
898
+
899
+ .<strong>create</strong>(bucket_id, parent_id, data) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::Document (class)">Basecamp3::Document</a></span></tt>
900
+
901
+
902
+
903
+
904
+
905
+ </h3><div class="docstring">
906
+ <div class="discussion">
907
+
908
+ <p>Creates a document.</p>
909
+
910
+
911
+ </div>
912
+ </div>
913
+ <div class="tags">
914
+ <p class="tag_title">Parameters:</p>
915
+ <ul class="param">
916
+
917
+ <li>
918
+
919
+ <span class='name'>bucket_id</span>
920
+
921
+
922
+ <span class='type'>(<tt>Integer</tt>)</span>
923
+
924
+
925
+
926
+ &mdash;
927
+ <div class='inline'>
928
+ <p>the id of the bucket</p>
929
+ </div>
930
+
931
+ </li>
932
+
933
+ <li>
934
+
935
+ <span class='name'>parent_id</span>
936
+
937
+
938
+ <span class='type'>(<tt>Integer</tt>)</span>
939
+
940
+
941
+
942
+ &mdash;
943
+ <div class='inline'>
944
+ <p>the id of the parent</p>
945
+ </div>
946
+
947
+ </li>
948
+
949
+ <li>
950
+
951
+ <span class='name'>data</span>
952
+
953
+
954
+ <span class='type'>(<tt>Hash</tt>)</span>
955
+
956
+
957
+
958
+ &mdash;
959
+ <div class='inline'>
960
+ <p>the data to create a Document with</p>
961
+ </div>
962
+
963
+ </li>
964
+
965
+ <li>
966
+
967
+ <span class='name'>params</span>
968
+
969
+
970
+ <span class='type'>(<tt>Hash</tt>)</span>
971
+
972
+
973
+
974
+ &mdash;
975
+ <div class='inline'>
976
+ <p>a customizable set of options</p>
977
+ </div>
978
+
979
+ </li>
980
+
981
+ </ul>
982
+
983
+
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+ <p class="tag_title">Returns:</p>
992
+ <ul class="return">
993
+
994
+ <li>
995
+
996
+
997
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Document (class)">Basecamp3::Document</a></span></tt>)</span>
998
+
999
+
1000
+
1001
+ </li>
1002
+
1003
+ </ul>
1004
+
1005
+ </div><table class="source_code">
1006
+ <tr>
1007
+ <td>
1008
+ <pre class="lines">
1009
+
1010
+
1011
+ 52
1012
+ 53
1013
+ 54
1014
+ 55</pre>
1015
+ </td>
1016
+ <td>
1017
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 52</span>
1018
+
1019
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_id'>parent_id</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1020
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_validate_required'>validate_required</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1021
+ <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_post'><span class='object_link'><a href="Request.html#post-instance_method" title="Basecamp3::Request#post (method)">post</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vaults/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_parent_id'>parent_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/documents</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Document (class)">Document</a></span></span><span class='rparen'>)</span>
1022
+ <span class='kw'>end</span></pre>
1023
+ </td>
1024
+ </tr>
1025
+ </table>
1026
+ </div>
1027
+
1028
+ <div class="method_details ">
1029
+ <h3 class="signature " id="find-class_method">
1030
+
1031
+ .<strong>find</strong>(bucket_id, id) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::Document (class)">Basecamp3::Document</a></span></tt>
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+ </h3><div class="docstring">
1038
+ <div class="discussion">
1039
+
1040
+ <p>Returns the document.</p>
1041
+
1042
+
1043
+ </div>
1044
+ </div>
1045
+ <div class="tags">
1046
+ <p class="tag_title">Parameters:</p>
1047
+ <ul class="param">
1048
+
1049
+ <li>
1050
+
1051
+ <span class='name'>bucket_id</span>
1052
+
1053
+
1054
+ <span class='type'>(<tt>Integer</tt>)</span>
1055
+
1056
+
1057
+
1058
+ &mdash;
1059
+ <div class='inline'>
1060
+ <p>the id of the bucket</p>
1061
+ </div>
1062
+
1063
+ </li>
1064
+
1065
+ <li>
1066
+
1067
+ <span class='name'>id</span>
1068
+
1069
+
1070
+ <span class='type'>(<tt>Integer</tt>)</span>
1071
+
1072
+
1073
+
1074
+ &mdash;
1075
+ <div class='inline'>
1076
+ <p>the id of the document</p>
1077
+ </div>
1078
+
1079
+ </li>
1080
+
1081
+ </ul>
1082
+
1083
+ <p class="tag_title">Returns:</p>
1084
+ <ul class="return">
1085
+
1086
+ <li>
1087
+
1088
+
1089
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Document (class)">Basecamp3::Document</a></span></tt>)</span>
1090
+
1091
+
1092
+
1093
+ </li>
1094
+
1095
+ </ul>
1096
+
1097
+ </div><table class="source_code">
1098
+ <tr>
1099
+ <td>
1100
+ <pre class="lines">
1101
+
1102
+
1103
+ 38
1104
+ 39
1105
+ 40</pre>
1106
+ </td>
1107
+ <td>
1108
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 38</span>
1109
+
1110
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
1111
+ <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Request.html#get-instance_method" title="Basecamp3::Request#get (method)">get</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/documents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Document (class)">Document</a></span></span><span class='rparen'>)</span>
1112
+ <span class='kw'>end</span></pre>
1113
+ </td>
1114
+ </tr>
1115
+ </table>
1116
+ </div>
1117
+
1118
+ <div class="method_details ">
1119
+ <h3 class="signature " id="update-class_method">
1120
+
1121
+ .<strong>update</strong>(bucket_id, id, data) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::Document (class)">Basecamp3::Document</a></span></tt>
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+ </h3><div class="docstring">
1128
+ <div class="discussion">
1129
+
1130
+ <p>Updates the document.</p>
1131
+
1132
+
1133
+ </div>
1134
+ </div>
1135
+ <div class="tags">
1136
+ <p class="tag_title">Parameters:</p>
1137
+ <ul class="param">
1138
+
1139
+ <li>
1140
+
1141
+ <span class='name'>bucket_id</span>
1142
+
1143
+
1144
+ <span class='type'>(<tt>Integer</tt>)</span>
1145
+
1146
+
1147
+
1148
+ &mdash;
1149
+ <div class='inline'>
1150
+ <p>the id of the bucket</p>
1151
+ </div>
1152
+
1153
+ </li>
1154
+
1155
+ <li>
1156
+
1157
+ <span class='name'>id</span>
1158
+
1159
+
1160
+ <span class='type'>(<tt>Integer</tt>)</span>
1161
+
1162
+
1163
+
1164
+ &mdash;
1165
+ <div class='inline'>
1166
+ <p>the id of the document</p>
1167
+ </div>
1168
+
1169
+ </li>
1170
+
1171
+ <li>
1172
+
1173
+ <span class='name'>data</span>
1174
+
1175
+
1176
+ <span class='type'>(<tt>Hash</tt>)</span>
1177
+
1178
+
1179
+
1180
+ &mdash;
1181
+ <div class='inline'>
1182
+ <p>the data to update the document with</p>
1183
+ </div>
1184
+
1185
+ </li>
1186
+
1187
+ <li>
1188
+
1189
+ <span class='name'>params</span>
1190
+
1191
+
1192
+ <span class='type'>(<tt>Hash</tt>)</span>
1193
+
1194
+
1195
+
1196
+ &mdash;
1197
+ <div class='inline'>
1198
+ <p>a customizable set of options</p>
1199
+ </div>
1200
+
1201
+ </li>
1202
+
1203
+ </ul>
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+ <p class="tag_title">Returns:</p>
1214
+ <ul class="return">
1215
+
1216
+ <li>
1217
+
1218
+
1219
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Document (class)">Basecamp3::Document</a></span></tt>)</span>
1220
+
1221
+
1222
+
1223
+ </li>
1224
+
1225
+ </ul>
1226
+
1227
+ </div><table class="source_code">
1228
+ <tr>
1229
+ <td>
1230
+ <pre class="lines">
1231
+
1232
+
1233
+ 67
1234
+ 68
1235
+ 69
1236
+ 70</pre>
1237
+ </td>
1238
+ <td>
1239
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/document.rb', line 67</span>
1240
+
1241
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1242
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_validate_required'>validate_required</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1243
+ <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_request'><span class='object_link'><a href="../Basecamp3.html#request-class_method" title="Basecamp3.request (method)">request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_put'><span class='object_link'><a href="Request.html#put-instance_method" title="Basecamp3::Request#put (method)">put</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/buckets/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_bucket_id'>bucket_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/documents/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="Basecamp3::Document (class)">Document</a></span></span><span class='rparen'>)</span>
1244
+ <span class='kw'>end</span></pre>
1245
+ </td>
1246
+ </tr>
1247
+ </table>
1248
+ </div>
1249
+
1250
+ </div>
1251
+
1252
+ </div>
1253
+
1254
+ <div id="footer">
1255
+ Generated on Tue May 9 15:32:18 2017 by
1256
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1257
+ 0.9.9 (ruby-2.2.2).
1258
+ </div>
1259
+
1260
+ </div>
1261
+ </body>
1262
+ </html>