@opusdns/api 0.273.0 → 0.275.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.273.0",
+  "version": "0.275.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)[];
 
 /**

package/src/helpers/requests.d.ts

@@ -4618,7 +4618,7 @@ export type POST_Organizations_Request_Body = POST_Organizations_Request['reques
  */
 export type GET_OrganizationsAttributes_Request = {
   parameters: {
-    query: operations['get_attributes_v1_organizations_attributes_get']['parameters']['query'];
+    query: operations['get_current_organization_attributes_v1_organizations_attributes_get']['parameters']['query'];
   };
 }
 /**
@@ -4657,24 +4657,8 @@ export type GET_OrganizationsAttributes_Request_Query = GET_OrganizationsAttribu
  * @see {@link PATCH_OrganizationsAttributes_Request_Body} - Request body type
  */
 export type PATCH_OrganizationsAttributes_Request = {
-  parameters: {
-    query: operations['update_attributes_v1_organizations_attributes_patch']['parameters']['query'];
-  };
   requestBody: OrganizationAttributeUpdateArray;
 }
-/**
- * Query parameters for PATCH /v1/organizations/attributes
- *
- * @remarks
- * This type defines the query parameters for the PATCH /v1/organizations/attributes endpoint.
- * It provides type safety for all query parameters as defined in the OpenAPI specification.
- *
- * @example
- * Use this type to ensure type safety for query parameters.
- *
- * @path /v1/organizations/attributes
- */
-export type PATCH_OrganizationsAttributes_Request_Query = PATCH_OrganizationsAttributes_Request['parameters']['query'];
 /**
  * Request body for PATCH /v1/organizations/attributes
  *
@@ -5048,8 +5032,8 @@ export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_Organizations
  */
 export type GET_OrganizationsOrganizationIdAttributes_Request = {
   parameters: {
-    query: operations['get_attributes_v1_organizations__organization_id__attributes_get']['parameters']['query'];
-    path: operations['get_attributes_v1_organizations__organization_id__attributes_get']['parameters']['path'];
+    query: operations['get_organization_attributes_v1_organizations__organization_id__attributes_get']['parameters']['query'];
+    path: operations['get_organization_attributes_v1_organizations__organization_id__attributes_get']['parameters']['path'];
   };
 }
 /**
@@ -5102,7 +5086,7 @@ export type GET_OrganizationsOrganizationIdAttributes_Request_Path = GET_Organiz
  */
 export type PATCH_OrganizationsOrganizationIdAttributes_Request = {
   parameters: {
-    path: operations['update_attributes_v1_organizations__organization_id__attributes_patch']['parameters']['path'];
+    path: operations['update_organization_attributes_v1_organizations__organization_id__attributes_patch']['parameters']['path'];
   };
   requestBody: OrganizationAttributeUpdateArray;
 }

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
@@ -10169,7 +10199,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-27-175347
+  version: 2026-04-27-193424
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -19682,21 +19712,8 @@ paths:
   /v1/organizations/attributes:
     get:
       description: Retrieves a list of organization attributes for the current organization
-      operationId: get_attributes_v1_organizations_attributes_get
+      operationId: get_current_organization_attributes_v1_organizations_attributes_get
       parameters:
-      - in: query
-        name: organization_id
-        required: false
-        schema:
-          anyOf:
-          - examples:
-            - organization_01h45ytscbebyvny4gc8cr8ma2
-            format: typeid
-            pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-            type: string
-            x-typeid-prefix: organization
-          - type: 'null'
-          title: Organization Id
       - description: Optional list of attribute keys to filter
         in: query
         name: keys
@@ -19716,7 +19733,8 @@ paths:
               schema:
                 items:
                   $ref: '#/components/schemas/OrganizationAttributeResponse'
-                title: Response Get Attributes V1 Organizations Attributes Get
+                title: Response Get Current Organization Attributes V1 Organizations
+                  Attributes Get
                 type: array
           description: Successful Response
         '401':
@@ -19757,21 +19775,7 @@ paths:
       - organization
     patch:
       description: Updates one or more organization attributes for the current organization
-      operationId: update_attributes_v1_organizations_attributes_patch
-      parameters:
-      - in: query
-        name: organization_id
-        required: false
-        schema:
-          anyOf:
-          - examples:
-            - organization_01h45ytscbebyvny4gc8cr8ma2
-            format: typeid
-            pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-            type: string
-            x-typeid-prefix: organization
-          - type: 'null'
-          title: Organization Id
+      operationId: update_current_organization_attributes_v1_organizations_attributes_patch
       requestBody:
         content:
           application/json:
@@ -19788,7 +19792,8 @@ paths:
               schema:
                 items:
                   $ref: '#/components/schemas/OrganizationAttributeResponse'
-                title: Response Update Attributes V1 Organizations Attributes Patch
+                title: Response Update Current Organization Attributes V1 Organizations
+                  Attributes Patch
                 type: array
           description: Successful Response
         '401':
@@ -20432,21 +20437,19 @@ paths:
   /v1/organizations/{organization_id}/attributes:
     get:
       description: Retrieves a list of organization attributes for the specified organization
-      operationId: get_attributes_v1_organizations__organization_id__attributes_get
+      operationId: get_organization_attributes_v1_organizations__organization_id__attributes_get
       parameters:
       - in: path
         name: organization_id
         required: true
         schema:
