resend-cli 1.2.2 → 1.3.0

package/src/commands/topics/create.ts

@@ -1,73 +0,0 @@
-import { Command, Option } from '@commander-js/extra-typings';
-import { runCreate } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import { requireText } from '../../lib/prompts';
-
-export const createTopicCommand = new Command('create')
-  .description('Create a new topic for subscription management')
-  .option('--name <name>', 'Topic name (required)')
-  .option(
-    '--description <description>',
-    'Description shown to contacts when managing subscriptions',
-  )
-  .addOption(
-    new Option(
-      '--default-subscription <mode>',
-      'Default subscription state for contacts',
-    )
-      .choices(['opt_in', 'opt_out'] as const)
-      .default('opt_in' as const),
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Topics enable fine-grained subscription management. Contacts can opt in or out of
-individual topics. Broadcasts can target only contacts opted into a specific topic.
-
-Example topics: "Product Updates", "Security Alerts", "Weekly Digest".
-
---default-subscription controls what happens for contacts with no explicit subscription:
-  opt_in   Contacts receive broadcasts unless they explicitly opt out (default)
-  opt_out  Contacts do NOT receive broadcasts unless they explicitly opt in
-
-Non-interactive: --name is required.`,
-      output: `  {"id":"<uuid>"}`,
-      errorCodes: ['auth_error', 'missing_name', 'create_error'],
-      examples: [
-        'resend topics create --name "Product Updates"',
-        'resend topics create --name "Weekly Digest" --default-subscription opt_out',
-        'resend topics create --name "Security Alerts" --description "Critical security notices" --json',
-      ],
-    }),
-  )
-  .action(async (opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-
-    const name = await requireText(
-      opts.name,
-      { message: 'Topic name', placeholder: 'Product Updates' },
-      { message: 'Missing --name flag.', code: 'missing_name' },
-      globalOpts,
-    );
-
-    await runCreate(
-      {
-        spinner: {
-          loading: 'Creating topic...',
-          success: 'Topic created',
-          fail: 'Failed to create topic',
-        },
-        sdkCall: (resend) =>
-          resend.topics.create({
-            name,
-            defaultSubscription: opts.defaultSubscription,
-            ...(opts.description && { description: opts.description }),
-          }),
-        onInteractive: (data) => {
-          console.log(`\nTopic created: ${data.id}`);
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/topics/delete.ts

@@ -1,47 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runDelete } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-
-export const deleteTopicCommand = new Command('delete')
-  .alias('rm')
-  .description('Delete a topic')
-  .argument('<id>', 'Topic UUID')
-  .option(
-    '--yes',
-    'Skip the confirmation prompt (required in non-interactive mode)',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Warning: Deleting a topic removes all contact subscriptions to that topic and may affect
-  broadcasts that reference this topic_id. Contacts themselves are not deleted.
-
-Non-interactive: --yes is required to confirm deletion when stdin/stdout is not a TTY.`,
-      output: `  {"object":"topic","id":"<uuid>","deleted":true}`,
-      errorCodes: ['auth_error', 'confirmation_required', 'delete_error'],
-      examples: [
-        'resend topics delete 78261eea-8f8b-4381-83c6-79fa7120f1cf --yes',
-        'resend topics delete 78261eea-8f8b-4381-83c6-79fa7120f1cf --yes --json',
-      ],
-    }),
-  )
-  .action(async (id, opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runDelete(
-      id,
-      !!opts.yes,
-      {
-        confirmMessage: `Delete topic ${id}?\nAll contact subscriptions and broadcast associations will be removed.`,
-        spinner: {
-          loading: 'Deleting topic...',
-          success: 'Topic deleted',
-          fail: 'Failed to delete topic',
-        },
-        object: 'topic',
-        successMsg: 'Topic deleted.',
-        sdkCall: (resend) => resend.topics.remove(id),
-      },
-      globalOpts,
-    );
-  });

package/src/commands/topics/get.ts

