@opusdns/api 0.158.0 → 0.159.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.158.0",
+  "version": "0.159.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -115,6 +115,7 @@ 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';
@@ -11334,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
  *
@@ -12151,6 +12257,56 @@ 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
  *
@@ -12275,6 +12431,8 @@ export const KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS: keyof EmailForwardMetrics = '
  * @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,
@@ -12332,6 +12490,31 @@ export const KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN: keyof EmailForwardMetrics
  * @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
  *
@@ -12381,113 +12564,114 @@ export const KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME: keyof EmailForwardMet
 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)[];
 
 /**
- * Delivered
+ * Bounce Rate
  *
- * Delivery rate percentage
+ * Bounce rate percentage
  *
  * @type {number}
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `delivered` property of EmailForwardMetricsRates objects.
+ * 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_DELIVERED];
+ * const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_BOUNCE_RATE];
  * 
  * // Dynamic property access
- * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERED;
+ * 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_DELIVERED: keyof EmailForwardMetricsRates = 'delivered';
+export const KEY_EMAIL_FORWARD_METRICS_RATES_BOUNCE_RATE: keyof EmailForwardMetricsRates = 'bounce_rate';
 /**
- * Hard Bounce
+ * Delivery Rate
  *
- * Hard bounce rate percentage
+ * Delivery rate percentage
  *
  * @type {number}
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `hard_bounce` property of EmailForwardMetricsRates objects.
+ * 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_HARD_BOUNCE];
+ * const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERY_RATE];
  * 
  * // Dynamic property access
- * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_HARD_BOUNCE;
+ * 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_HARD_BOUNCE: keyof EmailForwardMetricsRates = 'hard_bounce';
+export const KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERY_RATE: keyof EmailForwardMetricsRates = 'delivery_rate';
 /**
- * Refused
+ * Queued Rate
  *
- * Refused rate percentage
+ * Queued rate percentage
  *
  * @type {number}
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `refused` property of EmailForwardMetricsRates objects.
+ * 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_REFUSED];
+ * const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_QUEUED_RATE];
  * 
  * // Dynamic property access
- * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED;
+ * 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_REFUSED: keyof EmailForwardMetricsRates = 'refused';
+export const KEY_EMAIL_FORWARD_METRICS_RATES_QUEUED_RATE: keyof EmailForwardMetricsRates = 'queued_rate';
 /**
- * Soft Bounce
+ * Refused Rate
  *
- * Soft bounce rate percentage
+ * Refused rate percentage
  *
  * @type {number}
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `soft_bounce` property of EmailForwardMetricsRates objects.
+ * 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_SOFT_BOUNCE];
+ * const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED_RATE];
  * 
  * // Dynamic property access
- * const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_SOFT_BOUNCE;
+ * 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_SOFT_BOUNCE: keyof EmailForwardMetricsRates = 'soft_bounce';
+export const KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED_RATE: keyof EmailForwardMetricsRates = 'refused_rate';
 
 /**
  * Array of all EmailForwardMetricsRates property keys
@@ -12510,10 +12694,10 @@ export const KEY_EMAIL_FORWARD_METRICS_RATES_SOFT_BOUNCE: keyof EmailForwardMetr
  * @see {@link EmailForwardMetricsRates} - The TypeScript type definition
  */
 export const KEYS_EMAIL_FORWARD_METRICS_RATES = [
-  KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERED,
-  KEY_EMAIL_FORWARD_METRICS_RATES_HARD_BOUNCE,
-  KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED,
-  KEY_EMAIL_FORWARD_METRICS_RATES_SOFT_BOUNCE,
+  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)[];
 
 /**

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -597,6 +597,20 @@ export type EmailForwardAliasCreateArray = EmailForwardAliasCreate[];
  * @see {@link EmailForwardLogEvent} - The individual EmailForwardLogEvent type definition
  */
 export type EmailForwardLogEventArray = EmailForwardLogEvent[];
