@cakemail-org/cakemail-cli 1.7.0 → 2.0.0

package/src/commands/campaigns.ts

@@ -0,0 +1,469 @@
+// ABOUTME: CLI commands for Campaign.
+// 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 createCampaignsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('campaigns')
+    .description('Create and manage email campaigns. A campaign combines content (from a template or custom HTML), an audience (a list or segment), and a sender identity. Campaigns go through a lifecycle: incomplete → scheduled → delivering → delivered. They can also be active (ready to schedule), suspended, resumed, canceled, archived, or deleted. Send test emails before scheduling to preview the final result.');
+
+
+  cmd
+    .command('list')
+    .description('Show all campaigns')
+    .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:
+  - `status`
+  - `name`
+  - `type`
+  - `list_id`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `name`
+  - `created_on`
+  - `scheduled_for`
+  - `scheduled_on`
+  - `updated_on`
+  - `type`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching campaign...').start();
+      try {
+        const data = await client.listCampaigns({
+          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,
+          sort: options.sort,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create')
+    .description('Create a campaign')
+    .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 campaign...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createCampaign({
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <campaign-id>')
+    .description('Show a campaign details')
+    .option('--revision-id <value>', 'revision_id')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Fetching campaign...').start();
+      try {
+        const data = await client.getCampaign({
+          campaign_id: Number(campaign_id),
+          revisionId: options.revisionId != null ? Number(options.revisionId) : undefined,
+          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 <campaign-id>')
+    .description('Update a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Updating campaign...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchCampaign({
+          campaign_id: Number(campaign_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <campaign-id>')
+    .description('Delete a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (campaign_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('campaign', campaign_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting campaign...').start();
+      try {
+        const data = await client.deleteCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('render <campaign-id>')
+    .description('Render a campaign')
+    .option('--contact-id <value>', 'contact_id')
+    .option('--account-id <value>', 'account_id')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Fetching campaign...').start();
+      try {
+        const data = await client.renderCampaign({
+          campaign_id: Number(campaign_id),
+          contactId: options.contactId != null ? Number(options.contactId) : undefined,
+          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('send-test-email <campaign-id>')
+    .description('Send a test email')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--email <value>', 'email')
+    .option('--type <value>', 'type')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.sendTestEmail({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          email: options.email,
+          type: options.type,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('schedule <campaign-id>')
+    .description('Schedule a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--date <value>', 'A UNIX timestamp in the future')
+    .option('--html-empty <value>', 'Required to be true if the html message is empty')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.scheduleCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          date: options.date != null ? Number(options.date) : undefined,
+          htmlEmpty: options.htmlEmpty,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('unschedule <campaign-id>')
+    .description('Unschedule a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.unscheduleCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('reschedule <campaign-id>')
+    .description('Reschedule a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--date <value>', 'A UNIX timestamp in the future')
+    .option('--html-empty <value>', 'Required to be true if the html message is empty')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.rescheduleCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          date: options.date != null ? Number(options.date) : undefined,
+          htmlEmpty: options.htmlEmpty,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('suspend <campaign-id>')
+    .description('Suspend a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.suspendCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('resume <campaign-id>')
+    .description('Resume a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.resumeCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('cancel <campaign-id>')
+    .description('Cancel a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.cancelCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('archive <campaign-id>')
+    .description('Archive a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.archiveCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('unarchive <campaign-id>')
+    .description('Unarchive a campaign')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating campaign...').start();
+      try {
+        const data = await client.unarchiveCampaign({
+          campaign_id: Number(campaign_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Campaign created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-campaign-revisions <campaign-id>')
+    .description('Show all campaign revisions')
+    .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 (campaign_id, options) => {
+      const spinner = createSpinner('Fetching campaign...').start();
+      try {
+        const data = await client.getCampaignRevisions({
+          campaign_id: Number(campaign_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('list-links <campaign-id>')
+    .description('Show a campaign links')
+    .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 (campaign_id, options) => {
+      const spinner = createSpinner('Fetching campaign...').start();
+      try {
+        const data = await client.listLinks({
+          campaign_id: Number(campaign_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);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/config.ts

@@ -0,0 +1,77 @@
+// ABOUTME: Config management commands for the CLI.
+// ABOUTME: Show, set, and manage profile and default settings.
+
+import { Command } from 'commander';
+import { loadConfigFile, updateConfigFile, setCurrentProfile, getCurrentProfile, getDefaults, setDefault } from '../utils/config-file.js';
+import { getProfileConfig, type ProfileType } from '../types/profile.js';
+
+export function createConfigCommand(): Command {
+  const cmd = new Command('config')
+    .description('Manage CLI configuration');
+
+  cmd
+    .command('show')
+    .description('Show current configuration')
+    .action(() => {
+      const config = loadConfigFile();
+      if (!config) {
+        console.log('No configuration file found. Using defaults.');
+        console.log(`Profile: ${getCurrentProfile()}`);
+        return;
+      }
+      console.log(JSON.stringify(config, null, 2));
+    });
+
+  cmd
+    .command('set <key> <value>')
+    .description('Set a configuration value')
+    .action((key: string, value: string) => {
+      if (key === 'profile') {
+        const valid: ProfileType[] = ['developer', 'marketer', 'balanced'];
+        if (!valid.includes(value as ProfileType)) {
+          console.error(`Invalid profile: ${value}. Valid: ${valid.join(', ')}`);
+          process.exit(1);
+        }
+        setCurrentProfile(value as ProfileType);
+        console.log(`Profile set to: ${value}`);
+      } else if (key === 'default.list_id') {
+        setDefault('list_id', Number(value));
+        console.log(`Default list ID set to: ${value}`);
+      } else if (key === 'default.sender_id') {
+        setDefault('sender_id', Number(value));
+        console.log(`Default sender ID set to: ${value}`);
+      } else if (key === 'default.account_id') {
+        setDefault('account_id', Number(value));
+        console.log(`Default account ID set to: ${value}`);
+      } else {
+        console.error(`Unknown config key: ${key}`);
+        console.error('Valid keys: profile, default.list_id, default.sender_id, default.account_id');
+        process.exit(1);
+      }
+    });
+
+  cmd
+    .command('profile [type]')
+    .description('Show or set the active profile')
+    .action((type?: string) => {
+      if (!type) {
+        const current = getCurrentProfile();
+        const config = getProfileConfig(current);
+        console.log(`Active profile: ${current}`);
+        console.log(`  Output format: ${config.output.format}`);
+        console.log(`  Colors: ${config.output.colors}`);
+        console.log(`  Interactive: ${config.behavior.interactive_prompts}`);
+        console.log(`  Date format: ${config.display.date_format}`);
+        return;
+      }
+      const valid: ProfileType[] = ['developer', 'marketer', 'balanced'];
+      if (!valid.includes(type as ProfileType)) {
+        console.error(`Invalid profile: ${type}. Valid: ${valid.join(', ')}`);
+        process.exit(1);
+      }
+      setCurrentProfile(type as ProfileType);
+      console.log(`Profile set to: ${type}`);
+    });
+
+  return cmd;
+}