@opusdns/api 0.311.0 → 0.313.0

package/package.json

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

package/src/helpers/keys.ts

@@ -9940,6 +9940,31 @@ export const KEY_DNS_ZONE_CREATE_NAME: keyof DnsZoneCreate = 'name';
  * @see {@link KEYS_DNS_ZONE_CREATE} - Array of all keys for this type
  */
 export const KEY_DNS_ZONE_CREATE_RRSETS: keyof DnsZoneCreate = 'rrsets';
+/**
+ * Vanity Nameserver Set Id
+ *
+ * Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `vanity_nameserver_set_id` property of DnsZoneCreate objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszonecreate[KEY_DNS_ZONE_CREATE_VANITY_NAMESERVER_SET_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_CREATE_VANITY_NAMESERVER_SET_ID;
+ * const value = dnszonecreate[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneCreate} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_CREATE} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_CREATE_VANITY_NAMESERVER_SET_ID: keyof DnsZoneCreate = 'vanity_nameserver_set_id';
 
 /**
  * Array of all DnsZoneCreate property keys
@@ -9965,6 +9990,7 @@ export const KEYS_DNS_ZONE_CREATE = [
   KEY_DNS_ZONE_CREATE_DNSSEC_STATUS,
   KEY_DNS_ZONE_CREATE_NAME,
   KEY_DNS_ZONE_CREATE_RRSETS,
+  KEY_DNS_ZONE_CREATE_VANITY_NAMESERVER_SET_ID,
 ] as const satisfies (keyof DnsZoneCreate)[];
 
 /**
@@ -10556,6 +10582,31 @@ export const KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_NAME: keyof DnsZoneCreatePayloadDa
  * @see {@link KEYS_DNS_ZONE_CREATE_PAYLOAD_DATA} - Array of all keys for this type
  */
 export const KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_RRSETS: keyof DnsZoneCreatePayloadData = 'rrsets';
+/**
+ * Vanity Nameserver Set Id
+ *
+ * Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `vanity_nameserver_set_id` property of DnsZoneCreatePayloadData objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszonecreatepayloaddata[KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID;
+ * const value = dnszonecreatepayloaddata[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneCreatePayloadData} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_CREATE_PAYLOAD_DATA} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID: keyof DnsZoneCreatePayloadData = 'vanity_nameserver_set_id';
 
 /**
  * Array of all DnsZoneCreatePayloadData property keys
@@ -10581,6 +10632,7 @@ export const KEYS_DNS_ZONE_CREATE_PAYLOAD_DATA = [
   KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_DNSSEC_STATUS,
   KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_NAME,
   KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_RRSETS,
+  KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID,
 ] as const satisfies (keyof DnsZoneCreatePayloadData)[];
 
 /**
@@ -12523,6 +12575,31 @@ export const KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_NAME: keyof DnsZoneUpdatePayloadDa
  * @see {@link KEYS_DNS_ZONE_UPDATE_PAYLOAD_DATA} - Array of all keys for this type
  */
 export const KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_RRSETS: keyof DnsZoneUpdatePayloadData = 'rrsets';
+/**
+ * Vanity Nameserver Set Id
+ *
+ * Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `vanity_nameserver_set_id` property of DnsZoneUpdatePayloadData objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnszoneupdatepayloaddata[KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID;
+ * const value = dnszoneupdatepayloaddata[propertyName];
+ * ```
+ *
+ * @see {@link DnsZoneUpdatePayloadData} - The TypeScript type definition
+ * @see {@link KEYS_DNS_ZONE_UPDATE_PAYLOAD_DATA} - Array of all keys for this type
+ */
+export const KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID: keyof DnsZoneUpdatePayloadData = 'vanity_nameserver_set_id';
 
 /**
  * Array of all DnsZoneUpdatePayloadData property keys
@@ -12548,6 +12625,7 @@ export const KEYS_DNS_ZONE_UPDATE_PAYLOAD_DATA = [
   KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_DNSSEC_STATUS,
   KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_NAME,
   KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_RRSETS,
+  KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID,
 ] as const satisfies (keyof DnsZoneUpdatePayloadData)[];
 
 /**
@@ -27390,6 +27468,31 @@ export const KEY_JOB_BATCH_STATUS_DEAD_LETTER: keyof JobBatchStatus = 'dead_lett
  * @see {@link KEYS_JOB_BATCH_STATUS} - Array of all keys for this type
  */
 export const KEY_JOB_BATCH_STATUS_FAILED: keyof JobBatchStatus = 'failed';
