@opusdns/api 0.110.0 → 0.111.0

package/package.json

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

package/src/helpers/keys.ts

@@ -141,6 +141,7 @@ import { PublicAuthRequestForm } from './schemas';
 import { RdapBase } from './schemas';
 import { RegistryLockBase } from './schemas';
 import { RelationSet } from './schemas';
+import { RequestAuthcode } from './schemas';
 import { RequestHistory } from './schemas';
 import { ReservedDomainsBase } from './schemas';
 import { RgpOperations } from './schemas';
@@ -17284,6 +17285,110 @@ export const KEYS_RELATION_SET = [
   KEY_RELATION_SET_RELATIONS,
 ] as const satisfies (keyof RelationSet)[];
 
+/**
+ * Detail
+ *
+ * Additional information about the result in case of failure
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `detail` property of RequestAuthcode objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = requestauthcode[KEY_REQUEST_AUTHCODE_DETAIL];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_REQUEST_AUTHCODE_DETAIL;
+ * const value = requestauthcode[propertyName];
+ * ```
+ *
+ * @see {@link RequestAuthcode} - The TypeScript type definition
+ * @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
+ */
+export const KEY_REQUEST_AUTHCODE_DETAIL = 'detail' as keyof RequestAuthcode;
+/**
+ * Name
+ *
+ * The domain name that had the auth code requested
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `name` property of RequestAuthcode objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = requestauthcode[KEY_REQUEST_AUTHCODE_NAME];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_REQUEST_AUTHCODE_NAME;
+ * const value = requestauthcode[propertyName];
+ * ```
+ *
+ * @see {@link RequestAuthcode} - The TypeScript type definition
+ * @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
+ */
+export const KEY_REQUEST_AUTHCODE_NAME = 'name' as keyof RequestAuthcode;
+/**
+ * Success
+ *
+ * Whether the request had a successful result from DNS Belgium
+ *
+ * @type {boolean}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `success` property of RequestAuthcode objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = requestauthcode[KEY_REQUEST_AUTHCODE_SUCCESS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_REQUEST_AUTHCODE_SUCCESS;
+ * const value = requestauthcode[propertyName];
+ * ```
+ *
+ * @see {@link RequestAuthcode} - The TypeScript type definition
+ * @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
+ */
+export const KEY_REQUEST_AUTHCODE_SUCCESS = 'success' as keyof RequestAuthcode;
+
+/**
+ * Array of all RequestAuthcode property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for RequestAuthcode objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_REQUEST_AUTHCODE) {
+ *   console.log(`Property: ${key}, Value: ${requestauthcode[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_REQUEST_AUTHCODE.includes(someKey);
+ * ```
+ *
+ * @see {@link RequestAuthcode} - The TypeScript type definition
+ */
+export const KEYS_REQUEST_AUTHCODE = [
+  KEY_REQUEST_AUTHCODE_DETAIL,
+  KEY_REQUEST_AUTHCODE_NAME,
+  KEY_REQUEST_AUTHCODE_SUCCESS,
+] as const satisfies (keyof RequestAuthcode)[];
+
 /**
  * Client Ip
  *

package/src/helpers/requests.d.ts

@@ -2458,6 +2458,44 @@ export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Path = POST
  */
 export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Body = POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request['requestBody'];
 
+/**
+ * Request type for POST DomainsTldSpecificBeDomainReferenceAuthCodeRequest endpoint
+ *
+ * Requests your auth code directly from DNS Belgium (registry)
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST DomainsTldSpecificBeDomainReferenceAuthCodeRequest 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/tld-specific/be/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Query} - Query parameters type
+ * @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Path} - Path parameters type
+ * @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Body} - Request body type
+ */
+export type POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request = {
+  parameters: {
+    path: operations['request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post']['parameters']['path'];
+  };
+}
+/**
+ * Path parameters for POST /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
+ *
+ * @remarks
+ * This type defines the path parameters for the POST /v1/domains/tld-specific/be/{domain_reference}/auth_code/request 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/tld-specific/be/{domain_reference}/auth_code/request
+ */
+export type POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request['parameters']['path'];
+
 /**
  * Request type for POST DomainsTldSpecificDeDomainReferenceTransit endpoint
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, DomainTransit, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
+import { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET ArchiveObjectLogs endpoint
@@ -4431,6 +4431,79 @@ export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_404 = Pr
  */
 export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
