@beauraines/rtm-api 1.4.2 → 1.6.0

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 (42) hide show
  1. package/.eslintrc.json +31 -0
  2. package/.github/dependabot.yml +11 -0
  3. package/.github/workflows/publish.yml +54 -0
  4. package/.github/workflows/test.yaml +25 -0
  5. package/CHANGELOG.md +19 -0
  6. package/README.md +17 -4
  7. package/docs/RTMClient.html +2 -2
  8. package/docs/RTMError.html +2 -2
  9. package/docs/RTMList.html +2 -2
  10. package/docs/RTMResponse.html +2 -2
  11. package/docs/RTMSuccess.html +2 -2
  12. package/docs/RTMTask.html +227 -5
  13. package/docs/RTMUser.html +271 -21
  14. package/docs/client_auth.js.html +2 -2
  15. package/docs/client_index.js.html +2 -2
  16. package/docs/client_user.js.html +5 -5
  17. package/docs/global.html +298 -3
  18. package/docs/index.html +12 -7
  19. package/docs/list_index.js.html +2 -2
  20. package/docs/response_error.js.html +8 -8
  21. package/docs/response_response.js.html +5 -5
  22. package/docs/response_success.js.html +3 -3
  23. package/docs/task_helper.js.html +15 -18
  24. package/docs/task_index.js.html +34 -16
  25. package/docs/user_index.js.html +5 -5
  26. package/docs/user_lists.js.html +2 -2
  27. package/docs/user_tasks.js.html +73 -9
  28. package/docs/utils_fetch.js.html +128 -0
  29. package/package.json +17 -4
  30. package/src/client/user.js +3 -3
  31. package/src/list/helper.js +1 -1
  32. package/src/response/error.js +6 -6
  33. package/src/response/response.js +3 -3
  34. package/src/response/success.js +1 -1
  35. package/src/task/helper.js +13 -13
  36. package/src/task/index.js +3 -3
  37. package/src/user/index.js +4 -3
  38. package/src/user/tasks.js +56 -26
  39. package/src/utils/auth.js +9 -9
  40. package/src/utils/fetch.js +23 -21
  41. package/src/utils/get.js +8 -5
  42. package/src/utils/sign.js +2 -2
package/docs/RTMTask.html CHANGED
@@ -23,7 +23,7 @@
23
23
  <label for="nav-trigger" class="overlay"></label>
24
24
 
25
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>
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/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#callAPI">callAPI</a></li><li><a href="global.html#formQuery">formQuery</a></li><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
27
27
  </nav>
28
28
 
29
29
  <div id="main">
@@ -898,7 +898,7 @@ let priority = task.priority;
898
898
 
899
899
  <dt class="tag-source">Source:</dt>
900
900
  <dd class="tag-source"><ul class="dummy"><li>
901
- <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line215">line 215</a>
901
+ <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line233">line 233</a>
902
902
  </li></ul></dd>
903
903
 
904
904
 
@@ -1033,6 +1033,152 @@ let priority = task.priority;
1033
1033
 
1034
1034
 
1035
1035
 
