@opusdns/api 1.222.0 → 1.224.0

package/package.json

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

package/src/helpers/constants.ts

@@ -838,12 +838,14 @@ export const DOMAIN_INCLUDE_FIELD = {
   TAGS: "tags",
   RENEWAL_PRICE: "renewal_price",
   CONNECTED_ACCOUNT: "connected_account",
+  REGISTRANT_CHANGE: "registrant_change",
 } as const satisfies Record<string, DomainIncludeField>;
 
 export const DOMAIN_INCLUDE_FIELD_VALUES = [
   'tags',
   'renewal_price',
   'connected_account',
+  'registrant_change',
 ] as const satisfies ReadonlyArray<DomainIncludeField>;
 
 export const DOMAIN_LIST_INCLUDE_FIELD = {

package/src/helpers/keys.ts

@@ -193,6 +193,7 @@ import type {
   DomainPeriod,
   DomainRecommendationsContext,
   DomainRecommendationsContextCreate,
+  DomainRegistrantChange,
   DomainRegistrarCredential,
   DomainRenewRequest,
   DomainRenew,
@@ -2787,6 +2788,32 @@ export const KEYS_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE = [
   KEY_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE_PAYLOAD,
 ] as const satisfies (keyof DomainRecommendationsContextCreate)[];
 
+export const KEY_DOMAIN_REGISTRANT_CHANGE_CONFIRMATION_DEADLINE = 'confirmation_deadline' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_CONFIRMATION_METHOD = 'confirmation_method' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_CREATED_ON = 'created_on' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_DOMAIN_ID = 'domain_id' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_FAILURE_REASON = 'failure_reason' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_MATERIAL = 'material' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_NEW_REGISTRANT = 'new_registrant' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_PREVIOUS_REGISTRANT = 'previous_registrant' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_REGISTRANT_CHANGE_ID = 'registrant_change_id' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_STATUS = 'status' satisfies keyof DomainRegistrantChange;
+export const KEY_DOMAIN_REGISTRANT_CHANGE_TRANSFER_LOCK_OPT_OUT = 'transfer_lock_opt_out' satisfies keyof DomainRegistrantChange;
+
+export const KEYS_DOMAIN_REGISTRANT_CHANGE = [
+  KEY_DOMAIN_REGISTRANT_CHANGE_CONFIRMATION_DEADLINE,
+  KEY_DOMAIN_REGISTRANT_CHANGE_CONFIRMATION_METHOD,
+  KEY_DOMAIN_REGISTRANT_CHANGE_CREATED_ON,
+  KEY_DOMAIN_REGISTRANT_CHANGE_DOMAIN_ID,
+  KEY_DOMAIN_REGISTRANT_CHANGE_FAILURE_REASON,
+  KEY_DOMAIN_REGISTRANT_CHANGE_MATERIAL,
+  KEY_DOMAIN_REGISTRANT_CHANGE_NEW_REGISTRANT,
+  KEY_DOMAIN_REGISTRANT_CHANGE_PREVIOUS_REGISTRANT,
+  KEY_DOMAIN_REGISTRANT_CHANGE_REGISTRANT_CHANGE_ID,
+  KEY_DOMAIN_REGISTRANT_CHANGE_STATUS,
+  KEY_DOMAIN_REGISTRANT_CHANGE_TRANSFER_LOCK_OPT_OUT,
+] as const satisfies (keyof DomainRegistrantChange)[];
+
 export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_NAME = 'name' satisfies keyof DomainRegistrarCredential;
 export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR = 'registrar' satisfies keyof DomainRegistrarCredential;
 export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR_CREDENTIAL_ID = 'registrar_credential_id' satisfies keyof DomainRegistrarCredential;
@@ -2865,6 +2892,7 @@ export const KEY_DOMAIN_NAMESERVERS = 'nameservers' satisfies keyof Domain;
 export const KEY_DOMAIN_OWNER_ID = 'owner_id' satisfies keyof Domain;
 export const KEY_DOMAIN_READ_ONLY = 'read_only' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTERED_ON = 'registered_on' satisfies keyof Domain;
+export const KEY_DOMAIN_REGISTRANT_CHANGE = 'registrant_change' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies keyof Domain;
 export const KEY_DOMAIN_REGISTRY_STATUSES = 'registry_statuses' satisfies keyof Domain;
 export const KEY_DOMAIN_RENEWAL_MODE = 'renewal_mode' satisfies keyof Domain;
@@ -2897,6 +2925,7 @@ export const KEYS_DOMAIN = [
   KEY_DOMAIN_OWNER_ID,
   KEY_DOMAIN_READ_ONLY,
   KEY_DOMAIN_REGISTERED_ON,
+  KEY_DOMAIN_REGISTRANT_CHANGE,
   KEY_DOMAIN_REGISTRY_ACCOUNT_ID,
   KEY_DOMAIN_REGISTRY_STATUSES,
   KEY_DOMAIN_RENEWAL_MODE,

package/src/helpers/schemas.d.ts

@@ -243,6 +243,7 @@ export type DomainNameParts = components['schemas']['DomainNameParts'];
 export type DomainPeriod = components['schemas']['DomainPeriod'];
 export type DomainRecommendationsContext = components['schemas']['DomainRecommendationsContext'];
 export type DomainRecommendationsContextCreate = components['schemas']['DomainRecommendationsContextCreate'];
+export type DomainRegistrantChange = components['schemas']['DomainRegistrantChangeResponse'];
 export type DomainRegistrarCredential = components['schemas']['DomainRegistrarCredentialResponse'];
 export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
 export type DomainRenew = components['schemas']['DomainRenewResponse'];

package/src/openapi.yaml

@@ -12980,6 +12980,7 @@ components:
       - tags
       - renewal_price
       - connected_account
+      - registrant_change
       title: DomainIncludeField
       type: string
     DomainLifecycleBase:
@@ -13246,6 +13247,92 @@ components:
       - payload
       title: DomainRecommendationsContextCreate
       type: object
+    DomainRegistrantChangeResponse:
+      properties:
+        confirmation_deadline:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: When the request expires if not confirmed
+          title: Confirmation Deadline
+        confirmation_method:
+          anyOf:
+          - $ref: '#/components/schemas/RegistrantChangeConfirmationMethod'
+          - type: 'null'
+          description: How the change was confirmed, null when no confirmation applies
+        created_on:
+          description: When the request was created
+          format: date-time
+          title: Created On
+          type: string
+        domain_id:
+          description: The ID of the domain
+          examples:
+          - domain_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Domain Id
+          type: string
+          x-typeid-prefix: domain
+        failure_reason:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Why the registrant change failed
+          title: Failure Reason
+        material:
+          description: Whether the name, organization or email of the registrant changes
+          title: Material
+          type: boolean
+        new_registrant:
+          description: The registrant after the change
+          examples:
+          - contact_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: New Registrant
+          type: string
+          x-typeid-prefix: contact
+        previous_registrant:
+          description: The registrant before the change
+          examples:
+          - contact_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Previous Registrant
+          type: string
+          x-typeid-prefix: contact
+        registrant_change_id:
+          description: The ID of the registrant change
+          examples:
+          - registrant_change_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^registrant_change_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Registrant Change Id
+          type: string
+          x-typeid-prefix: registrant_change
+        status:
+          $ref: '#/components/schemas/RegistrantChangeStatus'
+          description: The status of the registrant change
+        transfer_lock_opt_out:
+          description: Whether the transfer lock after the change was opted out of
+          title: Transfer Lock Opt Out
+          type: boolean
+      required:
+      - registrant_change_id
+      - domain_id
+      - status
+      - material
+      - previous_registrant
+      - new_registrant
+      - confirmation_method
+      - transfer_lock_opt_out
+      - confirmation_deadline
+      - failure_reason
+      - created_on
+      title: DomainRegistrantChangeResponse
+      type: object
     DomainRegistrarCredentialResponse:
       properties:
         name:
@@ -13511,6 +13598,12 @@ components:
           - type: 'null'
           description: When the domain was registered
           title: Registered On
+        registrant_change:
+          anyOf:
+          - $ref: '#/components/schemas/DomainRegistrantChangeResponse'
+          - type: 'null'
+          description: The change of registrant in progress. Null unless `include=registrant_change`
+            is requested, and null even then when no change of registrant is in progress.
         registry_account_id:
           default: None
           examples:
@@ -20955,7 +21048,9 @@ components:
           - type: 'null'
           title: Confirmation Deadline
         confirmation_method:
-          $ref: '#/components/schemas/RegistrantChangeConfirmationMethod'
+          anyOf:
+          - $ref: '#/components/schemas/RegistrantChangeConfirmationMethod'
+          - type: 'null'
         detail_type:
           const: registrant_change
           default: registrant_change
@@ -21007,7 +21102,6 @@ components:
       - status
       - prior_registrant_id
       - new_registrant_id
-      - confirmation_method
       title: RegistrantChangeDetails
       type: object
     RegistrantChangeFeeType:
@@ -24977,7 +25071,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-10-13-132727
+  version: 2026-10-13-152516
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -35446,7 +35540,8 @@ paths:
       - description: Extra data to include in the response. `tags` populates the `tags`
           and `status_tags` fields, which are otherwise null. `renewal_price` resolves
           the domain's renewal price. `connected_account` populates the `connected_account`
-          field for domains held at an external registrar.
+          field for domains held at an external registrar. `registrant_change` populates
+          the `registrant_change` field with the change of registrant in progress.
         in: query
         name: include
         required: false
@@ -35459,7 +35554,9 @@ paths:
           description: Extra data to include in the response. `tags` populates the
             `tags` and `status_tags` fields, which are otherwise null. `renewal_price`
             resolves the domain's renewal price. `connected_account` populates the
-            `connected_account` field for domains held at an external registrar.
+            `connected_account` field for domains held at an external registrar. `registrant_change`
+            populates the `registrant_change` field with the change of registrant
+            in progress.
           title: Include
       - $ref: '#/components/parameters/DatetimeFormatHeader'
       responses:

package/src/schema.d.ts

@@ -12535,7 +12535,7 @@ export interface components {
          * DomainIncludeField
          * @enum {string}
          */
-        DomainIncludeField: "tags" | "renewal_price" | "connected_account";
+        DomainIncludeField: "tags" | "renewal_price" | "connected_account" | "registrant_change";
         /** DomainLifecycleBase */
         DomainLifecycleBase: {
             /**
@@ -12696,6 +12696,67 @@ export interface components {
             kind: "domain_recommendations";
             payload: components["schemas"]["ContextPayload_DomainSearchSuggestionWithPrice_"];
         };
+        /** DomainRegistrantChangeResponse */
+        DomainRegistrantChangeResponse: {
+            /**
+             * Confirmation Deadline
+             * @description When the request expires if not confirmed
+             */
+            confirmation_deadline: Date | null;
+            /** @description How the change was confirmed, null when no confirmation applies */
+            confirmation_method: components["schemas"]["RegistrantChangeConfirmationMethod"] | null;
+            /**
+             * Created On
+             * Format: date-time
+             * @description When the request was created
+             */
+            created_on: Date;
+            /**
+             * Domain Id
+             * Format: typeid
+             * @description The ID of the domain
+             * @example domain_01h45ytscbebyvny4gc8cr8ma2
+             */
+            domain_id: TypeId<"domain">;
+            /**
+             * Failure Reason
+             * @description Why the registrant change failed
+             */
+            failure_reason: string | null;
+            /**
+             * Material
+             * @description Whether the name, organization or email of the registrant changes
+             */
+            material: boolean;
+            /**
+             * New Registrant
+             * Format: typeid
+             * @description The registrant after the change
+             * @example contact_01h45ytscbebyvny4gc8cr8ma2
+             */
+            new_registrant: TypeId<"contact">;
+            /**
+             * Previous Registrant
+             * Format: typeid
+             * @description The registrant before the change
+             * @example contact_01h45ytscbebyvny4gc8cr8ma2
+             */
+            previous_registrant: TypeId<"contact">;
+            /**
+             * Registrant Change Id
+             * Format: typeid
+             * @description The ID of the registrant change
+             * @example registrant_change_01h45ytscbebyvny4gc8cr8ma2
+             */
+            registrant_change_id: TypeId<"registrant_change">;
+            /** @description The status of the registrant change */
+            status: components["schemas"]["RegistrantChangeStatus"];
+            /**
+             * Transfer Lock Opt Out
+             * @description Whether the transfer lock after the change was opted out of
+             */
+            transfer_lock_opt_out: boolean;
+        };
         /** DomainRegistrarCredentialResponse */
         DomainRegistrarCredentialResponse: {
             /**
@@ -12895,6 +12956,8 @@ export interface components {
              * @description When the domain was registered
              */
             registered_on?: Date | null;
+            /** @description The change of registrant in progress. Null unless `include=registrant_change` is requested, and null even then when no change of registrant is in progress. */
+            registrant_change?: components["schemas"]["DomainRegistrantChangeResponse"] | null;
             /**
              * Registry Account Id
              * Format: typeid
@@ -17926,7 +17989,7 @@ export interface components {
         RegistrantChangeDetails: {
             /** Confirmation Deadline */
             confirmation_deadline?: Date | null;
-            confirmation_method: components["schemas"]["RegistrantChangeConfirmationMethod"];
+            confirmation_method?: components["schemas"]["RegistrantChangeConfirmationMethod"] | null;
             /**
              * @description discriminator enum property added by openapi-typescript
              * @enum {string}
@@ -28329,7 +28392,7 @@ export interface operations {
     get_domain_v1_domains__domain_reference__get: {
         parameters: {
             query?: {
-                /** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. `connected_account` populates the `connected_account` field for domains held at an external registrar. */
+                /** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. `connected_account` populates the `connected_account` field for domains held at an external registrar. `registrant_change` populates the `registrant_change` field with the change of registrant in progress. */
                 include?: components["schemas"]["DomainIncludeField"][] | null;
             };
             header?: {