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