@opusdns/api 0.157.0 → 0.159.0

package/src/helpers/keys.ts

@@ -115,10 +115,14 @@ import { DomainWithdraw } from './schemas';
 import { DomainsExpiringSoon } from './schemas';
 import { EmailForwardAlias } from './schemas';
 import { EmailForwardAliasCreate } from './schemas';
+import { EmailForwardAliasMetrics } from './schemas';
 import { EmailForwardAliasUpdate } from './schemas';
 import { EmailForwardCreate } from './schemas';
 import { EmailForwardLog } from './schemas';
 import { EmailForwardLogEvent } from './schemas';
+import { EmailForwardMetrics } from './schemas';
+import { EmailForwardMetricsFilters } from './schemas';
+import { EmailForwardMetricsRates } from './schemas';
 import { EmailForward } from './schemas';
 import { EmailForwardZone } from './schemas';
 import { EventResponse } from './schemas';
@@ -11331,6 +11335,111 @@ export const KEYS_EMAIL_FORWARD_ALIAS_CREATE = [
   KEY_EMAIL_FORWARD_ALIAS_CREATE_FORWARD_TO,
 ] as const satisfies (keyof EmailForwardAliasCreate)[];
 
+/**
+ * Alias
+ *
+ * Email alias address
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `alias` property of EmailForwardAliasMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardaliasmetrics[KEY_EMAIL_FORWARD_ALIAS_METRICS_ALIAS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_ALIAS_METRICS_ALIAS;
+ * const value = emailforwardaliasmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardAliasMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_ALIAS_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_ALIAS_METRICS_ALIAS: keyof EmailForwardAliasMetrics = 'alias';
+/**
+ * By Status
+ *
+ * Log counts grouped by status
+ *
+ * @type {object}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `by_status` property of EmailForwardAliasMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardaliasmetrics[KEY_EMAIL_FORWARD_ALIAS_METRICS_BY_STATUS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_ALIAS_METRICS_BY_STATUS;
+ * const value = emailforwardaliasmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardAliasMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_ALIAS_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_ALIAS_METRICS_BY_STATUS: keyof EmailForwardAliasMetrics = 'by_status';
+/**
+ * Total Logs
+ *
+ * Total number of logs for this alias
+ *
+ * @type {integer}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `total_logs` property of EmailForwardAliasMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardaliasmetrics[KEY_EMAIL_FORWARD_ALIAS_METRICS_TOTAL_LOGS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_ALIAS_METRICS_TOTAL_LOGS;
+ * const value = emailforwardaliasmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardAliasMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_ALIAS_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_ALIAS_METRICS_TOTAL_LOGS: keyof EmailForwardAliasMetrics = 'total_logs';
+
+/**
+ * Array of all EmailForwardAliasMetrics property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for EmailForwardAliasMetrics objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_EMAIL_FORWARD_ALIAS_METRICS) {
+ *   console.log(`Property: ${key}, Value: ${emailforwardaliasmetrics[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_EMAIL_FORWARD_ALIAS_METRICS.includes(someKey);
+ * ```
+ *
+ * @see {@link EmailForwardAliasMetrics} - The TypeScript type definition
+ */
+export const KEYS_EMAIL_FORWARD_ALIAS_METRICS = [
+  KEY_EMAIL_FORWARD_ALIAS_METRICS_ALIAS,
+  KEY_EMAIL_FORWARD_ALIAS_METRICS_BY_STATUS,
+  KEY_EMAIL_FORWARD_ALIAS_METRICS_TOTAL_LOGS,
+] as const satisfies (keyof EmailForwardAliasMetrics)[];
+
 /**
  * Forward To
  *
@@ -11562,11 +11671,10 @@ export const KEY_EMAIL_FORWARD_LOG_DOMAIN: keyof EmailForwardLog = 'domain';
  */
 export const KEY_EMAIL_FORWARD_LOG_EVENTS: keyof EmailForwardLog = 'events';
 /**
- * Final Status
+ * final_status property
  *
  * Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
  *
- * @type {string}
  *
  *
  * @remarks
@@ -12149,6 +12257,449 @@ export const KEYS_EMAIL_FORWARD_LOG_EVENT = [
   KEY_EMAIL_FORWARD_LOG_EVENT_STATUS,
 ] as const satisfies (keyof EmailForwardLogEvent)[];
 
+/**
+ * Alias Count
+ *
+ * Number of aliases
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `alias_count` property of EmailForwardMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_ALIAS_COUNT];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_ALIAS_COUNT;
+ * const value = emailforwardmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_ALIAS_COUNT: keyof EmailForwardMetrics = 'alias_count';
+/**
+ * By Alias
+ *
+ * Metrics breakdown per alias
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `by_alias` property of EmailForwardMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_BY_ALIAS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_BY_ALIAS;
+ * const value = emailforwardmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_BY_ALIAS: keyof EmailForwardMetrics = 'by_alias';
+/**
+ * By Status
+ *
+ * Log counts grouped by status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
+ *
+ * @type {object}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `by_status` property of EmailForwardMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_BY_STATUS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_BY_STATUS;
+ * const value = emailforwardmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_BY_STATUS: keyof EmailForwardMetrics = 'by_status';
+/**
+ * filters property
+ *
+ * Applied filters
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `filters` property of EmailForwardMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_FILTERS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS;
+ * const value = emailforwardmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_FILTERS: keyof EmailForwardMetrics = 'filters';
+/**
+ * rates property
+ *
+ * Rate percentages for each status
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `rates` property of EmailForwardMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_RATES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES;
+ * const value = emailforwardmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_RATES: keyof EmailForwardMetrics = 'rates';
+/**
+ * Total Logs
+ *
+ * Total number of email forward logs
+ *
+ * @type {integer}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `total_logs` property of EmailForwardMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS;
+ * const value = emailforwardmetrics[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetrics} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS: keyof EmailForwardMetrics = 'total_logs';
+
+/**
+ * Array of all EmailForwardMetrics property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for EmailForwardMetrics objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_EMAIL_FORWARD_METRICS) {
+ *   console.log(`Property: ${key}, Value: ${emailforwardmetrics[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_EMAIL_FORWARD_METRICS.includes(someKey);
+ * ```
+ *
+ * @see {@link EmailForwardMetrics} - The TypeScript type definition
+ */
+export const KEYS_EMAIL_FORWARD_METRICS = [
+  KEY_EMAIL_FORWARD_METRICS_ALIAS_COUNT,
+  KEY_EMAIL_FORWARD_METRICS_BY_ALIAS,
+  KEY_EMAIL_FORWARD_METRICS_BY_STATUS,
+  KEY_EMAIL_FORWARD_METRICS_FILTERS,
+  KEY_EMAIL_FORWARD_METRICS_RATES,
+  KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS,
+] as const satisfies (keyof EmailForwardMetrics)[];
+
+/**
+ * Domain
+ *
+ * Domain name
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `domain` property of EmailForwardMetricsFilters objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetricsfilters[KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN;
+ * const value = emailforwardmetricsfilters[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS_FILTERS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN: keyof EmailForwardMetricsFilters = 'domain';
+/**
+ * End Time
+ *
+ * End time filter (RFC3339)
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `end_time` property of EmailForwardMetricsFilters objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetricsfilters[KEY_EMAIL_FORWARD_METRICS_FILTERS_END_TIME];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS_END_TIME;
+ * const value = emailforwardmetricsfilters[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS_FILTERS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_FILTERS_END_TIME: keyof EmailForwardMetricsFilters = 'end_time';
+/**
+ * Include Aliases
+ *
+ * Whether alias breakdown is included
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `include_aliases` property of EmailForwardMetricsFilters objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetricsfilters[KEY_EMAIL_FORWARD_METRICS_FILTERS_INCLUDE_ALIASES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS_INCLUDE_ALIASES;
+ * const value = emailforwardmetricsfilters[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS_FILTERS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_FILTERS_INCLUDE_ALIASES: keyof EmailForwardMetricsFilters = 'include_aliases';
+/**
+ * Start Time
+ *
+ * Start time filter (RFC3339)
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `start_time` property of EmailForwardMetricsFilters objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetricsfilters[KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME;
+ * const value = emailforwardmetricsfilters[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS_FILTERS} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME: keyof EmailForwardMetricsFilters = 'start_time';
+
+/**
+ * Array of all EmailForwardMetricsFilters property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for EmailForwardMetricsFilters objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_EMAIL_FORWARD_METRICS_FILTERS) {
+ *   console.log(`Property: ${key}, Value: ${emailforwardmetricsfilters[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_EMAIL_FORWARD_METRICS_FILTERS.includes(someKey);
+ * ```
+ *
+ * @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
+ */
+export const KEYS_EMAIL_FORWARD_METRICS_FILTERS = [
+  KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN,
+  KEY_EMAIL_FORWARD_METRICS_FILTERS_END_TIME,
+  KEY_EMAIL_FORWARD_METRICS_FILTERS_INCLUDE_ALIASES,
+  KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME,
+] as const satisfies (keyof EmailForwardMetricsFilters)[];
+
+/**
+ * Bounce Rate
+ *
+ * Bounce rate percentage
+ *
+ * @type {number}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `bounce_rate` property of EmailForwardMetricsRates objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_BOUNCE_RATE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_BOUNCE_RATE;
+ * const value = emailforwardmetricsrates[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetricsRates} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS_RATES} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_RATES_BOUNCE_RATE: keyof EmailForwardMetricsRates = 'bounce_rate';
+/**
+ * Delivery Rate
+ *
+ * Delivery rate percentage
+ *
+ * @type {number}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `delivery_rate` property of EmailForwardMetricsRates objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERY_RATE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERY_RATE;
+ * const value = emailforwardmetricsrates[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetricsRates} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS_RATES} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERY_RATE: keyof EmailForwardMetricsRates = 'delivery_rate';
+/**
+ * Queued Rate
+ *
+ * Queued rate percentage
+ *
+ * @type {number}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `queued_rate` property of EmailForwardMetricsRates objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_QUEUED_RATE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_QUEUED_RATE;
+ * const value = emailforwardmetricsrates[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetricsRates} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS_RATES} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_RATES_QUEUED_RATE: keyof EmailForwardMetricsRates = 'queued_rate';
+/**
+ * Refused Rate
+ *
+ * Refused rate percentage
+ *
+ * @type {number}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `refused_rate` property of EmailForwardMetricsRates objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED_RATE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED_RATE;
+ * const value = emailforwardmetricsrates[propertyName];
+ * ```
+ *
+ * @see {@link EmailForwardMetricsRates} - The TypeScript type definition
+ * @see {@link KEYS_EMAIL_FORWARD_METRICS_RATES} - Array of all keys for this type
+ */
+export const KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED_RATE: keyof EmailForwardMetricsRates = 'refused_rate';
+
+/**
+ * Array of all EmailForwardMetricsRates property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for EmailForwardMetricsRates objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_EMAIL_FORWARD_METRICS_RATES) {
+ *   console.log(`Property: ${key}, Value: ${emailforwardmetricsrates[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_EMAIL_FORWARD_METRICS_RATES.includes(someKey);
+ * ```
+ *
+ * @see {@link EmailForwardMetricsRates} - The TypeScript type definition
+ */
+export const KEYS_EMAIL_FORWARD_METRICS_RATES = [
+  KEY_EMAIL_FORWARD_METRICS_RATES_BOUNCE_RATE,
+  KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERY_RATE,
+  KEY_EMAIL_FORWARD_METRICS_RATES_QUEUED_RATE,
+  KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED_RATE,
+] as const satisfies (keyof EmailForwardMetricsRates)[];
+
 /**
  * Aliases
  *

package/src/helpers/requests.d.ts

@@ -3589,6 +3589,59 @@ export type PATCH_EmailForwardsEmailForwardIdEnable_Request = {
  */
 export type PATCH_EmailForwardsEmailForwardIdEnable_Request_Path = PATCH_EmailForwardsEmailForwardIdEnable_Request['parameters']['path'];
 
