@opusdns/api 0.307.0 → 0.309.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.307.0",
+  "version": "0.309.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)[];
 
 /**
@@ -44424,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/requests.d.ts

@@ -1691,6 +1691,45 @@ export type PUT_ContactsContactIdVerification_Request_Query = PUT_ContactsContac
  */
 export type PUT_ContactsContactIdVerification_Request_Path = PUT_ContactsContactIdVerification_Request['parameters']['path'];
 
+/**
+ * Request type for GET ContactsContactIdVerifications endpoint
+ *
+ * Get contact verification status
+ * Retrieve the current verification state for a contact from the contact-verification service.
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET ContactsContactIdVerifications endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/contacts/{contact_id}/verifications
+ *
+ * @see {@link GET_ContactsContactIdVerifications_Request_Query} - Query parameters type
+ * @see {@link GET_ContactsContactIdVerifications_Request_Path} - Path parameters type
+ * @see {@link GET_ContactsContactIdVerifications_Request_Body} - Request body type
+ */
+export type GET_ContactsContactIdVerifications_Request = {
+  parameters: {
+    path: operations['get_contact_verification_status_v1_contacts__contact_id__verifications_get']['parameters']['path'];
+  };
+}
+/**
+ * Path parameters for GET /v1/contacts/{contact_id}/verifications
+ *
+ * @remarks
+ * This type defines the path parameters for the GET /v1/contacts/{contact_id}/verifications endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/contacts/{contact_id}/verifications
+ */
+export type GET_ContactsContactIdVerifications_Request_Path = GET_ContactsContactIdVerifications_Request['parameters']['path'];
+
 /**
  * Request type for POST ContactsContactIdVerificationsAttest endpoint
  *

package/src/helpers/responses.d.ts

@@ -3257,6 +3257,116 @@ export type PUT_ContactsByContactIdVerification_Response_404 = Problem
  */
 export type PUT_ContactsByContactIdVerification_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET ContactsByContactIdVerifications endpoint
+ *
+ * Get contact verification status
+ * Retrieve the current verification state for a contact from the contact-verification service.
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET ContactsByContactIdVerifications endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications
+ *
+ * @see {@link GET_ContactsByContactIdVerifications_Response_200} - 200 response type
+ * @see {@link GET_ContactsByContactIdVerifications_Response_401} - 401 response type
+ * @see {@link GET_ContactsByContactIdVerifications_Response_404} - 404 response type
+ * @see {@link GET_ContactsByContactIdVerifications_Response_422} - 422 response type
+ * @see {@link GET_ContactsByContactIdVerifications_Response_502} - 502 response type
+ *
+
+ */
+export type GET_ContactsByContactIdVerifications_Response = GET_ContactsByContactIdVerifications_Response_200 | GET_ContactsByContactIdVerifications_Response_401 | GET_ContactsByContactIdVerifications_Response_404 | GET_ContactsByContactIdVerifications_Response_422 | GET_ContactsByContactIdVerifications_Response_502;
+
+/**
+ * 200 response for GET ContactsByContactIdVerifications endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET ContactsByContactIdVerifications endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications
+ *
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
+ * @see {@link ContactAttestRes} - The actual schema type definition
+ */
+export type GET_ContactsByContactIdVerifications_Response_200 = ContactAttestRes
+
+/**
+ * 401 response for GET ContactsByContactIdVerifications endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 status code
+ * of the GET ContactsByContactIdVerifications endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications
+ *
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_ContactsByContactIdVerifications_Response_401 = Problem
+
+/**
+ * 404 response for GET ContactsByContactIdVerifications endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the GET ContactsByContactIdVerifications endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications
+ *
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_ContactsByContactIdVerifications_Response_404 = Problem
+
+/**
+ * 422 response for GET ContactsByContactIdVerifications endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET ContactsByContactIdVerifications endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications
+ *
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_ContactsByContactIdVerifications_Response_422 = HTTPValidationError
+
+/**
+ * 502 response for GET ContactsByContactIdVerifications endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 502 status code
+ * of the GET ContactsByContactIdVerifications endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications
+ *
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_ContactsByContactIdVerifications_Response_502 = Problem
+
 /**
  * Response types for POST ContactsByContactIdVerificationsAttest endpoint
  *
@@ -3275,12 +3385,13 @@ export type PUT_ContactsByContactIdVerification_Response_422 = HTTPValidationErr
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_200} - 200 response type
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_400} - 400 response type
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_401} - 401 response type
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_404} - 404 response type
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_422} - 422 response type
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_502} - 502 response type
  *
 
  */
