@cakemail-org/cakemail-cli 1.7.0 → 2.0.0

package/src/commands/logs.ts

@@ -0,0 +1,386 @@
+// ABOUTME: CLI commands for Log.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+
+export function createLogsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('logs')
+    .description('Access detailed activity logs for campaigns and lists. Logs track individual email events (sends, opens, clicks, bounces, unsubscribes). Log data can be exported to CSV files.');
+
+
+  cmd
+    .command('get-list <list-id>')
+    .description('Show list logs')
+    .option('--start-time <value>', 'start_time')
+    .option('--end-time <value>', 'end_time')
+    .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:
+  - `additional_info`
+  - `contact_id`
+  - `email`
+  - `uniques`
+  - `group_by_contact`
+  - `track_id`
+  - `log_id`
+  - `start_id`
+  - `end_id`
+  - `totals`
+  - `type`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Fetching log...').start();
+      try {
+        const data = await client.getListLogs({
+          list_id: Number(list_id),
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+          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,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-campaign <campaign-id>')
+    .description('Show campaign logs')
+    .option('--start-time <value>', 'start_time')
+    .option('--end-time <value>', 'end_time')
+    .option('--cursor <value>', 'cursor')
+    .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:
+  - `additional_info`
+  - `link_id`
+  - `contact_id`
+  - `email`
+  - `uniques`
+  - `group_by_contact`
+  - `log_id`
+  - `totals`
+  - `type`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `time`
+  - `log_id`')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Fetching log...').start();
+      try {
+        const data = await client.getCampaignLogs({
+          campaign_id: Number(campaign_id),
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+          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,
+          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-action <workflow-id> <action-id>')
+    .description('Show action logs')
+    .option('--start-time <value>', 'start_time')
+    .option('--end-time <value>', 'end_time')
+    .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:
+  - `additional_info`
+  - `link_id`
+  - `contact_id`
+  - `email`
+  - `log_id`
+  - `track_id`
+  - `type`
+  - `group_by_contact`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `time`
+  - `log_id`')
+    .action(async (workflow_id, action_id, options) => {
+      const spinner = createSpinner('Fetching log...').start();
+      try {
+        const data = await client.getActionLogs({
+          workflow_id,
+          action_id,
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+          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('list-campaign-log-exports <campaign-id>')
+    .description('Show all campaign log 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')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Fetching log...').start();
+      try {
+        const data = await client.listCampaignLogExports({
+          campaign_id: Number(campaign_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('campaign-log-export-create <campaign-id>')
+    .description('Create a campaign log export')
+    .option('--description <value>', 'description')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--filter <value>', 'Valid Terms:
+  - `additional_info`
+  - `link_id`
+  - `contact_id`
+  - `email`
+  - `uniques`
+  - `group_by_contact`
+  - `log_id`
+  - `totals`
+  - `type`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .option('--description <value>', 'description')
+    .option('--filter <value>', 'Valid Terms:
+  - `additional_info`
+  - `link_id`
+  - `contact_id`
+  - `email`
+  - `uniques`
+  - `group_by_contact`
+  - `log_id`
+  - `totals`
+  - `type`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Creating log...').start();
+      try {
+        const data = await client.campaignLogExportCreate({
+          campaign_id: Number(campaign_id),
+          description: options.description,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          filter: options.filter,
+          description: options.description,
+          filter: options.filter,
+        });
+
+        spinner.stop();
+        formatter.success('Log created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('campaign-log-export-download <campaign-log-export-id> <campaign-id>')
+    .description('Download a campaign log export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_log_export_id, campaign_id, options) => {
+      const spinner = createSpinner('Fetching log...').start();
+      try {
+        const data = await client.campaignLogExportDownload({
+          campaign_log_export_id,
+          campaign_id: Number(campaign_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('list-list-logs-exports <list-id>')
+    .description('Show all list logs 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')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Fetching log...').start();
+      try {
+        const data = await client.listListLogsExports({
+          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('list-logs-export-create <list-id>')
+    .description('Create a list log export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--description <value>', 'description')
+    .option('--filter <value>', 'Valid Terms:
+  - `additional_info`
+  - `contact_id`
+  - `email`
+  - `uniques`
+  - `group_by_contact`
+  - `track_id`
+  - `log_id`
+  - `start_id`
+  - `end_id`
+  - `totals`
+  - `type`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Creating log...').start();
+      try {
+        const data = await client.listLogsExportCreate({
+          list_id: Number(list_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          description: options.description,
+          filter: options.filter,
+        });
+
+        spinner.stop();
+        formatter.success('Log created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-logs-export-download <list-logs-export-id> <list-id>')
+    .description('Download a list logs export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_logs_export_id, list_id, options) => {
+      const spinner = createSpinner('Fetching log...').start();
+      try {
+        const data = await client.listLogsExportDownload({
+          list_logs_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;
+}

package/src/commands/reports.ts

@@ -0,0 +1,306 @@
+// ABOUTME: CLI commands for Report.
+// 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 createReportsCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('reports')
+    .description('Access campaign, list, and account performance statistics. Includes open rates, click rates, bounce rates, and other delivery metrics. Campaign report data can be exported to CSV files.');
+
+
+  cmd
+    .command('get-list-stats <list-id>')
+    .description('Show list report')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (list_id, options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.getListStats({
+          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('get-campaign-stats <campaign-id>')
+    .description('Show campaign report')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.getCampaignStats({
+          campaign_id: Number(campaign_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('get-campaign-links-stats <campaign-id>')
+    .description('Show campaign links report')
+    .option('--start-time <value>', 'start_time')
+    .option('--end-time <value>', 'end_time')
+    .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:
+  - `unique`
+  - `total`
+  - `link`')
+    .action(async (campaign_id, options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.getCampaignLinksStats({
+          campaign_id: Number(campaign_id),
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+          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('get-self-account-stats')
+    .description('Show my account report')
+    .option('--start-time <value>', 'start_time')
+    .option('--end-time <value>', 'end_time')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.getSelfAccountStats({
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-account-stats <account-id>')
+    .description('Show account report')
+    .option('--start-time <value>', 'start_time')
+    .option('--end-time <value>', 'end_time')
+    .action(async (account_id, options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.getAccountStats({
+          account_id: Number(account_id),
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-action-stats <workflow-id> <action-id>')
+    .description('Show action report')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (workflow_id, action_id, options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.getActionStats({
+          workflow_id,
+          action_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('list-campaigns-reports-exports')
+    .description('List campaigns reports 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('--filter <value>', 'Valid Terms:
+  - `status`
+  - `progress`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.listCampaignsReportsExports({
+          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,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('create-campaigns-reports-export')
+    .description('Create a campaigns reports export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--description <value>', 'description')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating report...').start();
+      try {
+        const data = await client.createCampaignsReportsExport({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          description: options.description,
+        });
+
+        spinner.stop();
+        formatter.success('Report created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-campaigns-reports-export <export-id>')
+    .description('Get a campaigns reports export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (export_id, options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.getCampaignsReportsExport({
+          export_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-campaigns-reports-export <export-id>')
+    .description('Delete a campaigns report export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (export_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('report', export_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting report...').start();
+      try {
+        const data = await client.deleteCampaignsReportsExport({
+          export_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Report deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('download-campaigns-reports-export <export-id>')
+    .description('Download a campaigns reports export')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (export_id, options) => {
+      const spinner = createSpinner('Fetching report...').start();
+      try {
+        const data = await client.downloadCampaignsReportsExport({
+          export_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;
+}