@opusdns/api 0.94.0 → 0.96.0

package/package.json

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

package/src/helpers/constants.ts

@@ -2115,6 +2115,7 @@ export const PERMISSION = {
   MANAGE_DOMAINS: "manage_domains",
   MANAGE_EMAIL_FORWARDS: "manage_email_forwards",
   MANAGE_EVENTS: "manage_events",
+  MANAGE_HOSTS: "manage_hosts",
   MANAGE_OPUSDNS_API_KEYS: "manage_opusdns_api_keys",
   MANAGE_PRODUCTS: "manage_products",
   MANAGE_RESELLER: "manage_reseller",
@@ -2172,6 +2173,7 @@ export const PERMISSION_VALUES = [
   'manage_domains',
   'manage_email_forwards',
   'manage_events',
+  'manage_hosts',
   'manage_opusdns_api_keys',
   'manage_products',
   'manage_reseller',
@@ -2546,6 +2548,7 @@ export const RELATION = {
   DOMAIN_MANAGER: "domain_manager",
   EMAIL_FORWARD_MANAGER: "email_forward_manager",
   EVENTS_MANAGER: "events_manager",
+  HOST_MANAGER: "host_manager",
   MEMBER: "member",
   OPUSDNS_INTERNAL_API_KEY: "opusdns_internal_api_key",
   ORGANIZATION_MANAGER: "organization_manager",
@@ -2589,6 +2592,7 @@ export const RELATION_VALUES = [
   'domain_manager',
   'email_forward_manager',
   'events_manager',
+  'host_manager',
   'member',
   'opusdns_internal_api_key',
   'organization_manager',

package/src/helpers/keys.ts

@@ -76,6 +76,7 @@ import { DomainForwardProtocolSet } from './schemas';
 import { DomainForwardRequest } from './schemas';
 import { DomainForwardSetRequest } from './schemas';
 import { DomainForwardSet } from './schemas';
+import { DomainForwardZone } from './schemas';
 import { DomainLifecycleBase } from './schemas';
 import { DomainNameParts } from './schemas';
 import { DomainPeriod } from './schemas';
@@ -6670,30 +6671,6 @@ export const KEYS_DOMAIN_FORWARD_PATCH_OPS = [
   KEY_DOMAIN_FORWARD_PATCH_OPS_OPS,
 ] as const satisfies (keyof DomainForwardPatchOps)[];
 
-/**
- * Created On
- *
- *
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `created_on` property of DomainForwardProtocolSetRequest objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = domainforwardprotocolsetrequest[KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON];
- * 
- * // Dynamic property access
- * const propertyName = KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON;
- * const value = domainforwardprotocolsetrequest[propertyName];
- * ```
- *
- * @see {@link DomainForwardProtocolSetRequest} - The TypeScript type definition
- * @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
- */
-export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON = 'created_on' as keyof DomainForwardProtocolSetRequest;
 /**
  * Redirects
  *
@@ -6719,30 +6696,6 @@ export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON = 'created_on' a
  * @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
  */
 export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_REDIRECTS = 'redirects' as keyof DomainForwardProtocolSetRequest;
-/**
- * Updated On
- *
- *
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `updated_on` property of DomainForwardProtocolSetRequest objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = domainforwardprotocolsetrequest[KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_UPDATED_ON];
- * 
- * // Dynamic property access
- * const propertyName = KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_UPDATED_ON;
- * const value = domainforwardprotocolsetrequest[propertyName];
- * ```
- *
- * @see {@link DomainForwardProtocolSetRequest} - The TypeScript type definition
- * @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
- */
-export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_UPDATED_ON = 'updated_on' as keyof DomainForwardProtocolSetRequest;
 /**
  * Wildcard
  *
@@ -6789,9 +6742,7 @@ export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD = 'wildcard' as ke
  * @see {@link DomainForwardProtocolSetRequest} - The TypeScript type definition
  */
 export const KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST = [
-  KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON,
   KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_REDIRECTS,
-  KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_UPDATED_ON,
   KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD,
 ] as const satisfies (keyof DomainForwardProtocolSetRequest)[];
 
@@ -7277,6 +7228,108 @@ export const KEYS_DOMAIN_FORWARD_SET = [
   KEY_DOMAIN_FORWARD_SET_WILDCARD,
 ] as const satisfies (keyof DomainForwardSet)[];
 
+/**
+ * Domain Forwards
+ *
+ *
+ * @type {array}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `domain_forwards` property of DomainForwardZone objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_DOMAIN_FORWARDS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_FORWARD_ZONE_DOMAIN_FORWARDS;
+ * const value = domainforwardzone[propertyName];
+ * ```
+ *
+ * @see {@link DomainForwardZone} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_FORWARD_ZONE_DOMAIN_FORWARDS = 'domain_forwards' as keyof DomainForwardZone;
+/**
+ * Zone Id
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `zone_id` property of DomainForwardZone objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_ZONE_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_FORWARD_ZONE_ZONE_ID;
+ * const value = domainforwardzone[propertyName];
+ * ```
+ *
+ * @see {@link DomainForwardZone} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_FORWARD_ZONE_ZONE_ID = 'zone_id' as keyof DomainForwardZone;
+/**
+ * Zone Name
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `zone_name` property of DomainForwardZone objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME;
+ * const value = domainforwardzone[propertyName];
+ * ```
+ *
+ * @see {@link DomainForwardZone} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME = 'zone_name' as keyof DomainForwardZone;
+
+/**
+ * Array of all DomainForwardZone property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainForwardZone objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_FORWARD_ZONE) {
+ *   console.log(`Property: ${key}, Value: ${domainforwardzone[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_FORWARD_ZONE.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainForwardZone} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_FORWARD_ZONE = [
+  KEY_DOMAIN_FORWARD_ZONE_DOMAIN_FORWARDS,
+  KEY_DOMAIN_FORWARD_ZONE_ZONE_ID,
+  KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME,
+] as const satisfies (keyof DomainForwardZone)[];
+
 /**
  * Add Grace Period
  *

package/src/helpers/requests.d.ts

@@ -670,6 +670,45 @@ export type POST_Dns_Request = {
  */
 export type POST_Dns_Request_Body = POST_Dns_Request['requestBody'];
 
+/**
+ * Request type for GET DnsDomainForwards endpoint
+ *
+ * List domain forwards by zone
+ * Retrieves a paginated list of domain forwards grouped by DNS zones.
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET DnsDomainForwards 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/dns/domain-forwards
+ *
+ * @see {@link GET_DnsDomainForwards_Request_Query} - Query parameters type
+ * @see {@link GET_DnsDomainForwards_Request_Path} - Path parameters type
+ * @see {@link GET_DnsDomainForwards_Request_Body} - Request body type
+ */
+export type GET_DnsDomainForwards_Request = {
+  parameters: {
+    query: operations['list_domain_forwards_by_zone_v1_dns_domain_forwards_get']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for GET /v1/dns/domain-forwards
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/dns/domain-forwards 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/dns/domain-forwards
+ */
+export type GET_DnsDomainForwards_Request_Query = GET_DnsDomainForwards_Request['parameters']['query'];
+
 /**
  * Request type for GET DnsSummary endpoint
  *
@@ -852,6 +891,47 @@ export type POST_DnsZoneNameDnssecEnable_Request = {
  */
 export type POST_DnsZoneNameDnssecEnable_Request_Path = POST_DnsZoneNameDnssecEnable_Request['parameters']['path'];
 
+/**
+ * Request type for GET DnsZoneNameDomainForwards endpoint
+ *
+ * List domain forwards for a zone
+ * Retrieves all domain forwards configured for the specified DNS zone, including subdomains.
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET DnsZoneNameDomainForwards 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/dns/{zone_name}/domain-forwards
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Query} - Query parameters type
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Path} - Path parameters type
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Body} - Request body type
+ */
+export type GET_DnsZoneNameDomainForwards_Request = {
+  parameters: {
+    path: operations['list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get']['parameters']['path'];
+  };
+}
+/**
+ * Path parameters for GET /v1/dns/{zone_name}/domain-forwards
+ *
+ * @remarks
+ * This type defines the path parameters for the GET /v1/dns/{zone_name}/domain-forwards 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/dns/{zone_name}/domain-forwards
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ */
+export type GET_DnsZoneNameDomainForwards_Request_Path = GET_DnsZoneNameDomainForwards_Request['parameters']['path'];
+
 /**
  * Request type for PATCH DnsZoneNameRecords endpoint
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
+import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for POST AuthToken endpoint
@@ -1450,6 +1450,103 @@ export type POST_DnsByZoneNameDnssecEnable_Response_200 = DnsChanges
  */
 export type POST_DnsByZoneNameDnssecEnable_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET DnsByZoneNameDomainForwards endpoint
+ *
+ * List domain forwards for a zone
+ * Retrieves all domain forwards configured for the specified DNS zone, including subdomains.
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET DnsByZoneNameDomainForwards 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/dns/{zone_name}/domain-forwards
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response_200} - 200 response type
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response_401} - 401 response type
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response_403} - 403 response type
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response_422} - 422 response type
+ *
+
+ */
+export type GET_DnsByZoneNameDomainForwards_Response = GET_DnsByZoneNameDomainForwards_Response_200 | GET_DnsByZoneNameDomainForwards_Response_401 | GET_DnsByZoneNameDomainForwards_Response_403 | GET_DnsByZoneNameDomainForwards_Response_422;
+
+/**
+ * 200 response for GET DnsByZoneNameDomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET DnsByZoneNameDomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/{zone_name}/domain-forwards
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response} - The main response type definition
+ * @see {@link DomainForwardZone} - The actual schema type definition
+ */
+export type GET_DnsByZoneNameDomainForwards_Response_200 = DomainForwardZone
+
+/**
+ * 401 response for GET DnsByZoneNameDomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 status code
+ * of the GET DnsByZoneNameDomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/{zone_name}/domain-forwards
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_DnsByZoneNameDomainForwards_Response_401 = Problem
+
+/**
+ * 403 response for GET DnsByZoneNameDomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 403 status code
+ * of the GET DnsByZoneNameDomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/{zone_name}/domain-forwards
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_DnsByZoneNameDomainForwards_Response_403 = Problem
+
+/**
+ * 422 response for GET DnsByZoneNameDomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET DnsByZoneNameDomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/{zone_name}/domain-forwards
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_DnsByZoneNameDomainForwards_Response_422 = HTTPValidationError
+
 /**
  * Response types for PATCH DnsByZoneNameRecords endpoint
  *
@@ -1624,6 +1721,98 @@ export type PUT_DnsByZoneNameRrsets_Response_400 = Problem
  */
 export type PUT_DnsByZoneNameRrsets_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET DnsDomainForwards endpoint
+ *
+ * List domain forwards by zone
+ * Retrieves a paginated list of domain forwards grouped by DNS zones.
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET DnsDomainForwards 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/dns/domain-forwards
+ *
+ * @see {@link GET_DnsDomainForwards_Response_200} - 200 response type
+ * @see {@link GET_DnsDomainForwards_Response_401} - 401 response type
+ * @see {@link GET_DnsDomainForwards_Response_403} - 403 response type
+ * @see {@link GET_DnsDomainForwards_Response_422} - 422 response type
+ *
+
+ */
+export type GET_DnsDomainForwards_Response = GET_DnsDomainForwards_Response_200 | GET_DnsDomainForwards_Response_401 | GET_DnsDomainForwards_Response_403 | GET_DnsDomainForwards_Response_422;
+
+/**
+ * 200 response for GET DnsDomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET DnsDomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/domain-forwards
+ *
+ * @see {@link GET_DnsDomainForwards_Response} - The main response type definition
+ * @see {@link Pagination_DomainForwardZone} - The actual schema type definition
+ */
+export type GET_DnsDomainForwards_Response_200 = Pagination_DomainForwardZone
+
+/**
+ * 401 response for GET DnsDomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 status code
+ * of the GET DnsDomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/domain-forwards
+ *
+ * @see {@link GET_DnsDomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_DnsDomainForwards_Response_401 = Problem
+
+/**
+ * 403 response for GET DnsDomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 403 status code
+ * of the GET DnsDomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/domain-forwards
+ *
+ * @see {@link GET_DnsDomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_DnsDomainForwards_Response_403 = Problem
+
+/**
+ * 422 response for GET DnsDomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET DnsDomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/domain-forwards
+ *
+ * @see {@link GET_DnsDomainForwards_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_DnsDomainForwards_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET DnsSummary endpoint
  *

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, DomainForwardPatchOp, HttpRedirectList, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForward, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, 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, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -345,6 +345,20 @@ export type DomainForwardPatchOpArray = DomainForwardPatchOp[];
  * @see {@link HttpRedirectList} - The individual HttpRedirectListResponse type definition
  */
 export type HttpRedirectListArray = HttpRedirectList[];
+/**
+ * DomainForward
+ *
+ * @remarks
+ * Array type for DomainForward objects. Used when the API returns a collection of DomainForward instances.
+ *
+ * @example
+ * ```typescript
+ * const items: DomainForwardArray = await api.getDomainForwards();
+ * ```
+ *
+ * @see {@link DomainForward} - The individual DomainForward type definition
+ */
+export type DomainForwardArray = DomainForward[];
 /**
  * DeletePolicyType
  *
@@ -598,19 +612,19 @@ export type ContactSchemaArray = ContactSchema[];
  */
 export type DnsZoneArray = DnsZone[];
 /**
- * DomainForward
+ * DomainForwardZone
  *
  * @remarks
- * Array type for DomainForward objects. Used when the API returns a collection of DomainForward instances.
+ * Array type for DomainForwardZone objects. Used when the API returns a collection of DomainForwardZone instances.
  *
  * @example
  * ```typescript
- * const items: DomainForwardArray = await api.getDomainForwards();
+ * const items: DomainForwardZoneArray = await api.getDomainForwardZones();
  * ```
  *
- * @see {@link DomainForward} - The individual DomainForward type definition
+ * @see {@link DomainForwardZone} - The individual DomainForwardZone type definition
  */
-export type DomainForwardArray = DomainForward[];
+export type DomainForwardZoneArray = DomainForwardZone[];
 /**
  * DomainResponse
  *

package/src/helpers/schemas.d.ts

@@ -1146,6 +1146,22 @@ export type DomainForwardSetRequest = components['schemas']['DomainForwardSetReq
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardSet = components['schemas']['DomainForwardSetResponse'];
+/**
+ * DomainForwardZone
+ *
+ * @remarks
+ * Type alias for the `DomainForwardZone` OpenAPI schema.
+ * This type represents domainforwardzone data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardZone();
+ * const item: DomainForwardZone = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardZone = components['schemas']['DomainForwardZone'];
 /**
  * DomainLifecycleBase
  *
@@ -2239,6 +2255,22 @@ export type Pagination_ContactSchema = components['schemas']['Pagination_Contact
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Pagination_DnsZone = components['schemas']['Pagination_DnsZoneResponse_'];
+/**
+ * Pagination[DomainForwardZone]
+ *
+ * @remarks
+ * Type alias for the `Pagination_DomainForwardZone_` OpenAPI schema.
+ * This type represents pagination[domainforwardzone] data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPagination_DomainForwardZone();
+ * const item: Pagination_DomainForwardZone = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Pagination_DomainForwardZone = components['schemas']['Pagination_DomainForwardZone_'];
 /**
  * Pagination[DomainForward]
  *

package/src/openapi.yaml

@@ -1596,12 +1596,6 @@ components:
       type: object
     DomainForwardProtocolSetRequest:
       properties:
-        created_on:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Created On
         redirects:
           items:
             anyOf:
@@ -1609,12 +1603,6 @@ components:
             - $ref: '#/components/schemas/WildcardHttpRedirectRequest'
           title: Redirects
           type: array
-        updated_on:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Updated On
         wildcard:
           anyOf:
           - type: boolean
@@ -1715,6 +1703,30 @@ components:
       - created_on
       title: DomainForwardSetResponse
       type: object
+    DomainForwardZone:
+      properties:
+        domain_forwards:
+          items:
+            $ref: '#/components/schemas/DomainForward'
+          title: Domain Forwards
+          type: array
+        zone_id:
+          examples:
+          - zone_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Zone Id
+          type: string
+          x-typeid-prefix: zone
+        zone_name:
+          title: Zone Name
+          type: string
+      required:
+      - zone_id
+      - zone_name
+      - domain_forwards
+      title: DomainForwardZone
+      type: object
     DomainLifecycleBase:
       properties:
         add_grace_period:
@@ -3847,6 +3859,20 @@ components:
       - pagination
       title: Pagination[DnsZoneResponse]
       type: object
+    Pagination_DomainForwardZone_:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadata'
+        results:
+          items:
+            $ref: '#/components/schemas/DomainForwardZone'
+          title: Results
+          type: array
+      required:
+      - results
+      - pagination
+      title: Pagination[DomainForwardZone]
+      type: object
     Pagination_DomainForward_:
       properties:
         pagination:
@@ -4010,6 +4036,7 @@ components:
       - manage_domains
       - manage_email_forwards
       - manage_events
+      - manage_hosts
       - manage_opusdns_api_keys
       - manage_products
       - manage_reseller
@@ -4257,6 +4284,7 @@ components:
       - domain_manager
       - email_forward_manager
       - events_manager
+      - host_manager
       - member
       - opusdns_internal_api_key
       - organization_manager
@@ -5265,7 +5293,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-11-13-093836
+  version: 2025-11-14-091055
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6482,6 +6510,150 @@ paths:
       summary: Create Zone
       tags:
       - dns
+  /v1/dns/domain-forwards:
+    get:
+      description: Retrieves a paginated list of domain forwards grouped by DNS zones.
+      operationId: list_domain_forwards_by_zone_v1_dns_domain_forwards_get
+      parameters:
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/ZoneSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: dnssec_status
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/DnssecStatus'
+          - type: 'null'
+          title: Dnssec Status
+      - in: query
+        name: name
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Name
+      - in: query
+        name: search
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Search
+      - in: query
+        name: suffix
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Suffix
+      - in: query
+        name: created_after
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Created After
+      - in: query
+        name: created_before
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Created Before
+      - in: query
+        name: updated_after
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Updated After
+      - in: query
+        name: updated_before
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Updated Before
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pagination_DomainForwardZone_'
+          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
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: List domain forwards by zone
+      tags:
+      - dns
   /v1/dns/summary:
     get:
       operationId: get_zones_summary_v1_dns_summary_get
@@ -6612,6 +6784,62 @@ paths:
       summary: Enable Dnssec
       tags:
       - dns
+  /v1/dns/{zone_name}/domain-forwards:
+    get:
+      description: Retrieves all domain forwards configured for the specified DNS
+        zone, including subdomains.
+      operationId: list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainForwardZone'
+          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
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: List domain forwards for a zone
+      tags:
+      - dns
   /v1/dns/{zone_name}/records:
     patch:
       operationId: patch_zone_records_v1_dns__zone_name__records_patch

package/src/schema.d.ts

@@ -178,6 +178,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/dns/domain-forwards": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List domain forwards by zone
+         * @description Retrieves a paginated list of domain forwards grouped by DNS zones.
+         */
+        get: operations["list_domain_forwards_by_zone_v1_dns_domain_forwards_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/dns/summary": {
         parameters: {
             query?: never;
@@ -247,6 +267,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/dns/{zone_name}/domain-forwards": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List domain forwards for a zone
+         * @description Retrieves all domain forwards configured for the specified DNS zone, including subdomains.
+         */
+        get: operations["list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/dns/{zone_name}/records": {
         parameters: {
             query?: never;
@@ -2355,12 +2395,8 @@ export interface components {
         };
         /** DomainForwardProtocolSetRequest */
         DomainForwardProtocolSetRequest: {
-            /** Created On */
-            created_on?: Date | null;
             /** Redirects */
             redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
-            /** Updated On */
-            updated_on?: Date | null;
             /** Wildcard */
             wildcard?: boolean | null;
         };
@@ -2418,6 +2454,19 @@ export interface components {
             /** Wildcard */
             wildcard: boolean;
         };
+        /** DomainForwardZone */
+        DomainForwardZone: {
+            /** Domain Forwards */
+            domain_forwards: components["schemas"]["DomainForward"][];
+            /**
+             * Zone Id
+             * Format: typeid
+             * @example zone_01h45ytscbebyvny4gc8cr8ma2
+             */
+            zone_id: TypeId<"zone">;
+            /** Zone Name */
+            zone_name: string;
+        };
         /** DomainLifecycleBase */
         DomainLifecycleBase: {
             /**
@@ -3844,6 +3893,12 @@ export interface components {
             /** Results */
             results: components["schemas"]["DnsZoneResponse"][];
         };
+        /** Pagination[DomainForwardZone] */
+        Pagination_DomainForwardZone_: {
+            pagination: components["schemas"]["PaginationMetadata"];
+            /** Results */
+            results: components["schemas"]["DomainForwardZone"][];
+        };
         /** Pagination[DomainForward] */
         Pagination_DomainForward_: {
             pagination: components["schemas"]["PaginationMetadata"];
@@ -3919,7 +3974,7 @@ export interface components {
          * Permission
          * @enum {string}
          */
-        Permission: "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_email_forwards" | "manage_events" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_users" | "manage_user_relations" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "verify" | "view" | "view_audit_logs" | "view_events";
+        Permission: "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_email_forwards" | "manage_events" | "manage_hosts" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_users" | "manage_user_relations" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "verify" | "view" | "view_audit_logs" | "view_events";
         /** PermissionSet */
         PermissionSet: {
             /** Permissions */
@@ -4067,7 +4122,7 @@ export interface components {
          * Relation
          * @enum {string}
          */
-        Relation: "accepted_tos" | "admin" | "api_admin" | "billing_manager" | "client_api_key" | "cms_content_editor" | "contact_manager" | "domain_manager" | "email_forward_manager" | "events_manager" | "member" | "opusdns_internal_api_key" | "organization_manager" | "owner" | "parent" | "product_manager" | "reseller_manager" | "root_admin" | "self";
+        Relation: "accepted_tos" | "admin" | "api_admin" | "billing_manager" | "client_api_key" | "cms_content_editor" | "contact_manager" | "domain_manager" | "email_forward_manager" | "events_manager" | "host_manager" | "member" | "opusdns_internal_api_key" | "organization_manager" | "owner" | "parent" | "product_manager" | "reseller_manager" | "root_admin" | "self";
         /** RelationSet */
         RelationSet: {
             /** Relations */
@@ -5683,6 +5738,80 @@ export interface operations {
             };
         };
     };
+    list_domain_forwards_by_zone_v1_dns_domain_forwards_get: {
+        parameters: {
+            query?: {
+                sort_by?: components["schemas"]["ZoneSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
+                dnssec_status?: components["schemas"]["DnssecStatus"] | null;
+                name?: string | null;
+                search?: string | null;
+                suffix?: string | null;
+                created_after?: Date | null;
+                created_before?: Date | null;
+                updated_after?: Date | null;
+                updated_before?: Date | null;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Pagination_DomainForwardZone_"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_PERMISSION_DENIED",
+                     *       "detail": "Insufficient permissions to perform this action",
+                     *       "status": 403,
+                     *       "title": "Permission Denied",
+                     *       "type": "permission-denied"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_zones_summary_v1_dns_summary_get: {
         parameters: {
             query?: never;
@@ -5829,6 +5958,70 @@ export interface operations {
             };
         };
     };
+    list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description DNS zone name (trailing dot optional) */
+                zone_name: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DomainForwardZone"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_PERMISSION_DENIED",
+                     *       "detail": "Insufficient permissions to perform this action",
+                     *       "status": 403,
+                     *       "title": "Permission Denied",
+                     *       "type": "permission-denied"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     patch_zone_records_v1_dns__zone_name__records_patch: {
         parameters: {
             query?: never;