@opusdns/api 0.283.0 → 0.285.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.285.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -52,6 +52,7 @@ import { ContactCreateBulkTemplate } from './schemas';
 import { ContactCreateCommand } from './schemas';
 import { ContactCreatePayloadData } from './schemas';
 import { ContactCreateWorkerPayload } from './schemas';
+import { ContactCreateWorkerResult } from './schemas';
 import { ContactHandle } from './schemas';
 import { Contact } from './schemas';
 import { ContactSchema } from './schemas';
@@ -87,6 +88,7 @@ import { DnsZoneCreateBulkTemplate } from './schemas';
 import { DnsZoneCreateCommand } from './schemas';
 import { DnsZoneCreatePayloadData } from './schemas';
 import { DnsZoneCreateWorkerPayload } from './schemas';
+import { DnsZoneCreateWorkerResult } from './schemas';
 import { DnsZonePatchRecordsBulkCommand } from './schemas';
 import { DnsZonePatchRecordsBulkInstance } from './schemas';
 import { DnsZonePatchRecordsBulkPayload } from './schemas';
@@ -120,6 +122,7 @@ import { DomainCreateBulkTemplate } from './schemas';
 import { DomainCreateCommand } from './schemas';
 import { DomainCreatePayloadData } from './schemas';
 import { DomainCreateWorkerPayload } from './schemas';
+import { DomainCreateWorkerResult } from './schemas';
 import { DomainDnssecDataCreate } from './schemas';
 import { DomainDnssecData } from './schemas';
 import { DomainForward } from './schemas';
@@ -4266,6 +4269,82 @@ export const KEYS_CONTACT_CREATE_WORKER_PAYLOAD = [
   KEY_CONTACT_CREATE_WORKER_PAYLOAD_TYPE,
 ] as const satisfies (keyof ContactCreateWorkerPayload)[];
 
+/**
+ * Contact Id
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `contact_id` property of ContactCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = contactcreateworkerresult[KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID;
+ * const value = contactcreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_CONTACT_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID: keyof ContactCreateWorkerResult = 'contact_id';
+/**
+ * Type
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `type` property of ContactCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = contactcreateworkerresult[KEY_CONTACT_CREATE_WORKER_RESULT_TYPE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CONTACT_CREATE_WORKER_RESULT_TYPE;
+ * const value = contactcreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_CONTACT_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_CONTACT_CREATE_WORKER_RESULT_TYPE: keyof ContactCreateWorkerResult = 'type';
+
+/**
+ * Array of all ContactCreateWorkerResult property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for ContactCreateWorkerResult objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_CONTACT_CREATE_WORKER_RESULT) {
+ *   console.log(`Property: ${key}, Value: ${contactcreateworkerresult[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_CONTACT_CREATE_WORKER_RESULT.includes(someKey);
+ * ```
+ *
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
+ */
+export const KEYS_CONTACT_CREATE_WORKER_RESULT = [
+  KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID,
+  KEY_CONTACT_CREATE_WORKER_RESULT_TYPE,
+] as const satisfies (keyof ContactCreateWorkerResult)[];
+
 /**
  * Attributes
  *
@@ -9736,6 +9815,82 @@ export const KEYS_DNS_ZONE_CREATE_WORKER_PAYLOAD = [
   KEY_DNS_ZONE_CREATE_WORKER_PAYLOAD_ZONE,
 ] as const satisfies (keyof DnsZoneCreateWorkerPayload)[];
 
+/**
+ * Type
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `type` property of DnsZoneCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszonecreateworkerresult[KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE;
+ * const value = dnszonecreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE: keyof DnsZoneCreateWorkerResult = 'type';
+/**
+ * Zone Name
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `zone_name` property of DnsZoneCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszonecreateworkerresult[KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME;
+ * const value = dnszonecreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME: keyof DnsZoneCreateWorkerResult = 'zone_name';
+
+/**
+ * Array of all DnsZoneCreateWorkerResult property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DnsZoneCreateWorkerResult objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DNS_ZONE_CREATE_WORKER_RESULT) {
+ *   console.log(`Property: ${key}, Value: ${dnszonecreateworkerresult[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DNS_ZONE_CREATE_WORKER_RESULT.includes(someKey);
+ * ```
+ *
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
+ */
+export const KEYS_DNS_ZONE_CREATE_WORKER_RESULT = [
+  KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE,
+  KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME,
+] as const satisfies (keyof DnsZoneCreateWorkerResult)[];
+
 /**
  * Command
  *
@@ -13351,6 +13506,82 @@ export const KEYS_DOMAIN_CREATE_WORKER_PAYLOAD = [
   KEY_DOMAIN_CREATE_WORKER_PAYLOAD_TYPE,
 ] as const satisfies (keyof DomainCreateWorkerPayload)[];
 
+/**
+ * Domain Id
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `domain_id` property of DomainCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaincreateworkerresult[KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID;
+ * const value = domaincreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID: keyof DomainCreateWorkerResult = 'domain_id';
+/**
+ * Type
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `type` property of DomainCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaincreateworkerresult[KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE;
+ * const value = domaincreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE: keyof DomainCreateWorkerResult = 'type';
+
+/**
+ * Array of all DomainCreateWorkerResult property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainCreateWorkerResult objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_CREATE_WORKER_RESULT) {
+ *   console.log(`Property: ${key}, Value: ${domaincreateworkerresult[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_CREATE_WORKER_RESULT.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_CREATE_WORKER_RESULT = [
+  KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID,
+  KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE,
+] as const satisfies (keyof DomainCreateWorkerResult)[];
+
 /**
  * algorithm property
  *
@@ -26665,6 +26896,31 @@ export const KEY_JOB_PAYLOAD: keyof Job = 'payload';
  * @see {@link KEYS_JOB} - Array of all keys for this type
  */
 export const KEY_JOB_RESOURCE_KEY: keyof Job = 'resource_key';
