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/Forward.html ADDED
@@ -0,0 +1,1070 @@
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::Forward
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::Forward";
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 (F)</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">Forward</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::Forward
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::Forward</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/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/forward.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 Forward</p>
113
+
114
+ <p><a href="https://github.com/basecamp/bc3-api/blob/master/sections/forwards.md#forwards" target="_parent" title="For more information, see the official Basecamp3 API documentation for Forwards">For more information, see the official Basecamp3 API documentation for Forwards</a></p>
115
+
116
+
117
+ </div>
118
+ </div>
119
+ <div class="tags">
120
+
121
+
122
+ </div>
123
+
124
+
125
+ <h2>Constant Summary</h2>
126
+
127
+ <h3 class="inherited">Constants inherited
128
+ from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
129
+ <p class="inherited"><span class='object_link'><a href="Model.html#REQUIRED_FIELDS-constant" title="Basecamp3::Model::REQUIRED_FIELDS (constant)">Model::REQUIRED_FIELDS</a></span></p>
130
+
131
+
132
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
133
+ <ul class="summary">
134
+
135
+ <li class="public ">
136
+ <span class="summary_signature">
137
+
138
+ <a href="#content-instance_method" title="#content (instance method)">#<strong>content</strong> &#x21d2; Object </a>
139
+
140
+
141
+
142
+ </span>
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+ <span class="summary_desc"><div class='inline'>
156
+ <p>Returns the value of attribute content.</p>
157
+ </div></span>
158
+
159
+ </li>
160
+
161
+
162
+ <li class="public ">
163
+ <span class="summary_signature">
164
+
165
+ <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; Object </a>
166
+
167
+
168
+
169
+ </span>
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'>
183
+ <p>Returns the value of attribute created_at.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#from-instance_method" title="#from (instance method)">#<strong>from</strong> &#x21d2; Object </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+ <span class="summary_desc"><div class='inline'>
210
+ <p>Returns the value of attribute from.</p>
211
+ </div></span>
212
+
213
+ </li>
214
+
215
+
216
+ <li class="public ">
217
+ <span class="summary_signature">
218
+
219
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
220
+
221
+
222
+
223
+ </span>
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+ <span class="summary_desc"><div class='inline'>
237
+ <p>Returns the value of attribute id.</p>
238
+ </div></span>
239
+
240
+ </li>
241
+
242
+
243
+ <li class="public ">
244
+ <span class="summary_signature">
245
+
246
+ <a href="#replies_count-instance_method" title="#replies_count (instance method)">#<strong>replies_count</strong> &#x21d2; Object </a>
247
+
248
+
249
+
250
+ </span>
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+ <span class="summary_desc"><div class='inline'>
264
+ <p>Returns the value of attribute replies_count.</p>
265
+ </div></span>
266
+
267
+ </li>
268
+
269
+
270
+ <li class="public ">
271
+ <span class="summary_signature">
272
+
273
+ <a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong> &#x21d2; Object </a>
274
+
275
+
276
+
277
+ </span>
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+ <span class="summary_desc"><div class='inline'>
291
+ <p>Returns the value of attribute status.</p>
292
+ </div></span>
293
+
294
+ </li>
295
+
296
+
297
+ <li class="public ">
298
+ <span class="summary_signature">
299
+
300
+ <a href="#subject-instance_method" title="#subject (instance method)">#<strong>subject</strong> &#x21d2; Object </a>
301
+
302
+
303
+
304
+ </span>
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+ <span class="summary_desc"><div class='inline'>
318
+ <p>Returns the value of attribute subject.</p>
319
+ </div></span>
320
+
321
+ </li>
322
+
323
+
324
+ <li class="public ">
325
+ <span class="summary_signature">
326
+
327
+ <a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</strong> &#x21d2; Object </a>
328
+
329
+
330
+
331
+ </span>
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+ <span class="summary_desc"><div class='inline'>
345
+ <p>Returns the value of attribute updated_at.</p>
346
+ </div></span>
347
+
348
+ </li>
349
+
350
+
351
+ </ul>
352
+
353
+
354
+
355
+
356
+
357
+ <h2>
358
+ Class Method Summary
359
+ <small><a href="#" class="summary_toggle">collapse</a></small>
360
+ </h2>
361
+
362
+ <ul class="summary">
363
+
364
+ <li class="public ">
365
+ <span class="summary_signature">
366
+
367
+ <a href="#all-class_method" title="all (class method)">.<strong>all</strong>(bucket_id, parent_id, params = {}) &#x21d2; Array&lt;Basecamp3::Forward&gt; </a>
368
+
369
+
370
+
371
+ </span>
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+ <span class="summary_desc"><div class='inline'>
382
+ <p>Returns a paginated list of active forwards.</p>
383
+ </div></span>
384
+
385
+ </li>
386
+
387
+
388
+ <li class="public ">
389
+ <span class="summary_signature">
390
+
391
+ <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(bucket_id, id) &#x21d2; Basecamp3::Forward </a>
392
+
393
+
394
+
395
+ </span>
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+ <span class="summary_desc"><div class='inline'>
406
+ <p>Returns the forward.</p>
407
+ </div></span>
408
+
409
+ </li>
410
+
411
+
412
+ </ul>
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+ <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>
425
+ <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>
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+ <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>
436
+ <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>
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+ <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>
447
+ <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>
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+ <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>
458
+ <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>
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
469
+ <p class="inherited"><span class='object_link'><a href="Model.html#initialize-instance_method" title="Basecamp3::Model#initialize (method)">#initialize</a></span></p>
470
+ <div id="constructor_details" class="method_details_list">
471
+ <h2>Constructor Details</h2>
472
+
473
+ <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>
474
+
475
+ </div>
476
+
477
+ <div id="instance_attr_details" class="attr_details">
478
+ <h2>Instance Attribute Details</h2>
479
+
480
+
481
+ <span id="content=-instance_method"></span>
482
+ <div class="method_details first">
483
+ <h3 class="signature first" id="content-instance_method">
484
+
485
+ #<strong>content</strong> &#x21d2; <tt>Object</tt>
486
+
487
+
488
+
489
+
490
+
491
+ </h3><div class="docstring">
492
+ <div class="discussion">
493
+
494
+ <p>Returns the value of attribute content</p>
495
+
496
+
497
+ </div>
498
+ </div>
499
+ <div class="tags">
500
+
501
+
502
+ </div><table class="source_code">
503
+ <tr>
504
+ <td>
505
+ <pre class="lines">
506
+
507
+
508
+ 10
509
+ 11
510
+ 12</pre>
511
+ </td>
512
+ <td>
513
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 10</span>
514
+
515
+ <span class='kw'>def</span> <span class='id identifier rubyid_content'>content</span>
516
+ <span class='ivar'>@content</span>
517
+ <span class='kw'>end</span></pre>
518
+ </td>
519
+ </tr>
520
+ </table>
521
+ </div>
522
+
523
+
524
+ <span id="created_at=-instance_method"></span>
525
+ <div class="method_details ">
526
+ <h3 class="signature " id="created_at-instance_method">
527
+
528
+ #<strong>created_at</strong> &#x21d2; <tt>Object</tt>
529
+
530
+
531
+
532
+
533
+
534
+ </h3><div class="docstring">
535
+ <div class="discussion">
536
+
537
+ <p>Returns the value of attribute created_at</p>
538
+
539
+
540
+ </div>
541
+ </div>
542
+ <div class="tags">
543
+
544
+
545
+ </div><table class="source_code">
546
+ <tr>
547
+ <td>
548
+ <pre class="lines">
549
+
550
+
551
+ 10
552
+ 11
553
+ 12</pre>
554
+ </td>
555
+ <td>
556
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 10</span>
557
+
558
+ <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
559
+ <span class='ivar'>@created_at</span>
560
+ <span class='kw'>end</span></pre>
561
+ </td>
562
+ </tr>
563
+ </table>
564
+ </div>
565
+
566
+
567
+ <span id="from=-instance_method"></span>
568
+ <div class="method_details ">
569
+ <h3 class="signature " id="from-instance_method">
570
+
571
+ #<strong>from</strong> &#x21d2; <tt>Object</tt>
572
+
573
+
574
+
575
+
576
+
577
+ </h3><div class="docstring">
578
+ <div class="discussion">
579
+
580
+ <p>Returns the value of attribute from</p>
581
+
582
+
583
+ </div>
584
+ </div>
585
+ <div class="tags">
586
+
587
+
588
+ </div><table class="source_code">
589
+ <tr>
590
+ <td>
591
+ <pre class="lines">
592
+
593
+
594
+ 10
595
+ 11
596
+ 12</pre>
597
+ </td>
598
+ <td>
599
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 10</span>
600
+
601
+ <span class='kw'>def</span> <span class='id identifier rubyid_from'>from</span>
602
+ <span class='ivar'>@from</span>
603
+ <span class='kw'>end</span></pre>
604
+ </td>
605
+ </tr>
606
+ </table>
607
+ </div>
608
+
609
+
610
+ <span id="id=-instance_method"></span>
611
+ <div class="method_details ">
612
+ <h3 class="signature " id="id-instance_method">
613
+
614
+ #<strong>id</strong> &#x21d2; <tt>Object</tt>
615
+
616
+
617
+
618
+
619
+
620
+ </h3><div class="docstring">
621
+ <div class="discussion">
622
+
623
+ <p>Returns the value of attribute id</p>
624
+
625
+
626
+ </div>
627
+ </div>
628
+ <div class="tags">
629
+
630
+
631
+ </div><table class="source_code">
632
+ <tr>
633
+ <td>
634
+ <pre class="lines">
635
+
636
+
637
+ 10
638
+ 11
639
+ 12</pre>
640
+ </td>
641
+ <td>
642
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 10</span>
643
+
644
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
645
+ <span class='ivar'>@id</span>
646
+ <span class='kw'>end</span></pre>
647
+ </td>
648
+ </tr>
649
+ </table>
650
+ </div>
651
+
652
+
653
+ <span id="replies_count=-instance_method"></span>
654
+ <div class="method_details ">
655
+ <h3 class="signature " id="replies_count-instance_method">
656
+
657
+ #<strong>replies_count</strong> &#x21d2; <tt>Object</tt>
658
+
659
+
660
+
661
+
662
+
663
+ </h3><div class="docstring">
664
+ <div class="discussion">
665
+
666
+ <p>Returns the value of attribute replies_count</p>
667
+
668
+
669
+ </div>
670
+ </div>
671
+ <div class="tags">
672
+
673
+
674
+ </div><table class="source_code">
675
+ <tr>
676
+ <td>
677
+ <pre class="lines">
678
+
679
+
680
+ 10
681
+ 11
682
+ 12</pre>
683
+ </td>
684
+ <td>
685
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 10</span>
686
+
687
+ <span class='kw'>def</span> <span class='id identifier rubyid_replies_count'>replies_count</span>
688
+ <span class='ivar'>@replies_count</span>
689
+ <span class='kw'>end</span></pre>
690
+ </td>
691
+ </tr>
692
+ </table>
693
+ </div>
694
+
695
+
696
+ <span id="status=-instance_method"></span>
697
+ <div class="method_details ">
698
+ <h3 class="signature " id="status-instance_method">
699
+
700
+ #<strong>status</strong> &#x21d2; <tt>Object</tt>
701
+
702
+
703
+
704
+
705
+
706
+ </h3><div class="docstring">
707
+ <div class="discussion">
708
+
709
+ <p>Returns the value of attribute status</p>
710
+
711
+
712
+ </div>
713
+ </div>
714
+ <div class="tags">
715
+
716
+
717
+ </div><table class="source_code">
718
+ <tr>
719
+ <td>
720
+ <pre class="lines">
721
+
722
+
723
+ 10
724
+ 11
725
+ 12</pre>
726
+ </td>
727
+ <td>
728
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 10</span>
729
+
730
+ <span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
731
+ <span class='ivar'>@status</span>
732
+ <span class='kw'>end</span></pre>
733
+ </td>
734
+ </tr>
735
+ </table>
736
+ </div>
737
+
738
+
739
+ <span id="subject=-instance_method"></span>
740
+ <div class="method_details ">
741
+ <h3 class="signature " id="subject-instance_method">
742
+
743
+ #<strong>subject</strong> &#x21d2; <tt>Object</tt>
744
+
745
+
746
+
747
+
748
+
749
+ </h3><div class="docstring">
750
+ <div class="discussion">
751
+
752
+ <p>Returns the value of attribute subject</p>
753
+
754
+
755
+ </div>
756
+ </div>
757
+ <div class="tags">
758
+
759
+
760
+ </div><table class="source_code">
761
+ <tr>
762
+ <td>
763
+ <pre class="lines">
764
+
765
+
766
+ 10
767
+ 11
768
+ 12</pre>
769
+ </td>
770
+ <td>
771
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 10</span>
772
+
773
+ <span class='kw'>def</span> <span class='id identifier rubyid_subject'>subject</span>
774
+ <span class='ivar'>@subject</span>
775
+ <span class='kw'>end</span></pre>
776
+ </td>
777
+ </tr>
778
+ </table>
779
+ </div>
780
+
781
+
782
+ <span id="updated_at=-instance_method"></span>
783
+ <div class="method_details ">
784
+ <h3 class="signature " id="updated_at-instance_method">
785
+
786
+ #<strong>updated_at</strong> &#x21d2; <tt>Object</tt>
787
+
788
+
789
+
790
+
791
+
792
+ </h3><div class="docstring">
793
+ <div class="discussion">
794
+
795
+ <p>Returns the value of attribute updated_at</p>
796
+
797
+
798
+ </div>
799
+ </div>
800
+ <div class="tags">
801
+
802
+
803
+ </div><table class="source_code">
804
+ <tr>
805
+ <td>
806
+ <pre class="lines">
807
+
808
+
809
+ 10
810
+ 11
811
+ 12</pre>
812
+ </td>
813
+ <td>
814
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 10</span>
815
+
816
+ <span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
817
+ <span class='ivar'>@updated_at</span>
818
+ <span class='kw'>end</span></pre>
819
+ </td>
820
+ </tr>
821
+ </table>
822
+ </div>
823
+
824
+ </div>
825
+
826
+
827
+ <div id="class_method_details" class="method_details_list">
828
+ <h2>Class Method Details</h2>
829
+
830
+
831
+ <div class="method_details first">
832
+ <h3 class="signature first" id="all-class_method">
833
+
834
+ .<strong>all</strong>(bucket_id, parent_id, params = {}) &#x21d2; <tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::Forward (class)">Basecamp3::Forward</a></span>&gt;</tt>
835
+
836
+
837
+
838
+
839
+
840
+ </h3><div class="docstring">
841
+ <div class="discussion">
842
+
843
+ <p>Returns a paginated list of active forwards.</p>
844
+
845
+
846
+ </div>
847
+ </div>
848
+ <div class="tags">
849
+ <p class="tag_title">Parameters:</p>
850
+ <ul class="param">
851
+
852
+ <li>
853
+
854
+ <span class='name'>bucket_id</span>
855
+
856
+
857
+ <span class='type'>(<tt>Integer</tt>)</span>
858
+
859
+
860
+
861
+ &mdash;
862
+ <div class='inline'>
863
+ <p>the id of the bucket</p>
864
+ </div>
865
+
866
+ </li>
867
+
868
+ <li>
869
+
870
+ <span class='name'>parent_id</span>
871
+
872
+
873
+ <span class='type'>(<tt>Integer</tt>)</span>
874
+
875
+
876
+
877
+ &mdash;
878
+ <div class='inline'>
879
+ <p>the id of the inbox</p>
880
+ </div>
881
+
882
+ </li>
883
+
884
+ <li>
885
+
886
+ <span class='name'>params</span>
887
+
888
+
889
+ <span class='type'>(<tt>Hash</tt>)</span>
890
+
891
+
892
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
893
+
894
+
895
+ &mdash;
896
+ <div class='inline'>
897
+ <p>additional parameters</p>
898
+ </div>
899
+
900
+ </li>
901
+
902
+ </ul>
903
+
904
+
905
+
906
+
907
+
908
+
909
+
910
+
911
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
912
+ <ul class="option">
913
+
914
+ <li>
915
+ <span class="name">:page</span>
916
+ <span class="type">(<tt>Integer</tt>)</span>
917
+ <span class="default">
918
+
919
+ &mdash; default:
920
+ <tt>optional</tt>
921
+
922
+ </span>
923
+
924
+ &mdash; <div class='inline'>
925
+ <p>to paginate results</p>
926
+ </div>
927
+
928
+ </li>
929
+
930
+ </ul>
931
+
932
+
933
+ <p class="tag_title">Returns:</p>
934
+ <ul class="return">
935
+
936
+ <li>
937
+
938
+
939
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::Forward (class)">Basecamp3::Forward</a></span>&gt;</tt>)</span>
940
+
941
+
942
+
943
+ </li>
944
+
945
+ </ul>
946
+
947
+ </div><table class="source_code">
948
+ <tr>
949
+ <td>
950
+ <pre class="lines">
951
+
952
+
953
+ 27
954
+ 28
955
+ 29</pre>
956
+ </td>
957
+ <td>
958
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 27</span>
959
+
960
+ <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>
961
+ <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'>/inboxes/</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'>/forwards</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::Forward (class)">Forward</a></span></span><span class='rparen'>)</span>
962
+ <span class='kw'>end</span></pre>
963
+ </td>
964
+ </tr>
965
+ </table>
966
+ </div>
967
+
968
+ <div class="method_details ">
969
+ <h3 class="signature " id="find-class_method">
970
+
971
+ .<strong>find</strong>(bucket_id, id) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::Forward (class)">Basecamp3::Forward</a></span></tt>
972
+
973
+
974
+
975
+
976
+
977
+ </h3><div class="docstring">
978
+ <div class="discussion">
979
+
980
+ <p>Returns the forward.</p>
981
+
982
+
983
+ </div>
984
+ </div>
985
+ <div class="tags">
986
+ <p class="tag_title">Parameters:</p>
987
+ <ul class="param">
988
+
989
+ <li>
990
+
991
+ <span class='name'>bucket_id</span>
992
+
993
+
994
+ <span class='type'>(<tt>Integer</tt>)</span>
995
+
996
+
997
+
998
+ &mdash;
999
+ <div class='inline'>
1000
+ <p>the id of the bucket</p>
1001
+ </div>
1002
+
1003
+ </li>
1004
+
1005
+ <li>
1006
+
1007
+ <span class='name'>id</span>
1008
+
1009
+
1010
+ <span class='type'>(<tt>Integer</tt>)</span>
1011
+
1012
+
1013
+
1014
+ &mdash;
1015
+ <div class='inline'>
1016
+ <p>the id of the forward</p>
1017
+ </div>
1018
+
1019
+ </li>
1020
+
1021
+ </ul>
1022
+
1023
+ <p class="tag_title">Returns:</p>
1024
+ <ul class="return">
1025
+
1026
+ <li>
1027
+
1028
+
1029
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::Forward (class)">Basecamp3::Forward</a></span></tt>)</span>
1030
+
1031
+
1032
+
1033
+ </li>
1034
+
1035
+ </ul>
1036
+
1037
+ </div><table class="source_code">
1038
+ <tr>
1039
+ <td>
1040
+ <pre class="lines">
1041
+
1042
+
1043
+ 37
1044
+ 38
1045
+ 39</pre>
1046
+ </td>
1047
+ <td>
1048
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/forward.rb', line 37</span>
1049
+
1050
+ <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>
1051
+ <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'>/inbox_forwards/</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::Forward (class)">Forward</a></span></span><span class='rparen'>)</span>
1052
+ <span class='kw'>end</span></pre>
1053
+ </td>
1054
+ </tr>
1055
+ </table>
1056
+ </div>
1057
+
1058
+ </div>
1059
+
1060
+ </div>
1061
+
1062
+ <div id="footer">
1063
+ Generated on Tue May 9 15:32:17 2017 by
1064
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1065
+ 0.9.9 (ruby-2.2.2).
1066
+ </div>
1067
+
1068
+ </div>
1069
+ </body>
1070
+ </html>