@cakemail-org/cakemail-cli 1.5.0 → 2.0.0

package/src/commands/segments.ts

@@ -0,0 +1,158 @@
+// ABOUTME: CLI commands for Segment.
+// 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 createSegmentsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('segments')
+    .description('Create and manage segments within lists. A segment is a dynamic filter that defines a subset of contacts based on query criteria. Segments can be defined using SQL-like expressions, FIQL, or JSON query format. Segments are used to target specific audiences when sending campaigns.');
+
+
+  cmd
+    .command('list <list-id>')
+    .description('Show all segments')
+    .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:
+  - `id`
+  - `name`
+  - `created_on`')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Fetching segment...').start();
+      try {
+        const data = await client.listSegments({
+          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,
+          sort: options.sort,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create <list-id>')
+    .description('Create a segment')
+    .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 segment...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createSegment({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Segment created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <list-id> <segment-id>')
+    .description('Show a segment details')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_id, segment_id, options) => {
+      const spinner = createSpinner('Fetching segment...').start();
+      try {
+        const data = await client.getSegment({
+          list_id: Number(list_id),
+          segment_id: Number(segment_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> <segment-id>')
+    .description('Update a segment')
+    .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, segment_id, options) => {
+      const spinner = createSpinner('Updating segment...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchSegment({
+          list_id: Number(list_id),
+          segment_id: Number(segment_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Segment updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <list-id> <segment-id>')
+    .description('Delete a segment')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (list_id, segment_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('segment', list_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting segment...').start();
+      try {
+        const data = await client.deleteSegment({
+          list_id: Number(list_id),
+          segment_id: Number(segment_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Segment deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/senders.ts

@@ -0,0 +1,204 @@
+// ABOUTME: CLI commands for Sender.
+// 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 createSendersCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('senders')
+    .description('Manage sender identities (name and email pairs) used as the 'From' address in campaigns and transactional emails. New senders require email confirmation before use.');
+
+
+  cmd
+    .command('list')
+    .description('Show all senders')
+    .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`
+  - `email`
+  - `confirmed`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching sender...').start();
+      try {
+        const data = await client.listSenders({
+          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')
+    .description('Add a sender')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--name <value>', 'Display name of the sender')
+    .requiredOption('--email <value>', 'Email address of the sender')
+    .option('--language <value>', 'Language for sender-related communications')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating sender...').start();
+      try {
+        const data = await client.createSender({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          name: options.name,
+          email: options.email,
+          language: options.language,
+        });
+
+        spinner.stop();
+        formatter.success('Sender created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <sender-id>')
+    .description('Show a sender details')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (sender_id, options) => {
+      const spinner = createSpinner('Fetching sender...').start();
+      try {
+        const data = await client.getSender({
+          sender_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 <sender-id>')
+    .description('Update a sender')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--name <value>', 'Display name of the sender')
+    .option('--language <value>', 'Language for sender-related communications')
+    .action(async (sender_id, options) => {
+      const spinner = createSpinner('Updating sender...').start();
+      try {
+        const data = await client.patchSender({
+          sender_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          name: options.name,
+          language: options.language,
+        });
+
+        spinner.stop();
+        formatter.success('Sender updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <sender-id>')
+    .description('Delete a sender')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (sender_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('sender', sender_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting sender...').start();
+      try {
+        const data = await client.deleteSender({
+          sender_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Sender deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('confirm')
+    .description('Confirm a sender')
+    .requiredOption('--confirmation-id <value>', 'Confirmation token from the verification email')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating sender...').start();
+      try {
+        const data = await client.confirmSender({
+          confirmationId: options.confirmationId,
+        });
+
+        spinner.stop();
+        formatter.success('Sender created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('resend-confirmation-email <sender-id>')
+    .description('Resend confirmation email')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (sender_id, options) => {
+      const spinner = createSpinner('Creating sender...').start();
+      try {
+        const data = await client.resendConfirmationEmail({
+          sender_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Sender created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/sub-accounts.ts

@@ -0,0 +1,271 @@
+// ABOUTME: CLI commands for Sub-Account.
+// 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 createSubAccountsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('sub-accounts')
+    .description('Manage sub-accounts under a partner or organization account. Sub-accounts are independent accounts with their own users, contacts, and campaigns, managed by the parent account. Includes creation, suspension, and configuration.');
+
+
+  cmd
+    .command('list-accounts')
+    .description('Show all sub-accounts')
+    .option('--partner-account-id <value>', 'partner_account_id')
+    .option('--recursive <value>', 'recursive')
+    .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`')
+    .option('--filter <value>', 'Valid Terms:
+  - `name`
+  - `status`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching sub-account...').start();
+      try {
+        const data = await client.listAccounts({
+          partnerAccountId: options.partnerAccountId != null ? Number(options.partnerAccountId) : undefined,
+          recursive: options.recursive,
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          withCount: options.withCount,
+          sort: options.sort,
+          filter: options.filter,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create-account')
+    .description('Create a sub-account')
+    .option('--partner-account-id <value>', 'partner_account_id')
+    .option('--skip-verification <value>', 'skip_verification')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating sub-account...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createAccount({
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Sub-Account created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-account <account-id>')
+    .description('Show sub-account details')
+    .action(async (account_id) => {
+      const spinner = createSpinner('Fetching sub-account...').start();
+      try {
+        const data = await client.getAccount({
+          account_id,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('patch-account <account-id>')
+    .description('Update a sub-account')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (account_id, options) => {
+      const spinner = createSpinner('Updating sub-account...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchAccount({
+          account_id: Number(account_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Sub-Account updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete-account <account-id>')
+    .description('Delete a sub-account')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (account_idoptions) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('sub-account', account_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting sub-account...').start();
+      try {
+        const data = await client.deleteAccount({
+          account_id,
+        });
+
+        spinner.stop();
+        formatter.success('Sub-Account deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('suspend-account <account-id>')
+    .description('Suspend a sub-account')
+    .action(async (account_id) => {
+      const spinner = createSpinner('Creating sub-account...').start();
+      try {
+        const data = await client.suspendAccount({
+          account_id: Number(account_id),
+        });
+
+        spinner.stop();
+        formatter.success('Sub-Account created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('unsuspend-account <account-id>')
+    .description('Unsuspend a sub-account')
+    .action(async (account_id) => {
+      const spinner = createSpinner('Creating sub-account...').start();
+      try {
+        const data = await client.unsuspendAccount({
+          account_id: Number(account_id),
+        });
+
+        spinner.stop();
+        formatter.success('Sub-Account created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('confirm-account <account-id>')
+    .description('Confirm sub-account creation')
+    .requiredOption('--confirmation <value>', 'confirmation')
+    .action(async (account_id, options) => {
+      const spinner = createSpinner('Creating sub-account...').start();
+      try {
+        const data = await client.confirmAccount({
+          account_id,
+          confirmation: options.confirmation,
+        });
+
+        spinner.stop();
+        formatter.success('Sub-Account created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('resend-account-verification')
+    .description('Resend the account verification email')
+    .requiredOption('--email <value>', 'Email address to resend the verification to')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating sub-account...').start();
+      try {
+        const data = await client.resendAccountVerification({
+          email: options.email,
+        });
+
+        spinner.stop();
+        formatter.success('Sub-Account created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('convert-account-to-organization <account-id>')
+    .description('Convert an account to an Organization')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (account_id, options) => {
+      const spinner = createSpinner('Creating sub-account...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.convertAccountToOrganization({
+          account_id: Number(account_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Sub-Account created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}