+/**
+ * Result
+ *
+ * Structured result data from successful job execution (e.g. created entity IDs). Typed when the worker emits a known `type` discriminator; raw dict otherwise.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `result` property of Job objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = job[KEY_JOB_RESULT];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_JOB_RESULT;
+ * const value = job[propertyName];
+ * ```
+ *
+ * @see {@link Job} - The TypeScript type definition
+ * @see {@link KEYS_JOB} - Array of all keys for this type
+ */
+export const KEY_JOB_RESULT: keyof Job = 'result';
 /**
  * Started At
  *
@@ -26750,6 +27006,7 @@ export const KEYS_JOB = [
   KEY_JOB_PAUSED_AT,
   KEY_JOB_PAYLOAD,
   KEY_JOB_RESOURCE_KEY,
+  KEY_JOB_RESULT,
   KEY_JOB_STARTED_AT,
   KEY_JOB_STATUS,
 ] as const satisfies (keyof Job)[];
@@ -34681,7 +34938,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 +34964,7 @@ export const KEY_PREMIUM_PRICING_ACTION_ACTION: keyof PremiumPricingAction = 'ac
 /**
  * Currency
  *
- * Currency of the price
+ * ISO 4217 currency code
  *
  * @type {string}
  *
@@ -34733,7 +34990,7 @@ export const KEY_PREMIUM_PRICING_ACTION_CURRENCY: keyof PremiumPricingAction = '
 /**
  * Price
  *
- * Customer-facing price after markup
+ * Price for the action
  *
  * @type {string}
  *
@@ -41799,6 +42056,7 @@ export const KEYS_DOMAIN_AVAILABILITY_LIST = [
 /**
  * Available
  *
+ * True if the domain is available for registration
  *
  * @type {boolean}
  *
@@ -41824,7 +42082,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 +42107,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 +42133,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 +42159,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 +42184,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/helpers/schemas.d.ts

@@ -570,6 +570,22 @@ export type ContactCreatePayloadData = components['schemas']['ContactCreatePaylo
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactCreateWorkerPayload = components['schemas']['ContactCreateWorkerPayload'];
+/**
+ * ContactCreateWorkerResult
+ *
+ * @remarks
+ * Type alias for the `ContactCreateWorkerResult` OpenAPI schema.
+ * This type represents contactcreateworkerresult data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactCreateWorkerResult();
+ * const item: ContactCreateWorkerResult = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactCreateWorkerResult = components['schemas']['ContactCreateWorkerResult'];
 /**
  * ContactHandle
  *
@@ -1258,6 +1274,22 @@ export type DnsZoneCreatePayloadData = components['schemas']['DnsZoneCreatePaylo
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DnsZoneCreateWorkerPayload = components['schemas']['DnsZoneCreateWorkerPayload'];
+/**
+ * DnsZoneCreateWorkerResult
+ *
+ * @remarks
+ * Type alias for the `DnsZoneCreateWorkerResult` OpenAPI schema.
+ * This type represents dnszonecreateworkerresult data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDnsZoneCreateWorkerResult();
+ * const item: DnsZoneCreateWorkerResult = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DnsZoneCreateWorkerResult = components['schemas']['DnsZoneCreateWorkerResult'];
 /**
  * DnsZonePatchRecordsBulkCommand
  *
@@ -1946,6 +1978,22 @@ export type DomainCreatePayloadData = components['schemas']['DomainCreatePayload
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainCreateWorkerPayload = components['schemas']['DomainCreateWorkerPayload'];
+/**
+ * DomainCreateWorkerResult
+ *
+ * @remarks
+ * Type alias for the `DomainCreateWorkerResult` OpenAPI schema.
+ * This type represents domaincreateworkerresult data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainCreateWorkerResult();
+ * const item: DomainCreateWorkerResult = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainCreateWorkerResult = components['schemas']['DomainCreateWorkerResult'];
 /**
  * DomainDnssecDataCreate
  *

package/src/openapi.yaml

@@ -1035,6 +1035,22 @@ components:
       - contact
       title: ContactCreateWorkerPayload
       type: object
+    ContactCreateWorkerResult:
+      properties:
+        contact_id:
+          title: Contact Id
+          type: string
+        type:
+          enum:
+          - contact_create
+          - contact_create_bulk
+          title: Type
+          type: string
+      required:
+      - type
+      - contact_id
+      title: ContactCreateWorkerResult
+      type: object
     ContactHandle:
       properties:
         attributes:
@@ -2301,6 +2317,22 @@ components:
       - zone
       title: DnsZoneCreateWorkerPayload
       type: object
+    DnsZoneCreateWorkerResult:
+      properties:
+        type:
+          enum:
+          - dns_zone_create
+          - dns_zone_create_bulk
+          title: Type
+          type: string
+        zone_name:
+          title: Zone Name
+          type: string
+      required:
+      - type
+      - zone_name
+      title: DnsZoneCreateWorkerResult
+      type: object
     DnsZonePatchRecordsBulkCommand:
       properties:
         command:
@@ -3168,6 +3200,22 @@ components:
       - domain
       title: DomainCreateWorkerPayload
       type: object
+    DomainCreateWorkerResult:
+      properties:
+        domain_id:
+          title: Domain Id
+          type: string
+        type:
+          enum:
+          - domain_create
+          - domain_create_bulk
+          title: Type
+          type: string
+      required:
+      - type
+      - domain_id
+      title: DomainCreateWorkerResult
+      type: object
     DomainDnssecDataCreate:
       properties:
         algorithm:
@@ -6406,6 +6454,28 @@ components:
           - type: 'null'
           description: Resource identifier for this job
           title: Resource Key
+        result:
+          anyOf:
+          - discriminator:
+              mapping:
+                contact_create: '#/components/schemas/ContactCreateWorkerResult'
+                contact_create_bulk: '#/components/schemas/ContactCreateWorkerResult'
+                dns_zone_create: '#/components/schemas/DnsZoneCreateWorkerResult'
+                dns_zone_create_bulk: '#/components/schemas/DnsZoneCreateWorkerResult'
+                domain_create: '#/components/schemas/DomainCreateWorkerResult'
+                domain_create_bulk: '#/components/schemas/DomainCreateWorkerResult'
+              propertyName: type
+            oneOf:
+            - $ref: '#/components/schemas/ContactCreateWorkerResult'
+            - $ref: '#/components/schemas/DomainCreateWorkerResult'
+            - $ref: '#/components/schemas/DnsZoneCreateWorkerResult'
+          - additionalProperties: true
+            type: object
+          - type: 'null'
+          description: Structured result data from successful job execution (e.g.
+            created entity IDs). Typed when the worker emits a known `type` discriminator;
+            raw dict otherwise.
+          title: Result
         started_at:
           anyOf:
           - format: date-time
@@ -8704,15 +8774,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 +10642,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 +10760,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-223247
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -17919,16 +18007,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 +18049,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 +18081,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;
@@ -3105,6 +3115,16 @@ export interface components {
              */
             type: "contact_create" | "contact_create_bulk";
         };
