@cakemail-org/cakemail-cli 1.5.0 → 2.0.0

package/src/commands/suppressed-emails.ts

@@ -0,0 +1,234 @@
+// ABOUTME: CLI commands for Suppressed Email.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+import { confirmDelete } from '../utils/confirm.js';
+
+export function createSuppressedEmailsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('suppressed-emails')
+    .description('Manage the account-level email suppression list. Suppressed emails are blocked from receiving any messages. Includes export functionality for bulk data extraction.');
+
+
+  cmd
+    .command('list-suppressed-emails')
+    .description('Show all suppressed emails')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--with-count <value>', 'Include count in the response')
+    .option('--filter <value>', 'Valid Terms:
+  - `email`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching suppressed email...').start();
+      try {
+        const data = await client.listSuppressedEmails({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          withCount: options.withCount,
+          filter: options.filter,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create-suppressed-email')
+    .description('Add a suppressed email')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--email <value>', 'Full email, a local part wildcard or a domain wildcard.  Examples: *@hotmail.com, john@*, john@hotmail.com')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating suppressed email...').start();
+      try {
+        const data = await client.createSuppressedEmail({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          email: options.email,
+        });
+
+        spinner.stop();
+        formatter.success('Suppressed Email created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete-suppressed-email <email>')
+    .description('Delete a suppressed email')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (email, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('suppressed email', email);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting suppressed email...').start();
+      try {
+        const data = await client.deleteSuppressedEmail({
+          email,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Suppressed Email deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-suppressed-emails-export')
+    .description('Show all Suppressed Emails Export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--with-count <value>', 'Include count in the response')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching suppressed email...').start();
+      try {
+        const data = await client.listSuppressedEmailsExport({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          withCount: options.withCount,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create-suppressed-emails-export')
+    .description('Create a Suppressed Emails Export')
+    .option('--description <value>', 'description')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating suppressed email...').start();
+      try {
+        const data = await client.createSuppressedEmailsExport({
+          description: options.description,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Suppressed Email created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-suppressed-emails-export <export-id>')
+    .description('Show a Suppressed Emails Export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (export_id, options) => {
+      const spinner = createSpinner('Fetching suppressed email...').start();
+      try {
+        const data = await client.getSuppressedEmailsExport({
+          export_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete-suppressed-emails-export <export-id>')
+    .description('Delete a Suppressed Emails Export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (export_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('suppressed email', export_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting suppressed email...').start();
+      try {
+        const data = await client.deleteSuppressedEmailsExport({
+          export_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Suppressed Email deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('suppressed-emails-export-download <export-id>')
+    .description('Download a suppressed emails export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (export_id, options) => {
+      const spinner = createSpinner('Fetching suppressed email...').start();
+      try {
+        const data = await client.suppressedEmailsExportDownload({
+          export_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/suppressed.ts

@@ -0,0 +1,198 @@
+import { Command } from 'commander';
+import { CakemailClient } from '../client.js';
+import { OutputFormatter } from '../utils/output.js';
+import ora from '../utils/spinner.js';
+import { confirmDelete } from '../utils/confirm.js';
+
+export function createSuppressedCommand(client: CakemailClient, formatter: OutputFormatter): Command {
+  const suppressed = new Command('suppressed')
+    .description('Manage suppressed email addresses');
+
+  // List suppressed emails
+  suppressed
+    .command('list')
+    .description('List all suppressed email addresses')
+    .option('-l, --limit <number>', 'Limit number of results')
+    .option('-p, --page <number>', 'Page number')
+    .action(async (options) => {
+      const spinner = ora('Fetching suppressed emails...').start();
+      try {
+        const params: any = {};
+        if (options.limit) params.per_page = parseInt(options.limit);
+        if (options.page) params.page = parseInt(options.page);
+
+        const data = await client.sdk.suppressedEmailService.listSuppressedEmails(params);
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Add suppressed email
+  suppressed
+    .command('add <email>')
+    .description('Add an email to the suppression list')
+    .action(async (email) => {
+      const spinner = ora(`Adding ${email} to suppression list...`).start();
+      try {
+        const data = await client.sdk.suppressedEmailService.createSuppressedEmail({
+          requestBody: { email }
+        });
+        spinner.stop();
+        formatter.success(`Email ${email} added to suppression list`);
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Delete suppressed email
+  suppressed
+    .command('delete <email>')
+    .description('Remove an email from the suppression list')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (email, options) => {
+      // Interactive confirmation (unless --force is used)
+      if (!options.force) {
+        const confirmed = await confirmDelete('suppressed email', email, [
+          'Email will be removed from the suppression list',
+          'This email address will be able to receive emails again'
+        ]);
+
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = ora(`Removing ${email} from suppression list...`).start();
+      try {
+        await client.sdk.suppressedEmailService.deleteSuppressedEmail({ email });
+        spinner.stop();
+        formatter.success(`Email ${email} removed from suppression list`);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // List suppressed emails exports
+  suppressed
+    .command('exports')
+    .description('List suppressed emails exports')
+    .option('-l, --limit <number>', 'Limit number of results')
+    .option('-p, --page <number>', 'Page number')
+    .action(async (options) => {
+      const spinner = ora('Fetching exports...').start();
+      try {
+        const params: any = {};
+        if (options.limit) params.per_page = parseInt(options.limit);
+        if (options.page) params.page = parseInt(options.page);
+
+        const data = await client.sdk.suppressedEmailService.listSuppressedEmailsExport(params);
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Create export
+  suppressed
+    .command('export')
+    .description('Create a suppressed emails export')
+    .action(async () => {
+      const spinner = ora('Creating suppressed emails export...').start();
+      try {
+        const data = await client.sdk.suppressedEmailService.createSuppressedEmailsExport({});
+        spinner.stop();
+        formatter.success('Suppressed emails export created');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Get export
+  suppressed
+    .command('export-get <export-id>')
+    .description('Get a suppressed emails export status')
+    .action(async (exportId) => {
+      const spinner = ora(`Fetching export ${exportId}...`).start();
+      try {
+        const data = await client.sdk.suppressedEmailService.getSuppressedEmailsExport({
+          exportId: exportId
+        });
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Download export
+  suppressed
+    .command('export-download <export-id>')
+    .description('Download a suppressed emails export')
+    .action(async (exportId) => {
+      const spinner = ora(`Downloading export ${exportId}...`).start();
+      try {
+        const data = await client.sdk.suppressedEmailService.suppressedEmailsExportDownload({
+          exportId: exportId
+        });
+        spinner.stop();
+        formatter.success('Export downloaded');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Delete export
+  suppressed
+    .command('export-delete <export-id>')
+    .description('Delete a suppressed emails export')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (exportId, options) => {
+      // Interactive confirmation (unless --force is used)
+      if (!options.force) {
+        const confirmed = await confirmDelete('suppressed emails export', exportId, [
+          'Export file will be permanently deleted'
+        ]);
+
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = ora(`Deleting export ${exportId}...`).start();
+      try {
+        await client.sdk.suppressedEmailService.deleteSuppressedEmailsExport({
+          exportId: exportId
+        });
+        spinner.stop();
+        formatter.success(`Export ${exportId} deleted`);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  return suppressed;
+}

package/src/commands/system-emails.ts

@@ -0,0 +1,85 @@
+// ABOUTME: CLI commands for System Email.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+
+export function createSystemEmailsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('system-emails')
+    .description('Configure system-generated emails such as double opt-in confirmations, welcome messages, and unsubscribe confirmations. System emails can be customized per language.');
+
+
+  cmd
+    .command('show-system-emails')
+    .description('Show system emails configuration')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching system email...').start();
+      try {
+        const data = await client.showSystemEmails({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('set-system-emails')
+    .description('Set system emails configuration')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (options) => {
+      const spinner = createSpinner('Updating system email...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.setSystemEmails({
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('System Email updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('patch-system-emails')
+    .description('Update system emails configuration')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (options) => {
+      const spinner = createSpinner('Updating system email...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchSystemEmails({
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('System Email updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/tags.ts

@@ -0,0 +1,146 @@
+// ABOUTME: CLI commands for Tags.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+import { confirmDelete } from '../utils/confirm.js';
+
+export function createTagsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('tags')
+    .description('Manage contact tags for flexible organization and segmentation. Tags are simple labels that can be attached to contacts for grouping and filtering.');
+
+
+  cmd
+    .command('show <tag>')
+    .description('Show a Contact Tag')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (tag, options) => {
+      const spinner = createSpinner('Fetching tags...').start();
+      try {
+        const data = await client.showTag({
+          tag,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('patch <tag>')
+    .description('Edit a Contact Tag')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--tag <value>', 'tag')
+    .action(async (tag, options) => {
+      const spinner = createSpinner('Updating tags...').start();
+      try {
+        const data = await client.patchTag({
+          tag,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          tag: options.tag,
+        });
+
+        spinner.stop();
+        formatter.success('Tags updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <tag>')
+    .description('Delete a Contact Tag')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (tag, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('tags', tag);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting tags...').start();
+      try {
+        const data = await client.deleteTag({
+          tag,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Tags deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list')
+    .description('List Contact Tags')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--with-count <value>', 'Include count in the response')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching tags...').start();
+      try {
+        const data = await client.listTags({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          withCount: options.withCount,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create')
+    .description('Create a Contact Tag')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--tag <value>', 'tag')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating tags...').start();
+      try {
+        const data = await client.createTag({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          tag: options.tag,
+        });
+
+        spinner.stop();
+        formatter.success('Tags created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}