@opusdns/api 0.312.0 → 0.313.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.312.0",
6
+ "version": "0.313.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -9940,6 +9940,31 @@ export const KEY_DNS_ZONE_CREATE_NAME: keyof DnsZoneCreate = 'name';
9940
9940
  * @see {@link KEYS_DNS_ZONE_CREATE} - Array of all keys for this type
9941
9941
  */
9942
9942
  export const KEY_DNS_ZONE_CREATE_RRSETS: keyof DnsZoneCreate = 'rrsets';
9943
+ /**
9944
+ * Vanity Nameserver Set Id
9945
+ *
9946
+ * 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.
9947
+ *
9948
+ *
9949
+ *
9950
+ * @remarks
9951
+ * This key constant provides type-safe access to the `vanity_nameserver_set_id` property of DnsZoneCreate objects.
9952
+ * Use this constant when you need to access properties dynamically or ensure type safety.
9953
+ *
9954
+ * @example
9955
+ * ```typescript
9956
+ * // Direct property access
9957
+ * const value = dnszonecreate[KEY_DNS_ZONE_CREATE_VANITY_NAMESERVER_SET_ID];
9958
+ *
9959
+ * // Dynamic property access
9960
+ * const propertyName = KEY_DNS_ZONE_CREATE_VANITY_NAMESERVER_SET_ID;
9961
+ * const value = dnszonecreate[propertyName];
9962
+ * ```
9963
+ *
9964
+ * @see {@link DnsZoneCreate} - The TypeScript type definition
9965
+ * @see {@link KEYS_DNS_ZONE_CREATE} - Array of all keys for this type
9966
+ */
9967
+ export const KEY_DNS_ZONE_CREATE_VANITY_NAMESERVER_SET_ID: keyof DnsZoneCreate = 'vanity_nameserver_set_id';
9943
9968
 
9944
9969
  /**
9945
9970
  * Array of all DnsZoneCreate property keys
@@ -9965,6 +9990,7 @@ export const KEYS_DNS_ZONE_CREATE = [
9965
9990
  KEY_DNS_ZONE_CREATE_DNSSEC_STATUS,
9966
9991
  KEY_DNS_ZONE_CREATE_NAME,
9967
9992
  KEY_DNS_ZONE_CREATE_RRSETS,
9993
+ KEY_DNS_ZONE_CREATE_VANITY_NAMESERVER_SET_ID,
9968
9994
  ] as const satisfies (keyof DnsZoneCreate)[];
9969
9995
 
9970
9996
  /**
@@ -10556,6 +10582,31 @@ export const KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_NAME: keyof DnsZoneCreatePayloadDa
10556
10582
  * @see {@link KEYS_DNS_ZONE_CREATE_PAYLOAD_DATA} - Array of all keys for this type
10557
10583
  */
10558
10584
  export const KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_RRSETS: keyof DnsZoneCreatePayloadData = 'rrsets';
10585
+ /**
10586
+ * Vanity Nameserver Set Id
10587
+ *
10588
+ * 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.
10589
+ *
10590
+ *
10591
+ *
10592
+ * @remarks
10593
+ * This key constant provides type-safe access to the `vanity_nameserver_set_id` property of DnsZoneCreatePayloadData objects.
10594
+ * Use this constant when you need to access properties dynamically or ensure type safety.
10595
+ *
10596
+ * @example
10597
+ * ```typescript
10598
+ * // Direct property access
10599
+ * const value = dnszonecreatepayloaddata[KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID];
10600
+ *
10601
+ * // Dynamic property access
10602
+ * const propertyName = KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID;
10603
+ * const value = dnszonecreatepayloaddata[propertyName];
10604
+ * ```
10605
+ *
10606
+ * @see {@link DnsZoneCreatePayloadData} - The TypeScript type definition
10607
+ * @see {@link KEYS_DNS_ZONE_CREATE_PAYLOAD_DATA} - Array of all keys for this type
10608
+ */
10609
+ export const KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID: keyof DnsZoneCreatePayloadData = 'vanity_nameserver_set_id';
10559
10610
 
