@robinpath/basecamp
0.1.2Node.jsPublicBasecamp 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.listProjectsto perform this operation - getProject -- Use
basecamp.getProjectto perform this operation - createProject -- Use
basecamp.createProjectto perform this operation - updateProject -- Use
basecamp.updateProjectto perform this operation - listTodoLists -- Use
basecamp.listTodoListsto perform this operation
Quick Reference
| Function | Description | Returns |
|---|---|---|
setCredentials | Configure basecamp credentials. | object |
listProjects | listProjects | object |
getProject | getProject | object |
createProject | createProject | object |
updateProject | updateProject | object |
listTodoLists | listTodoLists | object |
createTodoList | createTodoList | object |
listTodos | listTodos | object |
createTodo | createTodo | object |
updateTodo | updateTodo | object |
completeTodo | completeTodo | object |
listMessages | listMessages | object |
createMessage | createMessage | object |
listCampfireMessages | listCampfireMessages | object |
sendCampfireMessage | sendCampfireMessage | object |
listPeople | listPeople | object |
getPerson | getPerson | object |
listComments | listComments | object |
createComment | createComment | object |
Functions
setCredentials
Configure basecamp credentials.
Module: basecamp | Returns: object -- API response.
basecamp.setCredentials
| Parameter | Type | Required | Description |
|---|---|---|---|
accountId | string | Yes | accountId |
accessToken | string | Yes | accessToken |
listProjects
listProjects
Module: basecamp | Returns: object -- API response.
basecamp.listProjects
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
getProject
getProject
Module: basecamp | Returns: object -- API response.
basecamp.getProject
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
createProject
createProject
Module: basecamp | Returns: object -- API response.
basecamp.createProject
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
updateProject
updateProject
Module: basecamp | Returns: object -- API response.
basecamp.updateProject
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
listTodoLists
listTodoLists
Module: basecamp | Returns: object -- API response.
basecamp.listTodoLists
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
createTodoList
createTodoList
Module: basecamp | Returns: object -- API response.
basecamp.createTodoList
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
listTodos
listTodos
Module: basecamp | Returns: object -- API response.
basecamp.listTodos
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
createTodo
createTodo
Module: basecamp | Returns: object -- API response.
basecamp.createTodo
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
updateTodo
updateTodo
Module: basecamp | Returns: object -- API response.
basecamp.updateTodo
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
completeTodo
completeTodo
Module: basecamp | Returns: object -- API response.
basecamp.completeTodo
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
listMessages
listMessages
Module: basecamp | Returns: object -- API response.
basecamp.listMessages
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
createMessage
createMessage
Module: basecamp | Returns: object -- API response.
basecamp.createMessage
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
listCampfireMessages
listCampfireMessages
Module: basecamp | Returns: object -- API response.
basecamp.listCampfireMessages
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
sendCampfireMessage
sendCampfireMessage
Module: basecamp | Returns: object -- API response.
basecamp.sendCampfireMessage
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
listPeople
listPeople
Module: basecamp | Returns: object -- API response.
basecamp.listPeople
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
getPerson
getPerson
Module: basecamp | Returns: object -- API response.
basecamp.getPerson
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
listComments
listComments
Module: basecamp | Returns: object -- API response.
basecamp.listComments
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
createComment
createComment
Module: basecamp | Returns: object -- API response.
basecamp.createComment
| Parameter | Type | Required | Description |
|---|---|---|---|
input | string | No | Input parameter |
Error Handling
All functions throw on failure. Common errors:
| Error | Cause |
|---|---|
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)
| Version | Tag | Published |
|---|---|---|
| 0.1.2 | latest | 1 months ago |
Related Modules
rightplace
JS@robinpathv0.1.3
RightPlace integration — 130 functions for projects, WordPress, WooCommerce, email, files, git, spreadsheets, stages, docs, automations via rightplace-cli
asana
JS@robinpathv0.1.2
Asana module for RobinPath.
google-sheets
JS@robinpathv0.1.1
Google Sheets module for RobinPath.
airtable
JS@robinpathv0.1.2
Airtable module for RobinPath.
$ robinpath add @robinpath/basecamp