+        /** ContactCreateWorkerResult */
+        ContactCreateWorkerResult: {
+            /** Contact Id */
+            contact_id: string;
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "contact_create" | "contact_create_bulk";
+        };
         /** ContactHandle */
         ContactHandle: {
             /**
@@ -3977,6 +3997,16 @@ export interface components {
             type: "dns_zone_create" | "dns_zone_create_bulk";
             zone: components["schemas"]["DnsZoneCreatePayloadData"];
         };
+        /** DnsZoneCreateWorkerResult */
+        DnsZoneCreateWorkerResult: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "dns_zone_create" | "dns_zone_create_bulk";
+            /** Zone Name */
+            zone_name: string;
+        };
         /** DnsZonePatchRecordsBulkCommand */
         DnsZonePatchRecordsBulkCommand: {
             /**
@@ -4538,6 +4568,16 @@ export interface components {
              */
             type: "domain_create" | "domain_create_bulk";
         };
+        /** DomainCreateWorkerResult */
+        DomainCreateWorkerResult: {
+            /** Domain Id */
+            domain_id: string;
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "domain_create" | "domain_create_bulk";
+        };
         /** DomainDnssecDataCreate */
         DomainDnssecDataCreate: {
             /** @description DNSSEC algorithm used */
@@ -6720,6 +6760,13 @@ export interface components {
              * @description Resource identifier for this job
              */
             resource_key?: string | null;
+            /**
+             * Result
+             * @description Structured result data from successful job execution (e.g. created entity IDs). Typed when the worker emits a known `type` discriminator; raw dict otherwise.
+             */
+            result?: (components["schemas"]["ContactCreateWorkerResult"] | components["schemas"]["DomainCreateWorkerResult"] | components["schemas"]["DnsZoneCreateWorkerResult"]) | {
+                [key: string]: unknown;
+            } | null;
             /**
              * Started At
              * @description Timestamp when job execution began (UTC)
@@ -8209,17 +8256,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 +9532,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 +14683,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[];
             };