@opusdns/api 0.272.0 → 0.274.0

package/package.json

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

package/src/helpers/keys.ts

@@ -1395,6 +1395,31 @@ export const KEYS_BULK_OBJECT_TAG_CHANGES = [
   KEY_BULK_OBJECT_TAG_CHANGES_TYPE,
 ] as const satisfies (keyof BulkObjectTagChanges)[];
 
+/**
+ * Code
+ *
+ * Stable semantic error code for known failure modes (e.g. 'ERROR_BATCH_EMPTY'); null for ad-hoc failures. Matches the 'code' field in top-level error responses.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `code` property of CommandError objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = commanderror[KEY_COMMAND_ERROR_CODE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_COMMAND_ERROR_CODE;
+ * const value = commanderror[propertyName];
+ * ```
+ *
+ * @see {@link CommandError} - The TypeScript type definition
+ * @see {@link KEYS_COMMAND_ERROR} - Array of all keys for this type
+ */
+export const KEY_COMMAND_ERROR_CODE: keyof CommandError = 'code';
 /**
  * Error
  *
@@ -1447,6 +1472,81 @@ export const KEY_COMMAND_ERROR_ERROR: keyof CommandError = 'error';
  * @see {@link KEYS_COMMAND_ERROR} - Array of all keys for this type
  */
 export const KEY_COMMAND_ERROR_INDEX: keyof CommandError = 'index';
+/**
+ * Instance Index
+ *
+ * Index within the bulk command's instances[] for per-instance failures
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `instance_index` property of CommandError objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = commanderror[KEY_COMMAND_ERROR_INSTANCE_INDEX];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_COMMAND_ERROR_INSTANCE_INDEX;
+ * const value = commanderror[propertyName];
+ * ```
+ *
+ * @see {@link CommandError} - The TypeScript type definition
+ * @see {@link KEYS_COMMAND_ERROR} - Array of all keys for this type
+ */
+export const KEY_COMMAND_ERROR_INSTANCE_INDEX: keyof CommandError = 'instance_index';
+/**
+ * Resource Key
+ *
+ * Resource identifier (zone name, domain name, contact email) for per-instance failures
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `resource_key` property of CommandError objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = commanderror[KEY_COMMAND_ERROR_RESOURCE_KEY];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_COMMAND_ERROR_RESOURCE_KEY;
+ * const value = commanderror[propertyName];
+ * ```
+ *
+ * @see {@link CommandError} - The TypeScript type definition
+ * @see {@link KEYS_COMMAND_ERROR} - Array of all keys for this type
+ */
+export const KEY_COMMAND_ERROR_RESOURCE_KEY: keyof CommandError = 'resource_key';
+/**
+ * Type
+ *
+ * RFC 9457 problem type identifier derived from the exception class (e.g. 'value', 'batch-empty'). Matches the 'type' field in top-level error responses.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `type` property of CommandError objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = commanderror[KEY_COMMAND_ERROR_TYPE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_COMMAND_ERROR_TYPE;
+ * const value = commanderror[propertyName];
+ * ```
+ *
+ * @see {@link CommandError} - The TypeScript type definition
+ * @see {@link KEYS_COMMAND_ERROR} - Array of all keys for this type
+ */
+export const KEY_COMMAND_ERROR_TYPE: keyof CommandError = 'type';
 
 /**
  * Array of all CommandError property keys
@@ -1469,8 +1569,12 @@ export const KEY_COMMAND_ERROR_INDEX: keyof CommandError = 'index';
  * @see {@link CommandError} - The TypeScript type definition
  */
 export const KEYS_COMMAND_ERROR = [
+  KEY_COMMAND_ERROR_CODE,
   KEY_COMMAND_ERROR_ERROR,
   KEY_COMMAND_ERROR_INDEX,
+  KEY_COMMAND_ERROR_INSTANCE_INDEX,
+  KEY_COMMAND_ERROR_RESOURCE_KEY,
+  KEY_COMMAND_ERROR_TYPE,
 ] as const satisfies (keyof CommandError)[];
 
 /**
@@ -10943,6 +11047,31 @@ export const KEY_DOMAIN_CREATE_ATTRIBUTES: keyof DomainCreate = 'attributes';
  * @see {@link KEYS_DOMAIN_CREATE} - Array of all keys for this type
  */
 export const KEY_DOMAIN_CREATE_AUTH_CODE: keyof DomainCreate = 'auth_code';
+/**
+ * The accept_hash of the related claims notice
+ *
+ * During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `claims_notice_acceptance_hash` property of DomainCreate objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaincreate[KEY_DOMAIN_CREATE_CLAIMS_NOTICE_ACCEPTANCE_HASH];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_CREATE_CLAIMS_NOTICE_ACCEPTANCE_HASH;
+ * const value = domaincreate[propertyName];
+ * ```
+ *
+ * @see {@link DomainCreate} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_CREATE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_CREATE_CLAIMS_NOTICE_ACCEPTANCE_HASH: keyof DomainCreate = 'claims_notice_acceptance_hash';
 /**
  * Contacts
  *
@@ -11144,6 +11273,7 @@ export const KEY_DOMAIN_CREATE_RENEWAL_MODE: keyof DomainCreate = 'renewal_mode'
 export const KEYS_DOMAIN_CREATE = [
   KEY_DOMAIN_CREATE_ATTRIBUTES,
   KEY_DOMAIN_CREATE_AUTH_CODE,
+  KEY_DOMAIN_CREATE_CLAIMS_NOTICE_ACCEPTANCE_HASH,
   KEY_DOMAIN_CREATE_CONTACTS,
   KEY_DOMAIN_CREATE_CREATE_ZONE,
   KEY_DOMAIN_CREATE_EXPECTED_PRICE,
@@ -11926,6 +12056,31 @@ export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_ATTRIBUTES: keyof DomainCreatePayloa
  * @see {@link KEYS_DOMAIN_CREATE_PAYLOAD_DATA} - Array of all keys for this type
  */
 export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_AUTH_CODE: keyof DomainCreatePayloadData = 'auth_code';
