@opusdns/api 0.156.0 → 0.158.0

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
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
+import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -6728,6 +6728,116 @@ export type PATCH_EmailForwardsByEmailForwardIdEnable_Response_404 = Problem
  */
 export type PATCH_EmailForwardsByEmailForwardIdEnable_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET EmailForwardsByEmailForwardIdMetrics endpoint
+ *
+ * Retrieve email forward metrics
+ * Retrieves metrics and statistics for a specific email forward, including delivery rates and status counts.
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET EmailForwardsByEmailForwardIdMetrics endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_200} - 200 response type
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_401} - 401 response type
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_403} - 403 response type
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_404} - 404 response type
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_422} - 422 response type
+ *
+
+ */
+export type GET_EmailForwardsByEmailForwardIdMetrics_Response = GET_EmailForwardsByEmailForwardIdMetrics_Response_200 | GET_EmailForwardsByEmailForwardIdMetrics_Response_401 | GET_EmailForwardsByEmailForwardIdMetrics_Response_403 | GET_EmailForwardsByEmailForwardIdMetrics_Response_404 | GET_EmailForwardsByEmailForwardIdMetrics_Response_422;
+
+/**
+ * 200 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
+ * @see {@link EmailForwardMetrics} - The actual schema type definition
+ */
+export type GET_EmailForwardsByEmailForwardIdMetrics_Response_200 = EmailForwardMetrics
+
+/**
+ * 401 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 status code
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_EmailForwardsByEmailForwardIdMetrics_Response_401 = Problem
+
+/**
+ * 403 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 403 status code
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_EmailForwardsByEmailForwardIdMetrics_Response_403 = Problem
+
+/**
+ * 404 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_EmailForwardsByEmailForwardIdMetrics_Response_404 = Problem
+
+/**
+ * 422 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/email-forwards/{email_forward_id}/metrics
+ *
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_EmailForwardsByEmailForwardIdMetrics_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET Events endpoint
  *

package/src/helpers/schemas.d.ts

@@ -1883,37 +1883,85 @@ export type EmailForwardLog = components['schemas']['EmailForwardLog'];
  */
 export type EmailForwardLogEvent = components['schemas']['EmailForwardLogEvent'];
 /**
- * EmailForwardLogFinalStatus
+ * EmailForwardLogSortField
  *
  * @remarks
- * Type alias for the `EmailForwardLogFinalStatus` OpenAPI schema.
- * This type represents emailforwardlogfinalstatus data structures used in API requests and responses.
+ * Type alias for the `EmailForwardLogSortField` OpenAPI schema.
+ * This type represents emailforwardlogsortfield data structures used in API requests and responses.
  *
  * @example
  * ```typescript
- * const response = await api.getEmailForwardLogFinalStatus();
- * const item: EmailForwardLogFinalStatus = response.results;
+ * const response = await api.getEmailForwardLogSortField();
+ * const item: EmailForwardLogSortField = response.results;
  * ```
  *
  * @see {@link components} - The OpenAPI components schema definition
  */
-export type EmailForwardLogFinalStatus = components['schemas']['EmailForwardLogFinalStatus'];
+export type EmailForwardLogSortField = components['schemas']['EmailForwardLogSortField'];
 /**
- * EmailForwardLogSortField
+ * EmailForwardLogStatus
  *
  * @remarks
- * Type alias for the `EmailForwardLogSortField` OpenAPI schema.
- * This type represents emailforwardlogsortfield data structures used in API requests and responses.
+ * Type alias for the `EmailForwardLogStatus` OpenAPI schema.
+ * This type represents emailforwardlogstatus data structures used in API requests and responses.
  *
  * @example
  * ```typescript
- * const response = await api.getEmailForwardLogSortField();
- * const item: EmailForwardLogSortField = response.results;
+ * const response = await api.getEmailForwardLogStatus();
+ * const item: EmailForwardLogStatus = response.results;
  * ```
  *
  * @see {@link components} - The OpenAPI components schema definition
  */
