@opusdns/api 0.306.0 → 0.308.0

package/package.json

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

package/src/helpers/keys.ts

@@ -339,6 +339,7 @@ import { UserWithRelationPermissions } from './schemas';
 import { ValidationError } from './schemas';
 import { VerificationDeadline } from './schemas';
 import { VerificationRegistrantDetails } from './schemas';
+import { Verification } from './schemas';
 import { VisitsByKeyBucket } from './schemas';
 import { WhoisBase } from './schemas';
 import { RequestAuthcode } from './schemas';
@@ -18174,6 +18175,31 @@ export const KEY_DOMAIN_TRANSFER_LOCK: keyof Domain = 'transfer_lock';
  * @see {@link KEYS_DOMAIN} - Array of all keys for this type
  */
 export const KEY_DOMAIN_UPDATED_ON: keyof Domain = 'updated_on';
+/**
+ * verification_required property
+ *
+ * Verification data for this domain, including pending claims and deadlines.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `verification_required` 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_VERIFICATION_REQUIRED];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_VERIFICATION_REQUIRED;
+ * 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_VERIFICATION_REQUIRED: keyof Domain = 'verification_required';
 
 /**
  * Array of all Domain property keys
@@ -18220,6 +18246,7 @@ export const KEYS_DOMAIN = [
   KEY_DOMAIN_TLD,
   KEY_DOMAIN_TRANSFER_LOCK,
   KEY_DOMAIN_UPDATED_ON,
+  KEY_DOMAIN_VERIFICATION_REQUIRED,
 ] as const satisfies (keyof Domain)[];
 
 /**
@@ -27938,6 +27965,56 @@ export const KEY_JOB_DOMAIN_NAME: keyof Job = 'domain_name';
  * @see {@link KEYS_JOB} - Array of all keys for this type
  */
 export const KEY_JOB_ERROR_CLASS: keyof Job = 'error_class';
