@opusdns/api 0.284.0 → 0.285.0

package/package.json

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

package/src/helpers/keys.ts

@@ -52,6 +52,7 @@ import { ContactCreateBulkTemplate } from './schemas';
 import { ContactCreateCommand } from './schemas';
 import { ContactCreatePayloadData } from './schemas';
 import { ContactCreateWorkerPayload } from './schemas';
+import { ContactCreateWorkerResult } from './schemas';
 import { ContactHandle } from './schemas';
 import { Contact } from './schemas';
 import { ContactSchema } from './schemas';
@@ -87,6 +88,7 @@ import { DnsZoneCreateBulkTemplate } from './schemas';
 import { DnsZoneCreateCommand } from './schemas';
 import { DnsZoneCreatePayloadData } from './schemas';
 import { DnsZoneCreateWorkerPayload } from './schemas';
+import { DnsZoneCreateWorkerResult } from './schemas';
 import { DnsZonePatchRecordsBulkCommand } from './schemas';
 import { DnsZonePatchRecordsBulkInstance } from './schemas';
 import { DnsZonePatchRecordsBulkPayload } from './schemas';
@@ -120,6 +122,7 @@ import { DomainCreateBulkTemplate } from './schemas';
 import { DomainCreateCommand } from './schemas';
 import { DomainCreatePayloadData } from './schemas';
 import { DomainCreateWorkerPayload } from './schemas';
+import { DomainCreateWorkerResult } from './schemas';
 import { DomainDnssecDataCreate } from './schemas';
 import { DomainDnssecData } from './schemas';
 import { DomainForward } from './schemas';
@@ -4266,6 +4269,82 @@ export const KEYS_CONTACT_CREATE_WORKER_PAYLOAD = [
   KEY_CONTACT_CREATE_WORKER_PAYLOAD_TYPE,
 ] as const satisfies (keyof ContactCreateWorkerPayload)[];
 
+/**
+ * Contact Id
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `contact_id` property of ContactCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = contactcreateworkerresult[KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID;
+ * const value = contactcreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_CONTACT_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID: keyof ContactCreateWorkerResult = 'contact_id';
+/**
+ * Type
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `type` property of ContactCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = contactcreateworkerresult[KEY_CONTACT_CREATE_WORKER_RESULT_TYPE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CONTACT_CREATE_WORKER_RESULT_TYPE;
+ * const value = contactcreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_CONTACT_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_CONTACT_CREATE_WORKER_RESULT_TYPE: keyof ContactCreateWorkerResult = 'type';
+
+/**
+ * Array of all ContactCreateWorkerResult property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for ContactCreateWorkerResult objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_CONTACT_CREATE_WORKER_RESULT) {
+ *   console.log(`Property: ${key}, Value: ${contactcreateworkerresult[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_CONTACT_CREATE_WORKER_RESULT.includes(someKey);
+ * ```
+ *
+ * @see {@link ContactCreateWorkerResult} - The TypeScript type definition
+ */
+export const KEYS_CONTACT_CREATE_WORKER_RESULT = [
+  KEY_CONTACT_CREATE_WORKER_RESULT_CONTACT_ID,
+  KEY_CONTACT_CREATE_WORKER_RESULT_TYPE,
+] as const satisfies (keyof ContactCreateWorkerResult)[];
+
 /**
  * Attributes
  *
@@ -9736,6 +9815,82 @@ export const KEYS_DNS_ZONE_CREATE_WORKER_PAYLOAD = [
   KEY_DNS_ZONE_CREATE_WORKER_PAYLOAD_ZONE,
 ] as const satisfies (keyof DnsZoneCreateWorkerPayload)[];
 
+/**
+ * Type
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `type` property of DnsZoneCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszonecreateworkerresult[KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE;
+ * const value = dnszonecreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE: keyof DnsZoneCreateWorkerResult = 'type';
+/**
+ * Zone Name
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `zone_name` property of DnsZoneCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszonecreateworkerresult[KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME;
+ * const value = dnszonecreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME: keyof DnsZoneCreateWorkerResult = 'zone_name';
+
+/**
+ * Array of all DnsZoneCreateWorkerResult property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DnsZoneCreateWorkerResult objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DNS_ZONE_CREATE_WORKER_RESULT) {
+ *   console.log(`Property: ${key}, Value: ${dnszonecreateworkerresult[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DNS_ZONE_CREATE_WORKER_RESULT.includes(someKey);
+ * ```
+ *
+ * @see {@link DnsZoneCreateWorkerResult} - The TypeScript type definition
+ */
+export const KEYS_DNS_ZONE_CREATE_WORKER_RESULT = [
+  KEY_DNS_ZONE_CREATE_WORKER_RESULT_TYPE,
+  KEY_DNS_ZONE_CREATE_WORKER_RESULT_ZONE_NAME,
+] as const satisfies (keyof DnsZoneCreateWorkerResult)[];
+
 /**
  * Command
  *
@@ -13351,6 +13506,82 @@ export const KEYS_DOMAIN_CREATE_WORKER_PAYLOAD = [
   KEY_DOMAIN_CREATE_WORKER_PAYLOAD_TYPE,
 ] as const satisfies (keyof DomainCreateWorkerPayload)[];
 
+/**
+ * Domain Id
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `domain_id` property of DomainCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaincreateworkerresult[KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID;
+ * const value = domaincreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID: keyof DomainCreateWorkerResult = 'domain_id';
+/**
+ * Type
+ *
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `type` property of DomainCreateWorkerResult objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domaincreateworkerresult[KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE;
+ * const value = domaincreateworkerresult[propertyName];
+ * ```
+ *
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_CREATE_WORKER_RESULT} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE: keyof DomainCreateWorkerResult = 'type';
+
+/**
+ * Array of all DomainCreateWorkerResult property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainCreateWorkerResult objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_CREATE_WORKER_RESULT) {
+ *   console.log(`Property: ${key}, Value: ${domaincreateworkerresult[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_CREATE_WORKER_RESULT.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainCreateWorkerResult} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_CREATE_WORKER_RESULT = [
+  KEY_DOMAIN_CREATE_WORKER_RESULT_DOMAIN_ID,
+  KEY_DOMAIN_CREATE_WORKER_RESULT_TYPE,
+] as const satisfies (keyof DomainCreateWorkerResult)[];
+
 /**
  * algorithm property
  *
@@ -26665,6 +26896,31 @@ export const KEY_JOB_PAYLOAD: keyof Job = 'payload';
  * @see {@link KEYS_JOB} - Array of all keys for this type
  */
 export const KEY_JOB_RESOURCE_KEY: keyof Job = 'resource_key';
