@opusdns/api 0.124.0 → 0.126.0

package/package.json

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

package/src/helpers/keys.ts

@@ -78,6 +78,7 @@ import { DomainForwardRequest } from './schemas';
 import { DomainForwardSetRequest } from './schemas';
 import { DomainForwardSet } from './schemas';
 import { DomainForwardZone } from './schemas';
+import { DomainHost } from './schemas';
 import { DomainLifecycleBase } from './schemas';
 import { DomainNameParts } from './schemas';
 import { DomainPeriod } from './schemas';
@@ -7498,6 +7499,57 @@ export const KEYS_DOMAIN_FORWARD_ZONE = [
   KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME,
 ] as const satisfies (keyof DomainForwardZone)[];
 
+/**
+ * Host Id
+ *
+ * The host id of the host
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `host_id` property of DomainHost objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainhost[KEY_DOMAIN_HOST_HOST_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_HOST_HOST_ID;
+ * const value = domainhost[propertyName];
+ * ```
+ *
+ * @see {@link DomainHost} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_HOST} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_HOST_HOST_ID = 'host_id' as keyof DomainHost;
+
+/**
+ * Array of all DomainHost property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainHost objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_HOST) {
+ *   console.log(`Property: ${key}, Value: ${domainhost[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_HOST.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainHost} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_HOST = [
+  KEY_DOMAIN_HOST_HOST_ID,
+] as const satisfies (keyof DomainHost)[];
+
 /**
  * Add Grace Period
  *
@@ -8419,6 +8471,32 @@ export const KEY_DOMAIN_DOMAIN_ID = 'domain_id' as keyof Domain;
  * @see {@link KEYS_DOMAIN} - Array of all keys for this type
  */
 export const KEY_DOMAIN_EXPIRES_ON = 'expires_on' as keyof Domain;
+/**
+ * Hosts
+ *
+ * The subordinate hosts of the domain
+ *
+ * @type {array}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `hosts` property of Domain objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domain[KEY_DOMAIN_HOSTS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_HOSTS;
+ * const value = domain[propertyName];
+ * ```
+ *
+ * @see {@link Domain} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_HOSTS = 'hosts' as keyof Domain;
 /**
  * Name
  *
@@ -8448,7 +8526,7 @@ export const KEY_DOMAIN_NAME = 'name' as keyof Domain;
 /**
  * Nameservers
  *
- * All the domain statuses
+ * The nameservers of the domain
  *
  * @type {array}
  *
@@ -8758,6 +8836,7 @@ export const KEYS_DOMAIN = [
   KEY_DOMAIN_DELETED_ON,
   KEY_DOMAIN_DOMAIN_ID,
   KEY_DOMAIN_EXPIRES_ON,
+  KEY_DOMAIN_HOSTS,
   KEY_DOMAIN_NAME,
   KEY_DOMAIN_NAMESERVERS,
   KEY_DOMAIN_OWNER_ID,

package/src/helpers/responses.d.ts

@@ -2335,10 +2335,11 @@ export type GET_DnsEmailForwards_Response_422 = HTTPValidationError
  * @path /v1/dns/summary
  *
  * @see {@link GET_DnsSummary_Response_200} - 200 response type
+ * @see {@link GET_DnsSummary_Response_422} - 422 response type
  *
 
  */
-export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
+export type GET_DnsSummary_Response = GET_DnsSummary_Response_200 | GET_DnsSummary_Response_422;
 
 /**
  * 200 response for GET DnsSummary endpoint
@@ -2357,6 +2358,23 @@ export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
  */
 export type GET_DnsSummary_Response_200 = DnsZoneSummary
 
+/**
+ * 422 response for GET DnsSummary endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET DnsSummary endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/dns/summary
+ *
+ * @see {@link GET_DnsSummary_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_DnsSummary_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET DomainForwards endpoint
  *
@@ -4760,10 +4778,11 @@ export type GET_DomainsCheck_Response_422 = HTTPValidationError
  * @path /v1/domains/summary
  *
  * @see {@link GET_DomainsSummary_Response_200} - 200 response type
+ * @see {@link GET_DomainsSummary_Response_422} - 422 response type
  *
 
  */
-export type GET_DomainsSummary_Response = GET_DomainsSummary_Response_200;
+export type GET_DomainsSummary_Response = GET_DomainsSummary_Response_200 | GET_DomainsSummary_Response_422;
 
 /**
  * 200 response for GET DomainsSummary endpoint
@@ -4782,6 +4801,23 @@ export type GET_DomainsSummary_Response = GET_DomainsSummary_Response_200;
  */
 export type GET_DomainsSummary_Response_200 = DomainSummary
 