-          anyOf:
-          - examples:
-            - organization_01h45ytscbebyvny4gc8cr8ma2
-            format: typeid
-            pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-            type: string
-            x-typeid-prefix: organization
-          - type: 'null'
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
           title: Organization Id
+          type: string
+          x-typeid-prefix: organization
       - description: Optional list of attribute keys to filter
         in: query
         name: keys
@@ -20466,8 +20469,8 @@ paths:
               schema:
                 items:
                   $ref: '#/components/schemas/OrganizationAttributeResponse'
-                title: Response Get Attributes V1 Organizations  Organization Id  Attributes
-                  Get
+                title: Response Get Organization Attributes V1 Organizations  Organization
+                  Id  Attributes Get
                 type: array
           description: Successful Response
         '401':
@@ -20508,21 +20511,19 @@ paths:
       - organization
     patch:
       description: Updates one or more organization attributes for the specified organization
-      operationId: update_attributes_v1_organizations__organization_id__attributes_patch
+      operationId: update_organization_attributes_v1_organizations__organization_id__attributes_patch
       parameters:
       - in: path
         name: organization_id
         required: true
         schema:
-          anyOf:
-          - examples:
-            - organization_01h45ytscbebyvny4gc8cr8ma2
-            format: typeid
-            pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-            type: string
-            x-typeid-prefix: organization
-          - type: 'null'
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
           title: Organization Id
+          type: string
+          x-typeid-prefix: organization
       requestBody:
         content:
           application/json:
@@ -20539,8 +20540,8 @@ paths:
               schema:
                 items:
                   $ref: '#/components/schemas/OrganizationAttributeResponse'
-                title: Response Update Attributes V1 Organizations  Organization Id  Attributes
-                  Patch
+                title: Response Update Organization Attributes V1 Organizations  Organization
+                  Id  Attributes Patch
                 type: array
           description: Successful Response
         '401':

package/src/schema.d.ts

@@ -1514,7 +1514,7 @@ export interface paths {
          * List organization attributes
          * @description Retrieves a list of organization attributes for the current organization
          */
-        get: operations["get_attributes_v1_organizations_attributes_get"];
+        get: operations["get_current_organization_attributes_v1_organizations_attributes_get"];
         put?: never;
         post?: never;
         delete?: never;
@@ -1524,7 +1524,7 @@ export interface paths {
          * Update organization attributes
          * @description Updates one or more organization attributes for the current organization
          */
-        patch: operations["update_attributes_v1_organizations_attributes_patch"];
+        patch: operations["update_current_organization_attributes_v1_organizations_attributes_patch"];
         trace?: never;
     };
     "/v1/organizations/ip-restrictions": {
@@ -1672,7 +1672,7 @@ export interface paths {
          * List organization attributes
          * @description Retrieves a list of organization attributes for the specified organization
          */
-        get: operations["get_attributes_v1_organizations__organization_id__attributes_get"];
+        get: operations["get_organization_attributes_v1_organizations__organization_id__attributes_get"];
         put?: never;
         post?: never;
         delete?: never;
@@ -1682,7 +1682,7 @@ export interface paths {
          * Update organization attributes
          * @description Updates one or more organization attributes for the specified organization
          */
-        patch: operations["update_attributes_v1_organizations__organization_id__attributes_patch"];
+        patch: operations["update_organization_attributes_v1_organizations__organization_id__attributes_patch"];
         trace?: never;
     };
     "/v1/organizations/{organization_id}/billing/invoices": {
@@ -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
@@ -15535,10 +15555,9 @@ export interface operations {
             };
         };
     };
-    get_attributes_v1_organizations_attributes_get: {
+    get_current_organization_attributes_v1_organizations_attributes_get: {
         parameters: {
             query?: {
-                organization_id?: TypeId<"organization"> | null;
                 /** @description Optional list of attribute keys to filter */
                 keys?: string[] | null;
             };
@@ -15600,11 +15619,9 @@ export interface operations {
             };
         };
     };
-    update_attributes_v1_organizations_attributes_patch: {
+    update_current_organization_attributes_v1_organizations_attributes_patch: {
         parameters: {
-            query?: {
-                organization_id?: TypeId<"organization"> | null;
-            };
+            query?: never;
             header?: never;
             path?: never;
             cookie?: never;
@@ -16303,7 +16320,7 @@ export interface operations {
             };
         };
     };
-    get_attributes_v1_organizations__organization_id__attributes_get: {
+    get_organization_attributes_v1_organizations__organization_id__attributes_get: {
         parameters: {
             query?: {
                 /** @description Optional list of attribute keys to filter */
@@ -16311,7 +16328,7 @@ export interface operations {
             };
             header?: never;
             path: {
-                organization_id: TypeId<"organization"> | null;
+                organization_id: TypeId<"organization">;
             };
             cookie?: never;
         };
@@ -16369,12 +16386,12 @@ export interface operations {
             };
         };
     };
-    update_attributes_v1_organizations__organization_id__attributes_patch: {
+    update_organization_attributes_v1_organizations__organization_id__attributes_patch: {
         parameters: {
             query?: never;
             header?: never;
             path: {
-                organization_id: TypeId<"organization"> | null;
+                organization_id: TypeId<"organization">;
             };
             cookie?: never;
         };