Modules@robinpath/todoist
todoist

@robinpath/todoist

0.1.1Node.jsPublic

Todoist module for RobinPath.

Todoist

Todoist module for RobinPath.

Package: @robinpath/todoist | Category: Project Management | Type: Integration

Authentication

todoist.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the todoist module when you need to:

  • listProjects -- Use todoist.listProjects to perform this operation
  • getProject -- Use todoist.getProject to perform this operation
  • createProject -- Use todoist.createProject to perform this operation
  • updateProject -- Use todoist.updateProject to perform this operation
  • deleteProject -- Use todoist.deleteProject to perform this operation

Quick Reference

FunctionDescriptionReturns
setCredentialsConfigure todoist credentials.object
listProjectslistProjectsobject
getProjectgetProjectobject
createProjectcreateProjectobject
updateProjectupdateProjectobject
deleteProjectdeleteProjectobject
listTaskslistTasksobject
getTaskgetTaskobject
createTaskcreateTaskobject
updateTaskupdateTaskobject
closeTaskcloseTaskobject
reopenTaskreopenTaskobject
deleteTaskdeleteTaskobject
listLabelslistLabelsobject
createLabelcreateLabelobject
listCommentslistCommentsobject
createCommentcreateCommentobject
deleteCommentdeleteCommentobject

Functions

setCredentials

Configure todoist credentials.

Module: todoist | Returns: object -- API response.

todoist.setCredentials
ParameterTypeRequiredDescription
apiTokenstringYesapiToken

listProjects

listProjects

Module: todoist | Returns: object -- API response.

todoist.listProjects
ParameterTypeRequiredDescription
inputstringNoInput parameter

getProject

getProject

Module: todoist | Returns: object -- API response.

todoist.getProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

createProject

createProject

Module: todoist | Returns: object -- API response.

todoist.createProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

updateProject

updateProject

Module: todoist | Returns: object -- API response.

todoist.updateProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

deleteProject

deleteProject

Module: todoist | Returns: object -- API response.

todoist.deleteProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

listTasks

listTasks

Module: todoist | Returns: object -- API response.

todoist.listTasks
ParameterTypeRequiredDescription
inputstringNoInput parameter

getTask

getTask

Module: todoist | Returns: object -- API response.

todoist.getTask
ParameterTypeRequiredDescription
inputstringNoInput parameter

createTask

createTask

Module: todoist | Returns: object -- API response.

todoist.createTask
ParameterTypeRequiredDescription
inputstringNoInput parameter

updateTask

updateTask

Module: todoist | Returns: object -- API response.

todoist.updateTask
ParameterTypeRequiredDescription
inputstringNoInput parameter

closeTask

closeTask

Module: todoist | Returns: object -- API response.

todoist.closeTask
ParameterTypeRequiredDescription
inputstringNoInput parameter

reopenTask

reopenTask

Module: todoist | Returns: object -- API response.

todoist.reopenTask
ParameterTypeRequiredDescription
inputstringNoInput parameter

deleteTask

deleteTask

Module: todoist | Returns: object -- API response.

todoist.deleteTask
ParameterTypeRequiredDescription
inputstringNoInput parameter

listLabels

listLabels

Module: todoist | Returns: object -- API response.

todoist.listLabels
ParameterTypeRequiredDescription
inputstringNoInput parameter

createLabel

createLabel

Module: todoist | Returns: object -- API response.

todoist.createLabel
ParameterTypeRequiredDescription
inputstringNoInput parameter

listComments

listComments

Module: todoist | Returns: object -- API response.

todoist.listComments
ParameterTypeRequiredDescription
inputstringNoInput parameter

createComment

createComment

Module: todoist | Returns: object -- API response.

todoist.createComment
ParameterTypeRequiredDescription
inputstringNoInput parameter

deleteComment

deleteComment

Module: todoist | Returns: object -- API response.

todoist.deleteComment
ParameterTypeRequiredDescription
inputstringNoInput parameter

Error Handling

All functions throw on failure. Common errors:

ErrorCause
Todoist API error (${res.status}): ${t}Check the error message for details
todoist.setCredentials requires apiToken.Check the error message for details
todoist.updateProject requires an ID.Check the error message for details
todoist.deleteProject requires an ID.Check the error message for details
todoist.updateTask requires an ID.Check the error message for details
todoist.closeTask requires an ID.Check the error message for details
todoist.reopenTask requires an ID.Check the error message for details
todoist.deleteTask requires an ID.Check the error message for details
@desc "List projects and validate result"
do
  set $result as todoist.listProjects
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Projects

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  todoist.setCredentials $token
enddo

@desc "List projects and iterate results"
do
  set $result as todoist.listProjects
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createProject

Create a new resource and capture the result.

@desc "Setup authentication"
do
  todoist.setCredentials $token
enddo

@desc "Create project"
do
  set $result as todoist.createProject
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  todoist.setCredentials $token
enddo

@desc "Create project and update project"
do
  set $created as todoist.createProject
  # Update the created item
  todoist.updateProject
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  todoist.setCredentials $token
enddo

@desc "List projects and create project"
do
  set $existing as todoist.listProjects
  if $existing == null
    todoist.createProject
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Todoist workflow

Chain multiple todoist operations together.

@desc "Setup authentication"
do
  todoist.setCredentials $token
enddo

@desc "List projects, get project, and more"
do
  set $r_listProjects as todoist.listProjects
  set $r_getProject as todoist.getProject
  set $r_createProject as todoist.createProject
  print "All operations complete"
enddo

6. Safe listProjects with validation

Check results before proceeding.

@desc "Setup authentication"
do
  todoist.setCredentials $token
enddo

@desc "List projects and validate result"
do
  set $result as todoist.listProjects
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

  • asana -- Asana module for complementary functionality
  • clickup -- ClickUp module for complementary functionality
  • jira -- Jira module for complementary functionality
  • linear -- Linear module for complementary functionality
  • monday -- Monday.com module for complementary functionality

Versions (1)

VersionTagPublished
0.1.1latest1 months ago
Install
$ robinpath add @robinpath/todoist

Collaborators

Dumitru Balaban
Dumitru Balaban
@dumitru
View all @robinpath modules
Version0.1.1
LicenseMIT
Unpacked Size4.7 KB
Versions1
Weekly Downloads21
Total Downloads21
Stars0
Last Publish1 months ago
Created1 months ago

Category

productivity