+/**
+ * Request type for GET EmailForwardsEmailForwardIdMetrics endpoint
+ *
+ * Retrieve email forward metrics
+ * Retrieves metrics and statistics for a specific email forward, including delivery rates and status counts.
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET EmailForwardsEmailForwardIdMetrics endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @see {@link GET_EmailForwardsEmailForwardIdMetrics_Request_Query} - Query parameters type
+ * @see {@link GET_EmailForwardsEmailForwardIdMetrics_Request_Path} - Path parameters type
+ * @see {@link GET_EmailForwardsEmailForwardIdMetrics_Request_Body} - Request body type
+ */
+export type GET_EmailForwardsEmailForwardIdMetrics_Request = {
+  parameters: {
+    query: operations['get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get']['parameters']['query'];
+    path: operations['get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get']['parameters']['path'];
+  };
+}
+/**
+ * Query parameters for GET /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/email-forwards/{email_forward_id}/metrics endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ */
+export type GET_EmailForwardsEmailForwardIdMetrics_Request_Query = GET_EmailForwardsEmailForwardIdMetrics_Request['parameters']['query'];
+/**
+ * Path parameters for GET /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @remarks
+ * This type defines the path parameters for the GET /v1/email-forwards/{email_forward_id}/metrics endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ */
+export type GET_EmailForwardsEmailForwardIdMetrics_Request_Path = GET_EmailForwardsEmailForwardIdMetrics_Request['parameters']['path'];
+
 /**
  * Request type for GET Events endpoint
  *