@elqnt/admin

Admin APIs and types for the Eloquent platform - onboarding, organization settings, billing, and user management.

Building an admin app / using an AI coding agent? Read SKILL.md — the full agent guide: the one-way architecture (admin app → @elqnt/admin hooks → API Gateway → admin Go service), the gateway-token flow, and the exact spec of every hook (useOrgAdmin — org CRUD + settings; useUsersAdmin — user CRUD + invitations) and its methods. It ships in the package, so the contract is this package's own .d.ts — your code type-checks against it. (Product analytics moved to @elqnt/analytics.)

Installation

npm install @elqnt/admin

Quick Start

import { getOnboardingStatusApi, getBillingPlansApi } from "@elqnt/admin/api";
import type { User, Org, Plan } from "@elqnt/admin/models";

// Check onboarding status
const status = await getOnboardingStatusApi({
  baseUrl: "https://api.example.com",
});

// Get billing plans
const plans = await getBillingPlansApi({
  baseUrl: "https://api.example.com",
  orgId: "org_123",
});

Entry Points

| Import | Description | |--------|-------------| | @elqnt/admin | All exports | | @elqnt/admin/api | Browser API functions | | @elqnt/admin/models | TypeScript types | | @elqnt/admin/hooks | React hooks (useOrgAdmin, useUsersAdmin) |

APIs

Onboarding

• getOnboardingStatusApi() - Get current state
• createOrganizationApi() - Create org
• completeOnboardingApi() - Finish onboarding

Organization Settings

• getOrgSettingsApi() - Get settings
• updateOrgSettingsApi() - Update settings

Billing

• getBillingPlansApi() - List plans
• getSubscriptionApi() - Current subscription
• createCheckoutSessionApi() - Stripe checkout
• createPortalSessionApi() - Billing portal

Hooks

import { useOrgAdmin, useUsersAdmin } from "@elqnt/admin/hooks";

// Organization management + settings
const {
  listOrgs, getOrg, createOrg, updateOrg, deleteOrg,
  getSettings, createSettings, updateSettings,
  loading, error,
} = useOrgAdmin(options);

// User management + invitations
const {
  listUsers, getUser, createUser, updateUser, deleteUser, getUserSettings, updateUserSettings,
  listInvites, sendInvite, sendInvites, getInvite, acceptInvite, revokeInvite, resendInvite,
  loading, error,
} = useUsersAdmin(options);

Models

import type {
  // User & Org
  User, Org, OrgRole, Permission, Invite,

  // Billing
  Plan, OrganizationBilling, CreditBalance, UsageSummary,

  // Onboarding
  OnboardingState, OnboardingStep,
} from "@elqnt/admin/models";

Documentation

Full API reference: https://docs.eloquent.ai/packages/admin

Changelog

See CHANGELOG.md

License

Private - Eloquent Platform