Wunderlist-api
📕 Wunderlist in a simple way.
Installation
[sudo] npm install --save wunderlist-api
Changelog
- 1.0.0 - ES6 MODULES! You can use Wunderlist-api with new sintax based in ES6, based in Class and features ES6!
- 0.2.2 - The names of some methods have changed from version 0.2.x, please see the new names from the need.
Docs
Concepts
There are some parameters that are needed to operate certain methods, among all, some are rather odd, such as the revision
, that is the amount of change that this task note, user, list, comment, subtask, in short, anything was modified, by default, it comes with the value 1
. When required this parameter, you must enter the value of the current revision
and not the following number. For example, to delete a user from the list that was newly created, I pass the current value of revision in case the value 1
.
For more information on types of parameters or any other matter, please visit the official site Wunderlist.
Usage
Authorization
To access the information have 2 data, the first the access token and the Client ID, this information is available here.
- accessToken - string
- clientId - string
'use strict'; ; const wunderlist = clientId: 'Your Client ID' accessToken: 'Your Access Token'// => authenticated
All the following methods may be accessed in the same way, only changing the parameter when it becomes necessary, show only an example that can be repeated after any other. The method is based on the concept of promises.
Universal Exampler: for all methods is REQUIRED use .then()
for get response!
// authenticationwunderlistmethodparameters ;
User
User information
wunderlist
Avatar
- userId: integer
- size: integer (optional)
- fallback: boolean (optional)
wunderlist
Lists
Get All lists
wunderlist
Get specified list
- listId: integer
wunderlist
Make a list from state (public or private)
- listId: integer
- revision: integer
- public: boolean
wunderlist
Create List
- title: string
wunderlist
Update List
- listId: integer
- revision: integer
- title: string
wunderlist
Delete List
- listId: integer
- revision: integer
wunderlist
Users authorized in list
- listId: integer
wunderlist
Notes
Get notes from list
- listId: integer
wunderlist
Get notes from task
- taskId: integer
wunderlist
Create note
- taskId: integer
- content: string
wunderlist
Delete note
- noteId: integer
- revision: integer
wunderlist
Tasks
Get all tasks
- listId: integer
wunderlist
Get tasks for state
- listId: integer
- state: boolean (completed or incompleted)
wunderlist
Get specified task
- taskId: integer
wunderlist
Create task
- listId: integer
- title: string
- state: boolean
- starred: boolean
wunderlist
Delete Task
- taskId: integer
- revision: integer
wunderlist
Subtasks
Get subtask from list
- taskId: integer
wunderlist
Get completed subtasks from list
- listId: integer
- completed: boolean
wunderlist
Get subtask from task
- taskId: integer
wunderlist
Get completed subtask from task
- taskId: integer
- completed: boolean
wunderlist
Create subtask
- taskId: integer
- title: string
- completed: boolean
wunderlist
Delete subtask
- subtaskId: integer
- revision: integer
wunderlist
Task Comments
Get comments from Task
- taskId: integer
wunderlist
Get comments from Lists
- listId: integer
wunderlist
Create Comment
- taskId: integer
- text: string
wunderlist
Membership
Get Membership
wunderlist
Add member to list
- user_id: integer
- listId: string
- muted: boolean
wunderlist
Remove a Member from a List
- user_id: integer
- revision: integer
wunderlist
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am "Add some feature"
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
For more information on types of parameters or any other matter, please visit the official site Wunderlist.
License MIT @ 2016 Felipe Sousa