10560
10611
  /**
10561
10612
  * Array of all DnsZoneCreatePayloadData property keys
@@ -10581,6 +10632,7 @@ export const KEYS_DNS_ZONE_CREATE_PAYLOAD_DATA = [
10581
10632
  KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_DNSSEC_STATUS,
10582
10633
  KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_NAME,
10583
10634
  KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_RRSETS,
10635
+ KEY_DNS_ZONE_CREATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID,
10584
10636
  ] as const satisfies (keyof DnsZoneCreatePayloadData)[];
10585
10637
 
10586
10638
  /**
@@ -12523,6 +12575,31 @@ export const KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_NAME: keyof DnsZoneUpdatePayloadDa
12523
12575
  * @see {@link KEYS_DNS_ZONE_UPDATE_PAYLOAD_DATA} - Array of all keys for this type
12524
12576
  */
12525
12577
  export const KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_RRSETS: keyof DnsZoneUpdatePayloadData = 'rrsets';
12578
+ /**
12579
+ * Vanity Nameserver Set Id
12580
+ *
12581
+ * 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.
12582
+ *
12583
+ *
12584
+ *
12585
+ * @remarks
12586
+ * This key constant provides type-safe access to the `vanity_nameserver_set_id` property of DnsZoneUpdatePayloadData objects.
12587
+ * Use this constant when you need to access properties dynamically or ensure type safety.
12588
+ *
12589
+ * @example
12590
+ * ```typescript
12591
+ * // Direct property access
12592
+ * const value = dnszoneupdatepayloaddata[KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID];
12593
+ *
12594
+ * // Dynamic property access
12595
+ * const propertyName = KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID;
12596
+ * const value = dnszoneupdatepayloaddata[propertyName];
12597
+ * ```
12598
+ *
12599
+ * @see {@link DnsZoneUpdatePayloadData} - The TypeScript type definition
12600
+ * @see {@link KEYS_DNS_ZONE_UPDATE_PAYLOAD_DATA} - Array of all keys for this type
12601
+ */
12602
+ export const KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID: keyof DnsZoneUpdatePayloadData = 'vanity_nameserver_set_id';
12526
12603
 
