@beauraines/rtm-api 1.14.3 → 1.15.2

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 (32) hide show
  1. package/.all-contributorsrc +26 -0
  2. package/CHANGELOG.md +14 -0
  3. package/README.md +26 -0
  4. package/docs/RTMClient.html +78 -78
  5. package/docs/RTMError.html +30 -30
  6. package/docs/RTMList.html +2 -2
  7. package/docs/RTMLocation.html +747 -0
  8. package/docs/RTMResponse.html +31 -31
  9. package/docs/RTMSuccess.html +2 -2
  10. package/docs/RTMTask.html +106 -33
  11. package/docs/RTMUser.html +736 -31
  12. package/docs/client_auth.js.html +2 -2
  13. package/docs/client_index.js.html +2 -2
  14. package/docs/client_user.js.html +2 -2
  15. package/docs/global.html +186 -2
  16. package/docs/index.html +13 -5
  17. package/docs/list_index.js.html +2 -2
  18. package/docs/location_index.js.html +140 -0
  19. package/docs/response_error.js.html +2 -2
  20. package/docs/response_response.js.html +2 -2
  21. package/docs/response_success.js.html +2 -2
  22. package/docs/task_helper.js.html +2 -2
  23. package/docs/task_index.js.html +12 -2
  24. package/docs/user_index.js.html +14 -3
  25. package/docs/user_lists.js.html +38 -4
  26. package/docs/user_locations.js.html +85 -0
  27. package/docs/user_tasks.js.html +34 -4
  28. package/docs/utils_fetch.js.html +2 -2
  29. package/docs/utils_rruleToDuration.js.html +102 -0
  30. package/package.json +3 -2
  31. package/src/list/helper.js +19 -1
  32. package/src/user/lists.js +36 -2