+ *
+ * Requests your auth code directly from DNS Belgium (registry)
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest 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/tld-specific/be/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200} - 200 response type
+ * @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404} - 404 response type
+ * @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422} - 422 response type
+ *
+
+ */
+export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422;
+
+/**
+ * 200 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
+ * @see {@link RequestAuthcode} - The actual schema type definition
+ */
+export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode
+
+/**
+ * 404 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 = Problem
+
+/**
+ * 422 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError
+
 /**
  * Response types for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
  *

package/src/helpers/schemas.d.ts

@@ -2943,6 +2943,22 @@ export type RelationSet = components['schemas']['RelationSet'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type RenewalMode = components['schemas']['RenewalMode'];
+/**
+ * RequestAuthcodeResponse
+ *
+ * @remarks
+ * Type alias for the `RequestAuthcodeResponse` OpenAPI schema.
+ * This type represents requestauthcoderesponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRequestAuthcode();
+ * const item: RequestAuthcode = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RequestAuthcode = components['schemas']['RequestAuthcodeResponse'];
 /**
  * RequestHistory
  *

package/src/openapi.yaml

@@ -4503,6 +4503,27 @@ components:
       - delete
       title: RenewalMode
       type: string
+    RequestAuthcodeResponse:
+      properties:
+        detail:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Additional information about the result in case of failure
+          title: Detail
+        name:
+          description: The domain name that had the auth code requested
+          title: Name
+          type: string
+        success:
+          description: Whether the request had a successful result from DNS Belgium
+          title: Success
+          type: boolean
+      required:
+      - name
+      - success
+      title: RequestAuthcodeResponse
+      type: object
     RequestHistory:
       properties:
         client_ip:
@@ -5608,7 +5629,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-12-04-140616
+  version: 2025-12-04-142309
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -9468,6 +9489,55 @@ paths:
       tags:
       - domain
       - domain_tld_specific
+  /v1/domains/tld-specific/be/{domain_reference}/auth_code/request:
+    post:
+      operationId: request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_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:
+                $ref: '#/components/schemas/RequestAuthcodeResponse'
+          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: Requests your auth code directly from DNS Belgium (registry)
+      tags:
+      - domain
+      - domain_tld_specific
   /v1/domains/tld-specific/de/{domain_reference}/transit:
     post:
       operationId: transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post

package/src/schema.d.ts

@@ -604,6 +604,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/domains/tld-specific/be/{domain_reference}/auth_code/request": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Requests your auth code directly from DNS Belgium (registry) */
+        post: operations["request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/domains/tld-specific/de/{domain_reference}/transit": {
         parameters: {
             query?: never;
@@ -4352,6 +4369,24 @@ export interface components {
          * @enum {string}
          */
         RenewalMode: "renew" | "expire" | "delete";
+        /** RequestAuthcodeResponse */
+        RequestAuthcodeResponse: {
+            /**
+             * Detail
+             * @description Additional information about the result in case of failure
+             */
+            detail?: string | null;
+            /**
+             * Name
+             * @description The domain name that had the auth code requested
+             */
+            name: string;
+            /**
+             * Success
+             * @description Whether the request had a successful result from DNS Belgium
+             */
+            success: boolean;
+        };
         /** RequestHistory */
         RequestHistory: {
             /**
@@ -7836,6 +7871,54 @@ export interface operations {
             };
         };
     };
+    request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_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"]["RequestAuthcodeResponse"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post: {
         parameters: {
             query?: never;