@opusdns/api 0.27.0 → 0.29.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.27.0",
+  "version": "0.29.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -7018,6 +7018,31 @@ export const KEYS_DOMAIN_SEARCH_SUGGESTION = [
  * @see {@link KEYS_DOMAIN_STATUSES_BASE} - Array of all keys for this type
  */
 export const KEY_DOMAIN_STATUSES_BASE_DEFAULT = 'default' as keyof DomainStatusesBase;
+/**
+ * Status Mapping
+ *
+ * Mapping of registry-specific statuses to their equivalent default ones, if any
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `status_mapping` property of DomainStatusesBase objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainstatusesbase[KEY_DOMAIN_STATUSES_BASE_STATUS_MAPPING];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_STATUSES_BASE_STATUS_MAPPING;
+ * const value = domainstatusesbase[propertyName];
+ * ```
+ *
+ * @see {@link DomainStatusesBase} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_STATUSES_BASE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_STATUSES_BASE_STATUS_MAPPING = 'status_mapping' as keyof DomainStatusesBase;
 /**
  * Supported Statuses
  *
@@ -7067,6 +7092,7 @@ export const KEY_DOMAIN_STATUSES_BASE_SUPPORTED_STATUSES = 'supported_statuses'
  */
 export const KEYS_DOMAIN_STATUSES_BASE = [
   KEY_DOMAIN_STATUSES_BASE_DEFAULT,
+  KEY_DOMAIN_STATUSES_BASE_STATUS_MAPPING,
   KEY_DOMAIN_STATUSES_BASE_SUPPORTED_STATUSES,
 ] as const satisfies (keyof DomainStatusesBase)[];
 

package/src/helpers/requests.d.ts

@@ -1663,6 +1663,82 @@ export type PUT_DomainsDomainReferenceDnssec_Request_Path = PUT_DomainsDomainRef
  */
 export type PUT_DomainsDomainReferenceDnssec_Request_Body = PUT_DomainsDomainReferenceDnssec_Request['requestBody'];
 
+/**
+ * Request type for POST DomainsDomainReferenceDnssecDisable endpoint
+ *
+ * Disable DNSSEC for domains using our nameservers
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST DomainsDomainReferenceDnssecDisable 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/domains/{domain_reference}/dnssec/disable
+ *
+ * @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Query} - Query parameters type
+ * @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Path} - Path parameters type
+ * @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Body} - Request body type
+ */
+export type POST_DomainsDomainReferenceDnssecDisable_Request = {
+  parameters: {
+    path: operations['disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post']['parameters']['path'];
+  };
+}
+/**
+ * Path parameters for POST /v1/domains/{domain_reference}/dnssec/disable
+ *
+ * @remarks
+ * This type defines the path parameters for the POST /v1/domains/{domain_reference}/dnssec/disable 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/domains/{domain_reference}/dnssec/disable
+ */
+export type POST_DomainsDomainReferenceDnssecDisable_Request_Path = POST_DomainsDomainReferenceDnssecDisable_Request['parameters']['path'];
+
+/**
+ * Request type for POST DomainsDomainReferenceDnssecEnable endpoint
+ *
+ * Enable DNSSEC for domains using our nameservers
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST DomainsDomainReferenceDnssecEnable 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/domains/{domain_reference}/dnssec/enable
+ *
+ * @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Query} - Query parameters type
+ * @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Path} - Path parameters type
+ * @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Body} - Request body type
+ */
+export type POST_DomainsDomainReferenceDnssecEnable_Request = {
+  parameters: {
+    path: operations['enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post']['parameters']['path'];
+  };
+}
+/**
+ * Path parameters for POST /v1/domains/{domain_reference}/dnssec/enable
+ *
+ * @remarks
+ * This type defines the path parameters for the POST /v1/domains/{domain_reference}/dnssec/enable 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/domains/{domain_reference}/dnssec/enable
+ */
+export type POST_DomainsDomainReferenceDnssecEnable_Request_Path = POST_DomainsDomainReferenceDnssecEnable_Request['parameters']['path'];
+
 /**
  * Request type for POST DomainsDomainReferenceRenew endpoint
  *

package/src/helpers/responses.d.ts

@@ -2678,6 +2678,134 @@ export type PUT_DomainsByDomainReferenceDnssec_Response_404 = Problem
  */
 export type PUT_DomainsByDomainReferenceDnssec_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST DomainsByDomainReferenceDnssecDisable endpoint
