@cakemail-org/cakemail-cli 1.5.0 → 2.0.0

package/src/commands/lists.ts

@@ -0,0 +1,406 @@
+// ABOUTME: CLI commands for List.
+// 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 createListsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('lists')
+    .description('Manage contact lists. A list is a collection of contacts (email subscribers) with its own sender identity, language, and subscription settings. Lists support double opt-in, custom redirect URLs after subscription events, and webhook notifications. Also includes deprecated subscription form endpoints for legacy integrations — use the Form endpoints instead.');
+
+
+  cmd
+    .command('list')
+    .description('Show all lists')
+    .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`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `name`
+  - `created_on`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching list...').start();
+      try {
+        const data = await client.listLists({
+          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 List')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--name <value>', 'List Name')
+    .requiredOption('--default-sender <value>', 'default_sender')
+    .option('--language <value>', 'language')
+    .option('--redirections <value>', 'redirections')
+    .option('--webhook <value>', 'webhook')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating list...').start();
+      try {
+        const data = await client.createList({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          name: options.name,
+          defaultSender: options.defaultSender,
+          language: options.language,
+          redirections: options.redirections,
+          webhook: options.webhook,
+        });
+
+        spinner.stop();
+        formatter.success('List created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <list-id>')
+    .description('Show a list parameters')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Fetching list...').start();
+      try {
+        const data = await client.getList({
+          list_id: Number(list_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('patch <list-id>')
+    .description('Update a list parameters')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--name <value>', 'name')
+    .option('--default-sender <value>', 'default_sender')
+    .option('--language <value>', 'language')
+    .option('--redirections <value>', 'redirections')
+    .option('--webhook <value>', 'webhook')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Updating list...').start();
+      try {
+        const data = await client.patchList({
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          name: options.name,
+          defaultSender: options.defaultSender,
+          language: options.language,
+          redirections: options.redirections,
+          webhook: options.webhook,
+        });
+
+        spinner.stop();
+        formatter.success('List updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <list-id>')
+    .description('Delete a List')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (list_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('list', list_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting list...').start();
+      try {
+        const data = await client.deleteList({
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('List deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('accept-list-policy <list-id>')
+    .description('Accept policy for a list')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Creating list...').start();
+      try {
+        const data = await client.acceptListPolicy({
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('List created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('archive <list-id>')
+    .description('Archive a list')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Creating list...').start();
+      try {
+        const data = await client.archiveList({
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('List created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('enable-subscription-form-endpoint <form-id> <list-id>')
+    .description('Enable a subscription form endpoint')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (form_id, list_id, options) => {
+      const spinner = createSpinner('Creating list...').start();
+      try {
+        const data = await client.enableSubscriptionFormEndpoint({
+          form_id,
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('List created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('disable-subscription-form-endpoint <form-id> <list-id>')
+    .description('Disable a subscription form endpoint')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (form_id, list_id, options) => {
+      const spinner = createSpinner('Creating list...').start();
+      try {
+        const data = await client.disableSubscriptionFormEndpoint({
+          form_id,
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('List created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-subscription-form-endpoints <list-id>')
+    .description('List subscription form endpoints')
+    .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 list...').start();
+      try {
+        const data = await client.listSubscriptionFormEndpoints({
+          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-subscription-form-endpoint <list-id>')
+    .description('Create a subscription form endpoint')
+    .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 list...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createSubscriptionFormEndpoint({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('List created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('show-subscription-form-endpoint <form-id> <list-id>')
+    .description('Show a subscription form endpoint')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (form_id, list_id, options) => {
+      const spinner = createSpinner('Fetching list...').start();
+      try {
+        const data = await client.showSubscriptionFormEndpoint({
+          form_id,
+          list_id: Number(list_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('patch-subscription-form-endpoint <form-id> <list-id>')
+    .description('Patch a subscription form endpoint')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (form_id, list_id, options) => {
+      const spinner = createSpinner('Updating list...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchSubscriptionFormEndpoint({
+          form_id,
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('List updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete-subscription-form-endpoint <form-id> <list-id>')
+    .description('Delete a subscription form endpoint')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (form_id, list_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('list', form_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting list...').start();
+      try {
+        const data = await client.deleteSubscriptionFormEndpoint({
+          form_id,
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('List deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/logos.ts

@@ -0,0 +1,71 @@
+// ABOUTME: CLI commands for Logo.
+// 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 createLogosCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('logos')
+    .description('Upload and manage the account logo used in campaigns and forms.');
+
+
+  cmd
+    .command('upload-default')
+    .description('Upload a default logo')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--file <value>', 'Data URI scheme, base64 encoded')
+    .action(async (options) => {
+      const spinner = createSpinner('Updating logo...').start();
+      try {
+        const data = await client.uploadDefaultLogo({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          file: options.file,
+        });
+
+        spinner.stop();
+        formatter.success('Logo updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete-default')
+    .description('Delete the default logo')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('logo', 'this resource');
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting logo...').start();
+      try {
+        const data = await client.deleteDefaultLogo({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Logo deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}