1036
+ <h4 class="name" id="isRecurring"><span class="type-signature"></span>isRecurring<span class="type-signature"> :boolean</span></h4>
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+ <dl class="details">
1043
+
1044
+
1045
+ <dt class="tag-source">Source:</dt>
1046
+ <dd class="tag-source"><ul class="dummy"><li>
1047
+ <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line212">line 212</a>
1048
+ </li></ul></dd>
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+ </dl>
1081
+
1082
+
1083
+
1084
+
1085
+
1086
+ <div class="description">
1087
+ <p>Task recurring flag</p>
1088
+ </div>
1089
+
1090
+
1091
+
1092
+ <h5>Type:</h5>
1093
+ <ul>
1094
+ <li>
1095
+
1096
+ <span class="param-type">boolean</span>
1097
+
1098
+
1099
+ </li>
1100
+ </ul>
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+ <h4 class="name" id="isSubtask"><span class="type-signature"></span>isSubtask<span class="type-signature"> :boolean</span></h4>
1110
+
1111
+
1112
+
1113
+
1114
+
1115
+ <dl class="details">
1116
+
1117
+
1118
+ <dt class="tag-source">Source:</dt>
1119
+ <dd class="tag-source"><ul class="dummy"><li>
1120
+ <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line218">line 218</a>
1121
+ </li></ul></dd>
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+ </dl>
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+ <div class="description">
1160
+ <p>Task subtask flag</p>
1161
+ </div>
1162
+
1163
+
1164
+
1165
+ <h5>Type:</h5>
1166
+ <ul>
1167
+ <li>
1168
+
1169
+ <span class="param-type">boolean</span>
1170
+
1171
+
1172
+ </li>
1173
+ </ul>
1174
+
1175
+
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+
1036
1182
  <h4 class="name" id="list"><span class="type-signature"></span>list<span class="type-signature"> :<a href="RTMList.html">RTMList</a></span></h4>
1037
1183
 
1038
1184
 
@@ -1044,7 +1190,7 @@ let priority = task.priority;
1044
1190
 
1045
1191
  <dt class="tag-source">Source:</dt>
1046
1192
  <dd class="tag-source"><ul class="dummy"><li>
1047
- <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line223">line 223</a>
1193
+ <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line241">line 241</a>
1048
1194
  </li></ul></dd>
1049
1195
 
1050
1196
 
@@ -1477,6 +1623,82 @@ let priority = task.priority;
1477
1623
 
1478
1624
 
1479
1625
 
1626
+ <h4 class="name" id="parentTaskId"><span class="type-signature"></span>parentTaskId<span class="type-signature"> :integer|undefined</span></h4>
1627
+
1628
+
1629
+
1630
+
1631
+
1632
+ <dl class="details">
1633
+
1634
+
1635
+ <dt class="tag-source">Source:</dt>
1636
+ <dd class="tag-source"><ul class="dummy"><li>
1637
+ <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line223">line 223</a>
1638
+ </li></ul></dd>
1639
+
1640
+
1641
+
1642
+
1643
+
1644
+
1645
+
1646
+
1647
+
1648
+
1649
+
1650
+
1651
+
1652
+
1653
+
1654
+
1655
+
1656
+
1657
+
1658
+
1659
+
1660
+
1661
+
1662
+
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+ </dl>
1671
+
1672
+
1673
+
1674
+
1675
+
1676
+ <div class="description">
1677
+ <p>Task parent task id</p>
1678
+ </div>
1679
+
1680
+
1681
+
1682
+ <h5>Type:</h5>
1683
+ <ul>
1684
+ <li>
1685
+
1686
+ <span class="param-type">integer</span>
1687
+ |
1688
+
1689
+ <span class="param-type">undefined</span>
1690
+
1691
+
1692
+ </li>
1693
+ </ul>
1694
+
1695
+
1696
+
1697
+
1698
+
1699
+
1700
+
1701
+
1480
1702
  <h4 class="name" id="participants"><span class="type-signature"></span>participants<span class="type-signature"> :Array</span></h4>
1481
1703
 
1482
1704
 
@@ -1707,7 +1929,7 @@ let priority = task.priority;
1707
1929
 
1708
1930
  <dt class="tag-source">Source:</dt>
1709
1931
  <dd class="tag-source"><ul class="dummy"><li>
1710
- <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line234">line 234</a>
1932
+ <a href="task_index.js.html">task/index.js</a>, <a href="task_index.js.html#line252">line 252</a>
1711
1933
  </li></ul></dd>
1712
1934
 
1713
1935
 
@@ -2452,7 +2674,7 @@ let priority = task.priority;
2452
2674
  <br class="clear">
2453
2675
 
2454
2676
  <footer>
2455
- 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.
2677
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Sun Mar 12 2023 09:58:16 GMT-0700 (Pacific Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
2456
2678
  </footer>
2457
2679
 
2458
2680
  <script>prettyPrint();</script>