-export type POST_ContactsByContactIdVerificationsAttest_Response = POST_ContactsByContactIdVerificationsAttest_Response_200 | POST_ContactsByContactIdVerificationsAttest_Response_400 | POST_ContactsByContactIdVerificationsAttest_Response_401 | POST_ContactsByContactIdVerificationsAttest_Response_422 | POST_ContactsByContactIdVerificationsAttest_Response_502;
+export type POST_ContactsByContactIdVerificationsAttest_Response = POST_ContactsByContactIdVerificationsAttest_Response_200 | POST_ContactsByContactIdVerificationsAttest_Response_400 | POST_ContactsByContactIdVerificationsAttest_Response_401 | POST_ContactsByContactIdVerificationsAttest_Response_404 | POST_ContactsByContactIdVerificationsAttest_Response_422 | POST_ContactsByContactIdVerificationsAttest_Response_502;
 
 /**
  * 200 response for POST ContactsByContactIdVerificationsAttest endpoint
@@ -3333,6 +3444,23 @@ export type POST_ContactsByContactIdVerificationsAttest_Response_400 = Problem
  */
 export type POST_ContactsByContactIdVerificationsAttest_Response_401 = Problem
 
+/**
+ * 404 response for POST ContactsByContactIdVerificationsAttest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST ContactsByContactIdVerificationsAttest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications/attest
+ *
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_ContactsByContactIdVerificationsAttest_Response_404 = Problem
+
 /**
  * 422 response for POST ContactsByContactIdVerificationsAttest endpoint
  *

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
@@ -11269,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
@@ -11505,7 +11529,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-05-18-215758
+  version: 2026-05-19-074821
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14581,6 +14605,79 @@ paths:
       summary: Complete contact verification by contact ID
       tags:
       - contact
+  /v1/contacts/{contact_id}/verifications:
+    get:
+      description: Retrieve the current verification state for a contact from the
+        contact-verification service.
+      operationId: get_contact_verification_status_v1_contacts__contact_id__verifications_get
+      parameters:
+      - in: path
+        name: contact_id
+        required: true
+        schema:
+          examples:
+          - contact_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Contact Id
+          type: string
+          x-typeid-prefix: contact
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ContactAttestRes'
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_VERIFICATION_UPSTREAM_NOT_FOUND
+                contact_id: Additional error context.
+                detail: Contact is not registered with the contact-verification service.
+                status: 404
+                title: Contact Not Registered with Verification Service
+                type: contact-verification-upstream-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+        '502':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_VERIFICATION_UPSTREAM_ERROR
+                detail: Additional error context.
+                status: 502
+                title: Contact Verification Service Error
+                type: contact-verification-upstream
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Bad Gateway
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Get contact verification status
+      tags:
+      - contact
   /v1/contacts/{contact_id}/verifications/attest:
     post:
       description: Submit one or more contact-verification attestations. Returns the
@@ -14638,6 +14735,19 @@ paths:
               schema:
                 $ref: '#/components/schemas/Problem'
           description: Unauthorized
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_CONTACT_VERIFICATION_UPSTREAM_NOT_FOUND
+                contact_id: Additional error context.
+                detail: Contact is not registered with the contact-verification service.
+                status: 404
+                title: Contact Not Registered with Verification Service
+                type: contact-verification-upstream-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
         '422':
           content:
             application/problem+json:

package/src/schema.d.ts

@@ -471,6 +471,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/contacts/{contact_id}/verifications": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get contact verification status
+         * @description Retrieve the current verification state for a contact from the contact-verification service.
+         */
+        get: operations["get_contact_verification_status_v1_contacts__contact_id__verifications_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/contacts/{contact_id}/verifications/attest": {
         parameters: {
             query?: never;
@@ -5350,6 +5370,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: {
@@ -9919,6 +9941,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}
@@ -12635,6 +12670,86 @@ export interface operations {
             };
         };
     };
+    get_contact_verification_status_v1_contacts__contact_id__verifications_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                contact_id: TypeId<"contact">;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ContactAttestRes"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_CONTACT_VERIFICATION_UPSTREAM_NOT_FOUND",
+                     *       "contact_id": "Additional error context.",
+                     *       "detail": "Contact is not registered with the contact-verification service.",
+                     *       "status": 404,
+                     *       "title": "Contact Not Registered with Verification Service",
+                     *       "type": "contact-verification-upstream-not-found"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+            /** @description Bad Gateway */
+            502: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_CONTACT_VERIFICATION_UPSTREAM_ERROR",
+                     *       "detail": "Additional error context.",
+                     *       "status": 502,
+                     *       "title": "Contact Verification Service Error",
+                     *       "type": "contact-verification-upstream"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+        };
+    };
     attest_contact_verification_v1_contacts__contact_id__verifications_attest_post: {
         parameters: {
             query?: never;
@@ -12692,6 +12807,23 @@ export interface operations {
                     "application/problem+json": components["schemas"]["Problem"];
                 };
             };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_CONTACT_VERIFICATION_UPSTREAM_NOT_FOUND",
+                     *       "contact_id": "Additional error context.",
+                     *       "detail": "Contact is not registered with the contact-verification service.",
+                     *       "status": 404,
+                     *       "title": "Contact Not Registered with Verification Service",
+                     *       "type": "contact-verification-upstream-not-found"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
             /** @description Validation Error */
             422: {
                 headers: {