@cakemail-org/cakemail-cli 1.7.0 → 2.0.0

package/src/commands/custom-attributes.ts

@@ -0,0 +1,127 @@
+// ABOUTME: CLI commands for Custom Attribute.
+// 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 createCustomAttributesCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('custom-attributes')
+    .description('Define custom data fields for contacts. Custom attributes extend the contact model with account-specific fields (e.g. company name, purchase date) that can be used in segmentation and merge tags.');
+
+
+  cmd
+    .command('list-custom-attributes <list-id>')
+    .description('Show all custom attributes')
+    .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 custom attribute...').start();
+      try {
+        const data = await client.listCustomAttributes({
+          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-custom-attribute <list-id>')
+    .description('Create a custom attribute')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--name <value>', 'Cannot be one of the reserved terms: id, email, status, registered, bounce_type, bounce_count, tags, _tags')
+    .requiredOption('--type <value>', 'type')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Creating custom attribute...').start();
+      try {
+        const data = await client.createCustomAttribute({
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          name: options.name,
+          type: options.type,
+        });
+
+        spinner.stop();
+        formatter.success('Custom Attribute created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-custom-attribute <list-id> <name>')
+    .description('Show a custom attribute')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_id, name, options) => {
+      const spinner = createSpinner('Fetching custom attribute...').start();
+      try {
+        const data = await client.getCustomAttribute({
+          list_id: Number(list_id),
+          name,
+          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-custom-attribute <list-id> <name>')
+    .description('Delete a custom attribute')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (list_id, name, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('custom attribute', list_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting custom attribute...').start();
+      try {
+        const data = await client.deleteCustomAttribute({
+          list_id: Number(list_id),
+          name,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Custom Attribute deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/dkims.ts

@@ -0,0 +1,117 @@
+// ABOUTME: CLI commands for DKIM.
+// 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 createDkimsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('dkims')
+    .description('Manage DKIM (DomainKeys Identified Mail) keys for email authentication. DKIM signing improves deliverability and prevents email spoofing.');
+
+
+  cmd
+    .command('list-dkim-keys-brands-default-dkim-get')
+    .description('List Dkim Keys')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching dkim...').start();
+      try {
+        const data = await client.list_dkim_keys_brands_default_dkim_get({
+          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('create-dkim-key-brands-default-dkim-post')
+    .description('Create Dkim Key')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--selector <value>', 'selector')
+    .requiredOption('--domain <value>', 'domain')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating dkim...').start();
+      try {
+        const data = await client.create_dkim_key_brands_default_dkim_post({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          selector: options.selector,
+          domain: options.domain,
+        });
+
+        spinner.stop();
+        formatter.success('DKIM created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-dkim-key-brands-default-dkim-id-get <id>')
+    .description('Get Dkim Key')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (id, options) => {
+      const spinner = createSpinner('Fetching dkim...').start();
+      try {
+        const data = await client.get_dkim_key_brands_default_dkim__id__get({
+          id: Number(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-dkim-key-brands-default-dkim-id-delete <id>')
+    .description('Delete Dkim Key')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('dkim', id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting dkim...').start();
+      try {
+        const data = await client.delete_dkim_key_brands_default_dkim__id__delete({
+          id: Number(id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('DKIM deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/domains.ts

@@ -0,0 +1,82 @@
+// ABOUTME: CLI commands for Domain.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+
+export function createDomainsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('domains')
+    .description('Configure custom tracking and bounce domains. Custom domains replace default platform URLs in email links and bounce handling with your own branded domains.');
+
+
+  cmd
+    .command('show')
+    .description('Show domains')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching domain...').start();
+      try {
+        const data = await client.showDomains({
+          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')
+    .description('Change domains')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--domains <value>', 'Custom domain configuration')
+    .action(async (options) => {
+      const spinner = createSpinner('Updating domain...').start();
+      try {
+        const data = await client.patchDomains({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          domains: options.domains,
+        });
+
+        spinner.stop();
+        formatter.success('Domain updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('validate')
+    .description('Validate domains')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching domain...').start();
+      try {
+        const data = await client.validateDomains({
+          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;
+}