@opusdns/api 1.108.0 → 1.110.0

package/package.json

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

package/src/helpers/keys.ts

@@ -5995,6 +5995,7 @@ export const KEYS_DOMAIN_AVAILABILITY_LIST = [
 export const KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE = 'available' satisfies keyof DomainAvailabilityCheck;
 export const KEY_DOMAIN_AVAILABILITY_CHECK_CLAIMS_KEY = 'claims_key' satisfies keyof DomainAvailabilityCheck;
 export const KEY_DOMAIN_AVAILABILITY_CHECK_DOMAIN = 'domain' satisfies keyof DomainAvailabilityCheck;
+export const KEY_DOMAIN_AVAILABILITY_CHECK_ERROR = 'error' satisfies keyof DomainAvailabilityCheck;
 export const KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM = 'is_premium' satisfies keyof DomainAvailabilityCheck;
 export const KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING = 'premium_pricing' satisfies keyof DomainAvailabilityCheck;
 export const KEY_DOMAIN_AVAILABILITY_CHECK_REASON = 'reason' satisfies keyof DomainAvailabilityCheck;
@@ -6003,6 +6004,7 @@ export const KEYS_DOMAIN_AVAILABILITY_CHECK = [
   KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE,
   KEY_DOMAIN_AVAILABILITY_CHECK_CLAIMS_KEY,
   KEY_DOMAIN_AVAILABILITY_CHECK_DOMAIN,
+  KEY_DOMAIN_AVAILABILITY_CHECK_ERROR,
   KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM,
   KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING,
   KEY_DOMAIN_AVAILABILITY_CHECK_REASON,

package/src/openapi.yaml

@@ -5492,8 +5492,8 @@ components:
               $ref: '#/components/schemas/StatusTagResponse'
             type: array
           - type: 'null'
-          description: Status tags assigned to this domain. Only included when ?include=tags
-            is specified.
+          description: Status tags assigned to this domain. Null unless `include=tags`
+            is requested.
           title: Status Tags
         tags:
           anyOf:
@@ -5501,8 +5501,8 @@ components:
               $ref: '#/components/schemas/TagEnrichedResponse'
             type: array
           - type: 'null'
-          description: User tags assigned to this domain. Only included when ?include=tags
-            is specified.
+          description: User tags assigned to this domain. Null unless `include=tags`
+            is requested.
           title: Tags
         tld:
           description: The top level domain of the domain
@@ -15071,6 +15071,13 @@ components:
           - example.com
           title: Domain
           type: string
+        error:
+          anyOf:
+          - $ref: '#/components/schemas/DomainAvailabilityError'
+          - type: 'null'
+          description: 'Error that prevented this domain from being checked: `validation_error`
+            if the domain name is invalid or its TLD is not supported, `check_error`
+            if the registry check failed.'
         is_premium:
           default: false
           description: True if the registry classifies this domain as premium (non-standard
@@ -15088,8 +15095,8 @@ components:
           - type: string
           - type: 'null'
           description: Registry-supplied reason the domain is unavailable (e.g. 'Domain
-            exists', 'Reserved', 'In Use'). May be null when the domain is available,
-            or when the registry did not provide a reason.
+            exists', 'Reserved', 'In Use'). Null if the domain is available, failed
+            prechecks, or no reason was returned by the registry.
           examples:
           - Domain exists
           title: Reason
@@ -15169,7 +15176,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-08-10-192446
+  version: 2026-08-12-133338
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -22833,7 +22840,7 @@ paths:
       - domain_search
   /v1/domains:
     get:
-      description: Retrieves a paginated list of all active domains
+      description: Retrieves a paginated list of all active domains.
       operationId: get_domains_v1_domains_get
       parameters:
       - in: query
@@ -23088,8 +23095,9 @@ paths:
           description: Filter domains by registry status. Can be specified multiple
             times (union of all provided values).
           title: Registry Statuses
-      - description: Include additional data in the response. Can be specified multiple
-          times.
+      - description: Extra data to include in each result. `tags` populates the `tags`
+          (user tags) and `status_tags` fields, which are otherwise null; filtering
+          by `tag_ids` or `status_tags` alone does not populate them.
         in: query
         name: include
         required: false
@@ -23099,8 +23107,9 @@ paths:
               $ref: '#/components/schemas/DomainListIncludeField'
             type: array
           - type: 'null'
-          description: Include additional data in the response. Can be specified multiple
-            times.
+          description: Extra data to include in each result. `tags` populates the
+            `tags` (user tags) and `status_tags` fields, which are otherwise null;
+            filtering by `tag_ids` or `status_tags` alone does not populate them.
           title: Include
       - $ref: '#/components/parameters/DatetimeFormatHeader'
       responses:
@@ -23310,7 +23319,9 @@ paths:
 
             '
           items:
+            maxLength: 1024
             type: string
+          maxItems: 500
           title: Domains
           type: array
       - $ref: '#/components/parameters/DatetimeFormatHeader'
@@ -24502,7 +24513,7 @@ paths:
       x-required-permissions:
       - domains:delete
     get:
-      description: Retrieves a single active domain by either its name or id
+      description: Retrieves a single active domain by either its name or id.
       operationId: get_domain_v1_domains__domain_reference__get
       parameters:
       - in: path
@@ -24518,7 +24529,9 @@ paths:
             x-typeid-prefix: domain
           - type: string
           title: Domain Reference
-      - description: Include additional data in the response.
+      - description: Extra data to include in the response. `tags` populates the `tags`
+          and `status_tags` fields, which are otherwise null. `renewal_price` resolves
+          the domain's renewal price.
         in: query
         name: include
         required: false
@@ -24528,7 +24541,9 @@ paths:
               $ref: '#/components/schemas/DomainIncludeField'
             type: array
           - type: 'null'
-          description: Include additional data in the response.
+          description: Extra data to include in the response. `tags` populates the
+            `tags` and `status_tags` fields, which are otherwise null. `renewal_price`
+            resolves the domain's renewal price.
           title: Include
       - $ref: '#/components/parameters/DatetimeFormatHeader'
       responses:

package/src/schema.d.ts

@@ -1083,7 +1083,7 @@ export interface paths {
         };
         /**
          * List all domains
-         * @description Retrieves a paginated list of all active domains
+         * @description Retrieves a paginated list of all active domains.
          */
         get: operations["get_domains_v1_domains_get"];
         put?: never;
@@ -1419,7 +1419,7 @@ export interface paths {
         };
         /**
          * Retrieve a domain
-         * @description Retrieves a single active domain by either its name or id
+         * @description Retrieves a single active domain by either its name or id.
          */
         get: operations["get_domain_v1_domains__domain_reference__get"];
         put?: never;
@@ -6539,12 +6539,12 @@ export interface components {
             sld: string;
             /**
              * Status Tags
-             * @description Status tags assigned to this domain. Only included when ?include=tags is specified.
+             * @description Status tags assigned to this domain. Null unless `include=tags` is requested.
              */
             status_tags?: components["schemas"]["StatusTagResponse"][] | null;
             /**
              * Tags
-             * @description User tags assigned to this domain. Only included when ?include=tags is specified.
+             * @description User tags assigned to this domain. Null unless `include=tags` is requested.
              */
             tags?: components["schemas"]["TagEnrichedResponse"][] | null;
             /**
@@ -12943,6 +12943,8 @@ export interface components {
              * @example example.com
              */
             domain: string;
+            /** @description Error that prevented this domain from being checked: `validation_error` if the domain name is invalid or its TLD is not supported, `check_error` if the registry check failed. */
+            error?: components["schemas"]["DomainAvailabilityError"] | null;
             /**
              * Is Premium
              * @description True if the registry classifies this domain as premium (non-standard pricing)
@@ -12953,7 +12955,7 @@ export interface components {
             premium_pricing?: components["schemas"]["PremiumPricingResponse"] | null;
             /**
              * Reason
-             * @description Registry-supplied reason the domain is unavailable (e.g. 'Domain exists', 'Reserved', 'In Use'). May be null when the domain is available, or when the registry did not provide a reason.
+             * @description Registry-supplied reason the domain is unavailable (e.g. 'Domain exists', 'Reserved', 'In Use'). Null if the domain is available, failed prechecks, or no reason was returned by the registry.
              * @example Domain exists
              */
             reason: string | null;
@@ -18903,7 +18905,7 @@ export interface operations {
                 transferred_before?: Date | null;
                 /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
                 registry_statuses?: string[] | null;
-                /** @description Include additional data in the response. Can be specified multiple times. */
+                /** @description Extra data to include in each result. `tags` populates the `tags` (user tags) and `status_tags` fields, which are otherwise null; filtering by `tag_ids` or `status_tags` alone does not populate them. */
                 include?: components["schemas"]["DomainListIncludeField"][] | null;
             };
             header?: {
@@ -20187,7 +20189,7 @@ export interface operations {
     get_domain_v1_domains__domain_reference__get: {
         parameters: {
             query?: {
-                /** @description Include additional data in the response. */
+                /** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. */
                 include?: components["schemas"]["DomainIncludeField"][] | null;
             };
             header?: {