@@ -1,42 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runGet } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-
-export const getTopicCommand = new Command('get')
-  .description('Retrieve a topic by ID')
-  .argument('<id>', 'Topic UUID')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      output: `  {"id":"<uuid>","name":"<name>","description":"<desc>","default_subscription":"opt_in|opt_out","created_at":"<iso-date>"}`,
-      errorCodes: ['auth_error', 'fetch_error'],
-      examples: [
-        'resend topics get 78261eea-8f8b-4381-83c6-79fa7120f1cf',
-        'resend topics get 78261eea-8f8b-4381-83c6-79fa7120f1cf --json',
-      ],
-    }),
-  )
-  .action(async (id, _opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runGet(
-      {
-        spinner: {
-          loading: 'Fetching topic...',
-          success: 'Topic fetched',
-          fail: 'Failed to fetch topic',
-        },
-        sdkCall: (resend) => resend.topics.get(id),
-        onInteractive: (data) => {
-          console.log(`\n${data.name}`);
-          console.log(`ID: ${data.id}`);
-          if (data.description) {
-            console.log(`Description: ${data.description}`);
-          }
-          console.log(`Default subscription: ${data.default_subscription}`);
-          console.log(`Created: ${data.created_at}`);
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/topics/index.ts

@@ -1,42 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { buildHelpText } from '../../lib/help-text';
-import { createTopicCommand } from './create';
-import { deleteTopicCommand } from './delete';
-import { getTopicCommand } from './get';
-import { listTopicsCommand } from './list';
-import { updateTopicCommand } from './update';
-
-export const topicsCommand = new Command('topics')
-  .description('Manage topics for contact subscription preferences')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Topics enable fine-grained subscription management beyond the global unsubscribe flag.
-A contact can opt in or out of individual topics independently.
-
-Broadcasts can target a topic_id so only contacts who have opted into that topic
-receive the email. Contacts with no subscription record use the topic's
-default_subscription setting.
-
-Subscription states:
-  opt_in   Contact will receive broadcasts for this topic
-  opt_out  Contact will NOT receive broadcasts for this topic
-
-Contact topic subscriptions are managed via the contacts namespace:
-  resend contacts topics <contactId>
-  resend contacts update-topics <contactId> --topic-id <id> --subscription opt_in`,
-      examples: [
-        'resend topics list',
-        'resend topics create --name "Product Updates"',
-        'resend topics create --name "Weekly Digest" --default-subscription opt_out',
-        'resend topics get 78261eea-8f8b-4381-83c6-79fa7120f1cf',
-        'resend topics update 78261eea-8f8b-4381-83c6-79fa7120f1cf --name "Security Alerts"',
-        'resend topics delete 78261eea-8f8b-4381-83c6-79fa7120f1cf --yes',
-      ],
-    }),
-  )
-  .addCommand(createTopicCommand)
-  .addCommand(getTopicCommand)
-  .addCommand(listTopicsCommand, { isDefault: true })
-  .addCommand(updateTopicCommand)
-  .addCommand(deleteTopicCommand);

package/src/commands/topics/list.ts

@@ -1,34 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runList } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import { renderTopicsTable } from './utils';
-
-export const listTopicsCommand = new Command('list')
-  .alias('ls')
-  .description('List all topics')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Returns all topics in your account. Topic subscription management for individual
-contacts is handled via "resend contacts topics <contactId>".`,
-      output: `  {"data":[{"id":"<uuid>","name":"<name>","description":"<desc>","default_subscription":"opt_in|opt_out","created_at":"<iso-date>"}]}`,
-      errorCodes: ['auth_error', 'list_error'],
-      examples: ['resend topics list', 'resend topics list --json'],
-    }),
-  )
-  .action(async (_opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runList(
-      {
-        spinner: {
-          loading: 'Fetching topics...',
-          success: 'Topics fetched',
-          fail: 'Failed to list topics',
-        },
-        sdkCall: (resend) => resend.topics.list(),
-        onInteractive: (list) => console.log(renderTopicsTable(list.data)),
-      },
-      globalOpts,
-    );
-  });

package/src/commands/topics/update.ts

@@ -1,59 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runWrite } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import { outputError } from '../../lib/output';
-
-export const updateTopicCommand = new Command('update')
-  .description("Update a topic's name or description")
-  .argument('<id>', 'Topic UUID')
-  .option('--name <name>', 'New topic name')
-  .option('--description <description>', 'New description shown to contacts')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `At least one of --name or --description must be provided to update the topic.
-
-Note: --default-subscription cannot be changed after creation.
-To change the default subscription, delete the topic and recreate it.`,
-      output: `  {"id":"<uuid>"}`,
-      errorCodes: ['auth_error', 'no_changes', 'update_error'],
-      examples: [
-        'resend topics update 78261eea-8f8b-4381-83c6-79fa7120f1cf --name "Security Alerts"',
-        'resend topics update 78261eea-8f8b-4381-83c6-79fa7120f1cf --description "Critical notices" --json',
-      ],
-    }),
-  )
-  .action(async (id, opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-
-    if (!opts.name && !opts.description) {
-      outputError(
-        {
-          message:
-            'Provide at least one option to update: --name or --description.',
-          code: 'no_changes',
-        },
-        { json: globalOpts.json },
-      );
-    }
-
-    await runWrite(
-      {
-        spinner: {
-          loading: 'Updating topic...',
-          success: 'Topic updated',
-          fail: 'Failed to update topic',
-        },
-        sdkCall: (resend) =>
-          resend.topics.update({
-            id,
-            ...(opts.name && { name: opts.name }),
-            ...(opts.description && { description: opts.description }),
-          }),
-        errorCode: 'update_error',
-        successMsg: `Topic updated: ${id}`,
-      },
-      globalOpts,
-    );
-  });