+ *
+ * Disable DNSSEC for domains using our nameservers
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST DomainsByDomainReferenceDnssecDisable 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/domains/{domain_reference}/dnssec/disable
+ *
+ * @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response_404} - 404 response type
+ * @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response_422} - 422 response type
+ *
+
+ */
+export type POST_DomainsByDomainReferenceDnssecDisable_Response = POST_DomainsByDomainReferenceDnssecDisable_Response_404 | POST_DomainsByDomainReferenceDnssecDisable_Response_422;
+
+/**
+ * 404 response for POST DomainsByDomainReferenceDnssecDisable endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST DomainsByDomainReferenceDnssecDisable endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/{domain_reference}/dnssec/disable
+ *
+ * @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainsByDomainReferenceDnssecDisable_Response_404 = Problem
+
+/**
+ * 422 response for POST DomainsByDomainReferenceDnssecDisable endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST DomainsByDomainReferenceDnssecDisable endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/{domain_reference}/dnssec/disable
+ *
+ * @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_DomainsByDomainReferenceDnssecDisable_Response_422 = HTTPValidationError
+
+/**
+ * Response types for POST DomainsByDomainReferenceDnssecEnable endpoint
+ *
+ * Enable DNSSEC for domains using our nameservers
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST DomainsByDomainReferenceDnssecEnable 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/domains/{domain_reference}/dnssec/enable
+ *
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_200} - 200 response type
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_404} - 404 response type
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_422} - 422 response type
+ *
+
+ */
+export type POST_DomainsByDomainReferenceDnssecEnable_Response = POST_DomainsByDomainReferenceDnssecEnable_Response_200 | POST_DomainsByDomainReferenceDnssecEnable_Response_404 | POST_DomainsByDomainReferenceDnssecEnable_Response_422;
+
+/**
+ * 200 response for POST DomainsByDomainReferenceDnssecEnable endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST DomainsByDomainReferenceDnssecEnable endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/{domain_reference}/dnssec/enable
+ *
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
+ * @see {@link DomainDnssecData} - The actual schema type definition
+ */
+export type POST_DomainsByDomainReferenceDnssecEnable_Response_200 = DomainDnssecDataArray
+
+/**
+ * 404 response for POST DomainsByDomainReferenceDnssecEnable endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST DomainsByDomainReferenceDnssecEnable endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/{domain_reference}/dnssec/enable
+ *
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainsByDomainReferenceDnssecEnable_Response_404 = Problem
+
+/**
+ * 422 response for POST DomainsByDomainReferenceDnssecEnable endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST DomainsByDomainReferenceDnssecEnable endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/{domain_reference}/dnssec/enable
+ *
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_DomainsByDomainReferenceDnssecEnable_Response_422 = HTTPValidationError
+
 /**
  * Response types for POST DomainsByDomainReferenceRenew endpoint
  *

package/src/openapi.yaml

@@ -1711,10 +1711,21 @@ components:
             type: string
           title: Default
           type: array
+        status_mapping:
+          anyOf:
+          - additionalProperties:
+              items:
+                $ref: '#/components/schemas/DomainStatus'
+              type: array
+            type: object
+          - type: 'null'
+          description: Mapping of registry-specific statuses to their equivalent default
+            ones, if any
+          title: Status Mapping
         supported_statuses:
           description: Supported domain statuses
           items:
-            $ref: '#/components/schemas/DomainStatus'
+            type: string
           title: Supported Statuses
           type: array
       required:
@@ -4787,7 +4798,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-08-29-160817
+  version: 2025-08-30-003827
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7133,6 +7144,102 @@ paths:
       summary: Update DNSSEC data
       tags:
       - domain
+  /v1/domains/{domain_reference}/dnssec/disable:
+    post:
+      operationId: disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post
+      parameters:
+      - in: path
+        name: domain_reference
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - domain_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: domain
+          - type: string
+          title: Domain Reference
+      responses:
+        '204':
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_NOT_FOUND
+                detail: Domain not found
+                domain_name: Additional error context.
+                status: 404
+                title: Domain Management Error
+                type: domain-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Disable DNSSEC for domains using our nameservers
+      tags:
+      - domain
+  /v1/domains/{domain_reference}/dnssec/enable:
+    post:
+      operationId: enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post
+      parameters:
+      - in: path
+        name: domain_reference
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - domain_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: domain
+          - type: string
+          title: Domain Reference
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                items:
+                  $ref: '#/components/schemas/DomainDnssecDataResponse'
+                title: Response Enable And Publish Dnssec Records V1 Domains  Domain
+                  Reference  Dnssec Enable Post
+                type: array
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_NOT_FOUND
+                detail: Domain not found
+                domain_name: Additional error context.
+                status: 404
+                title: Domain Management Error
+                type: domain-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Enable DNSSEC for domains using our nameservers
+      tags:
+      - domain
   /v1/domains/{domain_reference}/renew:
     post:
       description: 'Extends the registration period of an existing domain. The renewal

package/src/schema.d.ts

@@ -545,6 +545,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/domains/{domain_reference}/dnssec/disable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Disable DNSSEC for domains using our nameservers */
+        post: operations["disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/domains/{domain_reference}/dnssec/enable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Enable DNSSEC for domains using our nameservers */
+        post: operations["enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/domains/{domain_reference}/renew": {
         parameters: {
             query?: never;
@@ -2162,11 +2196,18 @@ export interface components {
              * @description The default status for an active domain with no restrictions
              */
             default: string[];
+            /**
+             * Status Mapping
+             * @description Mapping of registry-specific statuses to their equivalent default ones, if any
+             */
+            status_mapping?: {
+                [key: string]: components["schemas"]["DomainStatus"][];
+            } | null;
             /**
              * Supported Statuses
              * @description Supported domain statuses
              */
-            supported_statuses: components["schemas"]["DomainStatus"][];
+            supported_statuses: string[];
         };
         /** DomainSummaryData */
         DomainSummaryData: {
@@ -6281,6 +6322,100 @@ export interface operations {
             };
         };
     };
+    disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                domain_reference: TypeID<"domain"> | string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_DOMAIN_NOT_FOUND",
+                     *       "detail": "Domain not found",
+                     *       "domain_name": "Additional error context.",
+                     *       "status": 404,
+                     *       "title": "Domain Management Error",
+                     *       "type": "domain-not-found"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                domain_reference: TypeID<"domain"> | string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["DomainDnssecDataResponse"][];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_DOMAIN_NOT_FOUND",
+                     *       "detail": "Domain not found",
+                     *       "domain_name": "Additional error context.",
+                     *       "status": 404,
+                     *       "title": "Domain Management Error",
+                     *       "type": "domain-not-found"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     renew_domain_v1_domains__domain_reference__renew_post: {
         parameters: {
             query?: never;