`QumoClient` Reference

The QumoClient class is the central gateway to all Qumo Deploy control plane resources.

Configuration Options (`QumoConfig`)

Option	Type	Description
`baseUrl`	`string`	Base API URL for the Qumo Deploy control plane (e.g. `https://api.qumo-deploy.com`). Required. An empty string makes requests relative to the current origin (browser use).
`token`	`string?`	Optional Bearer token: a personal access token (`qumo_pat_...`), an identity token, or a `qumod login` session token.
`csrfToken`	`(() => string \| null \| undefined)?`	Optional callback returning the active CSRF token for cookie-authenticated browser sessions.

Resource Namespaces

The following namespaces are accessible directly from the client instance:

Namespace	Accessor	Key Methods
Authentication	`client.auth`	`getSession()`, `getMemberships()`, `loginWithDeviceFlow()`, `startDeviceFlow()`, `exchangeDeviceCode()`, `logout()`
Projects	`client.projects`	`list()`, `create()`, `rename()`, `delete()`, `getUsage()`
Signing Keys	`client.signingKeys`	`list()`, `create()`, `register()`, `registerSigned()`, `revoke()`
Relays	`client.relays`	`place()`, `resolve()`
Organizations	`client.organizations`	`list()`, `create()`, `get()`, `update()`
Identities & Machine IDs	`client.identities`	`list()`, `create()`, `delete()`, `createToken()`, `listTokens()`, `revokeToken()`
Billing	`client.billing`	`getProjectSummary()`, `getOrganizationSummary()`, `getBudget()`, `updateBudget()`, `createCheckoutSession()`, `createPortalSession()`, `cancelSubscription()`, `resumeSubscription()`, `usageCsvUrl()`
Payment Methods	`client.paymentMethods`	`list()`, `createSetupIntent()`, `setDefault()`, `delete()`
Pricing	`client.pricing`	`get()`, `listPlans()`, `listSKUs()`
Audit Logs	`client.audit`	`listLogs()`, `listProjectLogs()`
IAM	`client.iam`	`listBindings()`, `createBinding()`, `listOrganizationBindings()`, `createOrganizationBinding()`, `removeBinding()`, `listRoles()`
Invitations	`client.invitations`	`list()`, `create()`, `delete()`
Notifications	`client.notifications`	`listPolicies()`, `createPolicy()`, `deletePolicy()`, `testPolicy()`
IP Allowlists (identities)	`client.ipAllowlists`	`list()`, `create()`, `delete()`
Demo	`client.demo`	`createSession()`

Direct HTTP Access

If an endpoint has not yet been wrapped with a resource method, you can call it directly. Requests carry the client’s credentials and throw APIError on a non-2xx status, like the resource methods.

`client.request<T>(path, options)`

Executes an authenticated HTTP request and automatically parses JSON response bodies:

const customData = await client.request<{ status: string }>("/v1/custom-endpoint", {
  method: "POST",
  body: JSON.stringify({ key: "value" }),
});

`client.requestRaw(path, options)`

Executes an authenticated request and returns the raw Response object (for streams, binary payloads, or CSV downloads):

// The usage CSV export (from/to are RFC 3339 timestamps)
const rawResponse = await client.requestRaw(
  client.billing.usageCsvUrl("2026-10-01T00:00:00Z", "2026-11-01T00:00:00Z", organizationId),
);
const csvText = await rawResponse.text();