@opusdns/api 0.277.0 → 0.278.0

package/package.json

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

package/src/helpers/keys.ts

@@ -172,6 +172,7 @@ import { DomainUpdateWorkerPayload } from './schemas';
 import { DomainWithdrawRequest } from './schemas';
 import { DomainWithdraw } from './schemas';
 import { DomainsExpiringSoon } from './schemas';
+import { DuplicateCommand } from './schemas';
 import { EmailForwardAlias } from './schemas';
 import { EmailForwardAliasCreate } from './schemas';
 import { EmailForwardAliasMetrics } from './schemas';
@@ -6378,6 +6379,32 @@ export const KEYS_CONTACTS_BASE = [
  * @see {@link KEYS_CREATE_JOB_BATCH} - Array of all keys for this type
  */
 export const KEY_CREATE_JOB_BATCH_BATCH_ID: keyof CreateJobBatch = 'batch_id';
+/**
+ * Duplicates
+ *
+ * Per-command details for duplicates, including pointers to the existing jobs/batches
+ *
+ * @type {array}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `duplicates` property of CreateJobBatch objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = createjobbatch[KEY_CREATE_JOB_BATCH_DUPLICATES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CREATE_JOB_BATCH_DUPLICATES;
+ * const value = createjobbatch[propertyName];
+ * ```
+ *
+ * @see {@link CreateJobBatch} - The TypeScript type definition
+ * @see {@link KEYS_CREATE_JOB_BATCH} - Array of all keys for this type
+ */
+export const KEY_CREATE_JOB_BATCH_DUPLICATES: keyof CreateJobBatch = 'duplicates';
 /**
  * Errors
  *
@@ -6430,6 +6457,32 @@ export const KEY_CREATE_JOB_BATCH_ERRORS: keyof CreateJobBatch = 'errors';
  * @see {@link KEYS_CREATE_JOB_BATCH} - Array of all keys for this type
  */
 export const KEY_CREATE_JOB_BATCH_JOBS_CREATED: keyof CreateJobBatch = 'jobs_created';
+/**
+ * Jobs Duplicated
+ *
+ * Number of commands skipped because their idempotency_key matched a previously-submitted job
+ *
+ * @type {integer}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `jobs_duplicated` property of CreateJobBatch objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = createjobbatch[KEY_CREATE_JOB_BATCH_JOBS_DUPLICATED];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_CREATE_JOB_BATCH_JOBS_DUPLICATED;
+ * const value = createjobbatch[propertyName];
+ * ```
+ *
+ * @see {@link CreateJobBatch} - The TypeScript type definition
+ * @see {@link KEYS_CREATE_JOB_BATCH} - Array of all keys for this type
+ */
+export const KEY_CREATE_JOB_BATCH_JOBS_DUPLICATED: keyof CreateJobBatch = 'jobs_duplicated';
 /**
  * Jobs Failed
  *
@@ -6459,7 +6512,7 @@ export const KEY_CREATE_JOB_BATCH_JOBS_FAILED: keyof CreateJobBatch = 'jobs_fail
 /**
  * Status Url
  *
- * URL to check batch status
+ * URL to check batch status. May 404 if jobs_created is 0 — see duplicates[].existing_batch_id for prior batches.
  *
  * @type {string}
  *
@@ -6531,8 +6584,10 @@ export const KEY_CREATE_JOB_BATCH_TOTAL_COMMANDS: keyof CreateJobBatch = 'total_
  */
 export const KEYS_CREATE_JOB_BATCH = [
   KEY_CREATE_JOB_BATCH_BATCH_ID,
+  KEY_CREATE_JOB_BATCH_DUPLICATES,
   KEY_CREATE_JOB_BATCH_ERRORS,
   KEY_CREATE_JOB_BATCH_JOBS_CREATED,
+  KEY_CREATE_JOB_BATCH_JOBS_DUPLICATED,
   KEY_CREATE_JOB_BATCH_JOBS_FAILED,
   KEY_CREATE_JOB_BATCH_STATUS_URL,
   KEY_CREATE_JOB_BATCH_TOTAL_COMMANDS,
@@ -19905,6 +19960,162 @@ export const KEYS_DOMAINS_EXPIRING_SOON = [
   KEY_DOMAINS_EXPIRING_SOON_NEXT_90_DAYS,
 ] as const satisfies (keyof DomainsExpiringSoon)[];
 
+/**
+ * Existing Batch Id
+ *
+ * batch_id of the batch the existing job belongs to. Use this with /v1/jobs/{batch_id} to check status — the batch_id returned at the top level of this response will 404 if no new jobs were created.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `existing_batch_id` property of DuplicateCommand objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = duplicatecommand[KEY_DUPLICATE_COMMAND_EXISTING_BATCH_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DUPLICATE_COMMAND_EXISTING_BATCH_ID;
+ * const value = duplicatecommand[propertyName];
+ * ```
+ *
+ * @see {@link DuplicateCommand} - The TypeScript type definition
+ * @see {@link KEYS_DUPLICATE_COMMAND} - Array of all keys for this type
+ */
+export const KEY_DUPLICATE_COMMAND_EXISTING_BATCH_ID: keyof DuplicateCommand = 'existing_batch_id';
+/**
+ * Existing Job Id
+ *
+ * ID of the previously-created job whose idempotency_key matched this command
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `existing_job_id` property of DuplicateCommand objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = duplicatecommand[KEY_DUPLICATE_COMMAND_EXISTING_JOB_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DUPLICATE_COMMAND_EXISTING_JOB_ID;
+ * const value = duplicatecommand[propertyName];
+ * ```
+ *
+ * @see {@link DuplicateCommand} - The TypeScript type definition
+ * @see {@link KEYS_DUPLICATE_COMMAND} - Array of all keys for this type
+ */
+export const KEY_DUPLICATE_COMMAND_EXISTING_JOB_ID: keyof DuplicateCommand = 'existing_job_id';
+/**
+ * Index
+ *
+ * Index of the duplicate command in the request
+ *
+ * @type {integer}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `index` property of DuplicateCommand objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = duplicatecommand[KEY_DUPLICATE_COMMAND_INDEX];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DUPLICATE_COMMAND_INDEX;
+ * const value = duplicatecommand[propertyName];
+ * ```
+ *
+ * @see {@link DuplicateCommand} - The TypeScript type definition
+ * @see {@link KEYS_DUPLICATE_COMMAND} - Array of all keys for this type
+ */
+export const KEY_DUPLICATE_COMMAND_INDEX: keyof DuplicateCommand = 'index';
+/**
+ * Instance Index
+ *
+ * Index within a bulk command's instances[] for per-instance duplicates
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `instance_index` property of DuplicateCommand objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = duplicatecommand[KEY_DUPLICATE_COMMAND_INSTANCE_INDEX];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DUPLICATE_COMMAND_INSTANCE_INDEX;
+ * const value = duplicatecommand[propertyName];
+ * ```
+ *
+ * @see {@link DuplicateCommand} - The TypeScript type definition
+ * @see {@link KEYS_DUPLICATE_COMMAND} - Array of all keys for this type
+ */
+export const KEY_DUPLICATE_COMMAND_INSTANCE_INDEX: keyof DuplicateCommand = 'instance_index';
+/**
+ * Resource Key
+ *
+ * Resource identifier (zone name, domain name, contact email) for this duplicate
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `resource_key` property of DuplicateCommand objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = duplicatecommand[KEY_DUPLICATE_COMMAND_RESOURCE_KEY];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DUPLICATE_COMMAND_RESOURCE_KEY;
+ * const value = duplicatecommand[propertyName];
+ * ```
+ *
+ * @see {@link DuplicateCommand} - The TypeScript type definition
+ * @see {@link KEYS_DUPLICATE_COMMAND} - Array of all keys for this type
+ */
+export const KEY_DUPLICATE_COMMAND_RESOURCE_KEY: keyof DuplicateCommand = 'resource_key';
+
+/**
+ * Array of all DuplicateCommand property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DuplicateCommand objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DUPLICATE_COMMAND) {
+ *   console.log(`Property: ${key}, Value: ${duplicatecommand[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DUPLICATE_COMMAND.includes(someKey);
+ * ```
+ *
+ * @see {@link DuplicateCommand} - The TypeScript type definition
+ */
+export const KEYS_DUPLICATE_COMMAND = [
+  KEY_DUPLICATE_COMMAND_EXISTING_BATCH_ID,
+  KEY_DUPLICATE_COMMAND_EXISTING_JOB_ID,
+  KEY_DUPLICATE_COMMAND_INDEX,
+  KEY_DUPLICATE_COMMAND_INSTANCE_INDEX,
+  KEY_DUPLICATE_COMMAND_RESOURCE_KEY,
+] as const satisfies (keyof DuplicateCommand)[];
+
 /**
  * Alias
  *

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DuplicateCommand, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * ContactIncludeField
@@ -317,6 +317,20 @@ export type PostalAddressTypeArray = PostalAddressType[];
  * @see {@link ContactConfigBase} - The individual ContactConfigBase type definition
  */
 export type ContactConfigBaseArray = ContactConfigBase[];
+/**
+ * DuplicateCommand
+ *
+ * @remarks
+ * Array type for DuplicateCommand objects. Used when the API returns a collection of DuplicateCommand instances.
+ *
+ * @example
+ * ```typescript
+ * const items: DuplicateCommandArray = await api.getDuplicateCommands();
+ * ```
+ *
+ * @see {@link DuplicateCommand} - The individual DuplicateCommand type definition
+ */
+export type DuplicateCommandArray = DuplicateCommand[];
 /**
  * CommandError
  *

package/src/helpers/schemas.d.ts

@@ -2858,6 +2858,22 @@ export type DomainWithdraw = components['schemas']['DomainWithdrawResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainsExpiringSoon = components['schemas']['DomainsExpiringSoon'];
+/**
+ * DuplicateCommand
+ *
+ * @remarks
+ * Type alias for the `DuplicateCommand` OpenAPI schema.
+ * This type represents duplicatecommand data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDuplicateCommand();
+ * const item: DuplicateCommand = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DuplicateCommand = components['schemas']['DuplicateCommand'];
 /**
  * EmailForwardAlias
  *

package/src/openapi.yaml

@@ -1596,6 +1596,13 @@ components:
           title: Batch Id
           type: string
           x-typeid-prefix: batch
+        duplicates:
+          description: Per-command details for duplicates, including pointers to the
+            existing jobs/batches
+          items:
+            $ref: '#/components/schemas/DuplicateCommand'
+          title: Duplicates
+          type: array
         errors:
           description: Details of failed commands
           items:
@@ -1606,12 +1613,19 @@ components:
           description: Number of jobs successfully created
           title: Jobs Created
           type: integer
+        jobs_duplicated:
+          default: 0
+          description: Number of commands skipped because their idempotency_key matched
+            a previously-submitted job
+          title: Jobs Duplicated
+          type: integer
         jobs_failed:
           description: Number of jobs that failed to create
           title: Jobs Failed
           type: integer
         status_url:
-          description: URL to check batch status
+          description: "URL to check batch status. May 404 if jobs_created is 0 \u2014\
+            \ see duplicates[].existing_batch_id for prior batches."
           title: Status Url
           type: string
         total_commands:
@@ -4720,6 +4734,54 @@ components:
       - next_90_days
       title: DomainsExpiringSoon
       type: object
+    DuplicateCommand:
+      properties:
+        existing_batch_id:
+          anyOf:
+          - examples:
+            - batch_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: batch
+          - type: 'null'
+          description: "batch_id of the batch the existing job belongs to. Use this\
+            \ with /v1/jobs/{batch_id} to check status \u2014 the batch_id returned\
+            \ at the top level of this response will 404 if no new jobs were created."
+          title: Existing Batch Id
+        existing_job_id:
+          description: ID of the previously-created job whose idempotency_key matched
+            this command
+          examples:
+          - job_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^job_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Existing Job Id
+          type: string
+          x-typeid-prefix: job
+        index:
+          description: Index of the duplicate command in the request
+          title: Index
+          type: integer
+        instance_index:
+          anyOf:
+          - type: integer
+          - type: 'null'
+          description: Index within a bulk command's instances[] for per-instance
+            duplicates
+          title: Instance Index
+        resource_key:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Resource identifier (zone name, domain name, contact email)
+            for this duplicate
+          title: Resource Key
+      required:
+      - index
+      - existing_job_id
+      title: DuplicateCommand
+      type: object
     EmailForwardAlias:
       properties:
         alias:
@@ -10212,7 +10274,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-04-29-122519
+  version: 2026-04-30-022644
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -3385,6 +3385,11 @@ export interface components {
              * @example batch_01h45ytscbebyvny4gc8cr8ma2
              */
             batch_id: TypeId<"batch">;
+            /**
+             * Duplicates
+             * @description Per-command details for duplicates, including pointers to the existing jobs/batches
+             */
+            duplicates?: components["schemas"]["DuplicateCommand"][];
             /**
              * Errors
              * @description Details of failed commands
@@ -3395,6 +3400,12 @@ export interface components {
              * @description Number of jobs successfully created
              */
             jobs_created: number;
+            /**
+             * Jobs Duplicated
+             * @description Number of commands skipped because their idempotency_key matched a previously-submitted job
+             * @default 0
+             */
+            jobs_duplicated: number;
             /**
              * Jobs Failed
              * @description Number of jobs that failed to create
@@ -3402,7 +3413,7 @@ export interface components {
             jobs_failed: number;
             /**
              * Status Url
-             * @description URL to check batch status
+             * @description URL to check batch status. May 404 if jobs_created is 0 — see duplicates[].existing_batch_id for prior batches.
              */
             status_url: string;
             /**
@@ -5405,6 +5416,36 @@ export interface components {
              */
             next_90_days: number;
         };
+        /** DuplicateCommand */
+        DuplicateCommand: {
+            /**
+             * Existing Batch Id
+             * @description batch_id of the batch the existing job belongs to. Use this with /v1/jobs/{batch_id} to check status — the batch_id returned at the top level of this response will 404 if no new jobs were created.
+             */
+            existing_batch_id?: TypeId<"batch"> | null;
+            /**
+             * Existing Job Id
+             * Format: typeid
+             * @description ID of the previously-created job whose idempotency_key matched this command
+             * @example job_01h45ytscbebyvny4gc8cr8ma2
+             */
+            existing_job_id: TypeId<"job">;
+            /**
+             * Index
+             * @description Index of the duplicate command in the request
+             */
+            index: number;
+            /**
+             * Instance Index
+             * @description Index within a bulk command's instances[] for per-instance duplicates
+             */
+            instance_index?: number | null;
+            /**
+             * Resource Key
+             * @description Resource identifier (zone name, domain name, contact email) for this duplicate
+             */
+            resource_key?: string | null;
+        };
         /** EmailForwardAlias */
         EmailForwardAlias: {
             /** Alias */