Modules@robinpath/basecamp
basecamp

@robinpath/basecamp

0.1.2Node.jsPublic

Basecamp module for RobinPath.

Basecamp

Basecamp module for RobinPath.

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

Authentication

basecamp.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 basecamp module when you need to:

  • listProjects -- Use basecamp.listProjects to perform this operation
  • getProject -- Use basecamp.getProject to perform this operation
  • createProject -- Use basecamp.createProject to perform this operation
  • updateProject -- Use basecamp.updateProject to perform this operation
  • listTodoLists -- Use basecamp.listTodoLists to perform this operation

Quick Reference

FunctionDescriptionReturns
setCredentialsConfigure basecamp credentials.object
listProjectslistProjectsobject
getProjectgetProjectobject
createProjectcreateProjectobject
updateProjectupdateProjectobject
listTodoListslistTodoListsobject
createTodoListcreateTodoListobject
listTodoslistTodosobject
createTodocreateTodoobject
updateTodoupdateTodoobject
completeTodocompleteTodoobject
listMessageslistMessagesobject
createMessagecreateMessageobject
listCampfireMessageslistCampfireMessagesobject
sendCampfireMessagesendCampfireMessageobject
listPeoplelistPeopleobject
getPersongetPersonobject
listCommentslistCommentsobject
createCommentcreateCommentobject

Functions

setCredentials

Configure basecamp credentials.

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

basecamp.setCredentials
ParameterTypeRequiredDescription
accountIdstringYesaccountId
accessTokenstringYesaccessToken

listProjects

listProjects

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

basecamp.listProjects
ParameterTypeRequiredDescription
inputstringNoInput parameter

getProject

getProject

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

basecamp.getProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

createProject

createProject

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

basecamp.createProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

updateProject

updateProject

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

basecamp.updateProject
ParameterTypeRequiredDescription
inputstringNoInput parameter

listTodoLists

listTodoLists

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

basecamp.listTodoLists
ParameterTypeRequiredDescription
inputstringNoInput parameter

createTodoList

createTodoList

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

basecamp.createTodoList
ParameterTypeRequiredDescription
inputstringNoInput parameter

listTodos

listTodos

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

basecamp.listTodos
ParameterTypeRequiredDescription
inputstringNoInput parameter

createTodo

createTodo

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

basecamp.createTodo
ParameterTypeRequiredDescription
inputstringNoInput parameter

updateTodo

updateTodo

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

basecamp.updateTodo
ParameterTypeRequiredDescription
inputstringNoInput parameter

completeTodo

completeTodo

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

basecamp.completeTodo
ParameterTypeRequiredDescription
inputstringNoInput parameter

listMessages

listMessages

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

basecamp.listMessages
ParameterTypeRequiredDescription
inputstringNoInput parameter

createMessage

createMessage

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

basecamp.createMessage
ParameterTypeRequiredDescription
inputstringNoInput parameter

listCampfireMessages

listCampfireMessages

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

basecamp.listCampfireMessages
ParameterTypeRequiredDescription
inputstringNoInput parameter

sendCampfireMessage

sendCampfireMessage

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

basecamp.sendCampfireMessage
ParameterTypeRequiredDescription
inputstringNoInput parameter

listPeople

listPeople

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

basecamp.listPeople
ParameterTypeRequiredDescription
inputstringNoInput parameter

getPerson

getPerson

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

basecamp.getPerson
ParameterTypeRequiredDescription
inputstringNoInput parameter

listComments

listComments

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

basecamp.listComments
ParameterTypeRequiredDescription
inputstringNoInput parameter

createComment

createComment

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

basecamp.createComment
ParameterTypeRequiredDescription
inputstringNoInput parameter

Error Handling

All functions throw on failure. Common errors:

ErrorCause
Basecamp API error (${res.status}): ${t}Check the error message for details
basecamp.setCredentials requires accountId, accessToken.Check the error message for details
basecamp.updateProject requires an ID.Check the error message for details
basecamp.updateTodo requires an ID.Check the error message for details
basecamp.completeTodo requires an ID.Check the error message for details
Basecamp: "..." not configured. Call basecamp.setCredentials first.Check the error message for details
@desc "List projects and validate result"
do
  set $result as basecamp.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
  basecamp.setCredentials $token
enddo

@desc "List projects and iterate results"
do
  set $result as basecamp.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
  basecamp.setCredentials $token
enddo

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

3. Create and update workflow

Create an item and then update it.

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

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

4. Check before creating

List existing items and only create if needed.

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

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

5. Multi-step Basecamp workflow

Chain multiple basecamp operations together.

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

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

6. Safe listProjects with validation

Check results before proceeding.

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

@desc "List projects and validate result"
do
  set $result as basecamp.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.2latest1 months ago
Install
$ robinpath add @robinpath/basecamp

Collaborators

Dumitru Balaban
Dumitru Balaban
@dumitru
View all @robinpath modules
Version0.1.2
LicenseMIT
Unpacked Size4.8 KB
Versions1
Weekly Downloads26
Total Downloads26
Stars0
Last Publish1 months ago
Created1 months ago

Category

productivity