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/MessageType.html ADDED
@@ -0,0 +1,1160 @@
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::MessageType
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::MessageType";
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 (M)</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">MessageType</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::MessageType
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::MessageType</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/message_type.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 Message Board</p>
108
+
109
+ <p><a href="https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#get-message-types" target="_parent" title="For more information, see the official Basecamp3 API documentation for Message types">For more information, see the official Basecamp3 API documentation for Message types</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><span class='tstring_content'>icon</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="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</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 created_at.</p>
156
+ </div></span>
157
+
158
+ </li>
159
+
160
+
161
+ <li class="public ">
162
+ <span class="summary_signature">
163
+
164
+ <a href="#icon-instance_method" title="#icon (instance method)">#<strong>icon</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 icon.</p>
183
+ </div></span>
184
+
185
+ </li>
186
+
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</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 id.</p>
210
+ </div></span>
211
+
212
+ </li>
213
+
214
+
215
+ <li class="public ">
216
+ <span class="summary_signature">
217
+
218
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</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 name.</p>
237
+ </div></span>
238
+
239
+ </li>
240
+
241
+
242
+ <li class="public ">
243
+ <span class="summary_signature">
244
+
245
+ <a href="#updated_at-instance_method" title="#updated_at (instance method)">#<strong>updated_at</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 updated_at.</p>
264
+ </div></span>
265
+
266
+ </li>
267
+
268
+
269
+ </ul>
270
+
271
+
272
+
273
+
274
+
275
+ <h2>
276
+ Class Method Summary
277
+ <small><a href="#" class="summary_toggle">collapse</a></small>
278
+ </h2>
279
+
280
+ <ul class="summary">
281
+
282
+ <li class="public ">
283
+ <span class="summary_signature">
284
+
285
+ <a href="#all-class_method" title="all (class method)">.<strong>all</strong>(bucket_id) &#x21d2; Array&lt;Basecamp3::MessageType&gt; </a>
286
+
287
+
288
+
289
+ </span>
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+ <span class="summary_desc"><div class='inline'>
300
+ <p>Returns a list of all the message types.</p>
301
+ </div></span>
302
+
303
+ </li>
304
+
305
+
306
+ <li class="public ">
307
+ <span class="summary_signature">
308
+
309
+ <a href="#create-class_method" title="create (class method)">.<strong>create</strong>(bucket_id, data) &#x21d2; Basecamp3::MessageType </a>
310
+
311
+
312
+
313
+ </span>
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+ <span class="summary_desc"><div class='inline'>
324
+ <p>Creates a message type.</p>
325
+ </div></span>
326
+
327
+ </li>
328
+
329
+
330
+ <li class="public ">
331
+ <span class="summary_signature">
332
+
333
+ <a href="#delete-class_method" title="delete (class method)">.<strong>delete</strong>(bucket_id, id) &#x21d2; Boolean </a>
334
+
335
+
336
+
337
+ </span>
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+ <span class="summary_desc"><div class='inline'>
348
+ <p>Deletes the message type.</p>
349
+ </div></span>
350
+
351
+ </li>
352
+
353
+
354
+ <li class="public ">
355
+ <span class="summary_signature">
356
+
357
+ <a href="#find-class_method" title="find (class method)">.<strong>find</strong>(bucket_id, id) &#x21d2; Basecamp3::MessageType </a>
358
+
359
+
360
+
361
+ </span>
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+
371
+ <span class="summary_desc"><div class='inline'>
372
+ <p>Returns the message type.</p>
373
+ </div></span>
374
+
375
+ </li>
376
+
377
+
378
+ <li class="public ">
379
+ <span class="summary_signature">
380
+
381
+ <a href="#update-class_method" title="update (class method)">.<strong>update</strong>(bucket_id, id, data) &#x21d2; Basecamp3::MessageType </a>
382
+
383
+
384
+
385
+ </span>
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+ <span class="summary_desc"><div class='inline'>
396
+ <p>Updates a message type.</p>
397
+ </div></span>
398
+
399
+ </li>
400
+
401
+
402
+ </ul>
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Model.html" title="Basecamp3::Model (class)">Model</a></span></h3>
415
+ <p class="inherited"><span class='object_link'><a href="Model.html#initialize-instance_method" title="Basecamp3::Model#initialize (method)">#initialize</a></span></p>
416
+ <div id="constructor_details" class="method_details_list">
417
+ <h2>Constructor Details</h2>
418
+
419
+ <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>
420
+
421
+ </div>
422
+
423
+ <div id="instance_attr_details" class="attr_details">
424
+ <h2>Instance Attribute Details</h2>
425
+
426
+
427
+ <span id="created_at=-instance_method"></span>
428
+ <div class="method_details first">
429
+ <h3 class="signature first" id="created_at-instance_method">
430
+
431
+ #<strong>created_at</strong> &#x21d2; <tt>Object</tt>
432
+
433
+
434
+
435
+
436
+
437
+ </h3><div class="docstring">
438
+ <div class="discussion">
439
+
440
+ <p>Returns the value of attribute created_at</p>
441
+
442
+
443
+ </div>
444
+ </div>
445
+ <div class="tags">
446
+
447
+
448
+ </div><table class="source_code">
449
+ <tr>
450
+ <td>
451
+ <pre class="lines">
452
+
453
+
454
+ 5
455
+ 6
456
+ 7</pre>
457
+ </td>
458
+ <td>
459
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 5</span>
460
+
461
+ <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
462
+ <span class='ivar'>@created_at</span>
463
+ <span class='kw'>end</span></pre>
464
+ </td>
465
+ </tr>
466
+ </table>
467
+ </div>
468
+
469
+
470
+ <span id="icon=-instance_method"></span>
471
+ <div class="method_details ">
472
+ <h3 class="signature " id="icon-instance_method">
473
+
474
+ #<strong>icon</strong> &#x21d2; <tt>Object</tt>
475
+
476
+
477
+
478
+
479
+
480
+ </h3><div class="docstring">
481
+ <div class="discussion">
482
+
483
+ <p>Returns the value of attribute icon</p>
484
+
485
+
486
+ </div>
487
+ </div>
488
+ <div class="tags">
489
+
490
+
491
+ </div><table class="source_code">
492
+ <tr>
493
+ <td>
494
+ <pre class="lines">
495
+
496
+
497
+ 5
498
+ 6
499
+ 7</pre>
500
+ </td>
501
+ <td>
502
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 5</span>
503
+
504
+ <span class='kw'>def</span> <span class='id identifier rubyid_icon'>icon</span>
505
+ <span class='ivar'>@icon</span>
506
+ <span class='kw'>end</span></pre>
507
+ </td>
508
+ </tr>
509
+ </table>
510
+ </div>
511
+
512
+
513
+ <span id="id=-instance_method"></span>
514
+ <div class="method_details ">
515
+ <h3 class="signature " id="id-instance_method">
516
+
517
+ #<strong>id</strong> &#x21d2; <tt>Object</tt>
518
+
519
+
520
+
521
+
522
+
523
+ </h3><div class="docstring">
524
+ <div class="discussion">
525
+
526
+ <p>Returns the value of attribute id</p>
527
+
528
+
529
+ </div>
530
+ </div>
531
+ <div class="tags">
532
+
533
+
534
+ </div><table class="source_code">
535
+ <tr>
536
+ <td>
537
+ <pre class="lines">
538
+
539
+
540
+ 5
541
+ 6
542
+ 7</pre>
543
+ </td>
544
+ <td>
545
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 5</span>
546
+
547
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
548
+ <span class='ivar'>@id</span>
549
+ <span class='kw'>end</span></pre>
550
+ </td>
551
+ </tr>
552
+ </table>
553
+ </div>
554
+
555
+
556
+ <span id="name=-instance_method"></span>
557
+ <div class="method_details ">
558
+ <h3 class="signature " id="name-instance_method">
559
+
560
+ #<strong>name</strong> &#x21d2; <tt>Object</tt>
561
+
562
+
563
+
564
+
565
+
566
+ </h3><div class="docstring">
567
+ <div class="discussion">
568
+
569
+ <p>Returns the value of attribute name</p>
570
+
571
+
572
+ </div>
573
+ </div>
574
+ <div class="tags">
575
+
576
+
577
+ </div><table class="source_code">
578
+ <tr>
579
+ <td>
580
+ <pre class="lines">
581
+
582
+
583
+ 5
584
+ 6
585
+ 7</pre>
586
+ </td>
587
+ <td>
588
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 5</span>
589
+
590
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
591
+ <span class='ivar'>@name</span>
592
+ <span class='kw'>end</span></pre>
593
+ </td>
594
+ </tr>
595
+ </table>
596
+ </div>
597
+
598
+
599
+ <span id="updated_at=-instance_method"></span>
600
+ <div class="method_details ">
601
+ <h3 class="signature " id="updated_at-instance_method">
602
+
603
+ #<strong>updated_at</strong> &#x21d2; <tt>Object</tt>
604
+
605
+
606
+
607
+
608
+
609
+ </h3><div class="docstring">
610
+ <div class="discussion">
611
+
612
+ <p>Returns the value of attribute updated_at</p>
613
+
614
+
615
+ </div>
616
+ </div>
617
+ <div class="tags">
618
+
619
+
620
+ </div><table class="source_code">
621
+ <tr>
622
+ <td>
623
+ <pre class="lines">
624
+
625
+
626
+ 5
627
+ 6
628
+ 7</pre>
629
+ </td>
630
+ <td>
631
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 5</span>
632
+
633
+ <span class='kw'>def</span> <span class='id identifier rubyid_updated_at'>updated_at</span>
634
+ <span class='ivar'>@updated_at</span>
635
+ <span class='kw'>end</span></pre>
636
+ </td>
637
+ </tr>
638
+ </table>
639
+ </div>
640
+
641
+ </div>
642
+
643
+
644
+ <div id="class_method_details" class="method_details_list">
645
+ <h2>Class Method Details</h2>
646
+
647
+
648
+ <div class="method_details first">
649
+ <h3 class="signature first" id="all-class_method">
650
+
651
+ .<strong>all</strong>(bucket_id) &#x21d2; <tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::MessageType (class)">Basecamp3::MessageType</a></span>&gt;</tt>
652
+
653
+
654
+
655
+
656
+
657
+ </h3><div class="docstring">
658
+ <div class="discussion">
659
+
660
+ <p>Returns a list of all the message types.</p>
661
+
662
+
663
+ </div>
664
+ </div>
665
+ <div class="tags">
666
+ <p class="tag_title">Parameters:</p>
667
+ <ul class="param">
668
+
669
+ <li>
670
+
671
+ <span class='name'>bucket_id</span>
672
+
673
+
674
+ <span class='type'>(<tt>Integer</tt>)</span>
675
+
676
+
677
+
678
+ &mdash;
679
+ <div class='inline'>
680
+ <p>the id of the bucket</p>
681
+ </div>
682
+
683
+ </li>
684
+
685
+ </ul>
686
+
687
+ <p class="tag_title">Returns:</p>
688
+ <ul class="return">
689
+
690
+ <li>
691
+
692
+
693
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="Basecamp3::MessageType (class)">Basecamp3::MessageType</a></span>&gt;</tt>)</span>
694
+
695
+
696
+
697
+ </li>
698
+
699
+ </ul>
700
+
701
+ </div><table class="source_code">
702
+ <tr>
703
+ <td>
704
+ <pre class="lines">
705
+
706
+
707
+ 18
708
+ 19
709
+ 20</pre>
710
+ </td>
711
+ <td>
712
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 18</span>
713
+
714
+ <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='rparen'>)</span>
715
+ <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'>/categories</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::MessageType (class)">MessageType</a></span></span><span class='rparen'>)</span>
716
+ <span class='kw'>end</span></pre>
717
+ </td>
718
+ </tr>
719
+ </table>
720
+ </div>
721
+
722
+ <div class="method_details ">
723
+ <h3 class="signature " id="create-class_method">
724
+
725
+ .<strong>create</strong>(bucket_id, data) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::MessageType (class)">Basecamp3::MessageType</a></span></tt>
726
+
727
+
728
+
729
+
730
+
731
+ </h3><div class="docstring">
732
+ <div class="discussion">
733
+
734
+ <p>Creates a message type.</p>
735
+
736
+
737
+ </div>
738
+ </div>
739
+ <div class="tags">
740
+ <p class="tag_title">Parameters:</p>
741
+ <ul class="param">
742
+
743
+ <li>
744
+
745
+ <span class='name'>bucket_id</span>
746
+
747
+
748
+ <span class='type'>(<tt>Integer</tt>)</span>
749
+
750
+
751
+
752
+ &mdash;
753
+ <div class='inline'>
754
+ <p>the id of the bucket</p>
755
+ </div>
756
+
757
+ </li>
758
+
759
+ <li>
760
+
761
+ <span class='name'>data</span>
762
+
763
+
764
+ <span class='type'>(<tt>Hash</tt>)</span>
765
+
766
+
767
+
768
+ &mdash;
769
+ <div class='inline'>
770
+ <p>the data to create a message type with</p>
771
+ </div>
772
+
773
+ </li>
774
+
775
+ <li>
776
+
777
+ <span class='name'>params</span>
778
+
779
+
780
+ <span class='type'>(<tt>Hash</tt>)</span>
781
+
782
+
783
+
784
+ &mdash;
785
+ <div class='inline'>
786
+ <p>a customizable set of options</p>
787
+ </div>
788
+
789
+ </li>
790
+
791
+ </ul>
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+ <p class="tag_title">Returns:</p>
800
+ <ul class="return">
801
+
802
+ <li>
803
+
804
+
805
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::MessageType (class)">Basecamp3::MessageType</a></span></tt>)</span>
806
+
807
+
808
+
809
+ </li>
810
+
811
+ </ul>
812
+
813
+ </div><table class="source_code">
814
+ <tr>
815
+ <td>
816
+ <pre class="lines">
817
+
818
+
819
+ 40
820
+ 41
821
+ 42
822
+ 43</pre>
823
+ </td>
824
+ <td>
825
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 40</span>
826
+
827
+ <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_data'>data</span><span class='rparen'>)</span>
828
+ <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>
829
+ <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'>/categories</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::MessageType (class)">MessageType</a></span></span><span class='rparen'>)</span>
830
+ <span class='kw'>end</span></pre>
831
+ </td>
832
+ </tr>
833
+ </table>
834
+ </div>
835
+
836
+ <div class="method_details ">
837
+ <h3 class="signature " id="delete-class_method">
838
+
839
+ .<strong>delete</strong>(bucket_id, id) &#x21d2; <tt>Boolean</tt>
840
+
841
+
842
+
843
+
844
+
845
+ </h3><div class="docstring">
846
+ <div class="discussion">
847
+
848
+ <p>Deletes the message type.</p>
849
+
850
+
851
+ </div>
852
+ </div>
853
+ <div class="tags">
854
+ <p class="tag_title">Parameters:</p>
855
+ <ul class="param">
856
+
857
+ <li>
858
+
859
+ <span class='name'>bucket_id</span>
860
+
861
+
862
+ <span class='type'>(<tt>Integer</tt>)</span>
863
+
864
+
865
+
866
+ &mdash;
867
+ <div class='inline'>
868
+ <p>the id of the bucket</p>
869
+ </div>
870
+
871
+ </li>
872
+
873
+ <li>
874
+
875
+ <span class='name'>id</span>
876
+
877
+
878
+ <span class='type'>(<tt>Integer</tt>)</span>
879
+
880
+
881
+
882
+ &mdash;
883
+ <div class='inline'>
884
+ <p>the id of the message type</p>
885
+ </div>
886
+
887
+ </li>
888
+
889
+ </ul>
890
+
891
+ <p class="tag_title">Returns:</p>
892
+ <ul class="return">
893
+
894
+ <li>
895
+
896
+
897
+ <span class='type'>(<tt>Boolean</tt>)</span>
898
+
899
+
900
+
901
+ </li>
902
+
903
+ </ul>
904
+
905
+ </div><table class="source_code">
906
+ <tr>
907
+ <td>
908
+ <pre class="lines">
909
+
910
+
911
+ 65
912
+ 66
913
+ 67</pre>
914
+ </td>
915
+ <td>
916
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 65</span>
917
+
918
+ <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_bucket_id'>bucket_id</span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
919
+ <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'>/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'>/categories/</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>
920
+ <span class='kw'>end</span></pre>
921
+ </td>
922
+ </tr>
923
+ </table>
924
+ </div>
925
+
926
+ <div class="method_details ">
927
+ <h3 class="signature " id="find-class_method">
928
+
929
+ .<strong>find</strong>(bucket_id, id) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::MessageType (class)">Basecamp3::MessageType</a></span></tt>
930
+
931
+
932
+
933
+
934
+
935
+ </h3><div class="docstring">
936
+ <div class="discussion">
937
+
938
+ <p>Returns the message type.</p>
939
+
940
+
941
+ </div>
942
+ </div>
943
+ <div class="tags">
944
+ <p class="tag_title">Parameters:</p>
945
+ <ul class="param">
946
+
947
+ <li>
948
+
949
+ <span class='name'>bucket_id</span>
950
+
951
+
952
+ <span class='type'>(<tt>Integer</tt>)</span>
953
+
954
+
955
+
956
+ &mdash;
957
+ <div class='inline'>
958
+ <p>the id of the bucket</p>
959
+ </div>
960
+
961
+ </li>
962
+
963
+ <li>
964
+
965
+ <span class='name'>id</span>
966
+
967
+
968
+ <span class='type'>(<tt>Integer</tt>)</span>
969
+
970
+
971
+
972
+ &mdash;
973
+ <div class='inline'>
974
+ <p>the id of the message type</p>
975
+ </div>
976
+
977
+ </li>
978
+
979
+ </ul>
980
+
981
+ <p class="tag_title">Returns:</p>
982
+ <ul class="return">
983
+
984
+ <li>
985
+
986
+
987
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::MessageType (class)">Basecamp3::MessageType</a></span></tt>)</span>
988
+
989
+
990
+
991
+ </li>
992
+
993
+ </ul>
994
+
995
+ </div><table class="source_code">
996
+ <tr>
997
+ <td>
998
+ <pre class="lines">
999
+
1000
+
1001
+ 28
1002
+ 29
1003
+ 30</pre>
1004
+ </td>
1005
+ <td>
1006
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 28</span>
1007
+
1008
+ <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>
1009
+ <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'>/categories/</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::MessageType (class)">MessageType</a></span></span><span class='rparen'>)</span>
1010
+ <span class='kw'>end</span></pre>
1011
+ </td>
1012
+ </tr>
1013
+ </table>
1014
+ </div>
1015
+
1016
+ <div class="method_details ">
1017
+ <h3 class="signature " id="update-class_method">
1018
+
1019
+ .<strong>update</strong>(bucket_id, id, data) &#x21d2; <tt><span class='object_link'><a href="" title="Basecamp3::MessageType (class)">Basecamp3::MessageType</a></span></tt>
1020
+
1021
+
1022
+
1023
+
1024
+
1025
+ </h3><div class="docstring">
1026
+ <div class="discussion">
1027
+
1028
+ <p>Updates a message type.</p>
1029
+
1030
+
1031
+ </div>
1032
+ </div>
1033
+ <div class="tags">
1034
+ <p class="tag_title">Parameters:</p>
1035
+ <ul class="param">
1036
+
1037
+ <li>
1038
+
1039
+ <span class='name'>bucket_id</span>
1040
+
1041
+
1042
+ <span class='type'>(<tt>Integer</tt>)</span>
1043
+
1044
+
1045
+
1046
+ &mdash;
1047
+ <div class='inline'>
1048
+ <p>the id of the bucket</p>
1049
+ </div>
1050
+
1051
+ </li>
1052
+
1053
+ <li>
1054
+
1055
+ <span class='name'>id</span>
1056
+
1057
+
1058
+ <span class='type'>(<tt>Integer</tt>)</span>
1059
+
1060
+
1061
+
1062
+ &mdash;
1063
+ <div class='inline'>
1064
+ <p>the id of the message type</p>
1065
+ </div>
1066
+
1067
+ </li>
1068
+
1069
+ <li>
1070
+
1071
+ <span class='name'>data</span>
1072
+
1073
+
1074
+ <span class='type'>(<tt>Hash</tt>)</span>
1075
+
1076
+
1077
+
1078
+ &mdash;
1079
+ <div class='inline'>
1080
+ <p>the data to update the message type with</p>
1081
+ </div>
1082
+
1083
+ </li>
1084
+
1085
+ <li>
1086
+
1087
+ <span class='name'>params</span>
1088
+
1089
+
1090
+ <span class='type'>(<tt>Hash</tt>)</span>
1091
+
1092
+
1093
+
1094
+ &mdash;
1095
+ <div class='inline'>
1096
+ <p>a customizable set of options</p>
1097
+ </div>
1098
+
1099
+ </li>
1100
+
1101
+ </ul>
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+
1110
+
1111
+ <p class="tag_title">Returns:</p>
1112
+ <ul class="return">
1113
+
1114
+ <li>
1115
+
1116
+
1117
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Basecamp3::MessageType (class)">Basecamp3::MessageType</a></span></tt>)</span>
1118
+
1119
+
1120
+
1121
+ </li>
1122
+
1123
+ </ul>
1124
+
1125
+ </div><table class="source_code">
1126
+ <tr>
1127
+ <td>
1128
+ <pre class="lines">
1129
+
1130
+
1131
+ 54
1132
+ 55
1133
+ 56
1134
+ 57</pre>
1135
+ </td>
1136
+ <td>
1137
+ <pre class="code"><span class="info file"># File 'lib/basecamp3/models/message_type.rb', line 54</span>
1138
+
1139
+ <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>
1140
+ <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>
1141
+ <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'>/categories/</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::MessageType (class)">MessageType</a></span></span><span class='rparen'>)</span>
1142
+ <span class='kw'>end</span></pre>
1143
+ </td>
1144
+ </tr>
1145
+ </table>
1146
+ </div>
1147
+
1148
+ </div>
1149
+
1150
+ </div>
1151
+
1152
+ <div id="footer">
1153
+ Generated on Tue May 9 15:32:19 2017 by
1154
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1155
+ 0.9.9 (ruby-2.2.2).
1156
+ </div>
1157
+
1158
+ </div>
1159
+ </body>
1160
+ </html>