@beauraines/rtm-api 1.4.1

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 (52) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +285 -0
  3. package/config.js +22 -0
  4. package/docs/RTMClient.html +2798 -0
  5. package/docs/RTMError.html +1029 -0
  6. package/docs/RTMList.html +966 -0
  7. package/docs/RTMResponse.html +868 -0
  8. package/docs/RTMSuccess.html +337 -0
  9. package/docs/RTMTask.html +2461 -0
  10. package/docs/RTMUser.html +6761 -0
  11. package/docs/client_auth.js.html +123 -0
  12. package/docs/client_index.js.html +241 -0
  13. package/docs/client_user.js.html +170 -0
  14. package/docs/global.html +386 -0
  15. package/docs/index.html +305 -0
  16. package/docs/list_index.js.html +159 -0
  17. package/docs/response_error.js.html +172 -0
  18. package/docs/response_response.js.html +160 -0
  19. package/docs/response_success.js.html +104 -0
  20. package/docs/scripts/linenumber.js +25 -0
  21. package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
  22. package/docs/scripts/prettify/lang-css.js +2 -0
  23. package/docs/scripts/prettify/prettify.js +28 -0
  24. package/docs/styles/jsdoc.css +664 -0
  25. package/docs/styles/prettify.css +79 -0
  26. package/docs/task_helper.js.html +531 -0
  27. package/docs/task_index.js.html +304 -0
  28. package/docs/user_index.js.html +347 -0
  29. package/docs/user_lists.js.html +208 -0
  30. package/docs/user_tasks.js.html +703 -0
  31. package/jsdoc.json +13 -0
  32. package/package.json +33 -0
  33. package/src/client/auth.js +65 -0
  34. package/src/client/index.js +182 -0
  35. package/src/client/user.js +112 -0
  36. package/src/list/helper.js +131 -0
  37. package/src/list/index.js +101 -0
  38. package/src/response/error.js +114 -0
  39. package/src/response/index.js +8 -0
  40. package/src/response/parse.js +51 -0
  41. package/src/response/response.js +102 -0
  42. package/src/response/success.js +46 -0
  43. package/src/task/helper.js +469 -0
  44. package/src/task/index.js +264 -0
  45. package/src/user/index.js +288 -0
  46. package/src/user/lists.js +150 -0
  47. package/src/user/tasks.js +708 -0
  48. package/src/utils/auth.js +188 -0
  49. package/src/utils/fetch.js +67 -0
  50. package/src/utils/get.js +247 -0
  51. package/src/utils/sign.js +93 -0
  52. package/src/utils/taskIds.js +188 -0
