@opusdns/api 0.283.0 → 0.284.0

package/package.json

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

package/src/helpers/keys.ts

@@ -34681,7 +34681,7 @@ export const KEYS_PREMIUM_PRICE_ENTRY_RES = [
 /**
  * Action
  *
- * The action (e.g., create, renew, transfer)
+ * The action this price applies to (e.g., create, renew, transfer)
  *
  * @type {string}
  *
@@ -34707,7 +34707,7 @@ export const KEY_PREMIUM_PRICING_ACTION_ACTION: keyof PremiumPricingAction = 'ac
 /**
  * Currency
  *
- * Currency of the price
+ * ISO 4217 currency code
  *
  * @type {string}
  *
@@ -34733,7 +34733,7 @@ export const KEY_PREMIUM_PRICING_ACTION_CURRENCY: keyof PremiumPricingAction = '
 /**
  * Price
  *
- * Customer-facing price after markup
+ * Price for the action
  *
  * @type {string}
  *
@@ -41799,6 +41799,7 @@ export const KEYS_DOMAIN_AVAILABILITY_LIST = [
 /**
  * Available
  *
+ * True if the domain is available for registration
  *
  * @type {boolean}
  *
@@ -41824,7 +41825,7 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE: keyof DomainAvailabilityCh
 /**
  * Claims Key
  *
- * Claims key, if claims notice acceptance is required
+ * Trademark claims key returned when the TLD is in its claims phase and the domain matches a TMCH-registered mark. When present, the corresponding claims notice must be retrieved and acknowledged before registration.
  *
  *
  *
@@ -41849,7 +41850,7 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_CLAIMS_KEY: keyof DomainAvailabilityC
 /**
  * Domain
  *
- * The domain name
+ * The domain name that was checked
  *
  * @type {string}
  *
@@ -41875,7 +41876,7 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_DOMAIN: keyof DomainAvailabilityCheck
 /**
  * Is Premium
  *
- * Whether this is a premium domain
+ * True if the registry classifies this domain as premium (non-standard pricing)
  *
  * @type {boolean}
  *
@@ -41901,7 +41902,7 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM: keyof DomainAvailabilityC
 /**
  * premium_pricing property
  *
- * Premium pricing details, present when domain is premium and pricing is available
+ * Premium pricing per action (create / renew / transfer / restore). Present only when `is_premium` is true and the registry returned pricing.
  *
  *
  *
@@ -41926,6 +41927,7 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING: keyof DomainAvailabi
 /**
  * Reason
  *
+ * 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.
  *
  *
  *

package/src/helpers/requests.d.ts

@@ -3407,7 +3407,15 @@ export type POST_Domains_Request_Body = POST_Domains_Request['requestBody'];
 /**
  * Request type for GET DomainsCheck endpoint
  *
- * Check domain availability
+ * Check domain availability and registration metadata
+ * Performs a real-time check against the authoritative registry for each domain and returns availability plus any registry-specific metadata needed to register it.
+
+For each domain the response includes:
+- **Availability** — whether the domain can be registered, and the registry's reason if not.
+- **Trademark claims (TMCH)** — when the TLD is in its claims phase and the domain matches a trademark in the Trademark Clearinghouse, a `claims_key` is returned. The corresponding claims notice must be retrieved and acknowledged before the domain can be registered. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
+- **Premium status and pricing** — whether the domain is classified as premium by the registry, and if so, the price per action (create / renew / transfer / restore). See the [Premium domains](/products/domains/premium) guide for background on how premium domains are priced and registered.
+
+Domains are queried in parallel, grouped by registry connection. Availability and metadata reflect the registry's state at the moment of the call and are not cached.
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainsCheck endpoint.
@@ -3419,7 +3427,11 @@ export type POST_Domains_Request_Body = POST_Domains_Request['requestBody'];
  *
  * @path /v1/domains/check
  * @param domains (query) - 
-Specify one or more domains to check for availability.
+One or more fully-qualified domain names to check at the registry.
+
+Each domain is checked for availability and, when applicable, enriched with
+trademark claims information and premium pricing. The list of domains may
+include a mix of TLDs.
 
  *
  * @see {@link GET_DomainsCheck_Request_Query} - Query parameters type
@@ -3443,7 +3455,11 @@ export type GET_DomainsCheck_Request = {
  *
  * @path /v1/domains/check
  * @param domains (query) - 
-Specify one or more domains to check for availability.
+One or more fully-qualified domain names to check at the registry.
+
+Each domain is checked for availability and, when applicable, enriched with
+trademark claims information and premium pricing. The list of domains may
+include a mix of TLDs.
 
  */
 export type GET_DomainsCheck_Request_Query = GET_DomainsCheck_Request['parameters']['query'];

package/src/helpers/responses.d.ts

@@ -7597,7 +7597,15 @@ export type DELETE_DomainsByDomainReferenceTransfer_Response_422 = HTTPValidatio
 /**
  * Response types for GET DomainsCheck endpoint
  *
- * Check domain availability
+ * Check domain availability and registration metadata
+ * Performs a real-time check against the authoritative registry for each domain and returns availability plus any registry-specific metadata needed to register it.
+
+For each domain the response includes:
+- **Availability** — whether the domain can be registered, and the registry's reason if not.
+- **Trademark claims (TMCH)** — when the TLD is in its claims phase and the domain matches a trademark in the Trademark Clearinghouse, a `claims_key` is returned. The corresponding claims notice must be retrieved and acknowledged before the domain can be registered. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
+- **Premium status and pricing** — whether the domain is classified as premium by the registry, and if so, the price per action (create / renew / transfer / restore). See the [Premium domains](/products/domains/premium) guide for background on how premium domains are priced and registered.
+
+Domains are queried in parallel, grouped by registry connection. Availability and metadata reflect the registry's state at the moment of the call and are not cached.
  *
  * @remarks
  * This type defines all possible response structures for the GET DomainsCheck endpoint.
@@ -7608,7 +7616,11 @@ export type DELETE_DomainsByDomainReferenceTransfer_Response_422 = HTTPValidatio
  *
  * @path /v1/domains/check
  * @param domains (query) - 
-Specify one or more domains to check for availability.
+One or more fully-qualified domain names to check at the registry.
+
+Each domain is checked for availability and, when applicable, enriched with
+trademark claims information and premium pricing. The list of domains may
+include a mix of TLDs.
 
  *
  * @see {@link GET_DomainsCheck_Response_200} - 200 response type
@@ -7630,7 +7642,11 @@ export type GET_DomainsCheck_Response = GET_DomainsCheck_Response_200 | GET_Doma
  *
  * @path /v1/domains/check
  * @param domains (query) - 
-Specify one or more domains to check for availability.
+One or more fully-qualified domain names to check at the registry.
+
+Each domain is checked for availability and, when applicable, enriched with
+trademark claims information and premium pricing. The list of domains may
+include a mix of TLDs.
 
  *
  * @see {@link GET_DomainsCheck_Response} - The main response type definition
@@ -7650,7 +7666,11 @@ export type GET_DomainsCheck_Response_200 = DomainCheck
  *
  * @path /v1/domains/check
  * @param domains (query) - 
-Specify one or more domains to check for availability.
+One or more fully-qualified domain names to check at the registry.
+
+Each domain is checked for availability and, when applicable, enriched with
+trademark claims information and premium pricing. The list of domains may
+include a mix of TLDs.
 
  *
  * @see {@link GET_DomainsCheck_Response} - The main response type definition

package/src/openapi.yaml

@@ -8704,15 +8704,21 @@ components:
     PremiumPricingAction:
       properties:
         action:
-          description: The action (e.g., create, renew, transfer)
+          description: The action this price applies to (e.g., create, renew, transfer)
+          examples:
+          - create
           title: Action
           type: string
         currency:
-          description: Currency of the price
+          description: ISO 4217 currency code
+          examples:
+          - EUR
           title: Currency
           type: string
         price:
-          description: Customer-facing price after markup
+          description: Price for the action
+          examples:
+          - '625.00'
           pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
           title: Price
           type: string
@@ -10566,35 +10572,47 @@ components:
     common__models__domain__domain__DomainAvailabilityResponse:
       properties:
         available:
+          description: True if the domain is available for registration
           title: Available
           type: boolean
         claims_key:
           anyOf:
           - type: string
           - type: 'null'
-          description: Claims key, if claims notice acceptance is required
+          description: Trademark claims key returned when the TLD is in its claims
+            phase and the domain matches a TMCH-registered mark. When present, the
+            corresponding claims notice must be retrieved and acknowledged before
+            registration.
+          examples:
+          - 2013041500/2/6/9/rJ1NrDO92vDsAzf7EQzgjX4R0000000001
           title: Claims Key
         domain:
-          description: The domain name
+          description: The domain name that was checked
           examples:
           - example.com
           title: Domain
           type: string
         is_premium:
           default: false
-          description: Whether this is a premium domain
+          description: True if the registry classifies this domain as premium (non-standard
+            pricing)
           title: Is Premium
           type: boolean
         premium_pricing:
           anyOf:
           - $ref: '#/components/schemas/PremiumPricingResponse'
           - type: 'null'
-          description: Premium pricing details, present when domain is premium and
-            pricing is available
+          description: Premium pricing per action (create / renew / transfer / restore).
+            Present only when `is_premium` is true and the registry returned pricing.
         reason:
           anyOf:
           - 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.
+          examples:
+          - Domain exists
           title: Reason
       required:
       - domain
@@ -10672,7 +10690,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-05-05-155048
+  version: 2026-05-05-201917
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -17919,16 +17937,39 @@ paths:
       - domain
   /v1/domains/check:
     get:
+      description: "Performs a real-time check against the authoritative registry\
+        \ for each domain and returns availability plus any registry-specific metadata\
+        \ needed to register it.\n\nFor each domain the response includes:\n- **Availability**\
+        \ \u2014 whether the domain can be registered, and the registry's reason if\
+        \ not.\n- **Trademark claims (TMCH)** \u2014 when the TLD is in its claims\
+        \ phase and the domain matches a trademark in the Trademark Clearinghouse,\
+        \ a `claims_key` is returned. The corresponding claims notice must be retrieved\
+        \ and acknowledged before the domain can be registered. See the [Trademarked\
+        \ domains](/products/domains/trademarked-domains) guide for the full workflow.\n\
+        - **Premium status and pricing** \u2014 whether the domain is classified as\
+        \ premium by the registry, and if so, the price per action (create / renew\
+        \ / transfer / restore). See the [Premium domains](/products/domains/premium)\
+        \ guide for background on how premium domains are priced and registered.\n\
+        \nDomains are queried in parallel, grouped by registry connection. Availability\
+        \ and metadata reflect the registry's state at the moment of the call and\
+        \ are not cached."
       operationId: epp_check_domain_v1_domains_check_get
       parameters:
       - description: '
 
-          Specify one or more domains to check for availability.
+          One or more fully-qualified domain names to check at the registry.
+
+
+          Each domain is checked for availability and, when applicable, enriched with
+
+          trademark claims information and premium pricing. The list of domains may
+
+          include a mix of TLDs.
 
           '
         examples:
           list:
-            summary: A list of domains
+            summary: A list of domain names to check
             value:
             - example.com
             - example.org
@@ -17938,7 +17979,16 @@ paths:
         schema:
           description: '
 
-            Specify one or more domains to check for availability.
+            One or more fully-qualified domain names to check at the registry.
+
+
+            Each domain is checked for availability and, when applicable, enriched
+            with
+
+            trademark claims information and premium pricing. The list of domains
+            may
+
+            include a mix of TLDs.
 
             '
           items:
@@ -17961,7 +18011,7 @@ paths:
       security:
       - OAuth2PasswordBearer: []
       - APIKeyHeader: []
-      summary: Check domain availability
+      summary: Check domain availability and registration metadata
       tags:
       - domain
   /v1/domains/summary:

package/src/schema.d.ts

@@ -1028,7 +1028,17 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Check domain availability */
+        /**
+         * Check domain availability and registration metadata
+         * @description Performs a real-time check against the authoritative registry for each domain and returns availability plus any registry-specific metadata needed to register it.
+         *
+         *     For each domain the response includes:
+         *     - **Availability** — whether the domain can be registered, and the registry's reason if not.
+         *     - **Trademark claims (TMCH)** — when the TLD is in its claims phase and the domain matches a trademark in the Trademark Clearinghouse, a `claims_key` is returned. The corresponding claims notice must be retrieved and acknowledged before the domain can be registered. See the [Trademarked domains](/products/domains/trademarked-domains) guide for the full workflow.
+         *     - **Premium status and pricing** — whether the domain is classified as premium by the registry, and if so, the price per action (create / renew / transfer / restore). See the [Premium domains](/products/domains/premium) guide for background on how premium domains are priced and registered.
+         *
+         *     Domains are queried in parallel, grouped by registry connection. Availability and metadata reflect the registry's state at the moment of the call and are not cached.
+         */
         get: operations["epp_check_domain_v1_domains_check_get"];
         put?: never;
         post?: never;
@@ -8209,17 +8219,20 @@ export interface components {
         PremiumPricingAction: {
             /**
              * Action
-             * @description The action (e.g., create, renew, transfer)
+             * @description The action this price applies to (e.g., create, renew, transfer)
+             * @example create
              */
             action: string;
             /**
              * Currency
-             * @description Currency of the price
+             * @description ISO 4217 currency code
+             * @example EUR
              */
             currency: string;
             /**
              * Price
-             * @description Customer-facing price after markup
+             * @description Price for the action
+             * @example 625.00
              */
             price: string;
         };
@@ -9482,28 +9495,36 @@ export interface components {
         };
         /** DomainAvailabilityResponse */
         common__models__domain__domain__DomainAvailabilityResponse: {
-            /** Available */
+            /**
+             * Available
+             * @description True if the domain is available for registration
+             */
             available: boolean;
             /**
              * Claims Key
-             * @description Claims key, if claims notice acceptance is required
+             * @description Trademark claims key returned when the TLD is in its claims phase and the domain matches a TMCH-registered mark. When present, the corresponding claims notice must be retrieved and acknowledged before registration.
+             * @example 2013041500/2/6/9/rJ1NrDO92vDsAzf7EQzgjX4R0000000001
              */
             claims_key?: string | null;
             /**
              * Domain
-             * @description The domain name
+             * @description The domain name that was checked
              * @example example.com
              */
             domain: string;
             /**
              * Is Premium
-             * @description Whether this is a premium domain
+             * @description True if the registry classifies this domain as premium (non-standard pricing)
              * @default false
              */
             is_premium: boolean;
-            /** @description Premium pricing details, present when domain is premium and pricing is available */
+            /** @description Premium pricing per action (create / renew / transfer / restore). Present only when `is_premium` is true and the registry returned pricing. */
             premium_pricing?: components["schemas"]["PremiumPricingResponse"] | null;
-            /** Reason */
+            /**
+             * 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.
+             * @example Domain exists
+             */
             reason: string | null;
         };
     };
@@ -14625,7 +14646,11 @@ export interface operations {
         parameters: {
             query: {
                 /** @description
-                 *     Specify one or more domains to check for availability.
+                 *     One or more fully-qualified domain names to check at the registry.
+                 *
+                 *     Each domain is checked for availability and, when applicable, enriched with
+                 *     trademark claims information and premium pricing. The list of domains may
+                 *     include a mix of TLDs.
                  *      */
                 domains: string[];
             };