@cakemail-org/cakemail-cli 1.5.0 → 2.0.0

package/src/commands/contacts.ts

@@ -0,0 +1,612 @@
+// ABOUTME: CLI commands for Contact.
+// 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 createContactsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('contacts')
+    .description('Manage contacts within lists. Contacts are individual email subscribers with an email address, subscription status, custom attributes, tags, and interests. Supports creating, importing, updating, unsubscribing, and deleting contacts. Bulk operations are available for tagging and interest management. Contact data can be exported to CSV files.');
+
+
+  cmd
+    .command('add-interests-to <list-id>')
+    .description('Add interest(s) to contact(s)')
+    .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 contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.addInterestsToContacts({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-contacts-of-list <list-id>')
+    .description('Show contacts of a list')
+    .option('--query <value>', 'SQL selection query (only use one of query, fiql and json)')
+    .option('--json <value>', 'JSON selection expression (only use one of query, fiql and json)')
+    .option('--cursor <value>', 'Cursor pagination')
+    .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`
+  - `email`
+  - `status`
+  - `subscribed_on`
+  - `last_bounce_type`
+  - `bounces_count`')
+    .option('--filter <value>', 'Valid Terms:
+  - `status`
+  - `email`
+  - `tags`
+  - `interests`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--fiql <value>', 'fiql')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Fetching contact...').start();
+      try {
+        const data = await client.listContactsOfList({
+          list_id: Number(list_id),
+          query: options.query,
+          json: options.json,
+          cursor: options.cursor,
+          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,
+          filter: options.filter,
+          fiql: options.fiql,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create <list-id>')
+    .description('Add a contact')
+    .option('--send-double-opt-in <value>', 'send_double_opt_in')
+    .option('--resubscribe <value>', 'resubscribe')
+    .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 contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createContact({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-contacts-of-segment <segment-id> <list-id>')
+    .description('Show contacts of a segment')
+    .option('--query <value>', 'SQL selection query (only use one of query, fiql and json)')
+    .option('--json <value>', 'JSON selection expression (only use one of query, fiql and json)')
+    .option('--cursor <value>', 'Cursor pagination')
+    .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`
+  - `email`
+  - `status`
+  - `subscribed_on`
+  - `last_bounce_type`
+  - `bounces_count`')
+    .option('--filter <value>', 'Valid Terms:
+  - `status`
+  - `email`
+  - `tags`
+  - `interests`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--fiql <value>', 'fiql')
+    .action(async (segment_id, list_id, options) => {
+      const spinner = createSpinner('Fetching contact...').start();
+      try {
+        const data = await client.listContactsOfSegment({
+          segment_id: Number(segment_id),
+          list_id: Number(list_id),
+          query: options.query,
+          json: options.json,
+          cursor: options.cursor,
+          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,
+          filter: options.filter,
+          fiql: options.fiql,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('tag-multiple <list-id>')
+    .description('Tags multiple contacts')
+    .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 contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.tagMultipleContacts({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('untag-multiple <list-id>')
+    .description('Untags multiple contacts')
+    .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 contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.untagMultipleContacts({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <list-id> <contact-id>')
+    .description('Show a contact details')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_id, contact_id, options) => {
+      const spinner = createSpinner('Fetching contact...').start();
+      try {
+        const data = await client.getContact({
+          list_id: Number(list_id),
+          contact_id: Number(contact_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> <contact-id>')
+    .description('Update a contact')
+    .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, contact_id, options) => {
+      const spinner = createSpinner('Updating contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchContact({
+          list_id: Number(list_id),
+          contact_id: Number(contact_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <list-id> <contact-id>')
+    .description('Delete a contact')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (list_id, contact_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('contact', list_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting contact...').start();
+      try {
+        const data = await client.deleteContact({
+          list_id: Number(list_id),
+          contact_id: Number(contact_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Contact deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('import <list-id>')
+    .description('Import contacts')
+    .option('--send-double-opt-in <value>', 'send_double_opt_in')
+    .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 contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.importContacts({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('unsubscribe <list-id> <contact-id>')
+    .description('Unsubscribe a contact from a list')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_id, contact_id, options) => {
+      const spinner = createSpinner('Creating contact...').start();
+      try {
+        const data = await client.unsubscribeContact({
+          list_id: Number(list_id),
+          contact_id: Number(contact_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('tag <list-id> <contact-id>')
+    .description('Tags a contact')
+    .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, contact_id, options) => {
+      const spinner = createSpinner('Creating contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.tagContact({
+          list_id: Number(list_id),
+          contact_id: Number(contact_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('untag <list-id> <contact-id>')
+    .description('Untags a contact')
+    .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, contact_id, options) => {
+      const spinner = createSpinner('Creating contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.untagContact({
+          list_id: Number(list_id),
+          contact_id: Number(contact_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('remove-interests-from <list-id>')
+    .description('Remove interest(s) from contact(s)')
+    .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 contact...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.removeInterestsFromContacts({
+          list_id: Number(list_id),
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-contacts-exports <list-id>')
+    .description('Show all Contacts Exports')
+    .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:
+  - `status`
+  - `created_on`
+  - `expires_on`')
+    .option('--filter <value>', 'Valid Terms:
+  - `status`
+  - `progress`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Fetching contact...').start();
+      try {
+        const data = await client.listContactsExports({
+          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,
+          filter: options.filter,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('export <list-id>')
+    .description('Create a Contacts Export')
+    .option('--description <value>', 'description')
+    .option('--query <value>', 'query')
+    .option('--json <value>', 'json')
+    .option('--segment-id <value>', 'segment_id')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--filter <value>', 'Valid Terms:
+  - `status`
+  - `email`
+  - `tags`
+  - `interests`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--fiql <value>', 'fiql')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Creating contact...').start();
+      try {
+        const data = await client.exportContacts({
+          list_id: Number(list_id),
+          description: options.description,
+          query: options.query,
+          json: options.json,
+          segmentId: options.segmentId != null ? Number(options.segmentId) : undefined,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          filter: options.filter,
+          fiql: options.fiql,
+        });
+
+        spinner.stop();
+        formatter.success('Contact created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-contacts-export <export-id> <list-id>')
+    .description('Show a Contacts Export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (export_id, list_id, options) => {
+      const spinner = createSpinner('Fetching contact...').start();
+      try {
+        const data = await client.getContactsExport({
+          export_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('delete-contacts-export <export-id> <list-id>')
+    .description('Delete a Contacts Export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (export_id, list_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('contact', export_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting contact...').start();
+      try {
+        const data = await client.deleteContactsExport({
+          export_id,
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Contact deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('download-contacts-export <export-id> <list-id>')
+    .description('Download a Contacts Export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (export_id, list_id, options) => {
+      const spinner = createSpinner('Fetching contact...').start();
+      try {
+        const data = await client.downloadContactsExport({
+          export_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);
+      }
+    });
+
+
+  return cmd;
+}