-export type EmailForwardLogSortField = components['schemas']['EmailForwardLogSortField'];
+export type EmailForwardLogStatus = components['schemas']['EmailForwardLogStatus'];
+/**
+ * EmailForwardMetrics
+ *
+ * @remarks
+ * Type alias for the `EmailForwardMetrics` OpenAPI schema.
+ * This type represents emailforwardmetrics data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEmailForwardMetrics();
+ * const item: EmailForwardMetrics = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EmailForwardMetrics = components['schemas']['EmailForwardMetrics'];
+/**
+ * EmailForwardMetricsFilters
+ *
+ * @remarks
+ * Type alias for the `EmailForwardMetricsFilters` OpenAPI schema.
+ * This type represents emailforwardmetricsfilters data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEmailForwardMetricsFilters();
+ * const item: EmailForwardMetricsFilters = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EmailForwardMetricsFilters = components['schemas']['EmailForwardMetricsFilters'];
+/**
+ * EmailForwardMetricsRates
+ *
+ * @remarks
+ * Type alias for the `EmailForwardMetricsRates` OpenAPI schema.
+ * This type represents emailforwardmetricsrates data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEmailForwardMetricsRates();
+ * const item: EmailForwardMetricsRates = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EmailForwardMetricsRates = components['schemas']['EmailForwardMetricsRates'];
 /**
  * EmailForwardResponse
  *

package/src/openapi.yaml

@@ -2259,11 +2259,6 @@ components:
           - type: 'null'
           description: Additional information to include in the restore operation
           title: Additional Info
-        auto_renew:
-          default: true
-          description: Whether to automatically renew the domain after restore
-          title: Auto Renew
-          type: boolean
         reason:
           anyOf:
           - type: string
@@ -2760,10 +2755,9 @@ components:
           title: Events
           type: array
         final_status:
+          $ref: '#/components/schemas/EmailForwardLogStatus'
           description: Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
             HARD-BOUNCE)
-          title: Final Status
-          type: string
         forward_email:
           description: Forward destination email address
           title: Forward Email
@@ -2875,15 +2869,6 @@ components:
       - status
       title: EmailForwardLogEvent
       type: object
-    EmailForwardLogFinalStatus:
-      enum:
-      - QUEUED
-      - DELIVERED
-      - REFUSED
-      - SOFT-BOUNCE
-      - HARD-BOUNCE
-      title: EmailForwardLogFinalStatus
-      type: string
     EmailForwardLogSortField:
       enum:
       - log_id
@@ -2895,6 +2880,90 @@ components:
       - synced_on
       title: EmailForwardLogSortField
       type: string
+    EmailForwardLogStatus:
+      enum:
+      - QUEUED
+      - DELIVERED
+      - REFUSED
+      - SOFT-BOUNCE
+      - HARD-BOUNCE
+      title: EmailForwardLogStatus
+      type: string
+    EmailForwardMetrics:
+      properties:
+        by_status:
+          additionalProperties:
+            type: integer
+          description: Log counts grouped by status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
+            HARD-BOUNCE)
+          propertyNames:
+            $ref: '#/components/schemas/EmailForwardLogStatus'
+          title: By Status
+          type: object
+        filters:
+          $ref: '#/components/schemas/EmailForwardMetricsFilters'
+          description: Applied filters
+        rates:
+          $ref: '#/components/schemas/EmailForwardMetricsRates'
+          description: Rate percentages for each status
+        total_logs:
+          description: Total number of email forward logs
+          title: Total Logs
+          type: integer
+      required:
+      - total_logs
+      - by_status
+      - rates
+      - filters
+      title: EmailForwardMetrics
+      type: object
+    EmailForwardMetricsFilters:
+      properties:
+        domain:
+          description: Domain name
+          title: Domain
+          type: string
+        end_time:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: End time filter (RFC3339)
+          title: End Time
+        start_time:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Start time filter (RFC3339)
+          title: Start Time
+      required:
+      - domain
+      title: EmailForwardMetricsFilters
+      type: object
+    EmailForwardMetricsRates:
+      properties:
+        delivered:
+          description: Delivery rate percentage
+          title: Delivered
+          type: number
+        hard_bounce:
+          description: Hard bounce rate percentage
+          title: Hard Bounce
+          type: number
+        refused:
+          description: Refused rate percentage
+          title: Refused
+          type: number
+        soft_bounce:
+          description: Soft bounce rate percentage
+          title: Soft Bounce
+          type: number
+      required:
+      - delivered
+      - refused
+      - soft_bounce
+      - hard_bounce
+      title: EmailForwardMetricsRates
+      type: object
     EmailForwardResponse:
       properties:
         aliases:
@@ -6544,7 +6613,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-01-13-161713
+  version: 2026-01-15-094311
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6613,7 +6682,7 @@ paths:
         required: false
         schema:
           anyOf:
-          - $ref: '#/components/schemas/EmailForwardLogFinalStatus'
+          - $ref: '#/components/schemas/EmailForwardLogStatus'
           - type: 'null'
           title: Final Status
       - in: query
@@ -6703,7 +6772,7 @@ paths:
         required: false
         schema:
           anyOf:
-          - $ref: '#/components/schemas/EmailForwardLogFinalStatus'
+          - $ref: '#/components/schemas/EmailForwardLogStatus'
           - type: 'null'
           title: Final Status
       - in: query
@@ -12700,6 +12769,95 @@ paths:
       summary: Enable email forwarding
       tags:
       - email_forward
+  /v1/email-forwards/{email_forward_id}/metrics:
+    get:
+      description: Retrieves metrics and statistics for a specific email forward,
+        including delivery rates and status counts.
+      operationId: get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get
+      parameters:
+      - in: path
+        name: email_forward_id
+        required: true
+        schema:
+          examples:
+          - email_forward_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Email Forward Id
+          type: string
+          x-typeid-prefix: email_forward
+      - in: query
+        name: start_time
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Start Time
+      - in: query
+        name: end_time
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: End Time
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EmailForwardMetrics'
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PERMISSION_DENIED
+                detail: Insufficient permissions to perform this action
+                status: 403
+                title: Permission Denied
+                type: permission-denied
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_EMAIL_FORWARD_NOT_FOUND
+                detail: 'Email forward not found for hostname: Additional error context.'
+                status: 404
+                title: Email Forward Error
+                type: email-forward-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Retrieve email forward metrics
+      tags:
+      - email_forward
   /v1/events:
     get:
       description: Retrieves a paginated list of events for the organization