package/docs/RTMLocation.html ADDED
@@ -0,0 +1,747 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>RTMLocation - 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#toString">toString</a></li><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></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMLocation.html">RTMLocation</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/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#~lists/unarchive">lists/unarchive</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/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/setStartDate">tasks/setStartDate</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#callAPI">callAPI</a></li><li><a href="global.html#formQuery">formQuery</a></li><li><a href="global.html#rruleToISODuration">rruleToISODuration</a></li><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
27
+ </nav>
28
+
29
+ <div id="main">
30
+
31
+ <h1 class="page-title">RTMLocation</h1>
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+ <section>
40
+
41
+ <header>
42
+
43
+ <h2>
44
+ RTMLocation
45
+ </h2>
46
+
47
+ <div class="class-description"><h3>RTM Location</h3>
48
+ <p>This Class is used to represent the properties of an RTM Location.</p>
49
+ <p>All of the location properties from RTM are directly accessible from this Class.</p>
50
+ <pre class="prettyprint source"><code>let location = new RTMLocation(...);
51
+ let name = location.name;
52
+ </code></pre></div>
53
+
54
+
55
+ </header>
56
+
57
+ <article>
58
+ <div class="container-overview">
59
+
60
+
61
+
62
+
63
+ <h2>Constructor</h2>
64
+
65
+
66
+ <h4 class="name" id="RTMLocation"><span class="type-signature"></span>new RTMLocation<span class="signature">(props)</span><span class="type-signature"></span></h4>
67
+
68
+
69
+
70
+
71
+
72
+
73
+ <dl class="details">
74
+
75
+
76
+ <dt class="tag-source">Source:</dt>
77
+ <dd class="tag-source"><ul class="dummy"><li>
78
+ <a href="location_index.js.html">location/index.js</a>, <a href="location_index.js.html#line17">line 17</a>
79
+ </li></ul></dd>
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
+
111
+ </dl>
112
+
113
+
114
+
115
+
116
+
117
+ <div class="description">
118
+ <p>Create a new RTM Location</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>props</code></td>
157
+
158
+
159
+ <td class="type">
160
+
161
+
162
+ <span class="param-type">object</span>
163
+
164
+
165
+
166
+ </td>
167
+
168
+
169
+
170
+
171
+
172
+ <td class="description last"><p>The properties from the RTM API response <code>resp.locations.location</code></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="address"><span class="type-signature"></span>address<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="location_index.js.html">location/index.js</a>, <a href="location_index.js.html#line61">line 61</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
+
251
+
252
+
253
+
254
+
255
+
256
+ </dl>
257
+
258
+
259
+
260
+
261
+
262
+ <div class="description">
263
+ <p>Location Address</p>
264
+ </div>
265
+
266
+
267
+
268
+ <h5>Type:</h5>
269
+ <ul>
270
+ <li>
271
+
272
+ <span class="param-type">string</span>
273
+
274
+
275
+ </li>
276
+ </ul>
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+ <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :Number</span></h4>
286
+
287
+
288
+
289
+
290
+
291
+ <dl class="details">
292
+
293
+
294
+ <dt class="tag-source">Source:</dt>
295
+ <dd class="tag-source"><ul class="dummy"><li>
296
+ <a href="location_index.js.html">location/index.js</a>, <a href="location_index.js.html#line29">line 29</a>
297
+ </li></ul></dd>
298
+
299
+
300
+
301
+
302
+
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
+
329
+ </dl>
330
+
331
+
332
+
333
+
334
+
335
+ <div class="description">
336
+ <p>Location ID</p>
337
+ </div>
338
+
339
+
340
+
341
+ <h5>Type:</h5>
342
+ <ul>
343
+ <li>
344
+
345
+ <span class="param-type">Number</span>
346
+
347
+
348
+ </li>
349
+ </ul>
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+ <h4 class="name" id="latitude"><span class="type-signature"></span>latitude<span class="type-signature"> :Number</span></h4>
359
+
360
+
361
+
362
+
363
+
364
+ <dl class="details">
365
+
366
+
367
+ <dt class="tag-source">Source:</dt>
368
+ <dd class="tag-source"><ul class="dummy"><li>
369
+ <a href="location_index.js.html">location/index.js</a>, <a href="location_index.js.html#line48">line 48</a>
370
+ </li></ul></dd>
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+ </dl>
403
+
404
+
405
+
406
+
407
+
408
+ <div class="description">
409
+ <p>Location Latitude</p>
410
+ </div>
411
+
412
+
413
+
414
+ <h5>Type:</h5>
415
+ <ul>
416
+ <li>
417
+
418
+ <span class="param-type">Number</span>
419
+
420
+
421
+ </li>
422
+ </ul>
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+ <h4 class="name" id="longitude"><span class="type-signature"></span>longitude<span class="type-signature"> :Number</span></h4>
432
+
433
+
434
+
435
+
436
+
437
+ <dl class="details">
438
+
439
+
440
+ <dt class="tag-source">Source:</dt>
441
+ <dd class="tag-source"><ul class="dummy"><li>
442
+ <a href="location_index.js.html">location/index.js</a>, <a href="location_index.js.html#line42">line 42</a>
443
+ </li></ul></dd>
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+ </dl>
476
+
477
+
478
+
479
+
480
+
481
+ <div class="description">
482
+ <p>Location Longitude</p>
483
+ </div>
484
+
485
+
486
+
487
+ <h5>Type:</h5>
488
+ <ul>
489
+ <li>
490
+
491
+ <span class="param-type">Number</span>
492
+
493
+
494
+ </li>
495
+ </ul>
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+ <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
505
+
506
+
507
+
508
+
509
+
510
+ <dl class="details">
511
+
512
+
513
+ <dt class="tag-source">Source:</dt>
514
+ <dd class="tag-source"><ul class="dummy"><li>
515
+ <a href="location_index.js.html">location/index.js</a>, <a href="location_index.js.html#line35">line 35</a>
516
+ </li></ul></dd>
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+ </dl>
549
+
550
+
551
+
552
+
553
+
554
+ <div class="description">
555
+ <p>Location Name</p>
556
+ </div>
557
+
558
+
559
+
560
+ <h5>Type:</h5>
561
+ <ul>
562
+ <li>
563
+
564
+ <span class="param-type">string</span>
565
+
566
+
567
+ </li>
568
+ </ul>
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+ <h4 class="name" id="props"><span class="type-signature"></span>props<span class="type-signature"> :object</span></h4>
578
+
579
+
580
+
581
+
582
+
583
+ <dl class="details">
584
+
585
+
586
+ <dt class="tag-source">Source:</dt>
587
+ <dd class="tag-source"><ul class="dummy"><li>
588
+ <a href="location_index.js.html">location/index.js</a>, <a href="location_index.js.html#line69">line 69</a>
589
+ </li></ul></dd>
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+
604
+
605
+
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+ </dl>
622
+
623
+
624
+
625
+
626
+
627
+ <div class="description">
628
+ <p>All of the RTM Location properties</p>
629
+ </div>
630
+
631
+
632
+
633
+ <h5>Type:</h5>
634
+ <ul>
635
+ <li>
636
+
637
+ <span class="param-type">object</span>
638
+
639
+
640
+ </li>
641
+ </ul>
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+ <h4 class="name" id="zoom"><span class="type-signature"></span>zoom<span class="type-signature"> :Number</span></h4>
651
+
652
+
653
+
654
+
655
+
656
+ <dl class="details">
657
+
658
+
659
+ <dt class="tag-source">Source:</dt>
660
+ <dd class="tag-source"><ul class="dummy"><li>
661
+ <a href="location_index.js.html">location/index.js</a>, <a href="location_index.js.html#line55">line 55</a>
662
+ </li></ul></dd>
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+ </dl>
695
+
696
+
697
+
698
+
699
+
700
+ <div class="description">
701
+ <p>Location Zoom</p>
702
+ </div>
703
+
704
+
705
+
706
+ <h5>Type:</h5>
707
+ <ul>
708
+ <li>
709
+
710
+ <span class="param-type">Number</span>
711
+
712
+
713
+ </li>
714
+ </ul>
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+ </article>
730
+
731
+ </section>
732
+
733
+
734
+
735
+
736
+ </div>
737
+
738
+ <br class="clear">
739
+
740
+ <footer>
741
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a> on Sat May 23 2026 14:02:27 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
742
+ </footer>
743
+
744
+ <script>prettyPrint();</script>
745
+ <script src="scripts/linenumber.js"></script>
746
+ </body>
747
+ </html>