@opusdns/api 1.91.0 → 1.93.0

package/package.json

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

package/src/helpers/constants.ts

@@ -623,6 +623,7 @@ export const DOMAIN_ATTRIBUTE_KEY = {
   NOR_ID_DECLARATION_TOKEN: "nor_id_declaration_token",
   PUNKTUM_DK_TERMS_ACCEPTANCE: "punktum_dk_terms_acceptance",
   PUNKTUM_DK_TRACKING_NO: "punktum_dk_tracking_no",
+  PROMOTION: "promotion",
 } as const satisfies Record<string, DomainAttributeKey>;
 
 export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
@@ -640,6 +641,7 @@ export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
   'nor_id_declaration_token',
   'punktum_dk_terms_acceptance',
   'punktum_dk_tracking_no',
+  'promotion',
 ] as const satisfies ReadonlyArray<DomainAttributeKey>;
 
 export const DOMAIN_AVAILABILITY_STATUS = {

package/src/helpers/keys.ts

@@ -112,6 +112,7 @@ import type {
   DnsZoneUpdateWorkerPayload,
   DnsZoneVanitySetUpdateRes,
   DomainAvailability,
+  DomainAvailabilityError,
   DomainAvailabilityMeta,
   DomainAvailabilityRequest,
   DomainCheck,
@@ -1804,13 +1805,23 @@ export const KEYS_DNS_ZONE_VANITY_SET_UPDATE_RES = [
 ] as const satisfies (keyof DnsZoneVanitySetUpdateRes)[];
 
 export const KEY_DOMAIN_AVAILABILITY_DOMAIN = 'domain' satisfies keyof DomainAvailability;
+export const KEY_DOMAIN_AVAILABILITY_ERROR = 'error' satisfies keyof DomainAvailability;
 export const KEY_DOMAIN_AVAILABILITY_STATUS = 'status' satisfies keyof DomainAvailability;
 
 export const KEYS_DOMAIN_AVAILABILITY = [
   KEY_DOMAIN_AVAILABILITY_DOMAIN,
+  KEY_DOMAIN_AVAILABILITY_ERROR,
   KEY_DOMAIN_AVAILABILITY_STATUS,
 ] as const satisfies (keyof DomainAvailability)[];
 
+export const KEY_DOMAIN_AVAILABILITY_ERROR_MESSAGE = 'message' satisfies keyof DomainAvailabilityError;
+export const KEY_DOMAIN_AVAILABILITY_ERROR_TYPE = 'type' satisfies keyof DomainAvailabilityError;
+
+export const KEYS_DOMAIN_AVAILABILITY_ERROR = [
+  KEY_DOMAIN_AVAILABILITY_ERROR_MESSAGE,
+  KEY_DOMAIN_AVAILABILITY_ERROR_TYPE,
+] as const satisfies (keyof DomainAvailabilityError)[];
+
 export const KEY_DOMAIN_AVAILABILITY_META_PROCESSING_TIME_MS = 'processing_time_ms' satisfies keyof DomainAvailabilityMeta;
 export const KEY_DOMAIN_AVAILABILITY_META_TOTAL = 'total' satisfies keyof DomainAvailabilityMeta;
 

package/src/helpers/schemas.d.ts

@@ -146,6 +146,7 @@ export type DnssecRecordType = components['schemas']['DnssecRecordType'];
 export type DnssecStatus = components['schemas']['DnssecStatus'];
 export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
 export type DomainAvailability = components['schemas']['DomainAvailability'];
+export type DomainAvailabilityError = components['schemas']['DomainAvailabilityError'];
 export type DomainAvailabilityMeta = components['schemas']['DomainAvailabilityMeta'];
 export type DomainAvailabilityRequest = components['schemas']['DomainAvailabilityRequest'];
 export type DomainAvailabilityStatus = components['schemas']['DomainAvailabilityStatus'];

package/src/openapi.yaml

@@ -3640,6 +3640,7 @@ components:
       - nor_id_declaration_token
       - punktum_dk_terms_acceptance
       - punktum_dk_tracking_no
+      - promotion
       title: DomainAttributeKey
       type: string
     DomainAvailability:
@@ -3647,6 +3648,12 @@ components:
         domain:
           title: Domain
           type: string
+        error:
+          anyOf:
+          - $ref: '#/components/schemas/DomainAvailabilityError'
+          - type: 'null'
+          description: Error details when status is 'error', e.g. why a domain is
+            invalid
         status:
           $ref: '#/components/schemas/DomainAvailabilityStatus'
       required:
@@ -3654,6 +3661,21 @@ components:
       - status
       title: DomainAvailability
       type: object
+    DomainAvailabilityError:
+      properties:
+        message:
+          description: Human-readable error message
+          title: Message
+          type: string
+        type:
+          description: Error type identifier, e.g. validation_error or check_error
+          title: Type
+          type: string
+      required:
+      - type
+      - message
+      title: DomainAvailabilityError
+      type: object
     DomainAvailabilityMeta:
       properties:
         processing_time_ms:
@@ -3671,6 +3693,7 @@ components:
       properties:
         domains:
           items:
+            maxLength: 1024
             type: string
           maxItems: 1000
           minItems: 1
@@ -3756,7 +3779,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Additional attributes of the domain
+          description: Additional attributes of the domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -3851,7 +3875,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Override attributes for this domain
+          description: Override attributes for this domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -3933,7 +3958,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Additional attributes of the domain
+          description: Additional attributes of the domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -4005,7 +4031,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Additional attributes of the domain
+          description: Additional attributes of the domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -5739,7 +5766,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Override attributes for this domain
+          description: Override attributes for this domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -5821,7 +5849,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Additional attributes of the domain
+          description: Additional attributes of the domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         contacts:
           $ref: '#/components/schemas/DomainContactHandles'
@@ -5887,7 +5916,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Additional attributes of the domain
+          description: Additional attributes of the domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -5951,7 +5981,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Additional attributes of the domain
+          description: Additional attributes of the domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -6060,7 +6091,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Additional attributes of the domain
+          description: Additional attributes of the domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -6278,7 +6310,8 @@ components:
               $ref: '#/components/schemas/DomainAttributeKey'
             type: object
           - type: 'null'
-          description: Additional attributes of the domain
+          description: Additional attributes of the domain. Platform-reserved keys
+            are rejected if supplied.
           title: Attributes
         auth_code:
           anyOf:
@@ -14954,7 +14987,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-07-30-170548
+  version: 2026-07-31-125734
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -16930,7 +16963,9 @@ paths:
       - authentication
   /v1/availability:
     get:
-      description: Check the availability of one or more domains.
+      description: Check the availability of one or more domains. Invalid domains
+        are reported per domain (status 'error' with error details) instead of failing
+        the whole request.
       operationId: bulk_availability_v1_availability_get
       parameters:
       - description: '
@@ -16954,6 +16989,7 @@ paths:
 
             '
           items:
+            maxLength: 1024
             type: string
           maxItems: 50
           title: Domains
@@ -17018,6 +17054,7 @@ paths:
 
             '
           items:
+            maxLength: 1024
             type: string
           maxItems: 1000
           title: Domains

package/src/schema.d.ts

@@ -301,7 +301,7 @@ export interface paths {
         };
         /**
          * Check domain availability
-         * @description Check the availability of one or more domains.
+         * @description Check the availability of one or more domains. Invalid domains are reported per domain (status 'error' with error details) instead of failing the whole request.
          */
         get: operations["bulk_availability_v1_availability_get"];
         put?: never;
@@ -5266,13 +5266,28 @@ export interface components {
          * DomainAttributeKey
          * @enum {string}
          */
-        DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation" | "nic_it_compliance_confirmation" | "travel_industry_acknowledgement" | "verification_required" | "de_general_request_contact" | "de_abuse_contact" | "nor_id_applicant_version" | "nor_id_applicant_accept_name" | "nor_id_applicant_accept_date" | "nor_id_declaration" | "nor_id_declaration_token" | "punktum_dk_terms_acceptance" | "punktum_dk_tracking_no";
+        DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation" | "nic_it_compliance_confirmation" | "travel_industry_acknowledgement" | "verification_required" | "de_general_request_contact" | "de_abuse_contact" | "nor_id_applicant_version" | "nor_id_applicant_accept_name" | "nor_id_applicant_accept_date" | "nor_id_declaration" | "nor_id_declaration_token" | "punktum_dk_terms_acceptance" | "punktum_dk_tracking_no" | "promotion";
         /** DomainAvailability */
         DomainAvailability: {
             /** Domain */
             domain: string;
+            /** @description Error details when status is 'error', e.g. why a domain is invalid */
+            error?: components["schemas"]["DomainAvailabilityError"] | null;
             status: components["schemas"]["DomainAvailabilityStatus"];
         };
+        /** DomainAvailabilityError */
+        DomainAvailabilityError: {
+            /**
+             * Message
+             * @description Human-readable error message
+             */
+            message: string;
+            /**
+             * Type
+             * @description Error type identifier, e.g. validation_error or check_error
+             */
+            type: string;
+        };
         /** DomainAvailabilityMeta */
         DomainAvailabilityMeta: {
             /** Processing Time Ms */
@@ -5325,7 +5340,7 @@ export interface components {
         DomainCreate: {
             /**
              * Attributes
-             * @description Additional attributes of the domain
+             * @description Additional attributes of the domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -5396,7 +5411,7 @@ export interface components {
         DomainCreateBulkInstance: {
             /**
              * Attributes
-             * @description Override attributes for this domain
+             * @description Override attributes for this domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -5444,7 +5459,7 @@ export interface components {
         DomainCreateBulkTemplate: {
             /**
              * Attributes
-             * @description Additional attributes of the domain
+             * @description Additional attributes of the domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -5496,7 +5511,7 @@ export interface components {
         DomainCreatePayloadData: {
             /**
              * Attributes
-             * @description Additional attributes of the domain
+             * @description Additional attributes of the domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -6635,7 +6650,7 @@ export interface components {
         DomainTransferBulkInstance: {
             /**
              * Attributes
-             * @description Override attributes for this domain
+             * @description Override attributes for this domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -6683,7 +6698,7 @@ export interface components {
         DomainTransferBulkTemplate: {
             /**
              * Attributes
-             * @description Additional attributes of the domain
+             * @description Additional attributes of the domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -6731,7 +6746,7 @@ export interface components {
         DomainTransferIn: {
             /**
              * Attributes
-             * @description Additional attributes of the domain
+             * @description Additional attributes of the domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -6776,7 +6791,7 @@ export interface components {
         DomainTransferPayloadData: {
             /**
              * Attributes
-             * @description Additional attributes of the domain
+             * @description Additional attributes of the domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -6853,7 +6868,7 @@ export interface components {
         DomainUpdate: {
             /**
              * Attributes
-             * @description Additional attributes of the domain
+             * @description Additional attributes of the domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;
@@ -6998,7 +7013,7 @@ export interface components {
         DomainUpdatePayloadData: {
             /**
              * Attributes
-             * @description Additional attributes of the domain
+             * @description Additional attributes of the domain. Platform-reserved keys are rejected if supplied.
              */
             attributes?: {
                 [key: string]: string;