+/**
+ * Result
+ *
+ * Structured result data from successful job execution (e.g. created entity IDs). Typed when the worker emits a known `type` discriminator; raw dict otherwise.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `result` property of Job objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = job[KEY_JOB_RESULT];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_JOB_RESULT;
+ * const value = job[propertyName];
+ * ```
+ *
+ * @see {@link Job} - The TypeScript type definition
+ * @see {@link KEYS_JOB} - Array of all keys for this type
+ */
+export const KEY_JOB_RESULT: keyof Job = 'result';
 /**
  * Started At
  *
@@ -26750,6 +27006,7 @@ export const KEYS_JOB = [
   KEY_JOB_PAUSED_AT,
   KEY_JOB_PAYLOAD,
   KEY_JOB_RESOURCE_KEY,
+  KEY_JOB_RESULT,
   KEY_JOB_STARTED_AT,
   KEY_JOB_STATUS,
 ] as const satisfies (keyof Job)[];

package/src/helpers/schemas.d.ts

@@ -570,6 +570,22 @@ export type ContactCreatePayloadData = components['schemas']['ContactCreatePaylo
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactCreateWorkerPayload = components['schemas']['ContactCreateWorkerPayload'];
+/**
+ * ContactCreateWorkerResult
+ *
+ * @remarks
+ * Type alias for the `ContactCreateWorkerResult` OpenAPI schema.
+ * This type represents contactcreateworkerresult data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactCreateWorkerResult();
+ * const item: ContactCreateWorkerResult = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactCreateWorkerResult = components['schemas']['ContactCreateWorkerResult'];
 /**
  * ContactHandle
  *
@@ -1258,6 +1274,22 @@ export type DnsZoneCreatePayloadData = components['schemas']['DnsZoneCreatePaylo
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DnsZoneCreateWorkerPayload = components['schemas']['DnsZoneCreateWorkerPayload'];
+/**
+ * DnsZoneCreateWorkerResult
+ *
+ * @remarks
+ * Type alias for the `DnsZoneCreateWorkerResult` OpenAPI schema.
+ * This type represents dnszonecreateworkerresult data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDnsZoneCreateWorkerResult();
+ * const item: DnsZoneCreateWorkerResult = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DnsZoneCreateWorkerResult = components['schemas']['DnsZoneCreateWorkerResult'];
 /**
  * DnsZonePatchRecordsBulkCommand
  *
@@ -1946,6 +1978,22 @@ export type DomainCreatePayloadData = components['schemas']['DomainCreatePayload
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainCreateWorkerPayload = components['schemas']['DomainCreateWorkerPayload'];
+/**
+ * DomainCreateWorkerResult
+ *
+ * @remarks
+ * Type alias for the `DomainCreateWorkerResult` OpenAPI schema.
+ * This type represents domaincreateworkerresult data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainCreateWorkerResult();
+ * const item: DomainCreateWorkerResult = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainCreateWorkerResult = components['schemas']['DomainCreateWorkerResult'];
 /**
  * DomainDnssecDataCreate
  *

package/src/openapi.yaml

@@ -1035,6 +1035,22 @@ components:
       - contact
       title: ContactCreateWorkerPayload
       type: object
+    ContactCreateWorkerResult:
+      properties:
+        contact_id:
+          title: Contact Id
+          type: string
+        type:
+          enum:
+          - contact_create
+          - contact_create_bulk
+          title: Type
+          type: string
+      required:
+      - type
+      - contact_id
+      title: ContactCreateWorkerResult
+      type: object
     ContactHandle:
       properties:
         attributes:
@@ -2301,6 +2317,22 @@ components:
       - zone
       title: DnsZoneCreateWorkerPayload
       type: object
+    DnsZoneCreateWorkerResult:
+      properties:
+        type:
+          enum:
+          - dns_zone_create
+          - dns_zone_create_bulk
+          title: Type
+          type: string
+        zone_name:
+          title: Zone Name
+          type: string
+      required:
+      - type
+      - zone_name
+      title: DnsZoneCreateWorkerResult
+      type: object
     DnsZonePatchRecordsBulkCommand:
       properties:
         command:
@@ -3168,6 +3200,22 @@ components:
       - domain
       title: DomainCreateWorkerPayload
       type: object
+    DomainCreateWorkerResult:
+      properties:
+        domain_id:
+          title: Domain Id
+          type: string
+        type:
+          enum:
+          - domain_create
+          - domain_create_bulk
+          title: Type
+          type: string
+      required:
+      - type
+      - domain_id
+      title: DomainCreateWorkerResult
+      type: object
     DomainDnssecDataCreate:
       properties:
         algorithm:
@@ -6406,6 +6454,28 @@ components:
           - type: 'null'
           description: Resource identifier for this job
           title: Resource Key
+        result:
+          anyOf:
+          - discriminator:
+              mapping:
+                contact_create: '#/components/schemas/ContactCreateWorkerResult'
+                contact_create_bulk: '#/components/schemas/ContactCreateWorkerResult'
+                dns_zone_create: '#/components/schemas/DnsZoneCreateWorkerResult'
+                dns_zone_create_bulk: '#/components/schemas/DnsZoneCreateWorkerResult'
+                domain_create: '#/components/schemas/DomainCreateWorkerResult'
+                domain_create_bulk: '#/components/schemas/DomainCreateWorkerResult'
+              propertyName: type
+            oneOf:
+            - $ref: '#/components/schemas/ContactCreateWorkerResult'
+            - $ref: '#/components/schemas/DomainCreateWorkerResult'
+            - $ref: '#/components/schemas/DnsZoneCreateWorkerResult'
+          - additionalProperties: true
+            type: object
+          - type: 'null'
+          description: Structured result data from successful job execution (e.g.
+            created entity IDs). Typed when the worker emits a known `type` discriminator;
+            raw dict otherwise.
+          title: Result
         started_at:
           anyOf:
           - format: date-time
@@ -10690,7 +10760,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-05-05-201917
+  version: 2026-05-05-223247
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -3115,6 +3115,16 @@ export interface components {
              */
             type: "contact_create" | "contact_create_bulk";
         };
