@cakemail-org/cakemail-cli 1.5.0 → 2.0.0

package/src/commands/actions.ts

@@ -0,0 +1,249 @@
+// ABOUTME: CLI commands for Action.
+// 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 createActionsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('actions')
+    .description('Action');
+
+
+  cmd
+    .command('list <workflow-id>')
+    .description('List actions')
+    .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('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `name`
+  - `created_on`')
+    .action(async (workflow_id, options) => {
+      const spinner = createSpinner('Fetching action...').start();
+      try {
+        const data = await client.listActions({
+          workflow_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,
+          sort: options.sort,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create <workflow-id>')
+    .description('Create an action')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (workflow_id, options) => {
+      const spinner = createSpinner('Creating action...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createAction({
+          workflow_id,
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Action created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <workflow-id> <action-id>')
+    .description('Get an action')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .action(async (workflow_id, action_id, options) => {
+      const spinner = createSpinner('Fetching action...').start();
+      try {
+        const data = await client.getAction({
+          workflow_id,
+          action_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          lockKey: options.lockKey,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('patch <action-id> <workflow-id>')
+    .description('Update an action')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (action_id, workflow_id, options) => {
+      const spinner = createSpinner('Updating action...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchAction({
+          action_id,
+          workflow_id,
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Action updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <action-id> <workflow-id>')
+    .description('Delete an action')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (action_id, workflow_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('action', action_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting action...').start();
+      try {
+        const data = await client.deleteAction({
+          action_id,
+          workflow_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          lockKey: options.lockKey,
+        });
+
+        spinner.stop();
+        formatter.success('Action deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('render <workflow-id> <action-id>')
+    .description('Render an action')
+    .option('--contact-id <value>', 'contact_id')
+    .option('--account-id <value>', 'account_id')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .action(async (workflow_id, action_id, options) => {
+      const spinner = createSpinner('Fetching action...').start();
+      try {
+        const data = await client.renderAction({
+          workflow_id,
+          action_id,
+          contactId: options.contactId != null ? Number(options.contactId) : undefined,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          lockKey: options.lockKey,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('send-test <workflow-id> <action-id>')
+    .description('Send a test of an action')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--lock-key <value>', 'Locking key, preventing other users from modifying this workflow for a short period.')
+    .requiredOption('--email <value>', 'email')
+    .option('--type <value>', 'type')
+    .action(async (workflow_id, action_id, options) => {
+      const spinner = createSpinner('Creating action...').start();
+      try {
+        const data = await client.sendTestAction({
+          workflow_id,
+          action_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          lockKey: options.lockKey,
+          email: options.email,
+          type: options.type,
+        });
+
+        spinner.stop();
+        formatter.success('Action created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-action-links <action-id> <workflow-id>')
+    .description('Show action 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 (action_id, workflow_id, options) => {
+      const spinner = createSpinner('Fetching action...').start();
+      try {
+        const data = await client.listActionLinks({
+          action_id,
+          workflow_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/attributes.ts

@@ -0,0 +1,139 @@
+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';
+import { autoDetectList } from '../utils/defaults.js';
+
+export function createAttributesCommand(client: CakemailClient, formatter: OutputFormatter): Command {
+  const attributes = new Command('attributes')
+    .description('Manage custom attributes (custom fields)');
+
+  // List attributes
+  attributes
+    .command('list [list-id]')
+    .description('List all custom attributes for a list (auto-detects if only one list exists)')
+    .action(async (listId) => {
+      // Auto-detect list ID if not provided
+      const detectedListId = await autoDetectList(client, formatter, listId, { useCache: true });
+
+      if (!detectedListId) {
+        process.exit(1);
+      }
+
+      const spinner = ora('Fetching custom attributes...').start();
+      try {
+        const data = await client.sdk.customAttributeService.listCustomAttributes({
+          listId: detectedListId
+        });
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Get attribute
+  attributes
+    .command('get [list-id] <name>')
+    .description('Get custom attribute details (auto-detects if only one list exists)')
+    .action(async (listId, name) => {
+      // Auto-detect list ID if not provided
+      const detectedListId = await autoDetectList(client, formatter, listId, { useCache: true });
+
+      if (!detectedListId) {
+        process.exit(1);
+      }
+
+      const spinner = ora(`Fetching attribute ${name}...`).start();
+      try {
+        const data = await client.sdk.customAttributeService.getCustomAttribute({
+          listId: detectedListId,
+          name
+        });
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Create attribute
+  attributes
+    .command('create [list-id]')
+    .description('Create a new custom attribute (auto-detects if only one list exists)')
+    .requiredOption('-n, --name <name>', 'Attribute name')
+    .requiredOption('-t, --type <type>', 'Attribute type (text, number, date, boolean)')
+    .action(async (listId, options) => {
+      // Auto-detect list ID if not provided
+      const detectedListId = await autoDetectList(client, formatter, listId, { useCache: true });
+
+      if (!detectedListId) {
+        process.exit(1);
+      }
+
+      const spinner = ora('Creating custom attribute...').start();
+      try {
+        const data = await client.sdk.customAttributeService.createCustomAttribute({
+          listId: detectedListId,
+          requestBody: {
+            name: options.name,
+            type: options.type
+          }
+        });
+        spinner.stop();
+        formatter.success(`Custom attribute created: ${options.name}`);
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  // Delete attribute
+  attributes
+    .command('delete [list-id] <name>')
+    .description('Delete a custom attribute (auto-detects if only one list exists)')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (listId, name, options) => {
+      // Auto-detect list ID if not provided
+      const detectedListId = await autoDetectList(client, formatter, listId, { useCache: true });
+
+      if (!detectedListId) {
+        process.exit(1);
+      }
+
+      // Interactive confirmation (unless --force is used)
+      if (!options.force) {
+        const confirmed = await confirmDelete('custom attribute', name, [
+          'Attribute and all its data will be deleted from all contacts'
+        ]);
+
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = ora(`Deleting attribute ${name}...`).start();
+      try {
+        await client.sdk.customAttributeService.deleteCustomAttribute({
+          listId: detectedListId,
+          name
+        });
+        spinner.stop();
+        formatter.success(`Attribute ${name} deleted`);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+  return attributes;
+}

package/src/commands/campaign-blueprints.ts

@@ -0,0 +1,106 @@
+// ABOUTME: CLI commands for Campaign Blueprint.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+
+export function createCampaignBlueprintsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('campaign-blueprints')
+    .description('Browse pre-built campaign blueprints. Blueprints are ready-made campaign designs that can be used as starting points for new campaigns.');
+
+
+  cmd
+    .command('list-campaign-blueprints')
+    .description('Show all campaign blueprints')
+    .option('--account-id <value>', 'account_id')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--with-count <value>', 'Include count in the response')
+    .option('--filter <value>', 'Valid Terms:
+  - `tag`
+  - `not_tag`
+  - `name`
+  - `is_owner`
+  - `is_not_owner`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `id`
+  - `created_on`
+  - `updated_on`
+  - `name`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching campaign blueprint...').start();
+      try {
+        const data = await client.listCampaignBlueprints({
+          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('get-campaign-blueprint <blueprint-id>')
+    .description('Get a campaign blueprint')
+    .option('--account-id <value>', 'account_id')
+    .action(async (blueprint_id, options) => {
+      const spinner = createSpinner('Fetching campaign blueprint...').start();
+      try {
+        const data = await client.getCampaignBlueprint({
+          blueprint_id: Number(blueprint_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('render-campaign-blueprint <blueprint-id>')
+    .description('Render campaign blueprint')
+    .action(async (blueprint_id) => {
+      const spinner = createSpinner('Fetching campaign blueprint...').start();
+      try {
+        const data = await client.renderCampaignBlueprint({
+          blueprint_id: Number(blueprint_id),
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}