+/**
+ * Label
+ *
+ * Human-readable label for this batch
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `label` property of JobBatchStatus objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = jobbatchstatus[KEY_JOB_BATCH_STATUS_LABEL];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_JOB_BATCH_STATUS_LABEL;
+ * const value = jobbatchstatus[propertyName];
+ * ```
+ *
+ * @see {@link JobBatchStatus} - The TypeScript type definition
+ * @see {@link KEYS_JOB_BATCH_STATUS} - Array of all keys for this type
+ */
+export const KEY_JOB_BATCH_STATUS_LABEL: keyof JobBatchStatus = 'label';
 /**
  * Paused
  *
@@ -27573,6 +27676,7 @@ export const KEYS_JOB_BATCH_STATUS = [
   KEY_JOB_BATCH_STATUS_CANCELED,
   KEY_JOB_BATCH_STATUS_DEAD_LETTER,
   KEY_JOB_BATCH_STATUS_FAILED,
+  KEY_JOB_BATCH_STATUS_LABEL,
   KEY_JOB_BATCH_STATUS_PAUSED,
   KEY_JOB_BATCH_STATUS_PROGRESS_PERCENTAGE,
   KEY_JOB_BATCH_STATUS_QUEUED,

package/src/openapi.yaml

@@ -2445,6 +2445,19 @@ components:
             $ref: '#/components/schemas/DnsRrsetCreate'
           title: Rrsets
           type: array
+        vanity_nameserver_set_id:
+          anyOf:
+          - examples:
+            - vns_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: vns
+          - type: 'null'
+          description: Optional vanity NS set to brand this zone's apex NS + SOA with.
+            When omitted, the org's default ACTIVE set (if any) is used; when no default
+            exists the system default NS is used.
+          title: Vanity Nameserver Set Id
       required:
       - name
       title: DnsZoneCreate
@@ -2567,6 +2580,19 @@ components:
             $ref: '#/components/schemas/DnsRrsetCreate'
           title: Rrsets
           type: array
+        vanity_nameserver_set_id:
+          anyOf:
+          - examples:
+            - vns_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: vns
+          - type: 'null'
+          description: Optional vanity NS set to brand this zone's apex NS + SOA with.
+            When omitted, the org's default ACTIVE set (if any) is used; when no default
+            exists the system default NS is used.
+          title: Vanity Nameserver Set Id
       required:
       - name
       title: DnsZoneCreatePayloadData
@@ -2975,6 +3001,19 @@ components:
             $ref: '#/components/schemas/DnsRrsetCreate'
           title: Rrsets
           type: array
+        vanity_nameserver_set_id:
+          anyOf:
+          - examples:
+            - vns_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: vns
+          - type: 'null'
+          description: Optional vanity NS set to brand this zone's apex NS + SOA with.
+            When omitted, the org's default ACTIVE set (if any) is used; when no default
+            exists the system default NS is used.
+          title: Vanity Nameserver Set Id
       required:
       - name
       title: DnsZoneUpdatePayloadData
@@ -6618,6 +6657,12 @@ components:
           description: Number of jobs that failed execution
           title: Failed
           type: integer
+        label:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Human-readable label for this batch
+          title: Label
         paused:
           default: 0
           description: Number of jobs in paused state
@@ -11534,7 +11579,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-05-21-052241
+  version: 2026-05-26-190947
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -22166,6 +22211,7 @@ paths:
                     canceled: 0
                     dead_letter: 0
                     failed: 2
+                    label: Bulk RRset Patch
                     progress_percentage: 100.0
                     queued: 0
                     running: 0
@@ -22180,6 +22226,7 @@ paths:
                     canceled: 0
                     dead_letter: 0
                     failed: 0
+                    label: Bulk Domain Registration
                     progress_percentage: 50.0
                     queued: 3
                     running: 2

package/src/schema.d.ts

@@ -4126,6 +4126,11 @@ export interface components {
             name: string;
             /** Rrsets */
             rrsets?: components["schemas"]["DnsRrsetCreate"][];
+            /**
+             * Vanity Nameserver Set Id
+             * @description Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used.
+             */
+            vanity_nameserver_set_id?: TypeId<"vns"> | null;
         };
         /** DnsZoneCreateBulkCommand */
         DnsZoneCreateBulkCommand: {
@@ -4215,6 +4220,11 @@ export interface components {
             name: string;
             /** Rrsets */
             rrsets?: components["schemas"]["DnsRrsetCreate"][];
+            /**
+             * Vanity Nameserver Set Id
+             * @description Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used.
+             */
+            vanity_nameserver_set_id?: TypeId<"vns"> | null;
         };
         /** DnsZoneCreateWorkerPayload */
         DnsZoneCreateWorkerPayload: {
@@ -4479,6 +4489,11 @@ export interface components {
             name: string;
             /** Rrsets */
             rrsets?: components["schemas"]["DnsRrsetCreate"][];
+            /**
+             * Vanity Nameserver Set Id
+             * @description Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used.
+             */
+            vanity_nameserver_set_id?: TypeId<"vns"> | null;
         };
         /** DnsZoneUpdateWorkerPayload */
         DnsZoneUpdateWorkerPayload: {
@@ -6868,6 +6883,11 @@ export interface components {
              * @description Number of jobs that failed execution
              */
             failed: number;
+            /**
+             * Label
+             * @description Human-readable label for this batch
+             */
+            label?: string | null;
             /**
              * Paused
              * @description Number of jobs in paused state