+/**
+ * 422 response for GET DomainsSummary endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET DomainsSummary endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/summary
+ *
+ * @see {@link GET_DomainsSummary_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_DomainsSummary_Response_422 = HTTPValidationError
+
 /**
  * Response types for POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint
  *
@@ -7553,10 +7589,11 @@ Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6
  * @see {@link GET_OrganizationsIpRestrictions_Response_200} - 200 response type
  * @see {@link GET_OrganizationsIpRestrictions_Response_401} - 401 response type
  * @see {@link GET_OrganizationsIpRestrictions_Response_403} - 403 response type
+ * @see {@link GET_OrganizationsIpRestrictions_Response_422} - 422 response type
  *
 
  */
-export type GET_OrganizationsIpRestrictions_Response = GET_OrganizationsIpRestrictions_Response_200 | GET_OrganizationsIpRestrictions_Response_401 | GET_OrganizationsIpRestrictions_Response_403;
+export type GET_OrganizationsIpRestrictions_Response = GET_OrganizationsIpRestrictions_Response_200 | GET_OrganizationsIpRestrictions_Response_401 | GET_OrganizationsIpRestrictions_Response_403 | GET_OrganizationsIpRestrictions_Response_422;
 
 /**
  * 200 response for GET OrganizationsIpRestrictions endpoint
@@ -7609,6 +7646,23 @@ export type GET_OrganizationsIpRestrictions_Response_401 = Problem
  */
 export type GET_OrganizationsIpRestrictions_Response_403 = Problem
 
+/**
+ * 422 response for GET OrganizationsIpRestrictions endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET OrganizationsIpRestrictions endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/organizations/ip-restrictions
+ *
+ * @see {@link GET_OrganizationsIpRestrictions_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_OrganizationsIpRestrictions_Response_422 = HTTPValidationError
+
 /**
  * Response types for POST OrganizationsIpRestrictions endpoint
  *
@@ -7987,10 +8041,11 @@ export type PATCH_OrganizationsIpRestrictionsByIpRestrictionId_Response_422 = HT
  *
  * @see {@link GET_OrganizationsRoles_Response_401} - 401 response type
  * @see {@link GET_OrganizationsRoles_Response_403} - 403 response type
+ * @see {@link GET_OrganizationsRoles_Response_422} - 422 response type
  *
 
  */
-export type GET_OrganizationsRoles_Response = GET_OrganizationsRoles_Response_401 | GET_OrganizationsRoles_Response_403;
+export type GET_OrganizationsRoles_Response = GET_OrganizationsRoles_Response_401 | GET_OrganizationsRoles_Response_403 | GET_OrganizationsRoles_Response_422;
 
 /**
  * 401 response for GET OrganizationsRoles endpoint
@@ -8026,6 +8081,23 @@ export type GET_OrganizationsRoles_Response_401 = Problem
  */
 export type GET_OrganizationsRoles_Response_403 = Problem
 
+/**
+ * 422 response for GET OrganizationsRoles endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET OrganizationsRoles endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/organizations/roles
+ *
+ * @see {@link GET_OrganizationsRoles_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_OrganizationsRoles_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET OrganizationsUsers endpoint
  *
@@ -8246,10 +8318,11 @@ export type GET_TldsByTld_Response_422 = HTTPValidationError
  * @path /v1/tlds/portfolio
  *
  * @see {@link GET_TldsPortfolio_Response_200} - 200 response type
+ * @see {@link GET_TldsPortfolio_Response_422} - 422 response type
  *
 
  */
-export type GET_TldsPortfolio_Response = GET_TldsPortfolio_Response_200;
+export type GET_TldsPortfolio_Response = GET_TldsPortfolio_Response_200 | GET_TldsPortfolio_Response_422;
 
 /**
  * 200 response for GET TldsPortfolio endpoint
@@ -8268,6 +8341,23 @@ export type GET_TldsPortfolio_Response = GET_TldsPortfolio_Response_200;
  */
 export type GET_TldsPortfolio_Response_200 = TldResponseShortArray
 
+/**
+ * 422 response for GET TldsPortfolio endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET TldsPortfolio endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/tlds/portfolio
+ *
+ * @see {@link GET_TldsPortfolio_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_TldsPortfolio_Response_422 = HTTPValidationError
+
 /**
  * Response types for POST Users 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, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, 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, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -401,6 +401,20 @@ export type SyncOperationTypeArray = SyncOperationType[];
  * @see {@link DomainContact} - The individual DomainContactResponse type definition
  */
 export type DomainContactArray = DomainContact[];
