@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
@@ -0,0 +1,386 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Global - 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">Global</h1>
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+ <section>
40
+
41
+ <header>
42
+
43
+ <h2>
44
+
45
+ </h2>
46
+
47
+
48
+ </header>
49
+
50
+ <article>
51
+ <div class="container-overview">
52
+
53
+
54
+
55
+ <dl class="details">
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+ </dl>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ </div>
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ <h3 class="subsection-title">Methods</h3>
113
+
114
+
115
+
116
+
117
+
118
+
119
+ <h4 class="name" id="setStartDate"><span class="type-signature"></span>setStartDate<span class="signature">(listId, taskSeriesId, taskId, start, user, callback)</span><span class="type-signature"></span></h4>
120
+
121
+
122
+
123
+
124
+
125
+
126
+ <dl class="details">
127
+
128
+
129
+ <dt class="tag-source">Source:</dt>
130
+ <dd class="tag-source"><ul class="dummy"><li>
131
+ <a href="task_helper.js.html">task/helper.js</a>, <a href="task_helper.js.html#line394">line 394</a>
132
+ </li></ul></dd>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+ </dl>
165
+
166
+
167
+
168
+
169
+
170
+ <div class="description">
171
+ <p>API Call: rtm.tasks.setStartDate</p>
172
+ </div>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ <h5>Parameters:</h5>
185
+
186
+
187
+ <table class="params">
188
+ <thead>
189
+ <tr>
190
+
191
+ <th>Name</th>
192
+
193
+
194
+ <th>Type</th>
195
+
196
+
197
+
198
+
199
+
200
+ <th class="last">Description</th>
201
+ </tr>
202
+ </thead>
203
+
204
+ <tbody>
205
+
206
+
207
+ <tr>
208
+
209
+ <td class="name"><code>listId</code></td>
210
+
211
+
212
+ <td class="type">
213
+
214
+
215
+ <span class="param-type">number</span>
216
+
217
+
218
+
219
+ </td>
220
+
221
+
222
+
223
+
224
+
225
+ <td class="description last"><p>RTM List ID</p></td>
226
+ </tr>
227
+
228
+
229
+
230
+ <tr>
231
+
232
+ <td class="name"><code>taskSeriesId</code></td>
233
+
234
+
235
+ <td class="type">
236
+
237
+
238
+ <span class="param-type">number</span>
239
+
240
+
241
+
242
+ </td>
243
+
244
+
245
+
246
+
247
+
248
+ <td class="description last"><p>RTM Task Series ID</p></td>
249
+ </tr>
250
+
251
+
252
+
253
+ <tr>
254
+
255
+ <td class="name"><code>taskId</code></td>
256
+
257
+
258
+ <td class="type">
259
+
260
+
261
+ <span class="param-type">number</span>
262
+
263
+
264
+
265
+ </td>
266
+
267
+
268
+
269
+
270
+
271
+ <td class="description last"><p>RTM Task ID</p></td>
272
+ </tr>
273
+
274
+
275
+
276
+ <tr>
277
+
278
+ <td class="name"><code>start</code></td>
279
+
280
+
281
+ <td class="type">
282
+
283
+
284
+ <span class="param-type">string</span>
285
+
286
+
287
+
288
+ </td>
289
+
290
+
291
+
292
+
293
+
294
+ <td class="description last"><p>Task Start Date/Time (will be parsed by RTM)</p></td>
295
+ </tr>
296
+
297
+
298
+
299
+ <tr>
300
+
301
+ <td class="name"><code>user</code></td>
302
+
303
+
304
+ <td class="type">
305
+
306
+
307
+ <span class="param-type"><a href="RTMUser.html">RTMUser</a></span>
308
+
309
+
310
+
311
+ </td>
312
+
313
+
314
+
315
+
316
+
317
+ <td class="description last"><p>RTM User</p></td>
318
+ </tr>
319
+
320
+
321
+
322
+ <tr>
323
+
324
+ <td class="name"><code>callback</code></td>
325
+
326
+
327
+ <td class="type">
328
+
329
+
330
+ <span class="param-type">function</span>
331
+
332
+
333
+
334
+ </td>
335
+
336
+
337
+
338
+
339
+
340
+ <td class="description last"><p>Callback function(err)</p></td>
341
+ </tr>
342
+
343
+
344
+ </tbody>
345
+ </table>
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+
367
+
368
+ </article>
369
+
370
+ </section>
371
+
372
+
373
+
374
+
375
+ </div>
376
+
377
+ <br class="clear">
378
+
379
+ <footer>
380
+ 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.
381
+ </footer>
382
+
383
+ <script>prettyPrint();</script>
384
+ <script src="scripts/linenumber.js"></script>
385
+ </body>
386
+ </html>