+/**
+ * The accept_hash of the related claims notice
+ *
+ * During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `claims_notice_acceptance_hash` property of DomainCreatePayloadData objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaincreatepayloaddata[KEY_DOMAIN_CREATE_PAYLOAD_DATA_CLAIMS_NOTICE_ACCEPTANCE_HASH];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_CREATE_PAYLOAD_DATA_CLAIMS_NOTICE_ACCEPTANCE_HASH;
+ * const value = domaincreatepayloaddata[propertyName];
+ * ```
+ *
+ * @see {@link DomainCreatePayloadData} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_CREATE_PAYLOAD_DATA} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_CLAIMS_NOTICE_ACCEPTANCE_HASH: keyof DomainCreatePayloadData = 'claims_notice_acceptance_hash';
 /**
  * Contacts
  *
@@ -12127,6 +12282,7 @@ export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_RENEWAL_MODE: keyof DomainCreatePayl
 export const KEYS_DOMAIN_CREATE_PAYLOAD_DATA = [
   KEY_DOMAIN_CREATE_PAYLOAD_DATA_ATTRIBUTES,
   KEY_DOMAIN_CREATE_PAYLOAD_DATA_AUTH_CODE,
+  KEY_DOMAIN_CREATE_PAYLOAD_DATA_CLAIMS_NOTICE_ACCEPTANCE_HASH,
   KEY_DOMAIN_CREATE_PAYLOAD_DATA_CONTACTS,
   KEY_DOMAIN_CREATE_PAYLOAD_DATA_CREATE_ZONE,
   KEY_DOMAIN_CREATE_PAYLOAD_DATA_EXPECTED_PRICE,

package/src/openapi.yaml

@@ -325,6 +325,14 @@ components:
       type: object
     CommandError:
       properties:
+        code:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Stable semantic error code for known failure modes (e.g. 'ERROR_BATCH_EMPTY');
+            null for ad-hoc failures. Matches the 'code' field in top-level error
+            responses.
+          title: Code
         error:
           description: Error message
           title: Error
@@ -333,6 +341,28 @@ components:
           description: Index of the failed command in the request
           title: Index
           type: integer
+        instance_index:
+          anyOf:
+          - type: integer
+          - type: 'null'
+          description: Index within the bulk command's instances[] for per-instance
+            failures
+          title: Instance Index
+        resource_key:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Resource identifier (zone name, domain name, contact email)
+            for per-instance failures
+          title: Resource Key
+        type:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: RFC 9457 problem type identifier derived from the exception
+            class (e.g. 'value', 'batch-empty'). Matches the 'type' field in top-level
+            error responses.
+          title: Type
       required:
       - index
       - error
@@ -2629,6 +2659,14 @@ components:
           - type: 'null'
           description: The auth code used for the domain
           title: Auth Code
+        claims_notice_acceptance_hash:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: During the claims phase domain names that match a trademark
+            registered in the Trademark Clearinghouse require an acceptance by the
+            registrant.
+          title: The accept_hash of the related claims notice
         contacts:
           anyOf:
           - $ref: '#/components/schemas/DomainContactHandles'
@@ -2849,6 +2887,14 @@ components:
           - type: 'null'
           description: The auth code used for the domain
           title: Auth Code
+        claims_notice_acceptance_hash:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: During the claims phase domain names that match a trademark
+            registered in the Trademark Clearinghouse require an acceptance by the
+            registrant.
+          title: The accept_hash of the related claims notice
         contacts:
           anyOf:
           - $ref: '#/components/schemas/DomainContactHandles'
@@ -10153,7 +10199,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-27-163825
+  version: 2026-04-27-182502
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -2413,6 +2413,11 @@ export interface components {
         };
         /** CommandError */
         CommandError: {
+            /**
+             * Code
+             * @description Stable semantic error code for known failure modes (e.g. 'ERROR_BATCH_EMPTY'); null for ad-hoc failures. Matches the 'code' field in top-level error responses.
+             */
+            code?: string | null;
             /**
              * Error
              * @description Error message
@@ -2423,6 +2428,21 @@ export interface components {
              * @description Index of the failed command in the request
              */
             index: number;
+            /**
+             * Instance Index
+             * @description Index within the bulk command's instances[] for per-instance failures
+             */
+            instance_index?: number | null;
+            /**
+             * Resource Key
+             * @description Resource identifier (zone name, domain name, contact email) for per-instance failures
+             */
+            resource_key?: string | null;
+            /**
+             * Type
+             * @description RFC 9457 problem type identifier derived from the exception class (e.g. 'value', 'batch-empty'). Matches the 'type' field in top-level error responses.
+             */
+            type?: string | null;
         };
         /**
          * ComplianceStatus
@@ -4011,6 +4031,11 @@ export interface components {
              * @description The auth code used for the domain
              */
             auth_code?: string | null;
+            /**
+             * The accept_hash of the related claims notice
+             * @description During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant.
+             */
+            claims_notice_acceptance_hash?: string | null;
             /**
              * Contacts
              * @description The contacts of the domain
@@ -4168,6 +4193,11 @@ export interface components {
              * @description The auth code used for the domain
              */
             auth_code?: string | null;
+            /**
+             * The accept_hash of the related claims notice
+             * @description During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant.
+             */
+            claims_notice_acceptance_hash?: string | null;
             /**
              * Contacts
              * @description The contacts of the domain