+/**
+ * DomainHostResponse
+ *
+ * @remarks
+ * Array type for DomainHostResponse objects. Used when the API returns a collection of DomainHostResponse instances.
+ *
+ * @example
+ * ```typescript
+ * const items: DomainHostArray = await api.getDomainHosts();
+ * ```
+ *
+ * @see {@link DomainHost} - The individual DomainHostResponse type definition
+ */
+export type DomainHostArray = DomainHost[];
 /**
  * DomainSearchSuggestionWithPrice
  *

package/src/helpers/schemas.d.ts

@@ -1210,6 +1210,22 @@ export type DomainForwardZone = components['schemas']['DomainForwardZone'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardZoneSortField = components['schemas']['DomainForwardZoneSortField'];
+/**
+ * DomainHostResponse
+ *
+ * @remarks
+ * Type alias for the `DomainHostResponse` OpenAPI schema.
+ * This type represents domainhostresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainHost();
+ * const item: DomainHost = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainHost = components['schemas']['DomainHostResponse'];
 /**
  * DomainLifecycleBase
  *

package/src/openapi.yaml

@@ -1769,6 +1769,21 @@ components:
       - updated_on
       title: DomainForwardZoneSortField
       type: string
+    DomainHostResponse:
+      properties:
+        host_id:
+          description: The host id of the host
+          examples:
+          - host_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Host Id
+          type: string
+          x-typeid-prefix: host
+      required:
+      - host_id
+      title: DomainHostResponse
+      type: object
     DomainLifecycleBase:
       properties:
         add_grace_period:
@@ -2014,6 +2029,12 @@ components:
           - type: 'null'
           description: When the domain expires
           title: Expires On
+        hosts:
+          description: The subordinate hosts of the domain
+          items:
+            $ref: '#/components/schemas/DomainHostResponse'
+          title: Hosts
+          type: array
         name:
           description: The domain name
           examples:
@@ -2021,7 +2042,7 @@ components:
           title: Name
           type: string
         nameservers:
-          description: All the domain statuses
+          description: The nameservers of the domain
           items:
             $ref: '#/components/schemas/Nameserver'
           title: Nameservers
@@ -5978,7 +5999,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-12-11-192124
+  version: 2025-12-16-155016
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8040,6 +8061,12 @@ paths:
               schema:
                 $ref: '#/components/schemas/DnsZoneSummary'
           description: DNS zones summary retrieved successfully
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
       security:
       - OAuth2PasswordBearer: []
       summary: Get Zones Summary
@@ -10184,6 +10211,12 @@ paths:
               schema:
                 $ref: '#/components/schemas/DomainSummaryResponse'
           description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
       security:
       - OAuth2PasswordBearer: []
       summary: Get domain summary
@@ -12451,6 +12484,12 @@ paths:
               schema:
                 $ref: '#/components/schemas/Problem'
           description: Forbidden
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
       security:
       - OAuth2PasswordBearer: []
       summary: List IP restrictions
@@ -12722,6 +12761,12 @@ paths:
               schema:
                 $ref: '#/components/schemas/Problem'
           description: Forbidden
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
       security:
       - OAuth2PasswordBearer: []
       summary: List all roles
@@ -13379,6 +13424,12 @@ paths:
                 title: Response Get Tld Portfolio V1 Tlds Portfolio Get
                 type: array
           description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
       security:
       - OAuth2PasswordBearer: []
       summary: Get the list of TLDs we support

package/src/schema.d.ts

@@ -2767,6 +2767,16 @@ export interface components {
          * @enum {string}
          */
         DomainForwardZoneSortField: "name" | "created_on" | "updated_on";
+        /** DomainHostResponse */
+        DomainHostResponse: {
+            /**
+             * Host Id
+             * Format: typeid
+             * @description The host id of the host
+             * @example host_01h45ytscbebyvny4gc8cr8ma2
+             */
+            host_id: TypeId<"host">;
+        };
         /** DomainLifecycleBase */
         DomainLifecycleBase: {
             /**
@@ -2927,6 +2937,11 @@ export interface components {
              * @description When the domain expires
              */
             expires_on?: Date | null;
+            /**
+             * Hosts
+             * @description The subordinate hosts of the domain
+             */
+            hosts?: components["schemas"]["DomainHostResponse"][];
             /**
              * Name
              * @description The domain name
@@ -2935,7 +2950,7 @@ export interface components {
             name: string;
             /**
              * Nameservers
-             * @description All the domain statuses
+             * @description The nameservers of the domain
              */
             nameservers?: components["schemas"]["Nameserver"][];
             /**
@@ -6858,6 +6873,15 @@ export interface operations {
                     "application/json": components["schemas"]["DnsZoneSummary"];
                 };
             };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
         };
     };
     get_zone_v1_dns__zone_name__get: {
@@ -8543,6 +8567,15 @@ export interface operations {
                     "application/json": components["schemas"]["DomainSummaryResponse"];
                 };
             };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
         };
     };
     withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post: {
@@ -10744,6 +10777,15 @@ export interface operations {
                     "application/problem+json": components["schemas"]["Problem"];
                 };
             };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
         };
     };
     create_ip_restriction_v1_organizations_ip_restrictions_post: {
@@ -11052,6 +11094,15 @@ export interface operations {
                     "application/problem+json": components["schemas"]["Problem"];
                 };
             };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
         };
     };
     list_users_v1_organizations_users_get: {
@@ -11602,6 +11653,15 @@ export interface operations {
                     "application/json": components["schemas"]["TldResponseShort"][];
                 };
             };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
         };
     };
     get_tld_spec_v1_tlds__tld__get: {