@myapihq/sdk 1.3.8 → 1.3.12

package/dist/email.d.ts

@@ -106,6 +106,10 @@ export declare function createMailbox(apiKey: string, domain: string, username:
     address: string;
     created_at: string;
 }>;
+export declare function deleteMailbox(apiKey: string, address: string): Promise<void>;
+export declare function mailServerResync(apiKey: string, orgId: string, domain: string): Promise<{
+    ok: boolean;
+} & Record<string, unknown>>;
 export declare function listMailboxes(apiKey: string, options?: {
     domain?: string;
     filter?: 'unassigned';

package/dist/email.js

@@ -5,6 +5,8 @@ exports.verifyEmail = verifyEmail;
 exports.verifyBulk = verifyBulk;
 exports.getVerifyJob = getVerifyJob;
 exports.createMailbox = createMailbox;
+exports.deleteMailbox = deleteMailbox;
+exports.mailServerResync = mailServerResync;
 exports.listMailboxes = listMailboxes;
 exports.activateSending = activateSending;
 exports.setForwarding = setForwarding;
@@ -107,6 +109,20 @@ async function getVerifyJob(apiKey, orgId, jobId) {
 async function createMailbox(apiKey, domain, username, displayName) {
     return (0, client_1.request)('POST', `${config_1.EMAIL_BASE}/email/mailboxes/create`, apiKey, { domain, username, display_name: displayName });
 }
+// Backend (2026-06-06): idempotent — 204 whether the mailbox existed or not.
+// Returns 409 MAILBOX_IN_USE when an active/paused campaign still sends from
+// this address; pause/delete the campaign first.
+async function deleteMailbox(apiKey, address) {
+    return (0, client_1.request)('DELETE', `${config_1.EMAIL_BASE}/email/mailboxes/${encodeURIComponent(address)}`, apiKey);
+}
+// Backend (2026-06-06): re-run Stalwart provisioning for a domain. Use when
+// mailbox-create on a domain returns DOMAIN_NOT_MAIL_READY /
+// MAILBOX_PROVISION_FAILED, or when the inbox endpoint returns
+// "mail server error" on a domain whose `email_infra_ready` flag is stale.
+// Idempotent.
+async function mailServerResync(apiKey, orgId, domain) {
+    return (0, client_1.request)('POST', `${config_1.EMAIL_BASE}/email/orgs/${encodeURIComponent(orgId)}/domains/${encodeURIComponent(domain)}/mail-server-resync`, apiKey);
+}
 async function listMailboxes(apiKey, options) {
     const query = new URLSearchParams();
     if (options?.domain)

package/dist/funnel.d.ts

@@ -29,6 +29,11 @@ export interface CreateFunnelResponse {
     subdomain_url?: string;
     domain_url?: string;
 }
+export interface GetFunnelResponse {
+    funnel: Funnel;
+    subdomain_url?: string;
+    domain_url?: string;
+}
 export interface VerifyResult {
     pages?: Array<{
         slug: string;
@@ -45,7 +50,7 @@ export interface VerifyTest {
 export declare function createFunnel(apiKey: string, orgId: string, opts?: {
     name?: string;
 }): Promise<CreateFunnelResponse>;
-export declare function getFunnel(apiKey: string, orgId: string, funnelId: string): Promise<Funnel>;
+export declare function getFunnel(apiKey: string, orgId: string, funnelId: string): Promise<GetFunnelResponse>;
 export declare function listFunnels(apiKey: string, orgId: string): Promise<Funnel[]>;
 export declare function deleteFunnel(apiKey: string, orgId: string, funnelId: string): Promise<void>;
 export declare function pushFunnelPage(apiKey: string, orgId: string, funnelId: string, payload: {

package/dist/funnel.js

@@ -36,7 +36,14 @@ async function createFunnel(apiKey, orgId, opts) {
     return (0, client_1.request)('POST', `${config_1.FUNNEL_BASE}/funnel/orgs/${encodeURIComponent(orgId)}/funnels`, apiKey, opts?.name ? { name: opts.name } : {});
 }
 async function getFunnel(apiKey, orgId, funnelId) {
-    return (0, client_1.request)('GET', `${config_1.FUNNEL_BASE}/funnel/orgs/${encodeURIComponent(orgId)}/funnels/${encodeURIComponent(funnelId)}`, apiKey);
+    // Backend has wrapped GET responses since 2026-04 (`{funnel, subdomain_url, domain_url}`).
+    // Older builds returned a flat Funnel — normalize to the envelope so
+    // callers can rely on the typed shape.
+    const raw = await (0, client_1.request)('GET', `${config_1.FUNNEL_BASE}/funnel/orgs/${encodeURIComponent(orgId)}/funnels/${encodeURIComponent(funnelId)}`, apiKey);
+    if (raw && typeof raw === 'object' && 'funnel' in raw && raw.funnel) {
+        return raw;
+    }
+    return { funnel: raw };
 }
 async function listFunnels(apiKey, orgId) {
     return (0, client_1.request)('GET', `${config_1.FUNNEL_BASE}/funnel/orgs/${encodeURIComponent(orgId)}/funnels`, apiKey);

package/dist/hq.d.ts

@@ -74,6 +74,12 @@ export type FreeTierEntry = {
 };
 export declare function getFreeTier(apiKey: string): Promise<FreeTierEntry[] | null>;
 export declare function getAccount(apiKey: string): Promise<AccountInfo>;
+export declare function getMailingAddress(apiKey: string): Promise<{
+    mailing_address: string | null;
+}>;
+export declare function setMailingAddress(apiKey: string, mailingAddress: string): Promise<{
+    mailing_address: string;
+}>;
 export interface CreateApiKeyOptions {
     grants?: Grants;
     orgId?: string;

package/dist/hq.js

@@ -7,6 +7,8 @@ exports.verifyCode = verifyCode;
 exports.upgradeAccount = upgradeAccount;
 exports.getFreeTier = getFreeTier;
 exports.getAccount = getAccount;
+exports.getMailingAddress = getMailingAddress;
+exports.setMailingAddress = setMailingAddress;
 exports.createApiKey = createApiKey;
 exports.listApiKeys = listApiKeys;
 exports.revokeApiKey = revokeApiKey;
@@ -40,6 +42,11 @@ exports.EXPOSES = [
     'POST /hq/account/keys/revoke-all',
     'DELETE /hq/account/delete/key/{key_id}',
     'PATCH /hq/account/spend-cap',
+    // Backend (2026-06-06): account-scoped mailing address — required for
+    // transactional email per CAN-SPAM. PATCH sets, GET reads (null when
+    // unset). Hard-gates POST /email/send with MAILING_ADDRESS_REQUIRED.
+    'PATCH /hq/account/mailing-address',
+    'GET /hq/account/mailing-address',
     'POST /hq/orgs',
     'GET /hq/orgs',
     'GET /hq/orgs/{org_id}',
@@ -80,6 +87,14 @@ async function getFreeTier(apiKey) {
 async function getAccount(apiKey) {
     return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/account/me`, apiKey);
 }
+// Mailing address — required for transactional `email send` (CAN-SPAM).
+// `getMailingAddress` returns `null` for `mailing_address` when unset.
+async function getMailingAddress(apiKey) {
+    return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/account/mailing-address`, apiKey);
+}
+async function setMailingAddress(apiKey, mailingAddress) {
+    return (0, client_1.request)('PATCH', `${config_1.HQ_BASE}/hq/account/mailing-address`, apiKey, { mailing_address: mailingAddress });
+}
 // Mints a manual API key. The requested (grants, org, spend cap) must be a
 // subset of the calling key's authority — the backend rejects escalation
 // with 403 SCOPE_FORBIDDEN. The full `api_key` is in the response ONCE.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@myapihq/sdk",
   "license": "Apache-2.0",
-  "version": "1.3.8",
+  "version": "1.3.12",
   "description": "TypeScript SDK for the MyAPI ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/email.ts

@@ -137,6 +137,22 @@ export async function createMailbox(apiKey: string, domain: string, username: st
   return request('POST', `${BASE_URL}/email/mailboxes/create`, apiKey, { domain, username, display_name: displayName });
 }
 
+// Backend (2026-06-06): idempotent — 204 whether the mailbox existed or not.
+// Returns 409 MAILBOX_IN_USE when an active/paused campaign still sends from
+// this address; pause/delete the campaign first.
+export async function deleteMailbox(apiKey: string, address: string): Promise<void> {
+  return request('DELETE', `${BASE_URL}/email/mailboxes/${encodeURIComponent(address)}`, apiKey);
+}
+
+// Backend (2026-06-06): re-run Stalwart provisioning for a domain. Use when
+// mailbox-create on a domain returns DOMAIN_NOT_MAIL_READY /
+// MAILBOX_PROVISION_FAILED, or when the inbox endpoint returns
+// "mail server error" on a domain whose `email_infra_ready` flag is stale.
+// Idempotent.
+export async function mailServerResync(apiKey: string, orgId: string, domain: string): Promise<{ ok: boolean } & Record<string, unknown>> {
+  return request('POST', `${BASE_URL}/email/orgs/${encodeURIComponent(orgId)}/domains/${encodeURIComponent(domain)}/mail-server-resync`, apiKey);
+}
+
 export async function listMailboxes(apiKey: string, options?: { domain?: string; filter?: 'unassigned' }): Promise<{ address: string; created_at: string }[]> {
   const query = new URLSearchParams();
   if (options?.domain) query.append('domain', options.domain);

package/src/funnel.ts

@@ -55,6 +55,9 @@ export interface FormBinding {
   rate_limit?: { per_minute: number };
 }
 export interface CreateFunnelResponse { funnel: Funnel; subdomain_url?: string; domain_url?: string }
+// Same envelope shape on read — kept as its own name so call sites read
+// honestly. Wire shape is `{funnel: {...}, subdomain_url?, domain_url?}`.
+export interface GetFunnelResponse { funnel: Funnel; subdomain_url?: string; domain_url?: string }
 export interface VerifyResult {
   pages?: Array<{ slug: string; tests: VerifyTest[] }>;
   tests?: VerifyTest[];
@@ -66,8 +69,19 @@ export async function createFunnel(apiKey: string, orgId: string, opts?: { name?
   // matching the reserved-suffix rules; agent should pre-validate.
   return request('POST', `${BASE_URL}/funnel/orgs/${encodeURIComponent(orgId)}/funnels`, apiKey, opts?.name ? { name: opts.name } : {});
 }
-export async function getFunnel(apiKey: string, orgId: string, funnelId: string): Promise<Funnel> {
-  return request('GET', `${BASE_URL}/funnel/orgs/${encodeURIComponent(orgId)}/funnels/${encodeURIComponent(funnelId)}`, apiKey);
+export async function getFunnel(apiKey: string, orgId: string, funnelId: string): Promise<GetFunnelResponse> {
+  // Backend has wrapped GET responses since 2026-04 (`{funnel, subdomain_url, domain_url}`).
+  // Older builds returned a flat Funnel — normalize to the envelope so
+  // callers can rely on the typed shape.
+  const raw = await request<GetFunnelResponse | Funnel>(
+    'GET',
+    `${BASE_URL}/funnel/orgs/${encodeURIComponent(orgId)}/funnels/${encodeURIComponent(funnelId)}`,
+    apiKey,
+  );
+  if (raw && typeof raw === 'object' && 'funnel' in raw && (raw as GetFunnelResponse).funnel) {
+    return raw as GetFunnelResponse;
+  }
+  return { funnel: raw as Funnel };
 }
 export async function listFunnels(apiKey: string, orgId: string): Promise<Funnel[]> {
   return request('GET', `${BASE_URL}/funnel/orgs/${encodeURIComponent(orgId)}/funnels`, apiKey);

package/src/hq.ts

@@ -14,6 +14,11 @@ export const EXPOSES: Exposes = [
   'POST /hq/account/keys/revoke-all',
   'DELETE /hq/account/delete/key/{key_id}',
   'PATCH /hq/account/spend-cap',
+  // Backend (2026-06-06): account-scoped mailing address — required for
+  // transactional email per CAN-SPAM. PATCH sets, GET reads (null when
+  // unset). Hard-gates POST /email/send with MAILING_ADDRESS_REQUIRED.
+  'PATCH /hq/account/mailing-address',
+  'GET /hq/account/mailing-address',
   'POST /hq/orgs',
   'GET /hq/orgs',
   'GET /hq/orgs/{org_id}',
@@ -148,6 +153,16 @@ export async function getAccount(apiKey: string): Promise<AccountInfo> {
   return request('GET', `${BASE_URL}/hq/account/me`, apiKey);
 }
 
+// Mailing address — required for transactional `email send` (CAN-SPAM).
+// `getMailingAddress` returns `null` for `mailing_address` when unset.
+export async function getMailingAddress(apiKey: string): Promise<{ mailing_address: string | null }> {
+  return request('GET', `${BASE_URL}/hq/account/mailing-address`, apiKey);
+}
+
+export async function setMailingAddress(apiKey: string, mailingAddress: string): Promise<{ mailing_address: string }> {
+  return request('PATCH', `${BASE_URL}/hq/account/mailing-address`, apiKey, { mailing_address: mailingAddress });
+}
+
 export interface CreateApiKeyOptions {
   // Slot grants. Omitted → backend defaults to unrestricted ({"*":"write"}).
   grants?: Grants;