package/docs/RTMResponse.html ADDED
@@ -0,0 +1,868 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>RTMResponse - Documentation</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"></script>
8
+ <script src="scripts/prettify/lang-css.js"></script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
14
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
+ </head>
16
+ <body>
17
+
18
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
19
+ <label for="nav-trigger" class="navicon-button x">
20
+ <div class="navicon"></div>
21
+ </label>
22
+
23
+ <label for="nav-trigger" class="overlay"></label>
24
+
25
+ <nav>
26
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RTMClient.html">RTMClient</a><ul class='methods'><li data-type='method'><a href="RTMClient.html#get">get</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthToken">auth/getAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthUrl">auth/getAuthUrl</a></li><li data-type='method'><a href="RTMClient.html#~auth/verifyAuthToken">auth/verifyAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~user/create">user/create</a></li><li data-type='method'><a href="RTMClient.html#~user/export">user/export</a></li><li data-type='method'><a href="RTMClient.html#~user/exportToString">user/exportToString</a></li><li data-type='method'><a href="RTMClient.html#~user/import">user/import</a></li><li data-type='method'><a href="RTMClient.html#~user/importFromString">user/importFromString</a></li></ul></li><li><a href="RTMError.html">RTMError</a><ul class='methods'><li data-type='method'><a href="RTMError.html#.networkError">networkError</a></li><li data-type='method'><a href="RTMError.html#.rateLimitError">rateLimitError</a></li><li data-type='method'><a href="RTMError.html#.referenceError">referenceError</a></li><li data-type='method'><a href="RTMError.html#.responseError">responseError</a></li><li data-type='method'><a href="RTMError.html#.serverError">serverError</a></li><li data-type='method'><a href="RTMError.html#toString">toString</a></li></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMResponse.html">RTMResponse</a><ul class='methods'><li data-type='method'><a href="RTMResponse.html#has">has</a></li><li data-type='method'><a href="RTMResponse.html#toString">toString</a></li></ul></li><li><a href="RTMSuccess.html">RTMSuccess</a><ul class='methods'><li data-type='method'><a href="RTMSuccess.html#toString">toString</a></li></ul></li><li><a href="RTMTask.html">RTMTask</a></li><li><a href="RTMUser.html">RTMUser</a><ul class='methods'><li data-type='method'><a href="RTMUser.html#clearTaskIndexCache">clearTaskIndexCache</a></li><li data-type='method'><a href="RTMUser.html#get">get</a></li><li data-type='method'><a href="RTMUser.html#verifyAuthToken">verifyAuthToken</a></li><li data-type='method'><a href="RTMUser.html#~lists/add">lists/add</a></li><li data-type='method'><a href="RTMUser.html#~lists/archive">lists/archive</a></li><li data-type='method'><a href="RTMUser.html#~lists/get">lists/get</a></li><li data-type='method'><a href="RTMUser.html#~lists/remove">lists/remove</a></li><li data-type='method'><a href="RTMUser.html#~lists/rename">lists/rename</a></li><li data-type='method'><a href="RTMUser.html#~tasks/add">tasks/add</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addNotes">tasks/addNotes</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addTags">tasks/addTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/complete">tasks/complete</a></li><li data-type='method'><a href="RTMUser.html#~tasks/decreasePriority">tasks/decreasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/get">tasks/get</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/increasePriority">tasks/increasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/move">tasks/move</a></li><li data-type='method'><a href="RTMUser.html#~tasks/postpone">tasks/postpone</a></li><li data-type='method'><a href="RTMUser.html#~tasks/priority">tasks/priority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/remove">tasks/remove</a></li><li data-type='method'><a href="RTMUser.html#~tasks/removeTags">tasks/removeTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setDueDate">tasks/setDueDate</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setName">tasks/setName</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setURL">tasks/setURL</a></li><li data-type='method'><a href="RTMUser.html#~tasks/uncomplete">tasks/uncomplete</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
27
+ </nav>
28
+
29
+ <div id="main">
30
+
31
+ <h1 class="page-title">RTMResponse</h1>
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+ <section>
40
+
41
+ <header>
42
+
43
+ <h2>
44
+ RTMResponse
45
+ </h2>
46
+
47
+ <div class="class-description"><h3>RTM Generic Response</h3>
48
+ <p>This Class represents a generic Response from the RTM API Server.
49
+ The <code>RTMError</code> and <code>RTMSuccess</code> Classes represent the actual failed
50
+ and successful responses from the RTM API Server.</p>
51
+ <p>This Class is extended by the <a href="RTMSuccess.html">RTMSuccess</a> and <a href="RTMError.html">RTMError</a> Classes.</p></div>
52
+
53
+
54
+ </header>
55
+
56
+ <article>
57
+ <div class="container-overview">
58
+
59
+
60
+
61
+
62
+ <h2>Constructor</h2>
63
+
64
+
65
+ <h4 class="name" id="RTMResponse"><span class="type-signature"></span>new RTMResponse<span class="signature">(status)</span><span class="type-signature"></span></h4>
66
+
67
+
68
+
69
+
70
+
71
+
72
+ <dl class="details">
73
+
74
+
75
+ <dt class="tag-source">Source:</dt>
76
+ <dd class="tag-source"><ul class="dummy"><li>
77
+ <a href="response_response.js.html">response/response.js</a>, <a href="response_response.js.html#line14">line 14</a>
78
+ </li></ul></dd>
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ </dl>
111
+
112
+
113
+
114
+
115
+
116
+ <div class="description">
117
+ <p>Create a new Generic RTM Response with a status of either
118
+ <a href="RTMResponse.html#.STATUS_OK">RTMResponse.STATUS_OK</a> or <a href="RTMResponse.html#.STATUS_FAIL">RTMResponse.STATUS_FAIL</a>.</p>
119
+ </div>
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <h5>Parameters:</h5>
132
+
133
+
134
+ <table class="params">
135
+ <thead>
136
+ <tr>
137
+
138
+ <th>Name</th>
139
+
140
+
141
+ <th>Type</th>
142
+
143
+
144
+
145
+
146
+
147
+ <th class="last">Description</th>
148
+ </tr>
149
+ </thead>
150
+
151
+ <tbody>
152
+
153
+
154
+ <tr>
155
+
156
+ <td class="name"><code>status</code></td>
157
+
158
+
159
+ <td class="type">
160
+
161
+
162
+ <span class="param-type">string</span>
163
+
164
+
165
+
166
+ </td>
167
+
168
+
169
+
170
+
171
+
172
+ <td class="description last"><p>RTM API Status</p></td>
173
+ </tr>
174
+
175
+
176
+ </tbody>
177
+ </table>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ </div>
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+ <h3 class="subsection-title">Members</h3>
209
+
210
+
211
+
212
+ <h4 class="name" id=".STATUS_FAIL"><span class="type-signature">(static) </span>STATUS_FAIL<span class="type-signature"> :string</span></h4>
213
+
214
+
215
+
216
+
217
+
218
+ <dl class="details">
219
+
220
+
221
+ <dt class="tag-source">Source:</dt>
222
+ <dd class="tag-source"><ul class="dummy"><li>
223
+ <a href="response_response.js.html">response/response.js</a>, <a href="response_response.js.html#line98">line 98</a>
224
+ </li></ul></dd>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+ <dt class="tag-default">Default Value:</dt>
251
+ <dd class="tag-default"><ul class="dummy">
252
+ <li>fail</li>
253
+ </ul></dd>
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+ </dl>
262
+
263
+
264
+
265
+
266
+
267
+ <div class="description">
268
+ <p>RTM Status of 'fail' = error</p>
269
+ </div>
270
+
271
+
272
+
273
+ <h5>Type:</h5>
274
+ <ul>
275
+ <li>
276
+
277
+ <span class="param-type">string</span>
278
+
279
+
280
+ </li>
281
+ </ul>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+ <h4 class="name" id=".STATUS_OK"><span class="type-signature">(static) </span>STATUS_OK<span class="type-signature"> :string</span></h4>
291
+
292
+
293
+
294
+
295
+
296
+ <dl class="details">
297
+
298
+
299
+ <dt class="tag-source">Source:</dt>
300
+ <dd class="tag-source"><ul class="dummy"><li>
301
+ <a href="response_response.js.html">response/response.js</a>, <a href="response_response.js.html#line91">line 91</a>
302
+ </li></ul></dd>
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+ <dt class="tag-default">Default Value:</dt>
329
+ <dd class="tag-default"><ul class="dummy">
330
+ <li>ok</li>
331
+ </ul></dd>
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+ </dl>
340
+
341
+
342
+
343
+
344
+
345
+ <div class="description">
346
+ <p>RTM Status of 'ok' = successful</p>
347
+ </div>
348
+
349
+
350
+
351
+ <h5>Type:</h5>
352
+ <ul>
353
+ <li>
354
+
355
+ <span class="param-type">string</span>
356
+
357
+
358
+ </li>
359
+ </ul>
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+ <h4 class="name" id="isOk"><span class="type-signature"></span>isOk<span class="type-signature"> :boolean</span></h4>
369
+
370
+
371
+
372
+
373
+
374
+ <dl class="details">
375
+
376
+
377
+ <dt class="tag-source">Source:</dt>
378
+ <dd class="tag-source"><ul class="dummy"><li>
379
+ <a href="response_response.js.html">response/response.js</a>, <a href="response_response.js.html#line38">line 38</a>
380
+ </li></ul></dd>
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+ </dl>
413
+
414
+
415
+
416
+
417
+
418
+ <div class="description">
419
+ <p>The success of the RTM Response (ie, is <code>true</code> when status is 'ok')</p>
420
+ </div>
421
+
422
+
423
+
424
+ <h5>Type:</h5>
425
+ <ul>
426
+ <li>
427
+
428
+ <span class="param-type">boolean</span>
429
+
430
+
431
+ </li>
432
+ </ul>
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+ <h4 class="name" id="props"><span class="type-signature"></span>props<span class="type-signature"> :object</span></h4>
442
+
443
+
444
+
445
+
446
+
447
+ <dl class="details">
448
+
449
+
450
+ <dt class="tag-source">Source:</dt>
451
+ <dd class="tag-source"><ul class="dummy"><li>
452
+ <a href="response_response.js.html">response/response.js</a>, <a href="response_response.js.html#line46">line 46</a>
453
+ </li></ul></dd>
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+ </dl>
486
+
487
+
488
+
489
+
490
+
491
+ <div class="description">
492
+ <p>The RTM API properties of the Response</p>
493
+ </div>
494
+
495
+
496
+
497
+ <h5>Type:</h5>
498
+ <ul>
499
+ <li>
500
+
501
+ <span class="param-type">object</span>
502
+
503
+
504
+ </li>
505
+ </ul>
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+ <h4 class="name" id="status"><span class="type-signature"></span>status<span class="type-signature"> :string</span></h4>
515
+
516
+
517
+
518
+
519
+
520
+ <dl class="details">
521
+
522
+
523
+ <dt class="tag-source">Source:</dt>
524
+ <dd class="tag-source"><ul class="dummy"><li>
525
+ <a href="response_response.js.html">response/response.js</a>, <a href="response_response.js.html#line30">line 30</a>
526
+ </li></ul></dd>
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+ </dl>
559
+
560
+
561
+
562
+
563
+
564
+ <div class="description">
565
+ <p>The RTM Response Status</p>
566
+ </div>
567
+
568
+
569
+
570
+ <h5>Type:</h5>
571
+ <ul>
572
+ <li>
573
+
574
+ <span class="param-type">string</span>
575
+
576
+
577
+ </li>
578
+ </ul>
579
+
580
+
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+ <h3 class="subsection-title">Methods</h3>
590
+
591
+
592
+
593
+
594
+
595
+
596
+ <h4 class="name" id="has"><span class="type-signature"></span>has<span class="signature">(property)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
597
+
598
+
599
+
600
+
601
+
602
+
603
+ <dl class="details">
604
+
605
+
606
+ <dt class="tag-source">Source:</dt>
607
+ <dd class="tag-source"><ul class="dummy"><li>
608
+ <a href="response_response.js.html">response/response.js</a>, <a href="response_response.js.html#line61">line 61</a>
609
+ </li></ul></dd>
610
+
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+ </dl>
642
+
643
+
644
+
645
+
646
+
647
+ <div class="description">
648
+ <p>Check if the Response has the specified property</p>
649
+ </div>
650
+
651
+
652
+
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+ <h5>Parameters:</h5>
662
+
663
+
664
+ <table class="params">
665
+ <thead>
666
+ <tr>
667
+
668
+ <th>Name</th>
669
+
670
+
671
+ <th>Type</th>
672
+
673
+
674
+
675
+
676
+
677
+ <th class="last">Description</th>
678
+ </tr>
679
+ </thead>
680
+
681
+ <tbody>
682
+
683
+
684
+ <tr>
685
+
686
+ <td class="name"><code>property</code></td>
687
+
688
+
689
+ <td class="type">
690
+
691
+
692
+ <span class="param-type">string</span>
693
+
694
+
695
+
696
+ </td>
697
+
698
+
699
+
700
+
701
+
702
+ <td class="description last"><p>Property Name</p></td>
703
+ </tr>
704
+
705
+
706
+ </tbody>
707
+ </table>
708
+
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+ <h5>Returns:</h5>
723
+
724
+
725
+
726
+
727
+ <dl class="param-type">
728
+ <dt>
729
+ Type
730
+ </dt>
731
+ <dd>
732
+
733
+ <span class="param-type">boolean</span>
734
+
735
+
736
+ </dd>
737
+ </dl>
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
748
+
749
+
750
+
751
+
752
+
753
+
754
+ <dl class="details">
755
+
756
+
757
+ <dt class="tag-source">Source:</dt>
758
+ <dd class="tag-source"><ul class="dummy"><li>
759
+ <a href="response_response.js.html">response/response.js</a>, <a href="response_response.js.html#line79">line 79</a>
760
+ </li></ul></dd>
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+
786
+
787
+
788
+
789
+
790
+
791
+
792
+ </dl>
793
+
794
+
795
+
796
+
797
+
798
+ <div class="description">
799
+ <p>Get a String representation of the Response</p>
800
+ </div>
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+ <h5>Returns:</h5>
825
+
826
+
827
+
828
+
829
+ <dl class="param-type">
830
+ <dt>
831
+ Type
832
+ </dt>
833
+ <dd>
834
+
835
+ <span class="param-type">string</span>
836
+
837
+
838
+ </dd>
839
+ </dl>
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+
850
+ </article>
851
+
852
+ </section>
853
+
854
+
855
+
856
+
857
+ </div>
858
+
859
+ <br class="clear">
860
+
861
+ <footer>
862
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:26:15 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
863
+ </footer>
864
+
865
+ <script>prettyPrint();</script>
866
+ <script src="scripts/linenumber.js"></script>
867
+ </body>
868
+ </html>