+        /** ContactCreateWorkerResult */
+        ContactCreateWorkerResult: {
+            /** Contact Id */
+            contact_id: string;
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "contact_create" | "contact_create_bulk";
+        };
         /** ContactHandle */
         ContactHandle: {
             /**
@@ -3987,6 +3997,16 @@ export interface components {
             type: "dns_zone_create" | "dns_zone_create_bulk";
             zone: components["schemas"]["DnsZoneCreatePayloadData"];
         };
+        /** DnsZoneCreateWorkerResult */
+        DnsZoneCreateWorkerResult: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "dns_zone_create" | "dns_zone_create_bulk";
+            /** Zone Name */
+            zone_name: string;
+        };
         /** DnsZonePatchRecordsBulkCommand */
         DnsZonePatchRecordsBulkCommand: {
             /**
@@ -4548,6 +4568,16 @@ export interface components {
              */
             type: "domain_create" | "domain_create_bulk";
         };
+        /** DomainCreateWorkerResult */
+        DomainCreateWorkerResult: {
+            /** Domain Id */
+            domain_id: string;
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "domain_create" | "domain_create_bulk";
+        };
         /** DomainDnssecDataCreate */
         DomainDnssecDataCreate: {
             /** @description DNSSEC algorithm used */
@@ -6730,6 +6760,13 @@ export interface components {
              * @description Resource identifier for this job
              */
             resource_key?: string | null;
+            /**
+             * Result
+             * @description Structured result data from successful job execution (e.g. created entity IDs). Typed when the worker emits a known `type` discriminator; raw dict otherwise.
+             */
+            result?: (components["schemas"]["ContactCreateWorkerResult"] | components["schemas"]["DomainCreateWorkerResult"] | components["schemas"]["DnsZoneCreateWorkerResult"]) | {
+                [key: string]: unknown;
+            } | null;
             /**
              * Started At
              * @description Timestamp when job execution began (UTC)