@robinpath/box
v0.3.0
Published
Box Content API v2.0 — files, folders, shared links, search. Uses the encrypted credential vault (OAuth2 access token).
Readme
@robinpath/box
Box module for RobinPath.
Why use this module?
The box module lets you:
- listFolderItems
- getFolderInfo
- createFolder
- deleteFolder
- getFileInfo
All functions are callable directly from RobinPath scripts with a simple, consistent API.
Installation
robinpath add @robinpath/boxQuick Start
1. Set up credentials
box.setCredentials "your-credentials"2. listFolderItems
box.listFolderItemsAvailable Functions
| Function | Description |
|----------|-------------|
| box.setCredentials | Configure box credentials. |
| box.listFolderItems | listFolderItems |
| box.getFolderInfo | getFolderInfo |
| box.createFolder | createFolder |
| box.deleteFolder | deleteFolder |
| box.getFileInfo | getFileInfo |
| box.downloadFile | downloadFile |
| box.deleteFile | deleteFile |
| box.copyFile | copyFile |
| box.moveFile | moveFile |
| box.uploadFile | uploadFile |
| box.searchContent | searchContent |
| box.createSharedLink | createSharedLink |
| box.getSharedLink | getSharedLink |
| box.listCollaborations | listCollaborations |
| box.addCollaboration | addCollaboration |
| box.getUser | getUser |
| box.updateFileInfo | updateFileInfo |
| box.lockFile | lockFile |
Examples
listFolderItems
box.listFolderItemsgetFolderInfo
box.getFolderInfocreateFolder
box.createFolderIntegration with RobinPath
import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/box";
const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);
const result = await rp.executeScript(`
box.setCredentials "your-credentials"
box.listFolderItems
`);Full API Reference
See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.
Related Modules
@robinpath/s3— Amazon S3 module for complementary functionality@robinpath/dropbox— Dropbox module for complementary functionality@robinpath/onedrive— OneDrive module for complementary functionality@robinpath/google-drive— Google Drive module for complementary functionality@robinpath/json— JSON module for complementary functionality
License
MIT