+/**
+ * EmailForwardAliasMetrics
+ *
+ * @remarks
+ * Array type for EmailForwardAliasMetrics objects. Used when the API returns a collection of EmailForwardAliasMetrics instances.
+ *
+ * @example
+ * ```typescript
+ * const items: EmailForwardAliasMetricsArray = await api.getEmailForwardAliasMetricss();
+ * ```
+ *
+ * @see {@link EmailForwardAliasMetrics} - The individual EmailForwardAliasMetrics type definition
+ */
+export type EmailForwardAliasMetricsArray = EmailForwardAliasMetrics[];
 /**
  * EmailForwardAlias
  *

package/src/helpers/schemas.d.ts

@@ -1818,6 +1818,22 @@ export type EmailForwardAlias = components['schemas']['EmailForwardAlias'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type EmailForwardAliasCreate = components['schemas']['EmailForwardAliasCreate'];
+/**
+ * EmailForwardAliasMetrics
+ *
+ * @remarks
+ * Type alias for the `EmailForwardAliasMetrics` OpenAPI schema.
+ * This type represents emailforwardaliasmetrics data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEmailForwardAliasMetrics();
+ * const item: EmailForwardAliasMetrics = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EmailForwardAliasMetrics = components['schemas']['EmailForwardAliasMetrics'];
 /**
  * EmailForwardAliasUpdate
  *

package/src/openapi.yaml

@@ -2705,6 +2705,30 @@ components:
       - forward_to
       title: EmailForwardAliasCreate
       type: object
+    EmailForwardAliasMetrics:
+      properties:
+        alias:
+          description: Email alias address
+          title: Alias
+          type: string
+        by_status:
+          additionalProperties:
+            type: integer
+          description: Log counts grouped by status
+          propertyNames:
+            $ref: '#/components/schemas/EmailForwardLogStatus'
+          title: By Status
+          type: object
+        total_logs:
+          description: Total number of logs for this alias
+          title: Total Logs
+          type: integer
+      required:
+      - alias
+      - total_logs
+      - by_status
+      title: EmailForwardAliasMetrics
+      type: object
     EmailForwardAliasUpdate:
       properties:
         forward_to:
@@ -2891,6 +2915,20 @@ components:
       type: string
     EmailForwardMetrics:
       properties:
+        alias_count:
+          anyOf:
+          - type: integer
+          - type: 'null'
+          description: Number of aliases
+          title: Alias Count
+        by_alias:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/EmailForwardAliasMetrics'
+            type: array
+          - type: 'null'
+          description: Metrics breakdown per alias
+          title: By Alias
         by_status:
           additionalProperties:
             type: integer
@@ -2929,6 +2967,12 @@ components:
           - type: 'null'
           description: End time filter (RFC3339)
           title: End Time
+        include_aliases:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          description: Whether alias breakdown is included
+          title: Include Aliases
         start_time:
           anyOf:
           - type: string
@@ -2941,27 +2985,27 @@ components:
       type: object
     EmailForwardMetricsRates:
       properties:
-        delivered:
+        bounce_rate:
+          description: Bounce rate percentage
+          title: Bounce Rate
+          type: number
+        delivery_rate:
           description: Delivery rate percentage
-          title: Delivered
+          title: Delivery Rate
           type: number
-        hard_bounce:
-          description: Hard bounce rate percentage
-          title: Hard Bounce
+        queued_rate:
+          description: Queued rate percentage
+          title: Queued Rate
           type: number
-        refused:
+        refused_rate:
           description: Refused rate percentage
-          title: Refused
-          type: number
-        soft_bounce:
-          description: Soft bounce rate percentage
-          title: Soft Bounce
+          title: Refused Rate
           type: number
       required:
-      - delivered
-      - refused
-      - soft_bounce
-      - hard_bounce
+      - delivery_rate
+      - refused_rate
+      - queued_rate
+      - bounce_rate
       title: EmailForwardMetricsRates
       type: object
     EmailForwardResponse:
@@ -6613,7 +6657,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-01-15-094311
+  version: 2026-01-15-095407
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -3533,6 +3533,26 @@ export interface components {
             /** Forward To */
             forward_to: string[];
         };
+        /** EmailForwardAliasMetrics */
+        EmailForwardAliasMetrics: {
+            /**
+             * Alias
+             * @description Email alias address
+             */
+            alias: string;
+            /**
+             * By Status
+             * @description Log counts grouped by status
+             */
+            by_status: {
+                [key: string]: number;
+            };
+            /**
+             * Total Logs
+             * @description Total number of logs for this alias
+             */
+            total_logs: number;
+        };
         /** EmailForwardAliasUpdate */
         EmailForwardAliasUpdate: {
             /** Forward To */
@@ -3686,6 +3706,16 @@ export interface components {
         EmailForwardLogStatus: "QUEUED" | "DELIVERED" | "REFUSED" | "SOFT-BOUNCE" | "HARD-BOUNCE";
         /** EmailForwardMetrics */
         EmailForwardMetrics: {
+            /**
+             * Alias Count
+             * @description Number of aliases
+             */
+            alias_count?: number | null;
+            /**
+             * By Alias
+             * @description Metrics breakdown per alias
+             */
+            by_alias?: components["schemas"]["EmailForwardAliasMetrics"][] | null;
             /**
              * By Status
              * @description Log counts grouped by status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
@@ -3715,6 +3745,11 @@ export interface components {
              * @description End time filter (RFC3339)
              */
             end_time?: string | null;
+            /**
+             * Include Aliases
+             * @description Whether alias breakdown is included
+             */
+            include_aliases?: boolean | null;
             /**
              * Start Time
              * @description Start time filter (RFC3339)
@@ -3724,25 +3759,25 @@ export interface components {
         /** EmailForwardMetricsRates */
         EmailForwardMetricsRates: {
             /**
-             * Delivered
-             * @description Delivery rate percentage
+             * Bounce Rate
+             * @description Bounce rate percentage
              */
-            delivered: number;
+            bounce_rate: number;
             /**
-             * Hard Bounce
-             * @description Hard bounce rate percentage
+             * Delivery Rate
+             * @description Delivery rate percentage
              */
-            hard_bounce: number;
+            delivery_rate: number;
             /**
-             * Refused
-             * @description Refused rate percentage
+             * Queued Rate
+             * @description Queued rate percentage
              */
-            refused: number;
+            queued_rate: number;
             /**
-             * Soft Bounce
-             * @description Soft bounce rate percentage
+             * Refused Rate
+             * @description Refused rate percentage
              */
-            soft_bounce: number;
+            refused_rate: number;
         };
         /** EmailForwardResponse */
         EmailForwardResponse: {