@opusdns/api 0.207.0 → 0.209.0

package/package.json

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

package/src/helpers/keys.ts

@@ -211,7 +211,6 @@ import { UserWithRelationPermissions } from './schemas';
 import { ValidationError } from './schemas';
 import { VisitsByKeyBucket } from './schemas';
 import { WhoisBase } from './schemas';
-import { WildcardHttpRedirectRequest } from './schemas';
 import { RequestAuthcode } from './schemas';
 import { RequestAuthcode2 } from './schemas';
 import { DomainAvailabilityList } from './schemas';
@@ -27700,184 +27699,6 @@ export const KEYS_WHOIS_BASE = [
   KEY_WHOIS_BASE_WHOIS_SERVER,
 ] as const satisfies (keyof WhoisBase)[];
 
-/**
- * redirect_code property
- *
- *
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `redirect_code` property of WildcardHttpRedirectRequest objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = wildcardhttpredirectrequest[KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REDIRECT_CODE];
- * 
- * // Dynamic property access
- * const propertyName = KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REDIRECT_CODE;
- * const value = wildcardhttpredirectrequest[propertyName];
- * ```
- *
- * @see {@link WildcardHttpRedirectRequest} - The TypeScript type definition
- * @see {@link KEYS_WILDCARD_HTTP_REDIRECT_REQUEST} - Array of all keys for this type
- */
-export const KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REDIRECT_CODE: keyof WildcardHttpRedirectRequest = 'redirect_code';
-/**
- * Request Path
- *
- *
- * @type {string}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `request_path` property of WildcardHttpRedirectRequest objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = wildcardhttpredirectrequest[KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REQUEST_PATH];
- * 
- * // Dynamic property access
- * const propertyName = KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REQUEST_PATH;
- * const value = wildcardhttpredirectrequest[propertyName];
- * ```
- *
- * @see {@link WildcardHttpRedirectRequest} - The TypeScript type definition
- * @see {@link KEYS_WILDCARD_HTTP_REDIRECT_REQUEST} - Array of all keys for this type
- */
-export const KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REQUEST_PATH: keyof WildcardHttpRedirectRequest = 'request_path';
-/**
- * Request Subdomain
- *
- *
- * @type {string}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `request_subdomain` property of WildcardHttpRedirectRequest objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = wildcardhttpredirectrequest[KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REQUEST_SUBDOMAIN];
- * 
- * // Dynamic property access
- * const propertyName = KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REQUEST_SUBDOMAIN;
- * const value = wildcardhttpredirectrequest[propertyName];
- * ```
- *
- * @see {@link WildcardHttpRedirectRequest} - The TypeScript type definition
- * @see {@link KEYS_WILDCARD_HTTP_REDIRECT_REQUEST} - Array of all keys for this type
- */
-export const KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REQUEST_SUBDOMAIN: keyof WildcardHttpRedirectRequest = 'request_subdomain';
-/**
- * Target Hostname
- *
- *
- * @type {string}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `target_hostname` property of WildcardHttpRedirectRequest objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = wildcardhttpredirectrequest[KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_HOSTNAME];
- * 
- * // Dynamic property access
- * const propertyName = KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_HOSTNAME;
- * const value = wildcardhttpredirectrequest[propertyName];
- * ```
- *
- * @see {@link WildcardHttpRedirectRequest} - The TypeScript type definition
- * @see {@link KEYS_WILDCARD_HTTP_REDIRECT_REQUEST} - Array of all keys for this type
- */
-export const KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_HOSTNAME: keyof WildcardHttpRedirectRequest = 'target_hostname';
-/**
- * Target Path
- *
- *
- * @type {string}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `target_path` property of WildcardHttpRedirectRequest objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = wildcardhttpredirectrequest[KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PATH];
- * 
- * // Dynamic property access
- * const propertyName = KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PATH;
- * const value = wildcardhttpredirectrequest[propertyName];
- * ```
- *
- * @see {@link WildcardHttpRedirectRequest} - The TypeScript type definition
- * @see {@link KEYS_WILDCARD_HTTP_REDIRECT_REQUEST} - Array of all keys for this type
- */
-export const KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PATH: keyof WildcardHttpRedirectRequest = 'target_path';
-/**
- * target_protocol property
- *
- *
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `target_protocol` property of WildcardHttpRedirectRequest objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = wildcardhttpredirectrequest[KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PROTOCOL];
- * 
- * // Dynamic property access
- * const propertyName = KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PROTOCOL;
- * const value = wildcardhttpredirectrequest[propertyName];
- * ```
- *
- * @see {@link WildcardHttpRedirectRequest} - The TypeScript type definition
- * @see {@link KEYS_WILDCARD_HTTP_REDIRECT_REQUEST} - Array of all keys for this type
- */
-export const KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PROTOCOL: keyof WildcardHttpRedirectRequest = 'target_protocol';
-
-/**
- * Array of all WildcardHttpRedirectRequest property keys
- *
- * @remarks
- * This constant provides a readonly array containing all valid property keys for WildcardHttpRedirectRequest objects.
- * Useful for iteration, validation, and generating dynamic UI components.
- *
- * @example
- * ```typescript
- * // Iterating through all keys
- * for (const key of KEYS_WILDCARD_HTTP_REDIRECT_REQUEST) {
- *   console.log(`Property: ${key}, Value: ${wildcardhttpredirectrequest[key]}`);
- * }
- * 
- * // Validation
- * const isValidKey = KEYS_WILDCARD_HTTP_REDIRECT_REQUEST.includes(someKey);
- * ```
- *
- * @see {@link WildcardHttpRedirectRequest} - The TypeScript type definition
- */
-export const KEYS_WILDCARD_HTTP_REDIRECT_REQUEST = [
-  KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REDIRECT_CODE,
-  KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REQUEST_PATH,
-  KEY_WILDCARD_HTTP_REDIRECT_REQUEST_REQUEST_SUBDOMAIN,
-  KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_HOSTNAME,
-  KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PATH,
-  KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PROTOCOL,
-] as const satisfies (keyof WildcardHttpRedirectRequest)[];
-
 /**
  * Detail
  *

package/src/helpers/requests.d.ts

@@ -2066,61 +2066,6 @@ export type GET_DomainForwardsHostnameProtocol_Request = {
  */
 export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwardsHostnameProtocol_Request['parameters']['path'];
 
