@cakemail-org/cakemail-cli 1.7.0 → 2.0.0

package/src/commands/transactional-emails.ts

@@ -0,0 +1,374 @@
+// ABOUTME: CLI commands for Transactional 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 createTransactionalEmailsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('transactional-emails')
+    .description('Send transactional emails using templates. Transactional emails are one-to-one messages triggered by user actions (order confirmations, password resets, notifications). Create reusable templates with merge tags, then send them to individual contacts. Includes deprecated template-based endpoints — for new integrations, use the Email API.');
+
+
+  cmd
+    .command('send-email')
+    .description('Send an email')
+    .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('Creating transactional email...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.sendEmail({
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Transactional Email created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-emails-stats')
+    .description('Show email stats')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--start-time <value>', 'Start time for the report.')
+    .requiredOption('--end-time <value>', 'End time for the report.')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching transactional email...').start();
+      try {
+        const data = await client.getEmailsStats({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-email-logs')
+    .description('Show email activity logs')
+    .requiredOption('--log-type <value>', 'log_type')
+    .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('--start-time <value>', 'Start time for the report.')
+    .option('--end-time <value>', 'End time for the report.')
+    .option('--filter <value>', 'Valid Terms:
+  - `group_id`
+  - `email`
+  - `email_id`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching transactional email...').start();
+      try {
+        const data = await client.getEmailLogs({
+          logType: options.logType,
+          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,
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+          filter: options.filter,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-email-group-ids')
+    .description('List Email Group Ids')
+    .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 transactional email...').start();
+      try {
+        const data = await client.listEmailGroupIds({
+          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('patch-email-group-id <group-id>')
+    .description('Edit an Email Group Id')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--description <value>', 'description')
+    .action(async (group_id, options) => {
+      const spinner = createSpinner('Updating transactional email...').start();
+      try {
+        const data = await client.patchEmailGroupId({
+          group_id: Number(group_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          description: options.description,
+        });
+
+        spinner.stop();
+        formatter.success('Transactional Email updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-transactional-email-templates <list-id>')
+    .description('List Transactional Email Templates')
+    .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 (list_id, options) => {
+      const spinner = createSpinner('Fetching transactional email...').start();
+      try {
+        const data = await client.listTransactionalEmailTemplates({
+          list_id: Number(list_id),
+          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-transactional-email-template <list-id>')
+    .description('Create a Transactional Email Template')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Creating transactional email...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createTransactionalEmailTemplate({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Transactional Email created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('show-transactional-email-template <list-id> <transactional-email-template-id>')
+    .description('Show a Transactional Email Template')
+    .option('--account-id <value>', 'account_id')
+    .action(async (list_id, transactional_email_template_id, options) => {
+      const spinner = createSpinner('Fetching transactional email...').start();
+      try {
+        const data = await client.showTransactionalEmailTemplate({
+          list_id: Number(list_id),
+          transactional_email_template_id: Number(transactional_email_template_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('update-transactional-email-template <list-id> <transactional-email-template-id>')
+    .description('Update a Transactional Email Template')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (list_id, transactional_email_template_id, options) => {
+      const spinner = createSpinner('Updating transactional email...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.updateTransactionalEmailTemplate({
+          list_id: Number(list_id),
+          transactional_email_template_id: Number(transactional_email_template_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Transactional Email updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete-transactional-email-template <list-id> <transactional-email-template-id>')
+    .description('Delete a Transactional Email Template')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (list_id, transactional_email_template_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('transactional email', list_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting transactional email...').start();
+      try {
+        const data = await client.deleteTransactionalEmailTemplate({
+          list_id: Number(list_id),
+          transactional_email_template_id: Number(transactional_email_template_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Transactional Email deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('send-transactional-email <list-id> <transactional-email-template-id>')
+    .description('Send a Transactional Email from a Template to a contact')
+    .option('--account-id <value>', 'account_id')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (list_id, transactional_email_template_id, options) => {
+      const spinner = createSpinner('Creating transactional email...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.sendTransactionalEmail({
+          list_id: Number(list_id),
+          transactional_email_template_id: Number(transactional_email_template_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Transactional Email created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('send-test-transactional-email <list-id> <transactional-email-template-id>')
+    .description('Send a Test Transactional Email from a Template')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--email <value>', 'email')
+    .action(async (list_id, transactional_email_template_id, options) => {
+      const spinner = createSpinner('Creating transactional email...').start();
+      try {
+        const data = await client.sendTestTransactionalEmail({
+          list_id: Number(list_id),
+          transactional_email_template_id: Number(transactional_email_template_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          email: options.email,
+        });
+
+        spinner.stop();
+        formatter.success('Transactional Email created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('render-transactional-email-template <list-id> <transactional-email-template-id>')
+    .description('Render a Transactional Email Template')
+    .option('--account-id <value>', 'account_id')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (list_id, transactional_email_template_id, options) => {
+      const spinner = createSpinner('Creating transactional email...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.renderTransactionalEmailTemplate({
+          list_id: Number(list_id),
+          transactional_email_template_id: Number(transactional_email_template_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Transactional Email created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}