@cakemail-org/cakemail-cli 1.7.0 → 2.0.0

package/src/commands/users.ts

@@ -0,0 +1,506 @@
+// ABOUTME: CLI commands for User.
+// 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 createUsersCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('users')
+    .description('Manage users within an account. Users are individuals who can log in and perform actions. Each account can have multiple users with different roles. Includes user creation with email verification, password management, suspension, and multi-factor authentication (MFA) setup.');
+
+
+  cmd
+    .command('get-self')
+    .description('Show my user details')
+    .action(async () => {
+      const spinner = createSpinner('Fetching user...').start();
+      try {
+        const data = await client.getSelfUser({
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('forgot-my-password')
+    .description('Forgot my password')
+    .option('--account-id <value>', 'account_id')
+    .option('--language <value>', 'language')
+    .requiredOption('--email <value>', 'Email address of the user requesting a password reset')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.forgotMyPassword({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          language: options.language,
+          email: options.email,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('reset-self-password')
+    .description('Reset my password')
+    .action(async () => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.resetSelfPassword({
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('reset-user-password <user-id>')
+    .description('Reset a user password')
+    .option('--account-id <value>', 'account_id')
+    .option('--invalidate-current-password <value>', 'If true, immediately invalidates the current password, forcing the user to reset')
+    .action(async (user_id, options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.resetUserPassword({
+          user_id: Number(user_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          invalidateCurrentPassword: options.invalidateCurrentPassword,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('reset-password-confirm')
+    .description('Reset password confirmation')
+    .requiredOption('--token <value>', 'Password reset token received via email')
+    .requiredOption('--password <value>', 'New password to set')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.resetPasswordConfirm({
+          token: options.token,
+          password: options.password,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list')
+    .description('Show all users in my account')
+    .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:
+  - `email`
+  - `status`
+
+Valid Operators:
+  - `==`
+
+Query separator:
+  - `;`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching user...').start();
+      try {
+        const data = await client.listUsers({
+          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')
+    .description('Create a user')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--skip-verification <value>', 'skip_verification')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.createUser({
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <user-id>')
+    .description('Show a user details')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (user_id, options) => {
+      const spinner = createSpinner('Fetching user...').start();
+      try {
+        const data = await client.getUser({
+          user_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 <user-id>')
+    .description('Update a user')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (user_id, options) => {
+      const spinner = createSpinner('Updating user...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.patchUser({
+          user_id,
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('User updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete <user-id>')
+    .description('Delete a user')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (user_id, options) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('user', user_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting user...').start();
+      try {
+        const data = await client.deleteUser({
+          user_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('User deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('suspend <user-id>')
+    .description('Suspend a user')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (user_id, options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.suspendUser({
+          user_id: Number(user_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('unsuspend <user-id>')
+    .description('Unsuspend a user')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (user_id, options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.unsuspendUser({
+          user_id: Number(user_id),
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('confirm <user-id>')
+    .description('Confirm a user')
+    .requiredOption('--confirmation <value>', 'Confirmation hash from the verification email')
+    .requiredOption('--password <value>', 'Password to set for the new account (minimum 8 characters)')
+    .action(async (user_id, options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.confirmUser({
+          user_id,
+          confirmation: options.confirmation,
+          password: options.password,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('resend-user-verification <user-id>')
+    .description('Resend the user verification email')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (user_id, options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.resendUserVerification({
+          user_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('list-mfa')
+    .description('List active MFA methods')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--with-count <value>', 'Include count in the response')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching user...').start();
+      try {
+        const data = await client.listMfa({
+          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-mfa')
+    .description('Attach an MFA method')
+    .requiredOption('--type <value>', 'An enumeration.')
+    .option('--description <value>', 'description')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.createMfa({
+          type: options.type,
+          description: options.description,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('activate-mfa <mfa-id>')
+    .description('Activate an MFA method')
+    .requiredOption('--code <value>', '6 digit code from this MFA method')
+    .action(async (mfa_id, options) => {
+      const spinner = createSpinner('Creating user...').start();
+      try {
+        const data = await client.activateMfa({
+          mfa_id,
+          code: options.code,
+        });
+
+        spinner.stop();
+        formatter.success('User created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-mfa-recovery-codes')
+    .description('Get MFA recovery codes')
+    .action(async () => {
+      const spinner = createSpinner('Fetching user...').start();
+      try {
+        const data = await client.getMfaRecoveryCodes({
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-mfa-portal')
+    .description('Get the MFA portal URL')
+    .option('--return-url <value>', 'return_url')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching user...').start();
+      try {
+        const data = await client.getMfaPortal({
+          returnUrl: options.returnUrl,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('delete-mfa <mfa-id>')
+    .description('Remove an MFA method')
+    .option('-f, --force', 'Skip confirmation prompt')
+    .action(async (mfa_idoptions) => {
+      if (!options.force) {
+        const confirmed = await confirmDelete('user', mfa_id);
+        if (!confirmed) {
+          formatter.info('Deletion cancelled');
+          return;
+        }
+      }
+
+      const spinner = createSpinner('Deleting user...').start();
+      try {
+        const data = await client.deleteMfa({
+          mfa_id,
+        });
+
+        spinner.stop();
+        formatter.success('User deleted successfully');
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}

package/src/commands/webhooks.ts

@@ -0,0 +1,172 @@
+// ABOUTME: CLI commands for Webhook.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+
+export function createWebhooksCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('webhooks')
+    .description('Configure webhooks to receive real-time HTTP notifications when email events occur (delivery, open, click, bounce, unsubscribe, spam complaint). Webhooks can be filtered by event type and archived when no longer needed.');
+
+
+  cmd
+    .command('list')
+    .description('List all webhooks')
+    .option('--with-archived <value>', 'with_archived')
+    .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 (options) => {
+      const spinner = createSpinner('Fetching webhook...').start();
+      try {
+        const data = await client.listWebhooks({
+          withArchived: options.withArchived,
+          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')
+    .description('Create a webhook')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--event <value>', 'An enumeration.')
+    .requiredOption('--url <value>', 'url')
+    .option('--rate-limit <value>', 'rate_limit')
+    .option('--rate-limit-period <value>', 'rate_limit_period')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating webhook...').start();
+      try {
+        const data = await client.createWebhook({
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          event: options.event,
+          url: options.url,
+          rateLimit: options.rateLimit != null ? Number(options.rateLimit) : undefined,
+          rateLimitPeriod: options.rateLimitPeriod,
+        });
+
+        spinner.stop();
+        formatter.success('Webhook created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('archive <webhook-id>')
+    .description('Archive a webhook')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (webhook_id, options) => {
+      const spinner = createSpinner('Creating webhook...').start();
+      try {
+        const data = await client.archiveWebhook({
+          webhook_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Webhook created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('unarchive <webhook-id>')
+    .description('Unarchive a webhook')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (webhook_id, options) => {
+      const spinner = createSpinner('Creating webhook...').start();
+      try {
+        const data = await client.unarchiveWebhook({
+          webhook_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+        });
+
+        spinner.stop();
+        formatter.success('Webhook created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get <webhook-id>')
+    .description('Show a webhook')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (webhook_id, options) => {
+      const spinner = createSpinner('Fetching webhook...').start();
+      try {
+        const data = await client.getWebhook({
+          webhook_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 <webhook-id>')
+    .description('Patch a webhook')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--url <value>', 'url')
+    .option('--rate-limit <value>', 'rate_limit')
+    .option('--rate-limit-period <value>', 'An enumeration.')
+    .action(async (webhook_id, options) => {
+      const spinner = createSpinner('Updating webhook...').start();
+      try {
+        const data = await client.patchWebhook({
+          webhook_id,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          url: options.url,
+          rateLimit: options.rateLimit != null ? Number(options.rateLimit) : undefined,
+          rateLimitPeriod: options.rateLimitPeriod,
+        });
+
+        spinner.stop();
+        formatter.success('Webhook updated successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}