package/src/commands/topics/utils.ts

@@ -1,16 +0,0 @@
-import type { Topic } from 'resend';
-import { renderTable } from '../../lib/table';
-
-export function renderTopicsTable(topics: Topic[]): string {
-  const rows = topics.map((t) => [
-    t.name,
-    t.description ?? '',
-    t.id,
-    t.created_at,
-  ]);
-  return renderTable(
-    ['Name', 'Description', 'ID', 'Created'],
-    rows,
-    '(no topics)',
-  );
-}

package/src/commands/webhooks/create.ts

@@ -1,128 +0,0 @@
-import * as p from '@clack/prompts';
-import { Command } from '@commander-js/extra-typings';
-import type { WebhookEvent } from 'resend';
-import { runCreate } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import { outputError } from '../../lib/output';
-import { cancelAndExit, requireText } from '../../lib/prompts';
-import { isInteractive } from '../../lib/tty';
-import { ALL_WEBHOOK_EVENTS } from './utils';
-
-export const createWebhookCommand = new Command('create')
-  .description(
-    'Register a new webhook endpoint to receive real-time event notifications',
-  )
-  .option(
-    '--endpoint <endpoint>',
-    'HTTPS URL to receive webhook events (required)',
-  )
-  .option(
-    '--events <events...>',
-    'Event types to subscribe to. Use "all" as shorthand for all 17 events.',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Webhooks deliver real-time event notifications to your HTTPS endpoint.
-Events fire per-recipient: a batch email to 3 recipients generates 3 email.sent events.
-
---endpoint must use HTTPS.
-
---events accepts space-separated event types or the special value "all":
-  resend webhooks create --endpoint https://... --events email.sent email.delivered
-  resend webhooks create --endpoint https://... --events all
-
-Available event types (17 total):
-  Email:   email.sent, email.delivered, email.delivery_delayed, email.bounced,
-           email.complained, email.opened, email.clicked, email.failed,
-           email.scheduled, email.suppressed, email.received
-  Contact: contact.created, contact.updated, contact.deleted
-  Domain:  domain.created, domain.updated, domain.deleted
-
-The signing_secret in the response is shown ONCE — save it immediately to verify
-webhook payloads using Svix signature headers (svix-id, svix-timestamp, svix-signature).
-Use resend.webhooks.verify() in your application to validate incoming payloads.
-
-Non-interactive: --endpoint and --events are required.`,
-      output: `  {"object":"webhook","id":"<uuid>","signing_secret":"<whsec_...>"}`,
-      errorCodes: [
-        'auth_error',
-        'missing_endpoint',
-        'missing_events',
-        'create_error',
-      ],
-      examples: [
-        'resend webhooks create --endpoint https://app.example.com/hooks/resend --events all',
-        'resend webhooks create --endpoint https://app.example.com/hooks/resend --events email.sent email.bounced',
-        'resend webhooks create --endpoint https://app.example.com/hooks/resend --events all --json',
-      ],
-    }),
-  )
-  .action(async (opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-
-    const endpoint = await requireText(
-      opts.endpoint,
-      {
-        message: 'Webhook endpoint URL',
-        placeholder: 'https://your-app.com/webhooks/resend',
-        validate: (v) => {
-          if (!v) {
-            return 'Endpoint URL is required';
-          }
-          if (!v.startsWith('https://')) {
-            return 'Endpoint must use HTTPS';
-          }
-          return undefined;
-        },
-      },
-      { message: 'Missing --endpoint flag.', code: 'missing_endpoint' },
-      globalOpts,
-    );
-
-    let selectedEvents: WebhookEvent[];
-
-    if (opts.events?.includes('all')) {
-      selectedEvents = ALL_WEBHOOK_EVENTS;
-    } else if (opts.events?.length) {
-      selectedEvents = opts.events as WebhookEvent[];
-    } else {
-      if (!isInteractive()) {
-        outputError(
-          { message: 'Missing --events flag.', code: 'missing_events' },
-          { json: globalOpts.json },
-        );
-      }
-      const result = await p.multiselect({
-        message: 'Select event types to subscribe to',
-        options: ALL_WEBHOOK_EVENTS.map((e) => ({ value: e, label: e })),
-      });
-      if (p.isCancel(result)) {
-        cancelAndExit('Cancelled.');
-      }
-      selectedEvents = result;
-    }
-
-    await runCreate(
-      {
-        spinner: {
-          loading: 'Creating webhook...',
-          success: 'Webhook created',
-          fail: 'Failed to create webhook',
-        },
-        sdkCall: (resend) =>
-          resend.webhooks.create({
-            endpoint,
-            events: selectedEvents,
-          }),
-        onInteractive: (d) => {
-          console.log(`\nWebhook created`);
-          console.log(`ID:             ${d.id}`);
-          console.log(`Signing Secret: ${d.signing_secret}`);
-          console.log(`\nSave the signing secret — it is only shown once.`);
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/webhooks/delete.ts

@@ -1,49 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runDelete } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-
-export const deleteWebhookCommand = new Command('delete')
-  .alias('rm')
-  .description('Delete a webhook endpoint and stop all event deliveries to it')
-  .argument('<id>', 'Webhook UUID')
-  .option(
-    '--yes',
-    'Skip the confirmation prompt (required in non-interactive mode)',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Warning: Deleting a webhook immediately stops event delivery to the endpoint.
-  In-flight events may still be attempted once before the deletion takes effect.
-  To temporarily pause delivery without losing configuration, use:
-    resend webhooks update <id> --status disabled
-
-Non-interactive: --yes is required to confirm deletion when stdin/stdout is not a TTY.`,
-      output: `  {"object":"webhook","id":"<uuid>","deleted":true}`,
-      errorCodes: ['auth_error', 'confirmation_required', 'delete_error'],
-      examples: [
-        'resend webhooks delete wh_abc123 --yes',
-        'resend webhooks delete wh_abc123 --yes --json',
-      ],
-    }),
-  )
-  .action(async (id, opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runDelete(
-      id,
-      !!opts.yes,
-      {
-        confirmMessage: `Delete webhook ${id}?\nEvents will no longer be delivered to this endpoint.`,
-        spinner: {
-          loading: 'Deleting webhook...',
-          success: 'Webhook deleted',
-          fail: 'Failed to delete webhook',
-        },
-        object: 'webhook',
-        successMsg: 'Webhook deleted.',
-        sdkCall: (resend) => resend.webhooks.remove(id),
-      },
-      globalOpts,
-    );
-  });

