EveryBenefits API Client

TypeScript client library for consuming the EveryBenefits REST API.

Installation

npm install everybenefits-client

Usage

import { EveryBenefitsClient } from 'everybenefits-client';

// Initialize client
const client = new EveryBenefitsClient({
  baseURL: 'https://your-api-url.com',
  apiKey: 'your-api-key', // Optional
});

// Health check
const health = await client.health.check();

// Authenticate
await client.auth.signIn('[email protected]', 'password');

// Get current user
const user = await client.users.getMe();

// Update user profile
await client.users.updateMe({
  displayName: 'John Doe',
  phoneNumber: '+1234567890',
});

API Reference

Health

• client.health.check() - Check API health status

Authentication

• client.auth.signIn(email, password) - Sign in with email and password
• client.auth.signOut() - Sign out current user
• client.auth.getCurrentUser() - Get current authenticated user

Users

• client.users.getMe() - Get current user profile
• client.users.updateMe(data) - Update current user profile
• client.users.getById(userId) - Get user by ID

Admin (requires admin role)

• client.admin.getUsers(options) - List users with pagination
• client.admin.updateUserRole(userId, role) - Update user role
• client.admin.updateUserStatus(userId, status) - Update user status

License

ISC