management

@sendmux/management

Generated TypeScript client for the Sendmux Management API.

Documentation

• Management API reference: sendmux.ai/docs/api/introduction
• Source repository: Sendmux/sendmux-sdk

Requirements

• A root Sendmux API key with the smx_root_* prefix.
• A JavaScript runtime with the standard Fetch API.

Installation

npm install @sendmux/management

Usage

import {
  createManagementClient,
  managementListDomains,
} from "@sendmux/management";

const client = createManagementClient({
  apiKey: process.env.SENDMUX_API_KEY!,
});

const domains = await managementListDomains({ client });

console.log(domains.data);

The package exports every generated Management operation plus:

• createManagementClient
• configureManagement
• ManagementClient

Conditional requests

Use conditionalHeaders from @sendmux/core for operations that accept If-Match or If-None-Match.

import { conditionalHeaders } from "@sendmux/core";
import {
  createManagementClient,
  managementGetDomain,
} from "@sendmux/management";

const client = createManagementClient({
  apiKey: process.env.SENDMUX_API_KEY!,
});

const domain = await managementGetDomain({
  client,
  path: { public_id: "mdom_123" },
  headers: conditionalHeaders({ ifNoneMatch: 'W/"etag"' }),
});

console.log(domain.data);

Support

Open an issue in Sendmux/sendmux-sdk with the package name, version, and request ID from any API error.

Licence

MIT. See the licence file.