package/src/commands/webhooks/get.ts

@@ -1,42 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runGet } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-
-export const getWebhookCommand = new Command('get')
-  .description('Retrieve a webhook endpoint configuration by ID')
-  .argument('<id>', 'Webhook UUID')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Note: The signing_secret is not returned by the get endpoint.
-To rotate secrets, delete the webhook and recreate it.`,
-      output: `  {"object":"webhook","id":"<uuid>","endpoint":"<url>","events":["<event>"],"status":"enabled|disabled","created_at":"<iso-date>","signing_secret":"<whsec_...>"}`,
-      errorCodes: ['auth_error', 'fetch_error'],
-      examples: [
-        'resend webhooks get wh_abc123',
-        'resend webhooks get wh_abc123 --json',
-      ],
-    }),
-  )
-  .action(async (id, _opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runGet(
-      {
-        spinner: {
-          loading: 'Fetching webhook...',
-          success: 'Webhook fetched',
-          fail: 'Failed to fetch webhook',
-        },
-        sdkCall: (resend) => resend.webhooks.get(id),
-        onInteractive: (d) => {
-          console.log(`\n${d.endpoint}`);
-          console.log(`ID:      ${d.id}`);
-          console.log(`Status:  ${d.status}`);
-          console.log(`Events:  ${(d.events ?? []).join(', ') || '(none)'}`);
-          console.log(`Created: ${d.created_at}`);
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/webhooks/index.ts

@@ -1,44 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { buildHelpText } from '../../lib/help-text';
-import { createWebhookCommand } from './create';
-import { deleteWebhookCommand } from './delete';
-import { getWebhookCommand } from './get';
-import { listWebhooksCommand } from './list';
-import { updateWebhookCommand } from './update';
-
-export const webhooksCommand = new Command('webhooks')
-  .description('Manage webhook endpoints for real-time event notifications')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Webhooks let you receive real-time event notifications from Resend at an HTTPS endpoint.
-Payloads are signed with Svix headers for verification.
-
-As of January 2026, webhook events fire per-recipient. A batch email to 3 recipients
-generates 3 email.sent events. The "to" field remains an array for backward compatibility
-but contains one entry per event.
-
-Event categories (17 total):
-  Email:   email.sent, email.delivered, email.delivery_delayed, email.bounced,
-           email.complained, email.opened, email.clicked, email.failed,
-           email.scheduled, email.suppressed, email.received
-  Contact: contact.created, contact.updated, contact.deleted
-  Domain:  domain.created, domain.updated, domain.deleted
-
-Signature verification (Svix):
-  Each delivery includes headers: svix-id, svix-timestamp, svix-signature
-  Verify payloads in your application using: resend.webhooks.verify({ payload, headers, webhookSecret })`,
-      examples: [
-        'resend webhooks list',
-        'resend webhooks create --endpoint https://app.example.com/hooks/resend --events all',
-        'resend webhooks get wh_abc123',
-        'resend webhooks update wh_abc123 --status disabled',
-        'resend webhooks delete wh_abc123 --yes',
-      ],
-    }),
-  )
-  .addCommand(createWebhookCommand)
-  .addCommand(getWebhookCommand)
-  .addCommand(listWebhooksCommand, { isDefault: true })
-  .addCommand(updateWebhookCommand)
-  .addCommand(deleteWebhookCommand);

