@opusdns/api 0.206.0 → 0.208.0

package/package.json

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

package/src/helpers/requests.d.ts

@@ -2179,7 +2179,8 @@ export type PUT_DomainForwardsHostnameProtocol_Request_Body = PUT_DomainForwards
 /**
  * Request type for GET DomainForwardsMetrics endpoint
  *
- * Metrics
+ * Get domain forward metrics
+ * Retrieves overall metrics for domain forwards including total and unique visit counts.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetrics endpoint.
@@ -2223,7 +2224,8 @@ export type GET_DomainForwardsMetrics_Request_Query = GET_DomainForwardsMetrics_
 /**
  * Request type for GET DomainForwardsMetricsBrowser endpoint
  *
- * Browser Stats
+ * Get browser statistics
+ * Retrieves visitor traffic broken down by browser type (Chrome, Safari, Firefox, etc.) with total and unique visit counts.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetricsBrowser endpoint.
@@ -2267,7 +2269,8 @@ export type GET_DomainForwardsMetricsBrowser_Request_Query = GET_DomainForwardsM
 /**
  * Request type for GET DomainForwardsMetricsGeo endpoint
  *
- * Geo Stats
+ * Get geographic statistics
+ * Retrieves visitor traffic broken down by geographic location (country code) with visit counts.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetricsGeo endpoint.
@@ -2311,7 +2314,8 @@ export type GET_DomainForwardsMetricsGeo_Request_Query = GET_DomainForwardsMetri
 /**
  * Request type for GET DomainForwardsMetricsPlatform endpoint
  *
- * Platform Stats
+ * Get platform statistics
+ * Retrieves visitor traffic broken down by platform (Windows, Macintosh, iOS, Android, Linux) with total and unique visit counts.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetricsPlatform endpoint.
@@ -2355,7 +2359,8 @@ export type GET_DomainForwardsMetricsPlatform_Request_Query = GET_DomainForwards
 /**
  * Request type for GET DomainForwardsMetricsReferrer endpoint
  *
- * Referrer Stats
+ * Get referrer statistics
+ * Retrieves visitor referral sources (where traffic came from) with total and unique visit counts.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetricsReferrer endpoint.
@@ -2399,7 +2404,8 @@ export type GET_DomainForwardsMetricsReferrer_Request_Query = GET_DomainForwards
 /**
  * Request type for GET DomainForwardsMetricsStatusCode endpoint
  *
- * Status Code Stats
+ * Get HTTP status code statistics
+ * Retrieves distribution of HTTP redirect status codes (301, 302, 307, 308) used across forwards.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetricsStatusCode endpoint.
@@ -2443,7 +2449,8 @@ export type GET_DomainForwardsMetricsStatusCode_Request_Query = GET_DomainForwar
 /**
  * Request type for GET DomainForwardsMetricsTimeSeries endpoint
  *
- * Time Series
+ * Get domain forward time series metrics
+ * Retrieves visit counts bucketed by time intervals (hourly, daily) for the specified time range.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetricsTimeSeries endpoint.
@@ -2487,7 +2494,8 @@ export type GET_DomainForwardsMetricsTimeSeries_Request_Query = GET_DomainForwar
 /**
  * Request type for GET DomainForwardsMetricsUserAgent endpoint
  *
- * User Agent Stats
+ * Get user agent statistics
+ * Retrieves visitor traffic broken down by user agent string with total and unique visit counts.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetricsUserAgent endpoint.
@@ -2531,7 +2539,8 @@ export type GET_DomainForwardsMetricsUserAgent_Request_Query = GET_DomainForward
 /**
  * Request type for GET DomainForwardsMetricsVisitsByKey endpoint
  *
- * Visits By Key
+ * Get visits grouped by key
+ * Retrieves visit metrics grouped by a specified key (url, fqdn, domain, or forward) with total and unique visit counts.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwardsMetricsVisitsByKey endpoint.
@@ -3551,7 +3560,7 @@ export type POST_EmailForwards_Request_Body = POST_EmailForwards_Request['reques
  * Request type for DELETE EmailForwardsEmailForwardId endpoint
  *
  * Delete email forward configuration
- * Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from ImprovMX).
+ * Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from the email forwarding provider).
  *
  * @remarks
  * This type defines the complete request structure for the DELETE EmailForwardsEmailForwardId endpoint.
@@ -3590,7 +3599,7 @@ export type DELETE_EmailForwardsEmailForwardId_Request_Path = DELETE_EmailForwar
  * Request type for GET EmailForwardsEmailForwardId endpoint
  *
  * Get email forward configuration
- * Retrieves the email forward configuration for the specified zone including all aliases
+ * Retrieves the email forward configuration for the specified email forward including all aliases
  *
  * @remarks
  * This type defines the complete request structure for the GET EmailForwardsEmailForwardId endpoint.
@@ -3629,7 +3638,7 @@ export type GET_EmailForwardsEmailForwardId_Request_Path = GET_EmailForwardsEmai
  * Request type for POST EmailForwardsEmailForwardIdAliases endpoint
  *
  * Create email forward alias
- * Creates a new email forward alias for the specified hostname.
+ * Creates a new email forward alias for the specified email forward. Use '*' as the alias name to configure a catch-all alias that forwards all unmatched emails for the domain.
  *
  * @remarks
  * This type defines the complete request structure for the POST EmailForwardsEmailForwardIdAliases endpoint.
@@ -3682,7 +3691,7 @@ export type POST_EmailForwardsEmailForwardIdAliases_Request_Body = POST_EmailFor
  * Request type for DELETE EmailForwardsEmailForwardIdAliasesAliasId endpoint
  *
  * Delete email forward alias
- * Deletes a specific email forward alias for the specified zone
+ * Deletes a specific email forward alias specified by email_forward_alias_id for the specified email forward
  *
  * @remarks
  * This type defines the complete request structure for the DELETE EmailForwardsEmailForwardIdAliasesAliasId endpoint.
@@ -3721,7 +3730,7 @@ export type DELETE_EmailForwardsEmailForwardIdAliasesAliasId_Request_Path = DELE
  * Request type for PUT EmailForwardsEmailForwardIdAliasesAliasId endpoint
  *
  * Update email forward alias
- * Updates the forward_to address for a specific email forward alias
+ * Updates the forward_to address for a specific email forward alias specified by email_forward_alias_id
  *
  * @remarks
  * This type defines the complete request structure for the PUT EmailForwardsEmailForwardIdAliasesAliasId endpoint.
@@ -3774,7 +3783,7 @@ export type PUT_EmailForwardsEmailForwardIdAliasesAliasId_Request_Body = PUT_Ema
  * Request type for PATCH EmailForwardsEmailForwardIdDisable endpoint
  *
  * Disable email forwarding
- * Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forward provider. The email forward configuration is preserved but disabled.
+ * Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forwarding provider. The email forward configuration is preserved but disabled.
  *
  * @remarks
  * This type defines the complete request structure for the PATCH EmailForwardsEmailForwardIdDisable endpoint.
@@ -3813,7 +3822,7 @@ export type PATCH_EmailForwardsEmailForwardIdDisable_Request_Path = PATCH_EmailF
  * Request type for PATCH EmailForwardsEmailForwardIdEnable endpoint
  *
  * Enable email forwarding
- * Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forward provider.
+ * Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forwarding provider.
  *
  * @remarks
  * This type defines the complete request structure for the PATCH EmailForwardsEmailForwardIdEnable endpoint.