@opusdns/api 1.210.0 → 1.212.0

package/package.json

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

package/src/helpers/constants.ts

@@ -2223,6 +2223,7 @@ export const STATUS_TAG_TYPE = {
   IMPORT_REQUESTED: "IMPORT_REQUESTED",
   IMPORT_PENDING: "IMPORT_PENDING",
   DNSSEC_PENDING: "DNSSEC_PENDING",
+  TRANSFER_ON_RENEW_PENDING: "TRANSFER_ON_RENEW_PENDING",
 } as const satisfies Record<string, StatusTagType>;
 
 export const STATUS_TAG_TYPE_VALUES = [
@@ -2234,6 +2235,7 @@ export const STATUS_TAG_TYPE_VALUES = [
   'IMPORT_REQUESTED',
   'IMPORT_PENDING',
   'DNSSEC_PENDING',
+  'TRANSFER_ON_RENEW_PENDING',
 ] as const satisfies ReadonlyArray<StatusTagType>;
 
 export const SYNC_OPERATION_TYPE = {

package/src/helpers/keys.ts

@@ -195,6 +195,7 @@ import type {
   DomainRegistrarCredential,
   DomainRenewRequest,
   DomainRenew,
+  DomainRenewTransferPending,
   DomainRenewalDetails,
   DomainRenewalPrice,
   Domain,
@@ -2803,6 +2804,16 @@ export const KEYS_DOMAIN_RENEW = [
   KEY_DOMAIN_RENEW_PERIOD_EXTENDED,
 ] as const satisfies (keyof DomainRenew)[];
 
+export const KEY_DOMAIN_RENEW_TRANSFER_PENDING_NAME = 'name' satisfies keyof DomainRenewTransferPending;
+export const KEY_DOMAIN_RENEW_TRANSFER_PENDING_REQUEST_ID = 'request_id' satisfies keyof DomainRenewTransferPending;
+export const KEY_DOMAIN_RENEW_TRANSFER_PENDING_STATUS = 'status' satisfies keyof DomainRenewTransferPending;
+
+export const KEYS_DOMAIN_RENEW_TRANSFER_PENDING = [
+  KEY_DOMAIN_RENEW_TRANSFER_PENDING_NAME,
+  KEY_DOMAIN_RENEW_TRANSFER_PENDING_REQUEST_ID,
+  KEY_DOMAIN_RENEW_TRANSFER_PENDING_STATUS,
+] as const satisfies (keyof DomainRenewTransferPending)[];
+
 export const KEY_DOMAIN_RENEWAL_DETAILS_DETAIL_TYPE = 'detail_type' satisfies keyof DomainRenewalDetails;
 export const KEY_DOMAIN_RENEWAL_DETAILS_EXPIRES_ON = 'expires_on' satisfies keyof DomainRenewalDetails;
 

package/src/helpers/responses.d.ts

@@ -36,6 +36,7 @@ import type {
   DomainForwardVisitsByKey,
   DomainForwardZone,
   DomainRenew,
+  DomainRenewTransferPending,
   DomainRestore,
   DomainSearch,
   DomainStatistics,
@@ -1201,10 +1202,13 @@ export type POST_DomainsByDomainReferenceDnssecEnable_Response_404 = Problem;
 export type POST_DomainsByDomainReferenceDnssecEnable_Response_409 = Problem;
 export type POST_DomainsByDomainReferenceDnssecEnable_Response_422 = Problem;
 
-export type POST_DomainsByDomainReferenceRenew_Response = POST_DomainsByDomainReferenceRenew_Response_200 | POST_DomainsByDomainReferenceRenew_Response_422;
+export type POST_DomainsByDomainReferenceRenew_Response = POST_DomainsByDomainReferenceRenew_Response_200 | POST_DomainsByDomainReferenceRenew_Response_202 | POST_DomainsByDomainReferenceRenew_Response_409 | POST_DomainsByDomainReferenceRenew_Response_422 | POST_DomainsByDomainReferenceRenew_Response_503;
 
 export type POST_DomainsByDomainReferenceRenew_Response_200 = DomainRenew;
-export type POST_DomainsByDomainReferenceRenew_Response_422 = HTTPValidationError;
+export type POST_DomainsByDomainReferenceRenew_Response_202 = DomainRenewTransferPending;
+export type POST_DomainsByDomainReferenceRenew_Response_409 = Problem;
+export type POST_DomainsByDomainReferenceRenew_Response_422 = Problem;
+export type POST_DomainsByDomainReferenceRenew_Response_503 = Problem;
 
 export type POST_DomainsByDomainReferenceRestore_Response = POST_DomainsByDomainReferenceRestore_Response_200 | POST_DomainsByDomainReferenceRestore_Response_422;
 

package/src/helpers/schemas.d.ts

@@ -242,6 +242,7 @@ export type DomainRecommendationsContextCreate = components['schemas']['DomainRe
 export type DomainRegistrarCredential = components['schemas']['DomainRegistrarCredentialResponse'];
 export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
 export type DomainRenew = components['schemas']['DomainRenewResponse'];
+export type DomainRenewTransferPending = components['schemas']['DomainRenewTransferPendingResponse'];
 export type DomainRenewalDetails = components['schemas']['DomainRenewalDetails'];
 export type DomainRenewalPrice = components['schemas']['DomainRenewalPriceResponse'];
 export type Domain = components['schemas']['DomainResponse'];

package/src/openapi.yaml

@@ -6308,6 +6308,7 @@ components:
           data:
             anyOf:
             - $ref: '#/components/schemas/DomainRenewResponse'
+            - $ref: '#/components/schemas/DomainRenewTransferPendingResponse'
             - type: string
           headers:
             additionalProperties:
@@ -13217,6 +13218,28 @@ components:
       - period_extended
       title: DomainRenewResponse
       type: object
+    DomainRenewTransferPendingResponse:
+      properties:
+        name:
+          description: The domain name the renewal was requested for
+          title: Name
+          type: string
+        request_id:
+          description: Identifier of the transfer this renewal started
+          title: Request Id
+          type: string
+        status:
+          const: transfer_pending
+          default: transfer_pending
+          description: The domain is held at another registrar, so the renewal transfers
+            it into OpusDNS. The outcome is reported as domain events.
+          title: Status
+          type: string
+      required:
+      - name
+      - request_id
+      title: DomainRenewTransferPendingResponse
+      type: object
     DomainRenewalDetails:
       properties:
         detail_type:
@@ -21656,6 +21679,7 @@ components:
       - IMPORT_REQUESTED
       - IMPORT_PENDING
       - DNSSEC_PENDING
+      - TRANSFER_ON_RENEW_PENDING
       title: StatusTagType
       type: string
     StrictMoneyDecimal:
@@ -24831,7 +24855,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-10-02-161543
+  version: 2026-10-05-214656
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -35667,7 +35691,13 @@ paths:
       description: 'Extends the registration period of an existing domain. The renewal
         period is added
 
-        to the current expiration date of the domain.'
+        to the current expiration date of the domain.
+
+
+        For a domain held at another registrar, the renewal transfers the domain into
+        OpusDNS
+
+        and answers 202 before the transfer starts.'
       operationId: renew_domain_v1_domains__domain_reference__renew_post
       parameters:
       - in: path
@@ -35697,12 +35727,65 @@ paths:
               schema:
                 $ref: '#/components/schemas/DomainRenewResponse'
           description: Successful Response
+        '202':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainRenewTransferPendingResponse'
+          description: 'The domain is held at another registrar, so the renewal transfers
+            it into OpusDNS: it is unlocked there, its auth code and contacts are
+            copied, and a transfer-in is requested at the transfer price. The transfer''s
+            progress and outcome are reported as domain events, including an inbound-transfer
+            failure event if any step fails.'
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_TRANSFER_ON_RENEW_PENDING
+                detail: A renewal already started the transfer of this domain into
+                  OpusDNS
+                domain_name: example.com
+                status: 409
+                title: Domain Management Error
+                type: domain-transfer-on-renew-pending
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Conflict
         '422':
           content:
             application/problem+json:
+              example:
+                code: ERROR_REGISTRAR_CREDENTIAL_REJECTED
+                detail: INTERNETX rejected the connected registrar credential holding
+                  the domain. Update the credential under Connected Registrars, then
+                  retry the renewal
+                domain_name: example.com
+                registrar: INTERNETX
+                status: 422
+                title: Registrar Credential Rejected
+                type: domain-registrar-credential-rejected
               schema:
-                $ref: '#/components/schemas/HTTPValidationError'
-          description: Validation Error
+                $ref: '#/components/schemas/Problem'
+          description: Unprocessable Content
+        '503':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_REGISTRAR_UNAVAILABLE
+                detail: The registrar currently holding the domain is unavailable,
+                  please retry later
+                domain_name: example.com
+                status: 503
+                title: Registrar Unavailable
+                type: domain-registrar-unavailable
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Service Unavailable
+          headers:
+            Retry-After:
+              description: Seconds to wait before retrying the renewal
+              schema:
+                type: integer
       security:
       - OAuth2PasswordBearer: []
       - APIKeyHeader: []
@@ -36939,7 +37022,7 @@ paths:
           $ref: '#/components/schemas/SortOrder'
           default: desc
           description: Sort order direction
-      - description: Filter by
+      - description: Filter by the type of object the event is about
         in: query
         name: object_type
         required: false
@@ -36947,7 +37030,7 @@ paths:
           anyOf:
           - $ref: '#/components/schemas/EventObjectType'
           - type: 'null'
-          description: Filter by
+          description: Filter by the type of object the event is about
           title: Object Type
       - description: Filter by specific domain/contact/host name
         in: query

package/src/schema.d.ts

@@ -1612,6 +1612,9 @@ export interface paths {
          * Renew a domain
          * @description Extends the registration period of an existing domain. The renewal period is added
          *     to the current expiration date of the domain.
+         *
+         *     For a domain held at another registrar, the renewal transfers the domain into OpusDNS
+         *     and answers 202 before the transfer starts.
          */
         post: operations["renew_domain_v1_domains__domain_reference__renew_post"];
         delete?: never;
@@ -7912,7 +7915,7 @@ export interface components {
              */
             truncated: boolean;
         } | {
-            data?: components["schemas"]["DomainRenewResponse"] | string;
+            data?: components["schemas"]["DomainRenewResponse"] | components["schemas"]["DomainRenewTransferPendingResponse"] | string;
             /**
              * Headers
              * @description Selected response headers
@@ -12632,6 +12635,26 @@ export interface components {
             /** @description The period by which the domain was extended */
             period_extended: components["schemas"]["DomainPeriod"];
         };
+        /** DomainRenewTransferPendingResponse */
+        DomainRenewTransferPendingResponse: {
+            /**
+             * Name
+             * @description The domain name the renewal was requested for
+             */
+            name: string;
+            /**
+             * Request Id
+             * @description Identifier of the transfer this renewal started
+             */
+            request_id: string;
+            /**
+             * Status
+             * @description The domain is held at another registrar, so the renewal transfers it into OpusDNS. The outcome is reported as domain events.
+             * @default transfer_pending
+             * @constant
+             */
+            status: "transfer_pending";
+        };
         /** DomainRenewalDetails */
         DomainRenewalDetails: {
             /**
@@ -18236,7 +18259,7 @@ export interface components {
          * StatusTagType
          * @enum {string}
          */
-        StatusTagType: "VERIFICATION_REQUIRED" | "CREATE_REQUESTED" | "INBOUND_TRANSFER_PENDING" | "OUTBOUND_TRANSFER_PENDING" | "EXTERNAL" | "IMPORT_REQUESTED" | "IMPORT_PENDING" | "DNSSEC_PENDING";
+        StatusTagType: "VERIFICATION_REQUIRED" | "CREATE_REQUESTED" | "INBOUND_TRANSFER_PENDING" | "OUTBOUND_TRANSFER_PENDING" | "EXTERNAL" | "IMPORT_REQUESTED" | "IMPORT_PENDING" | "DNSSEC_PENDING" | "TRANSFER_ON_RENEW_PENDING";
         /** @example 12.50 */
         StrictMoneyDecimal: string;
         /** Support */
@@ -28648,13 +28671,67 @@ export interface operations {
                     "application/json": components["schemas"]["DomainRenewResponse"];
                 };
             };
-            /** @description Validation Error */
+            /** @description The domain is held at another registrar, so the renewal transfers it into OpusDNS: it is unlocked there, its auth code and contacts are copied, and a transfer-in is requested at the transfer price. The transfer's progress and outcome are reported as domain events, including an inbound-transfer failure event if any step fails. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DomainRenewTransferPendingResponse"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_DOMAIN_TRANSFER_ON_RENEW_PENDING",
+                     *       "detail": "A renewal already started the transfer of this domain into OpusDNS",
+                     *       "domain_name": "example.com",
+                     *       "status": 409,
+                     *       "title": "Domain Management Error",
+                     *       "type": "domain-transfer-on-renew-pending"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Unprocessable Content */
             422: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                    /** @example {
+                     *       "code": "ERROR_REGISTRAR_CREDENTIAL_REJECTED",
+                     *       "detail": "INTERNETX rejected the connected registrar credential holding the domain. Update the credential under Connected Registrars, then retry the renewal",
+                     *       "domain_name": "example.com",
+                     *       "registrar": "INTERNETX",
+                     *       "status": 422,
+                     *       "title": "Registrar Credential Rejected",
+                     *       "type": "domain-registrar-credential-rejected"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Service Unavailable */
+            503: {
+                headers: {
+                    /** @description Seconds to wait before retrying the renewal */
+                    "Retry-After"?: number;
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_DOMAIN_REGISTRAR_UNAVAILABLE",
+                     *       "detail": "The registrar currently holding the domain is unavailable, please retry later",
+                     *       "domain_name": "example.com",
+                     *       "status": 503,
+                     *       "title": "Registrar Unavailable",
+                     *       "type": "domain-registrar-unavailable"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
                 };
             };
         };
@@ -29745,7 +29822,7 @@ export interface operations {
                 sort_by?: components["schemas"]["EventSortField"];
                 /** @description Sort order direction */
                 sort_order?: components["schemas"]["SortOrder"];
-                /** @description Filter by */
+                /** @description Filter by the type of object the event is about */
                 object_type?: components["schemas"]["EventObjectType"] | null;
                 /** @description Filter by specific domain/contact/host name */
                 object_id?: string | null;