Skip to content

feat: cover remaining documented Platform API endpoints #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
priosshrsth merged 2 commits into from
Aug 18, 2026
Merged

feat: cover remaining documented Platform API endpoints #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2c4a60
feat: cover remaining documented Platform API endpoints
priosshrsth Aug 18, 2026
9440826
fix(schemas): align response enums with the documented API
priosshrsth Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 33 additions & 30 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,36 +45,39 @@ const kit = createAssemblyKit({

Access API resources via `kit.<namespace>.<method>()`:

| Namespace | Methods |
| ----------------------- | ------------------------------------------------------------------ |
| `workspace` | `retrieve()` |
| `clients` | `list()` `retrieve()` `create()` `delete()` `listAll()` |
| `companies` | `list()` `retrieve()` `create()` `update()` `delete()` `listAll()` |
| `internalUsers` | `list()` `retrieve()` `listAll()` |
| `notes` | `list()` `retrieve()` `create()` `update()` `delete()` `listAll()` |
| `tasks` | `list()` `retrieve()` `create()` `update()` `delete()` `listAll()` |
| `taskTemplates` | `list()` `retrieve()` `listAll()` |
| `invoices` | `list()` `retrieve()` `create()` `listAll()` |
| `invoiceTemplates` | `list()` `listAll()` |
| `subscriptions` | `list()` `retrieve()` `create()` `cancel()` `listAll()` |
| `subscriptionTemplates` | `list()` `listAll()` |
| `payments` | `list()` `listAll()` |
| `products` | `list()` `retrieve()` `listAll()` |
| `prices` | `list()` `retrieve()` `listAll()` |
| `contracts` | `retrieve()` `send()` |
| `contractTemplates` | `list()` `retrieve()` |
| `forms` | `list()` `retrieve()` `listAll()` |
| `formResponses` | `list()` `create()` |
| `files` | `list()` `retrieve()` `delete()` `listAll()` |
| `fileChannels` | `list()` `retrieve()` `create()` `listAll()` |
| `messageChannels` | `list()` `retrieve()` `create()` `listAll()` |
| `messages` | `list()` `send()` `listAll()` |
| `events` | `list()` `retrieve()` `create()` `listAll()` |
| `notifications` | `list()` `create()` `delete()` `markRead()` `markUnread()` |
| `customFields` | `list()` |
| `customFieldOptions` | `list()` |
| `appConnections` | `list()` `create()` |
| `appInstalls` | `list()` `retrieve()` |
| Namespace | Methods |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workspace` | `retrieve()` |
| `me` | `retrieve()` |
| `clients` | `list()` `retrieve()` `retrieveWithAppVisibility()` `create()` `update()` `delete()` `listAll()` |
| `companies` | `list()` `retrieve()` `create()` `update()` `delete()` `addClients()` `listAll()` |
| `internalUsers` | `list()` `retrieve()` `update()` `retrieveNotificationSettings()` `listAll()` |
| `notes` | `list()` `retrieve()` `create()` `update()` `delete()` `listAll()` |
| `tasks` | `list()` `retrieve()` `create()` `update()` `delete()` `listAll()` |
| `taskComments` | `list()` `retrieve()` `delete()` `listAll()` |
| `taskTemplates` | `list()` `retrieve()` `listAll()` |
| `invoices` | `list()` `retrieve()` `create()` `listAll()` |
| `invoiceTemplates` | `list()` `listAll()` |
| `subscriptions` | `list()` `retrieve()` `create()` `cancel()` `listAll()` |
| `subscriptionTemplates` | `list()` `listAll()` |
| `refunds` | `list()` `create()` `listAll()` |
| `payments` | `list()` `listAll()` |
| `products` | `list()` `retrieve()` `create()` `listAll()` |
| `prices` | `list()` `retrieve()` `create()` `listAll()` |
| `contracts` | `retrieve()` `send()` |
| `contractTemplates` | `list()` `retrieve()` |
| `forms` | `list()` `retrieve()` `create()` `listSubmissions()` `listAllSubmissions()` `listAll()` |
| `formResponses` | `list()` `create()` |
| `files` | `list()` `retrieve()` `create()` `delete()` `retrieveDownloadUrl()` `download()` `updateFolderPermissions()` `updateRootFolderPermissions()` `listAll()` |
| `fileChannels` | `list()` `retrieve()` `create()` `listAll()` |
| `messageChannels` | `list()` `retrieve()` `create()` `listUnread()` `listAll()` |
| `messages` | `list()` `send()` `listAll()` |
| `events` | `list()` `retrieve()` `create()` `listAll()` |
| `notifications` | `list()` `retrieve()` `create()` `delete()` `markRead()` `markUnread()` |
| `customFields` | `list()` `create()` |
| `customFieldOptions` | `list()` |
| `appConnections` | `list()` `create()` |
| `appInstalls` | `list()` `retrieve()` `retrieveNotificationSettings()` `createNotificationSettings()` `updateNotificationSettings()` |

## Pagination

Expand Down
67 changes: 37 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,36 +141,43 @@ const kit = createAssemblyKit({

#### Resource namespaces

| Namespace | Methods |
| ----------------------- | ----------------------------------------------------------------------- |
| `workspace` | `retrieve()` |
| `clients` | `list()`, `retrieve()`, `create()`, `update()`, `delete()`, `listAll()` |
| `companies` | `list()`, `retrieve()`, `create()`, `update()`, `delete()`, `listAll()` |
| `internalUsers` | `list()`, `retrieve()`, `listAll()` |
| `customFields` | `list()` |
| `customFieldOptions` | `list()` |
| `notes` | `list()`, `retrieve()`, `create()`, `update()`, `delete()`, `listAll()` |
| `messageChannels` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `messages` | `list()`, `send()`, `listAll()` |
| `products` | `list()`, `retrieve()`, `listAll()` |
| `prices` | `list()`, `retrieve()`, `listAll()` |
| `invoiceTemplates` | `list()`, `listAll()` |
| `invoices` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `subscriptionTemplates` | `list()`, `listAll()` |
| `subscriptions` | `list()`, `retrieve()`, `create()`, `cancel()`, `listAll()` |
| `payments` | `list()`, `listAll()` |
| `fileChannels` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `files` | `list()`, `retrieve()`, `create()`, `delete()`, `listAll()` |
| `contractTemplates` | `list()`, `retrieve()`, `listAll()` |
| `contracts` | `list()`, `retrieve()`, `send()` |
| `forms` | `list()`, `retrieve()`, `listAll()` |
| `formResponses` | `list()`, `create()` |
| `tasks` | `list()`, `retrieve()`, `create()`, `update()`, `delete()`, `listAll()` |
| `taskTemplates` | `list()`, `retrieve()`, `listAll()` |
| `notifications` | `list()`, `create()`, `delete()`, `markRead()`, `markUnread()` |
| `events` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `appConnections` | `list()`, `create()` |
| `appInstalls` | `list()`, `retrieve()` |
| Namespace | Methods |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `workspace` | `retrieve()` |
| `me` | `retrieve()` |
| `clients` | `list()`, `retrieve()`, `retrieveWithAppVisibility()`, `create()`, `update()`, `delete()`, `listAll()` |
| `companies` | `list()`, `retrieve()`, `create()`, `update()`, `delete()`, `addClients()`, `listAll()` |
| `internalUsers` | `list()`, `retrieve()`, `update()`, `retrieveNotificationSettings()`, `listAll()` |
| `customFields` | `list()`, `create()` |
| `customFieldOptions` | `list()` |
| `notes` | `list()`, `retrieve()`, `create()`, `update()`, `delete()`, `listAll()` |
| `messageChannels` | `list()`, `retrieve()`, `create()`, `listUnread()`, `listAll()` |
| `messages` | `list()`, `send()`, `listAll()` |
| `products` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `prices` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `invoiceTemplates` | `list()`, `listAll()` |
| `invoices` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `subscriptionTemplates` | `list()`, `listAll()` |
| `subscriptions` | `list()`, `retrieve()`, `create()`, `cancel()`, `listAll()` |
| `refunds` | `list()`, `create()`, `listAll()` |
| `payments` | `list()`, `listAll()` |
| `fileChannels` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `files` | `list()`, `retrieve()`, `create()`, `delete()`, `retrieveDownloadUrl()`, `download()`, `updateFolderPermissions()`, `updateRootFolderPermissions()`, `listAll()` |
| `contractTemplates` | `list()`, `retrieve()`, `listAll()` |
| `contracts` | `list()`, `retrieve()`, `send()` |
| `forms` | `list()`, `retrieve()`, `create()`, `listSubmissions()`, `listAllSubmissions()`, `listAll()` |
| `formResponses` | `list()`, `create()` |
| `tasks` | `list()`, `retrieve()`, `create()`, `update()`, `delete()`, `listAll()` |
| `taskComments` | `list()`, `retrieve()`, `delete()`, `listAll()` |
| `taskTemplates` | `list()`, `retrieve()`, `listAll()` |
| `notifications` | `list()`, `retrieve()`, `create()`, `delete()`, `markRead()`, `markUnread()` |
| `events` | `list()`, `retrieve()`, `create()`, `listAll()` |
| `appConnections` | `list()`, `create()` |
| `appInstalls` | `list()`, `retrieve()`, `retrieveNotificationSettings()`, `createNotificationSettings()`, `updateNotificationSettings()` |

`files.download()` returns an `ArrayBuffer` — the endpoint streams `application/octet-stream`
rather than JSON. Use `files.retrieveDownloadUrl()` instead when you want a presigned URL to
hand to a browser.

### Pagination

Expand Down
4 changes: 2 additions & 2 deletions bun.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"p-throttle": "^8.1.0"
},
"devDependencies": {
"@assembly-js/app-bridge": "^1.1.1",
"@assembly-js/app-bridge": "^1.4.0",
"@types/node": "^25.6.0",
"@types/react": "^19.2.14",
"@typescript/native-preview": "7.0.0-dev.20260505.1",
Expand Down
Loading
Loading