package/src/commands/webhooks/list.ts

@@ -1,55 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runList } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import {
-  buildPaginationOpts,
-  parseLimitOpt,
-  printPaginationHint,
-} from '../../lib/pagination';
-import { renderWebhooksTable } from './utils';
-
-export const listWebhooksCommand = new Command('list')
-  .alias('ls')
-  .description('List all registered webhook endpoints')
-  .option('--limit <n>', 'Maximum number of webhooks to return (1-100)', '10')
-  .option('--after <cursor>', 'Return webhooks after this cursor (next page)')
-  .option(
-    '--before <cursor>',
-    'Return webhooks before this cursor (previous page)',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Pagination: use --after or --before with a webhook ID as the cursor.
-Only one of --after or --before may be used at a time.
-The response includes has_more: true when additional pages exist.`,
-      output: `  {"object":"list","data":[{"id":"<uuid>","endpoint":"<url>","events":["<event>"],"status":"enabled","created_at":"<iso-date>"}],"has_more":false}`,
-      errorCodes: ['auth_error', 'invalid_limit', 'list_error'],
-      examples: [
-        'resend webhooks list',
-        'resend webhooks list --limit 25 --json',
-        'resend webhooks list --after wh_abc123 --json',
-      ],
-    }),
-  )
-  .action(async (opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    const limit = parseLimitOpt(opts.limit, globalOpts);
-    const paginationOpts = buildPaginationOpts(limit, opts.after, opts.before);
-    await runList(
-      {
-        spinner: {
-          loading: 'Fetching webhooks...',
-          success: 'Webhooks fetched',
-          fail: 'Failed to list webhooks',
-        },
-        sdkCall: (resend) => resend.webhooks.list(paginationOpts),
-        onInteractive: (list) => {
-          console.log(renderWebhooksTable(list.data));
-          printPaginationHint(list);
-        },
-      },
-      globalOpts,
-    );
-  });