For setup instructions and how to use the SDK, see Setup & Installation. If you are using a framework or programming language other than Next.js, you can use our REST API.
General
| Type | Description |
|---|---|
| HexclaveClientApp | Client-level permissions for frontend code |
| HexclaveServerApp | Server-level permissions with full access |
| Project | Project configuration and settings |
Users & User Data
| Type | Description |
|---|---|
| CurrentUser | Client-side authenticated user |
| ServerUser | Server-side user with full access |
| CurrentServerUser | Current user with server permissions |
| ContactChannel | User contact information (email, phone) |
| ServerContactChannel | Server-side contact channel with extended control |
Teams
| Type | Description |
|---|---|
| Team | Team management and configuration |
| ServerTeam | Server-side team with full access |
| TeamPermission | Team-level permissions |
| ServerTeamPermission | Server-side team permissions |
| TeamUser | Team membership representation |
| ServerTeamUser | Server-side team user |
| TeamProfile | Team-specific user profiles |
| ServerTeamProfile | Server-side team profiles |
| Type | Description |
|---|---|
| SendEmailOptions | Email sending configuration |
Payments & Items
| Type | Description |
|---|---|
| Customer | Customer billing interface |
| Item | Client-side resource management |
| ServerItem | Server-side resource management with quantity operations |
Hooks
| Hook | Description |
|---|---|
| useHexclaveApp | React hook to access the HexclaveClientApp instance |
| useUser | React hook to access the current user |
API Keys
| Type | Description |
|---|---|
| ApiKey | API key management for programmatic access |