12527
12604
  /**
12528
12605
  * Array of all DnsZoneUpdatePayloadData property keys
@@ -12548,6 +12625,7 @@ export const KEYS_DNS_ZONE_UPDATE_PAYLOAD_DATA = [
12548
12625
  KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_DNSSEC_STATUS,
12549
12626
  KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_NAME,
12550
12627
  KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_RRSETS,
12628
+ KEY_DNS_ZONE_UPDATE_PAYLOAD_DATA_VANITY_NAMESERVER_SET_ID,
12551
12629
  ] as const satisfies (keyof DnsZoneUpdatePayloadData)[];
12552
12630
 
12553
12631
  /**
package/src/openapi.yaml CHANGED
@@ -2445,6 +2445,19 @@ components:
2445
2445
  $ref: '#/components/schemas/DnsRrsetCreate'
2446
2446
  title: Rrsets
2447
2447
  type: array
2448
+ vanity_nameserver_set_id:
2449
+ anyOf:
2450
+ - examples:
2451
+ - vns_01h45ytscbebyvny4gc8cr8ma2
2452
+ format: typeid
2453
+ pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
2454
+ type: string
2455
+ x-typeid-prefix: vns
2456
+ - type: 'null'
2457
+ description: Optional vanity NS set to brand this zone's apex NS + SOA with.
2458
+ When omitted, the org's default ACTIVE set (if any) is used; when no default
2459
+ exists the system default NS is used.
2460
+ title: Vanity Nameserver Set Id
2448
2461
  required:
2449
2462
  - name
2450
2463
  title: DnsZoneCreate
@@ -2567,6 +2580,19 @@ components:
2567
2580
  $ref: '#/components/schemas/DnsRrsetCreate'
2568
2581
  title: Rrsets
2569
2582
  type: array
2583
+ vanity_nameserver_set_id:
2584
+ anyOf:
2585
+ - examples:
2586
+ - vns_01h45ytscbebyvny4gc8cr8ma2
2587
+ format: typeid
2588
+ pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
2589
+ type: string
2590
+ x-typeid-prefix: vns
2591
+ - type: 'null'
2592
+ description: Optional vanity NS set to brand this zone's apex NS + SOA with.
2593
+ When omitted, the org's default ACTIVE set (if any) is used; when no default
2594
+ exists the system default NS is used.
2595
+ title: Vanity Nameserver Set Id
2570
2596
  required:
2571
2597
  - name
2572
2598
  title: DnsZoneCreatePayloadData
@@ -2975,6 +3001,19 @@ components:
2975
3001
  $ref: '#/components/schemas/DnsRrsetCreate'
2976
3002
  title: Rrsets
2977
3003
  type: array
3004
+ vanity_nameserver_set_id:
3005
+ anyOf:
3006
+ - examples:
3007
+ - vns_01h45ytscbebyvny4gc8cr8ma2
3008
+ format: typeid
3009
+ pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
3010
+ type: string
3011
+ x-typeid-prefix: vns
3012
+ - type: 'null'
3013
+ description: Optional vanity NS set to brand this zone's apex NS + SOA with.
3014
+ When omitted, the org's default ACTIVE set (if any) is used; when no default
3015
+ exists the system default NS is used.
3016
+ title: Vanity Nameserver Set Id
2978
3017
  required:
2979
3018
  - name
2980
3019
  title: DnsZoneUpdatePayloadData
@@ -11540,7 +11579,7 @@ info:
11540
11579
  \n\n"
11541
11580
  summary: OpusDNS - your gateway to a seamless domain management experience.
11542
11581
  title: OpusDNS API
11543
- version: 2026-05-21-193646
11582
+ version: 2026-05-26-190947
11544
11583
  x-logo:
11545
11584
  altText: OpusDNS API Reference
11546
11585
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
package/src/schema.d.ts CHANGED
@@ -4126,6 +4126,11 @@ export interface components {
4126
4126
  name: string;
4127
4127
  /** Rrsets */
4128
4128
  rrsets?: components["schemas"]["DnsRrsetCreate"][];
4129
+ /**
4130
+ * Vanity Nameserver Set Id
4131
+ * @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.
4132
+ */
4133
+ vanity_nameserver_set_id?: TypeId<"vns"> | null;
4129
4134
  };
4130
4135
  /** DnsZoneCreateBulkCommand */
4131
4136
  DnsZoneCreateBulkCommand: {
@@ -4215,6 +4220,11 @@ export interface components {
4215
4220
  name: string;
4216
4221
  /** Rrsets */
4217
4222
  rrsets?: components["schemas"]["DnsRrsetCreate"][];
4223
+ /**
4224
+ * Vanity Nameserver Set Id
4225
+ * @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.
4226
+ */
4227
+ vanity_nameserver_set_id?: TypeId<"vns"> | null;
4218
4228
  };
4219
4229
  /** DnsZoneCreateWorkerPayload */
4220
4230
  DnsZoneCreateWorkerPayload: {
@@ -4479,6 +4489,11 @@ export interface components {
4479
4489
  name: string;
4480
4490
  /** Rrsets */
4481
4491
  rrsets?: components["schemas"]["DnsRrsetCreate"][];
4492
+ /**
4493
+ * Vanity Nameserver Set Id
4494
+ * @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.
4495
+ */
4496
+ vanity_nameserver_set_id?: TypeId<"vns"> | null;
4482
4497
  };
4483
4498
  /** DnsZoneUpdateWorkerPayload */
4484
4499
  DnsZoneUpdateWorkerPayload: {