+/**
+ * Error Code
+ *
+ * Stable semantic error code propagated verbatim from the failing upstream service (e.g. 'ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE'). Suitable for i18n / per-error UI branching. Null when the job did not fail or the upstream error did not carry a code.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `error_code` 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_ERROR_CODE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_JOB_ERROR_CODE;
+ * 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_ERROR_CODE: keyof Job = 'error_code';
+/**
+ * Error Details
+ *
+ * Full upstream problem-details payload (RFC 9457) preserved verbatim — e.g. type/title/status/code/detail plus service-specific extras like domain_name, reason. Null when the failure didn't originate from a typed upstream response.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `error_details` 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_ERROR_DETAILS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_JOB_ERROR_DETAILS;
+ * 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_ERROR_DETAILS: keyof Job = 'error_details';
 /**
  * Error Message
  *
@@ -28217,6 +28294,8 @@ export const KEYS_JOB = [
   KEY_JOB_DISPLAY,
   KEY_JOB_DOMAIN_NAME,
   KEY_JOB_ERROR_CLASS,
+  KEY_JOB_ERROR_CODE,
+  KEY_JOB_ERROR_DETAILS,
   KEY_JOB_ERROR_MESSAGE,
   KEY_JOB_FINISHED_AT,
   KEY_JOB_JOB_ID,
@@ -44372,6 +44451,84 @@ export const KEYS_VERIFICATION_REGISTRANT_DETAILS = [
   KEY_VERIFICATION_REGISTRANT_DETAILS_NAME,
 ] as const satisfies (keyof VerificationRegistrantDetails)[];
 
+/**
+ * Claims
+ *
+ * Verification claims
+ *
+ * @type {array}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `claims` property of Verification objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = verification[KEY_VERIFICATION_CLAIMS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_VERIFICATION_CLAIMS;
+ * const value = verification[propertyName];
+ * ```
+ *
+ * @see {@link Verification} - The TypeScript type definition
+ * @see {@link KEYS_VERIFICATION} - Array of all keys for this type
+ */
+export const KEY_VERIFICATION_CLAIMS: keyof Verification = 'claims';
+/**
+ * Deadlines
+ *
+ * Verification deadlines
+ *
+ * @type {array}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `deadlines` property of Verification objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = verification[KEY_VERIFICATION_DEADLINES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_VERIFICATION_DEADLINES;
+ * const value = verification[propertyName];
+ * ```
+ *
+ * @see {@link Verification} - The TypeScript type definition
+ * @see {@link KEYS_VERIFICATION} - Array of all keys for this type
+ */
+export const KEY_VERIFICATION_DEADLINES: keyof Verification = 'deadlines';
+
+/**
+ * Array of all Verification property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for Verification objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_VERIFICATION) {
+ *   console.log(`Property: ${key}, Value: ${verification[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_VERIFICATION.includes(someKey);
+ * ```
+ *
+ * @see {@link Verification} - The TypeScript type definition
+ */
+export const KEYS_VERIFICATION = [
+  KEY_VERIFICATION_CLAIMS,
+  KEY_VERIFICATION_DEADLINES,
+] as const satisfies (keyof Verification)[];
+
 /**
  * Key
  *

package/src/helpers/schemas.d.ts

@@ -7028,6 +7028,22 @@ export type VerificationDeadlineType = components['schemas']['VerificationDeadli
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type VerificationRegistrantDetails = components['schemas']['VerificationRegistrantDetails'];
+/**
+ * VerificationResponse
+ *
+ * @remarks
+ * Type alias for the `VerificationResponse` OpenAPI schema.
+ * This type represents verificationresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getVerification();
+ * const item: Verification = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Verification = components['schemas']['VerificationResponse'];
 /**
  * VerificationType
  *

package/src/openapi.yaml

@@ -4369,6 +4369,12 @@ components:
           format: date-time
           title: Updated On
           type: string
+        verification_required:
+          anyOf:
+          - $ref: '#/components/schemas/VerificationResponse'
+          - type: 'null'
+          description: Verification data for this domain, including pending claims
+            and deadlines.
       required:
       - name
       - sld
@@ -6720,6 +6726,25 @@ components:
           - type: 'null'
           description: Error type if the job failed (e.g., ValidationError, TimeoutError)
           title: Error Class
+        error_code:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Stable semantic error code propagated verbatim from the failing
+            upstream service (e.g. 'ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE'). Suitable
+            for i18n / per-error UI branching. Null when the job did not fail or the
+            upstream error did not carry a code.
+          title: Error Code
+        error_details:
+          anyOf:
+          - additionalProperties: true
+            type: object
+          - type: 'null'
+          description: "Full upstream problem-details payload (RFC 9457) preserved\
+            \ verbatim \u2014 e.g. type/title/status/code/detail plus service-specific\
+            \ extras like domain_name, reason. Null when the failure didn't originate\
+            \ from a typed upstream response."
+          title: Error Details
         error_message:
           anyOf:
           - type: string
@@ -11250,6 +11275,24 @@ components:
       - email
       title: VerificationRegistrantDetails
       type: object
+    VerificationResponse:
+      properties:
+        claims:
+          description: Verification claims
+          items:
+            $ref: '#/components/schemas/VerificationClaimType'
+          title: Claims
+          type: array
+        deadlines:
+          description: Verification deadlines
+          items:
+            $ref: '#/components/schemas/VerificationDeadline'
+          title: Deadlines
+          type: array
+      required:
+      - claims
+      title: VerificationResponse
+      type: object
     VerificationType:
       enum:
       - api
@@ -11486,7 +11529,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-05-18-161414
+  version: 2026-05-19-074018
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -22219,8 +22262,18 @@ paths:
                       created_on: '2025-01-15T10:00:00Z'
                       display: Update Domain 'flaky-domain.com'
                       domain_name: flaky-domain.com
-                      error_class: RegistryError
-                      error_message: Registry unavailable after 5 retry attempts
+                      error_class: DomainsClientError
+                      error_code: ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE
+                      error_details:
+                        code: ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE
+                        detail: There was an error transferring the domain
+                        domain_name: flaky-domain.com
+                        reason: Domain transfer failed, invalid auth code provided
+                        status: 403
+                        title: Domain Transfer Error
+                        type: domain-transfer-invalid-auth
+                      error_message: 'Domains service error: There was an error transferring
+                        the domain'
                       finished_at: '2025-01-15T10:15:30Z'
                       job_id: job_01h45ytscbebyvny4gc8cr8ma7
                       operation: update

package/src/schema.d.ts

@@ -5350,6 +5350,8 @@ export interface components {
              * @description The date/time the entry was last updated on
              */
             updated_on?: Date;
+            /** @description Verification data for this domain, including pending claims and deadlines. */
+            verification_required?: components["schemas"]["VerificationResponse"] | null;
         };
         /** DomainRestoreRequest */
         DomainRestoreRequest: {
@@ -6954,6 +6956,18 @@ export interface components {
              * @description Error type if the job failed (e.g., ValidationError, TimeoutError)
              */
             error_class?: string | null;
+            /**
+             * Error Code
+             * @description Stable semantic error code propagated verbatim from the failing upstream service (e.g. 'ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE'). Suitable for i18n / per-error UI branching. Null when the job did not fail or the upstream error did not carry a code.
+             */
+            error_code?: string | null;
+            /**
+             * Error Details
+             * @description Full upstream problem-details payload (RFC 9457) preserved verbatim — e.g. type/title/status/code/detail plus service-specific extras like domain_name, reason. Null when the failure didn't originate from a typed upstream response.
+             */
+            error_details?: {
+                [key: string]: unknown;
+            } | null;
             /**
              * Error Message
              * @description Detailed error message if the job failed
@@ -9907,6 +9921,19 @@ export interface components {
             /** Name */
             name: string;
         };
+        /** VerificationResponse */
+        VerificationResponse: {
+            /**
+             * Claims
+             * @description Verification claims
+             */
+            claims: components["schemas"]["VerificationClaimType"][];
+            /**
+             * Deadlines
+             * @description Verification deadlines
+             */
+            deadlines?: components["schemas"]["VerificationDeadline"][];
+        };
         /**
          * VerificationType
          * @enum {string}