-/**
- * Request type for POST DomainForwardsHostnameProtocol endpoint
- *
- * Create domain forward set (deprecated)
- * Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
- *
- * @remarks
- * This type defines the complete request structure for the POST DomainForwardsHostnameProtocol 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/domain-forwards/{hostname}/{protocol}
- * @param hostname (path) - Hostname
- *
- * @see {@link POST_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
- * @see {@link POST_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
- * @see {@link POST_DomainForwardsHostnameProtocol_Request_Body} - Request body type
- */
-export type POST_DomainForwardsHostnameProtocol_Request = {
-  parameters: {
-    path: operations['create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post']['parameters']['path'];
-  };
-  requestBody: DomainForwardSetRequest;
-}
-/**
- * Path parameters for POST /v1/domain-forwards/{hostname}/{protocol}
- *
- * @remarks
- * This type defines the path parameters for the POST /v1/domain-forwards/{hostname}/{protocol} 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/domain-forwards/{hostname}/{protocol}
- * @param hostname (path) - Hostname
- */
-export type POST_DomainForwardsHostnameProtocol_Request_Path = POST_DomainForwardsHostnameProtocol_Request['parameters']['path'];
-/**
- * Request body for POST /v1/domain-forwards/{hostname}/{protocol}
- *
- * @remarks
- * This type defines the request body structure for the POST /v1/domain-forwards/{hostname}/{protocol} endpoint.
- * It provides type safety for the request body as defined in the OpenAPI specification.
- *
- * @example
- * Use this type to ensure type safety for request body structure.
- *
- * @path /v1/domain-forwards/{hostname}/{protocol}
- */
-export type POST_DomainForwardsHostnameProtocol_Request_Body = POST_DomainForwardsHostnameProtocol_Request['requestBody'];
-
 /**
  * Request type for PUT DomainForwardsHostnameProtocol endpoint
  *
@@ -2179,7 +2124,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 +2169,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 +2214,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 +2259,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 +2304,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 +2349,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 +2394,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 +2439,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 +2484,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.