@cakemail-org/cakemail-cli 1.5.0 → 2.0.0

package/src/commands/email-apis.ts

@@ -0,0 +1,569 @@
+// ABOUTME: CLI commands for Email API.
+// ABOUTME: Generated by api-kit from the OpenAPI spec.
+
+import { Command } from 'commander';
+import { createSpinner } from '../utils/spinner.js';
+
+export function createEmailApisCommand(
+  client: any,
+  formatter: any
+): Command {
+  const cmd = new Command('email-apis')
+    .description('Submit and track individual transactional emails. The Email API provides full control over email content, tracking, and delivery. Each email goes through a lifecycle: submitted, queued, delivered, with events for opens, clicks, bounces, and unsubscribes. Includes statistics, activity logs, and tag-based organization.');
+
+
+  cmd
+    .command('submit-email')
+    .description('Submit an email')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .requiredOption('--data <value>', 'Request body as JSON string')
+    .action(async (options) => {
+      const spinner = createSpinner('Creating email api...').start();
+      try {
+        const body = JSON.parse(options.data);
+        const data = await client.submitEmail({
+          ...body,
+        });
+
+        spinner.stop();
+        formatter.success('Email API created successfully');
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('show-email <email-id>')
+    .description('Retrieve a submitted email')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (email_id, options) => {
+      const spinner = createSpinner('Fetching email api...').start();
+      try {
+        const data = await client.showEmail({
+          email_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('render-email <email-id>')
+    .description('Render a submitted email')
+    .option('--as-submitted <value>', 'Render the original submitted content of the email')
+    .option('--tracking <value>', 'Enable tracking')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .action(async (email_id, options) => {
+      const spinner = createSpinner('Fetching email api...').start();
+      try {
+        const data = await client.renderEmail({
+          email_id,
+          asSubmitted: options.asSubmitted,
+          tracking: options.tracking,
+          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-email-tags')
+    .description('List Email Tags')
+    .option('--type <value>', 'Query tags from the `emails` or `events` table. Required when using `start_time`, `end_time`, or `tags` filters.')
+    .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('--name <value>', 'Tag name to filter by, with optional operator.
+
+#### Operators:
+==: Exact match (default)
+!=: Not equal
+~~: Like (anywhere in the email)
+!~: Not like (anywhere in the email)
+')
+    .option('--tags <value>', '### Recursive Filter Query Language
+
+The filter is a JSON object that represents a recursive query structure. It uses the logical operators `and`, `or`, `not` and `is` as keys, with the following types of values:
+
+1. **`object`**: A nested filter object that defines additional conditions.
+
+2. **`string`**: A condition expressed as a single string.
+
+3. **`array`**: An array of strings (conditions) or nested filter objects.
+
+
+- The `and` and `or` operators accept `object` and `array`
+
+- The `not` operator accepts `object` and `string`
+
+- The `is` operator accepts `object` and `string`
+
+### Examples
+
+#### 1. Simple condition with a string
+
+```json
+{ "is": "condition1" }
+ ```
+
+ #### 2. Array of strings
+
+```json
+{ "or": ["condition1", "condition2"] }
+```
+
+#### 3. Nested filter object
+
+```json
+{ "not": { "and": ["condition1", "condition2"] } }
+```
+
+#### 4. Complex recursive query
+
+```json
+{ "and": [ { "or": ["condition1", "condition2"] }, { "not": { "and": ["condition3", "condition4"] } } ] }
+```
+
+')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching email api...').start();
+      try {
+        const data = await client.listEmailTags({
+          type: options.type,
+          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,
+          name: options.name,
+          tags: options.tags,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-email-apilogs')
+    .description('Show Email API activity logs')
+    .option('--log-type <value>', 'log_type')
+    .option('--email-id <value>', 'email_id')
+    .option('--iso-time <value>', 'Convert timestamps to human readable ISO format')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--start-time <value>', 'Start time for the report, defaults to 7 days ago.')
+    .option('--end-time <value>', 'End time for the report, defaults to the current time.')
+    .option('--tags <value>', '### Recursive Filter Query Language
+
+The filter is a JSON object that represents a recursive query structure. It uses the logical operators `and`, `or`, `not` and `is` as keys, with the following types of values:
+
+1. **`object`**: A nested filter object that defines additional conditions.
+
+2. **`string`**: A condition expressed as a single string.
+
+3. **`array`**: An array of strings (conditions) or nested filter objects.
+
+
+- The `and` and `or` operators accept `object` and `array`
+
+- The `not` operator accepts `object` and `string`
+
+- The `is` operator accepts `object` and `string`
+
+### Examples
+
+#### 1. Simple condition with a string
+
+```json
+{ "is": "condition1" }
+ ```
+
+ #### 2. Array of strings
+
+```json
+{ "or": ["condition1", "condition2"] }
+```
+
+#### 3. Nested filter object
+
+```json
+{ "not": { "and": ["condition1", "condition2"] } }
+```
+
+#### 4. Complex recursive query
+
+```json
+{ "and": [ { "or": ["condition1", "condition2"] }, { "not": { "and": ["condition3", "condition4"] } } ] }
+```
+
+')
+    .option('--providers <value>', '### Recursive Filter Query Language
+
+The filter is a JSON object that represents a recursive query structure. It uses the logical operators `and`, `or`, `not` and `is` as keys, with the following types of values:
+
+1. **`object`**: A nested filter object that defines additional conditions.
+
+2. **`string`**: A condition expressed as a single string.
+
+3. **`array`**: An array of strings (conditions) or nested filter objects.
+
+
+- The `and` and `or` operators accept `object` and `array`
+
+- The `not` operator accepts `object` and `string`
+
+- The `is` operator accepts `object` and `string`
+
+### Examples
+
+#### 1. Simple condition with a string
+
+```json
+{ "is": "condition1" }
+ ```
+
+ #### 2. Array of strings
+
+```json
+{ "or": ["condition1", "condition2"] }
+```
+
+#### 3. Nested filter object
+
+```json
+{ "not": { "and": ["condition1", "condition2"] } }
+```
+
+#### 4. Complex recursive query
+
+```json
+{ "and": [ { "or": ["condition1", "condition2"] }, { "not": { "and": ["condition3", "condition4"] } } ] }
+```
+
+')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `id`
+  - `time`
+  - `submitted_time`
+  - `type`
+  - `provider`')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching email api...').start();
+      try {
+        const data = await client.getEmailAPILogs({
+          logType: options.logType,
+          emailId: options.emailId,
+          isoTime: options.isoTime,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+          tags: options.tags,
+          providers: options.providers,
+          sort: options.sort,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-email-apisummary')
+    .description('Show Email API activity summary')
+    .option('--email-id <value>', 'email_id')
+    .option('--engagement <value>', 'engagement')
+    .option('--status <value>', 'status')
+    .option('--iso-time <value>', 'Convert timestamps to human readable ISO format')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--page <value>', 'page')
+    .option('--per-page <value>', 'per_page')
+    .option('--start-time <value>', 'Start time for the report, defaults to 7 days ago.')
+    .option('--end-time <value>', 'End time for the report, defaults to the current time.')
+    .option('--tags <value>', '### Recursive Filter Query Language
+
+The filter is a JSON object that represents a recursive query structure. It uses the logical operators `and`, `or`, `not` and `is` as keys, with the following types of values:
+
+1. **`object`**: A nested filter object that defines additional conditions.
+
+2. **`string`**: A condition expressed as a single string.
+
+3. **`array`**: An array of strings (conditions) or nested filter objects.
+
+
+- The `and` and `or` operators accept `object` and `array`
+
+- The `not` operator accepts `object` and `string`
+
+- The `is` operator accepts `object` and `string`
+
+### Examples
+
+#### 1. Simple condition with a string
+
+```json
+{ "is": "condition1" }
+ ```
+
+ #### 2. Array of strings
+
+```json
+{ "or": ["condition1", "condition2"] }
+```
+
+#### 3. Nested filter object
+
+```json
+{ "not": { "and": ["condition1", "condition2"] } }
+```
+
+#### 4. Complex recursive query
+
+```json
+{ "and": [ { "or": ["condition1", "condition2"] }, { "not": { "and": ["condition3", "condition4"] } } ] }
+```
+
+')
+    .option('--providers <value>', '### Recursive Filter Query Language
+
+The filter is a JSON object that represents a recursive query structure. It uses the logical operators `and`, `or`, `not` and `is` as keys, with the following types of values:
+
+1. **`object`**: A nested filter object that defines additional conditions.
+
+2. **`string`**: A condition expressed as a single string.
+
+3. **`array`**: An array of strings (conditions) or nested filter objects.
+
+
+- The `and` and `or` operators accept `object` and `array`
+
+- The `not` operator accepts `object` and `string`
+
+- The `is` operator accepts `object` and `string`
+
+### Examples
+
+#### 1. Simple condition with a string
+
+```json
+{ "is": "condition1" }
+ ```
+
+ #### 2. Array of strings
+
+```json
+{ "or": ["condition1", "condition2"] }
+```
+
+#### 3. Nested filter object
+
+```json
+{ "not": { "and": ["condition1", "condition2"] } }
+```
+
+#### 4. Complex recursive query
+
+```json
+{ "and": [ { "or": ["condition1", "condition2"] }, { "not": { "and": ["condition3", "condition4"] } } ] }
+```
+
+')
+    .option('--sort <value>', 'Sort term and direction, using syntax `[-|+]term`.
+
+Valid terms:
+  - `submitted_time`')
+    .option('--email <value>', 'Email address to filter by, with optional operator.
+
+#### Operators:
+==: Exact match (default)
+!=: Not equal
+~~: Like (anywhere in the email)
+!~: Not like (anywhere in the email)
+')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching email api...').start();
+      try {
+        const data = await client.getEmailAPISummary({
+          emailId: options.emailId,
+          engagement: options.engagement,
+          status: options.status,
+          isoTime: options.isoTime,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          page: options.page != null ? Number(options.page) : undefined,
+          perPage: options.perPage != null ? Number(options.perPage) : undefined,
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+          tags: options.tags,
+          providers: options.providers,
+          sort: options.sort,
+          email: options.email,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  cmd
+    .command('get-email-apistats')
+    .description('Show Email API statistics')
+    .option('--interval <value>', 'interval')
+    .option('--iso-time <value>', 'Convert timestamps to human readable ISO format')
+    .option('--account-id <value>', 'Optional Account ID to be used for the request')
+    .option('--start-time <value>', 'Start time for the report.')
+    .option('--end-time <value>', 'End time for the report.')
+    .option('--providers <value>', '### Recursive Filter Query Language
+
+The filter is a JSON object that represents a recursive query structure. It uses the logical operators `and`, `or`, `not` and `is` as keys, with the following types of values:
+
+1. **`object`**: A nested filter object that defines additional conditions.
+
+2. **`string`**: A condition expressed as a single string.
+
+3. **`array`**: An array of strings (conditions) or nested filter objects.
+
+
+- The `and` and `or` operators accept `object` and `array`
+
+- The `not` operator accepts `object` and `string`
+
+- The `is` operator accepts `object` and `string`
+
+### Examples
+
+#### 1. Simple condition with a string
+
+```json
+{ "is": "condition1" }
+ ```
+
+ #### 2. Array of strings
+
+```json
+{ "or": ["condition1", "condition2"] }
+```
+
+#### 3. Nested filter object
+
+```json
+{ "not": { "and": ["condition1", "condition2"] } }
+```
+
+#### 4. Complex recursive query
+
+```json
+{ "and": [ { "or": ["condition1", "condition2"] }, { "not": { "and": ["condition3", "condition4"] } } ] }
+```
+
+')
+    .option('--tags <value>', '### Recursive Filter Query Language
+
+The filter is a JSON object that represents a recursive query structure. It uses the logical operators `and`, `or`, `not` and `is` as keys, with the following types of values:
+
+1. **`object`**: A nested filter object that defines additional conditions.
+
+2. **`string`**: A condition expressed as a single string.
+
+3. **`array`**: An array of strings (conditions) or nested filter objects.
+
+
+- The `and` and `or` operators accept `object` and `array`
+
+- The `not` operator accepts `object` and `string`
+
+- The `is` operator accepts `object` and `string`
+
+### Examples
+
+#### 1. Simple condition with a string
+
+```json
+{ "is": "condition1" }
+ ```
+
+ #### 2. Array of strings
+
+```json
+{ "or": ["condition1", "condition2"] }
+```
+
+#### 3. Nested filter object
+
+```json
+{ "not": { "and": ["condition1", "condition2"] } }
+```
+
+#### 4. Complex recursive query
+
+```json
+{ "and": [ { "or": ["condition1", "condition2"] }, { "not": { "and": ["condition3", "condition4"] } } ] }
+```
+
+')
+    .action(async (options) => {
+      const spinner = createSpinner('Fetching email api...').start();
+      try {
+        const data = await client.getEmailAPIStats({
+          interval: options.interval,
+          isoTime: options.isoTime,
+          accountId: options.accountId != null ? Number(options.accountId) : undefined,
+          startTime: options.startTime != null ? Number(options.startTime) : undefined,
+          endTime: options.endTime != null ? Number(options.endTime) : undefined,
+          providers: options.providers,
+          tags: options.tags,
+        });
+
+        spinner.stop();
+        formatter.output(data);
+      } catch (error: any) {
+        spinner.stop();
+        formatter.error(error.message);
+        process.exit(1);
+      }
+    });
+
+
+  return cmd;
+}