@opusdns/api 1.25.0 → 1.27.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/src/schema.d.ts CHANGED
@@ -733,6 +733,23 @@ export interface paths {
733
733
  patch: operations["patch_zone_rrsets_v1_dns__zone_name__rrsets_patch"];
734
734
  trace?: never;
735
735
  };
736
+ "/v1/dns/{zone_name}/vanity-set": {
737
+ parameters: {
738
+ query?: never;
739
+ header?: never;
740
+ path?: never;
741
+ cookie?: never;
742
+ };
743
+ get?: never;
744
+ put?: never;
745
+ post?: never;
746
+ delete?: never;
747
+ options?: never;
748
+ head?: never;
749
+ /** Assign or clear a zone's vanity nameserver set */
750
+ patch: operations["update_zone_vanity_set_v1_dns__zone_name__vanity_set_patch"];
751
+ trace?: never;
752
+ };
736
753
  "/v1/domain-forwards": {
737
754
  parameters: {
738
755
  query?: never;
@@ -2580,6 +2597,127 @@ export interface paths {
2580
2597
  patch?: never;
2581
2598
  trace?: never;
2582
2599
  };
2600
+ "/v1/vanity-nameserver-sets": {
2601
+ parameters: {
2602
+ query?: never;
2603
+ header?: never;
2604
+ path?: never;
2605
+ cookie?: never;
2606
+ };
2607
+ /** List vanity nameserver sets */
2608
+ get: operations["list_vanity_nameserver_sets_v1_vanity_nameserver_sets_get"];
2609
+ put?: never;
2610
+ /** Create a vanity nameserver set */
2611
+ post: operations["create_vanity_nameserver_set_v1_vanity_nameserver_sets_post"];
2612
+ delete?: never;
2613
+ options?: never;
2614
+ head?: never;
2615
+ patch?: never;
2616
+ trace?: never;
2617
+ };
2618
+ "/v1/vanity-nameserver-sets/check": {
2619
+ parameters: {
2620
+ query?: never;
2621
+ header?: never;
2622
+ path?: never;
2623
+ cookie?: never;
2624
+ };
2625
+ get?: never;
2626
+ put?: never;
2627
+ /** Run a read-only diagnostic on a vanity nameserver set */
2628
+ post: operations["check_vanity_nameserver_set_v1_vanity_nameserver_sets_check_post"];
2629
+ delete?: never;
2630
+ options?: never;
2631
+ head?: never;
2632
+ patch?: never;
2633
+ trace?: never;
2634
+ };
2635
+ "/v1/vanity-nameserver-sets/default": {
2636
+ parameters: {
2637
+ query?: never;
2638
+ header?: never;
2639
+ path?: never;
2640
+ cookie?: never;
2641
+ };
2642
+ get?: never;
2643
+ put?: never;
2644
+ post?: never;
2645
+ /** Unset the organization's default vanity nameserver set */
2646
+ delete: operations["clear_vanity_nameserver_set_default_v1_vanity_nameserver_sets_default_delete"];
2647
+ options?: never;
2648
+ head?: never;
2649
+ patch?: never;
2650
+ trace?: never;
2651
+ };
2652
+ "/v1/vanity-nameserver-sets/{set_id}": {
2653
+ parameters: {
2654
+ query?: never;
2655
+ header?: never;
2656
+ path?: never;
2657
+ cookie?: never;
2658
+ };
2659
+ /** Get a vanity nameserver set */
2660
+ get: operations["get_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__get"];
2661
+ put?: never;
2662
+ post?: never;
2663
+ /** Delete a vanity nameserver set */
2664
+ delete: operations["delete_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__delete"];
2665
+ options?: never;
2666
+ head?: never;
2667
+ patch?: never;
2668
+ trace?: never;
2669
+ };
2670
+ "/v1/vanity-nameserver-sets/{set_id}/default": {
2671
+ parameters: {
2672
+ query?: never;
2673
+ header?: never;
2674
+ path?: never;
2675
+ cookie?: never;
2676
+ };
2677
+ get?: never;
2678
+ put?: never;
2679
+ post?: never;
2680
+ delete?: never;
2681
+ options?: never;
2682
+ head?: never;
2683
+ /** Set a vanity nameserver set as the org default */
2684
+ patch: operations["set_vanity_nameserver_set_default_v1_vanity_nameserver_sets__set_id__default_patch"];
2685
+ trace?: never;
2686
+ };
2687
+ "/v1/vanity-nameserver-sets/{set_id}/restore": {
2688
+ parameters: {
2689
+ query?: never;
2690
+ header?: never;
2691
+ path?: never;
2692
+ cookie?: never;
2693
+ };
2694
+ get?: never;
2695
+ put?: never;
2696
+ /** Restore a suspended vanity nameserver set */
2697
+ post: operations["restore_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__restore_post"];
2698
+ delete?: never;
2699
+ options?: never;
2700
+ head?: never;
2701
+ patch?: never;
2702
+ trace?: never;
2703
+ };
2704
+ "/v1/vanity-nameserver-sets/{set_id}/zones": {
2705
+ parameters: {
2706
+ query?: never;
2707
+ header?: never;
2708
+ path?: never;
2709
+ cookie?: never;
2710
+ };
2711
+ /** List DNS zones referencing a vanity nameserver set */
2712
+ get: operations["list_zones_referencing_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__zones_get"];
2713
+ put?: never;
2714
+ post?: never;
2715
+ delete?: never;
2716
+ options?: never;
2717
+ head?: never;
2718
+ patch?: never;
2719
+ trace?: never;
2720
+ };
2583
2721
  }
2584
2722
  export type webhooks = Record<string, never>;
2585
2723
  export interface components {
@@ -2880,6 +3018,14 @@ export interface components {
2880
3018
  /** Claims Notices */
2881
3019
  claims_notices: components["schemas"]["ClaimsNotice"][];
2882
3020
  };
3021
+ /** ClearVanityNameserverSetDefaultRes */
3022
+ ClearVanityNameserverSetDefaultRes: {
3023
+ /**
3024
+ * Cleared
3025
+ * @description True if an ACTIVE default was unset; False on an idempotent no-op (org had no default).
3026
+ */
3027
+ cleared: boolean;
3028
+ };
2883
3029
  /** CommandError */
2884
3030
  CommandError: {
2885
3031
  /**
@@ -4223,6 +4369,14 @@ export interface components {
4223
4369
  /** Rdata */
4224
4370
  rdata: string;
4225
4371
  };
4372
+ /** DnsRecordDTO */
4373
+ DnsRecordDTO: {
4374
+ /**
4375
+ * Rdata
4376
+ * @description The record data (e.g., IP address, domain name)
4377
+ */
4378
+ rdata: string;
4379
+ };
4226
4380
  /** DnsRecordPatchOp */
4227
4381
  DnsRecordPatchOp: {
4228
4382
  op: components["schemas"]["PatchOp"];
@@ -4251,6 +4405,26 @@ export interface components {
4251
4405
  ttl: number;
4252
4406
  type: components["schemas"]["DnsRrsetType"];
4253
4407
  };
4408
+ /** DnsRrsetDTO */
4409
+ DnsRrsetDTO: {
4410
+ /**
4411
+ * Name
4412
+ * @description The RRset name (e.g., '@', 'www')
4413
+ */
4414
+ name: string;
4415
+ /**
4416
+ * Records
4417
+ * @description List of records in this RRset
4418
+ */
4419
+ records?: components["schemas"]["DnsRecordDTO"][];
4420
+ /**
4421
+ * Ttl
4422
+ * @description Time to live in seconds
4423
+ */
4424
+ ttl: number;
4425
+ /** @description The RRset type */
4426
+ type: components["schemas"]["DnsRrsetType"];
4427
+ };
4254
4428
  /** DnsRrsetPatch */
4255
4429
  DnsRrsetPatch: {
4256
4430
  /** Name */
@@ -4428,6 +4602,39 @@ export interface components {
4428
4602
  /** Zone Name */
4429
4603
  zone_name: string;
4430
4604
  };
4605
+ /** DnsZoneDTO */
4606
+ DnsZoneDTO: {
4607
+ /**
4608
+ * Created On
4609
+ * @description Zone creation timestamp
4610
+ */
4611
+ created_on?: Date | null;
4612
+ /**
4613
+ * @description DNSSEC status
4614
+ * @default disabled
4615
+ */
4616
+ dnssec_status: components["schemas"]["DnssecStatus"];
4617
+ /**
4618
+ * Name
4619
+ * @description The zone name (e.g., 'example.com')
4620
+ */
4621
+ name: string;
4622
+ /**
4623
+ * Rrsets
4624
+ * @description List of RRsets in the zone
4625
+ */
4626
+ rrsets?: components["schemas"]["DnsRrsetDTO"][];
4627
+ /**
4628
+ * Updated On
4629
+ * @description Zone last update timestamp
4630
+ */
4631
+ updated_on?: Date | null;
4632
+ /**
4633
+ * Vanity Nameserver Set Id
4634
+ * @description Vanity NS set branding this zone's apex, or null for system default NS
4635
+ */
4636
+ vanity_nameserver_set_id?: TypeId<"vns"> | null;
4637
+ };
4431
4638
  /** DnsZonePatchRecordsBulkCommand */
4432
4639
  DnsZonePatchRecordsBulkCommand: {
4433
4640
  /**
@@ -4692,6 +4899,11 @@ export interface components {
4692
4899
  type: "dns_zone_update" | "dns_zone_update_bulk";
4693
4900
  zone: components["schemas"]["DnsZoneUpdatePayloadData"];
4694
4901
  };
4902
+ /** DnsZoneVanitySetUpdateRes */
4903
+ DnsZoneVanitySetUpdateRes: {
4904
+ /** @description The zone after restamping */
4905
+ zone: components["schemas"]["DnsZoneDTO"];
4906
+ };
4695
4907
  /**
4696
4908
  * DnssecAlgorithm
4697
4909
  * @enum {integer}
@@ -7930,6 +8142,26 @@ export interface components {
7930
8142
  * @enum {string}
7931
8143
  */
7932
8144
  LegalRequirementType: "notice" | "confirmation";
8145
+ /** ListVanityNameserverSetsRes */
8146
+ ListVanityNameserverSetsRes: {
8147
+ /** @description Pagination metadata */
8148
+ pagination: components["schemas"]["PaginationMetadataDTO"];
8149
+ /**
8150
+ * Results
8151
+ * @description Sets owned by the org, newest first; includes non-ACTIVE rows
8152
+ */
8153
+ results?: components["schemas"]["VanityNameserverSetSummaryDTO"][];
8154
+ };
8155
+ /** ListZonesReferencingSetRes */
8156
+ ListZonesReferencingSetRes: {
8157
+ /** @description Pagination metadata */
8158
+ pagination: components["schemas"]["PaginationMetadataDTO"];
8159
+ /**
8160
+ * Results
8161
+ * @description Zones whose apex is branded by the set, ordered by zone name
8162
+ */
8163
+ results?: components["schemas"]["DnsZoneDTO"][];
8164
+ };
7933
8165
  /** LocalPresenceBase */
7934
8166
  LocalPresenceBase: {
7935
8167
  /**
@@ -8761,6 +8993,39 @@ export interface components {
8761
8993
  /** Total Pages */
8762
8994
  total_pages: number;
8763
8995
  };
8996
+ /** PaginationMetadataDTO */
8997
+ PaginationMetadataDTO: {
8998
+ /**
8999
+ * Current Page
9000
+ * @description Current page number
9001
+ */
9002
+ current_page: number;
9003
+ /**
9004
+ * Has Next Page
9005
+ * @description Whether there is a next page
9006
+ */
9007
+ has_next_page: boolean;
9008
+ /**
9009
+ * Has Previous Page
9010
+ * @description Whether there is a previous page
9011
+ */
9012
+ has_previous_page: boolean;
9013
+ /**
9014
+ * Page Size
9015
+ * @description Items per page
9016
+ */
9017
+ page_size: number;
9018
+ /**
9019
+ * Total Items
9020
+ * @description Total number of items
9021
+ */
9022
+ total_items: number;
9023
+ /**
9024
+ * Total Pages
9025
+ * @description Total number of pages
9026
+ */
9027
+ total_pages: number;
9028
+ };
8764
9029
  /** Pagination[BillingTransactionResponse] */
8765
9030
  Pagination_BillingTransactionResponse_: {
8766
9031
  pagination: components["schemas"]["PaginationMetadata"];
@@ -9774,6 +10039,11 @@ export interface components {
9774
10039
  */
9775
10040
  request: boolean;
9776
10041
  };
10042
+ /** SetVanityNameserverSetDefaultRes */
10043
+ SetVanityNameserverSetDefaultRes: {
10044
+ /** @description The set that is now the org's default (or unchanged set on a no-op 200). */
10045
+ vanity_nameserver_set: components["schemas"]["VanityNameserverSetDTO"];
10046
+ };
9777
10047
  /** SldLength */
9778
10048
  SldLength: {
9779
10049
  /**
@@ -10898,81 +11168,330 @@ export interface components {
10898
11168
  /** Error Type */
10899
11169
  type: string;
10900
11170
  };
10901
- /**
10902
- * VerificationClaimType
10903
- * @enum {string}
10904
- */
10905
- VerificationClaimType: "name" | "address" | "email" | "phone";
10906
- /** VerificationDeadline */
10907
- VerificationDeadline: {
11171
+ /** VanityNameserverDTO */
11172
+ VanityNameserverDTO: {
10908
11173
  /**
10909
- * Date
10910
- * Format: date-time
11174
+ * Hostname
11175
+ * @description Fully-qualified hostname of the vanity nameserver
10911
11176
  */
10912
- date: Date;
10913
- type: components["schemas"]["VerificationDeadlineType"];
11177
+ hostname: string;
11178
+ /**
11179
+ * Position
11180
+ * @description Ordering within the set; lowest position becomes SOA MNAME
11181
+ */
11182
+ position: number;
10914
11183
  };
10915
11184
  /**
10916
- * VerificationDeadlineType
10917
- * @enum {string}
11185
+ * VanityNameserverSetCreate
11186
+ * @description Public create request body. The owning org comes from auth context, and the
11187
+ * anycast IPs are allocated server-side from `VanityNameserversConfig`, so neither is
11188
+ * accepted here.
10918
11189
  */
10919
- VerificationDeadlineType: "dedelegation" | "deletion";
10920
- /** VerificationRegistrantDetails */
10921
- VerificationRegistrantDetails: {
10922
- /** Contact Id */
10923
- contact_id: string;
10924
- /** Email */
10925
- email: string;
10926
- /** Name */
11190
+ VanityNameserverSetCreate: {
11191
+ /**
11192
+ * Hostnames
11193
+ * @description Fully-qualified vanity NS hostnames, ordered by intended position.
11194
+ */
11195
+ hostnames: string[];
11196
+ /**
11197
+ * Name
11198
+ * @description Human-readable name for the set
11199
+ */
10927
11200
  name: string;
10928
- };
10929
- /** VerificationResponse */
10930
- VerificationResponse: {
10931
11201
  /**
10932
- * Claims
10933
- * @description Verification claims
11202
+ * Parent Domain Name
11203
+ * @description Apex domain of the vanity NS zone; all hostnames must be subdomains.
10934
11204
  */
10935
- claims: components["schemas"]["VerificationClaimType"][];
11205
+ parent_domain_name: string;
10936
11206
  /**
10937
- * Deadlines
10938
- * @description Verification deadlines
11207
+ * Soa Rname
11208
+ * @description SOA RNAME stamped verbatim into the vanity NS zone
10939
11209
  */
10940
- deadlines?: components["schemas"]["VerificationDeadline"][];
10941
- };
10942
- /**
10943
- * VerificationType
10944
- * @enum {string}
10945
- */
10946
- VerificationType: "api" | "email";
10947
- /** VisitsByKeyBucket */
10948
- VisitsByKeyBucket: {
10949
- /** Key */
10950
- key: string;
10951
- /** Total */
10952
- total: number;
10953
- /** Unique */
10954
- unique: number;
11210
+ soa_rname: string;
10955
11211
  };
10956
- /** WhoisBase */
10957
- WhoisBase: {
11212
+ /** VanityNameserverSetDTO */
11213
+ VanityNameserverSetDTO: {
10958
11214
  /**
10959
- * Whois Server
10960
- * @description WHOIS server
11215
+ * Name
11216
+ * @description Human-readable name for the vanity NS set
10961
11217
  */
10962
- whois_server?: string | null;
11218
+ name: string;
11219
+ /**
11220
+ * Nameservers
11221
+ * @description Nameservers in the set, ordered by position
11222
+ */
11223
+ nameservers?: components["schemas"]["VanityNameserverDTO"][];
11224
+ /**
11225
+ * Parent Domain Name
11226
+ * @description Parent domain used as the apex of the vanity NS zone
11227
+ */
11228
+ parent_domain_name: string;
11229
+ /**
11230
+ * Set Id
11231
+ * Format: typeid
11232
+ * @description Stable identifier for the vanity NS set
11233
+ * @example vns_01h45ytscbebyvny4gc8cr8ma2
11234
+ */
11235
+ set_id: TypeId<"vns">;
11236
+ /**
11237
+ * Soa Rname
11238
+ * @description SOA RNAME used verbatim when creating vanity-branded zones
11239
+ */
11240
+ soa_rname: string;
10963
11241
  };
10964
11242
  /**
10965
- * ZoneIncludeField
11243
+ * VanityNameserverSetStatusDTO
11244
+ * @description Wire mirror of `VanityNameserverSetStatus` — local so dns_client doesn't
11245
+ * pull schema imports.
10966
11246
  * @enum {string}
10967
11247
  */
10968
- ZoneIncludeField: "tags";
11248
+ VanityNameserverSetStatusDTO: "provisioning" | "active" | "suspended" | "failed" | "deleting";
10969
11249
  /**
10970
- * ZoneSortField
10971
- * @enum {string}
11250
+ * VanityNameserverSetSummaryDTO
11251
+ * @description Status-aware variant of `VanityNameserverSetDTO` for list/get endpoints.
11252
+ * `VanityNameserverSetDTO` stays the brandable-only read shape (always ACTIVE).
10972
11253
  */
10973
- ZoneSortField: "name" | "created_on" | "updated_on" | "dnssec_status";
10974
- /** RequestAuthcodeResponse */
10975
- api__domain__tld_specific__be__models__RequestAuthcodeResponse: {
11254
+ VanityNameserverSetSummaryDTO: {
11255
+ /**
11256
+ * Is Default
11257
+ * @description Whether this is the org's default vanity NS set
11258
+ */
11259
+ is_default: boolean;
11260
+ /**
11261
+ * Name
11262
+ * @description Human-readable name for the vanity NS set
11263
+ */
11264
+ name: string;
11265
+ /**
11266
+ * Nameservers
11267
+ * @description Nameservers in the set, ordered by position
11268
+ */
11269
+ nameservers?: components["schemas"]["VanityNameserverDTO"][];
11270
+ /**
11271
+ * Organization Id
11272
+ * Format: typeid
11273
+ * @description Owning organization
11274
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
11275
+ */
11276
+ organization_id: TypeId<"organization">;
11277
+ /**
11278
+ * Parent Domain Name
11279
+ * @description Parent domain used as the apex of the vanity NS zone
11280
+ */
11281
+ parent_domain_name: string;
11282
+ /**
11283
+ * Set Id
11284
+ * Format: typeid
11285
+ * @description Stable identifier for the vanity NS set
11286
+ * @example vns_01h45ytscbebyvny4gc8cr8ma2
11287
+ */
11288
+ set_id: TypeId<"vns">;
11289
+ /**
11290
+ * Soa Rname
11291
+ * @description SOA RNAME used verbatim when creating vanity-branded zones
11292
+ */
11293
+ soa_rname: string;
11294
+ /** @description Lifecycle status of the set */
11295
+ status: components["schemas"]["VanityNameserverSetStatusDTO"];
11296
+ };
11297
+ /**
11298
+ * VanityNsCheckConfidence
11299
+ * @enum {string}
11300
+ */
11301
+ VanityNsCheckConfidence: "authoritative" | "best_effort";
11302
+ /**
11303
+ * VanityNsCheckPublicReq
11304
+ * @description Public `/check` request body. The owning org comes from auth context, so only
11305
+ * the set identifier is accepted here.
11306
+ */
11307
+ VanityNsCheckPublicReq: {
11308
+ /**
11309
+ * Set Id
11310
+ * Format: typeid
11311
+ * @description The vanity NS set to diagnose
11312
+ * @example vns_01h45ytscbebyvny4gc8cr8ma2
11313
+ */
11314
+ set_id: TypeId<"vns">;
11315
+ };
11316
+ /** VanityNsCheckRes */
11317
+ VanityNsCheckRes: {
11318
+ /**
11319
+ * Checks
11320
+ * @description Individual diagnostic checks
11321
+ */
11322
+ checks?: components["schemas"]["VanityNsCheckResultDTO"][];
11323
+ /**
11324
+ * Parent Domain Name
11325
+ * @description Parent domain of the set's vanity NS hostnames
11326
+ */
11327
+ parent_domain_name: string;
11328
+ /**
11329
+ * Set Id
11330
+ * Format: typeid
11331
+ * @description The diagnosed set
11332
+ * @example vns_01h45ytscbebyvny4gc8cr8ma2
11333
+ */
11334
+ set_id: TypeId<"vns">;
11335
+ /** @description Lifecycle status of the set at check time */
11336
+ status: components["schemas"]["VanityNameserverSetStatusDTO"];
11337
+ /** @description Synthesized overall verdict */
11338
+ summary: components["schemas"]["VanityNsCheckSummaryDTO"];
11339
+ };
11340
+ /** VanityNsCheckResultDTO */
11341
+ VanityNsCheckResultDTO: {
11342
+ /** @description How authoritative the observation is */
11343
+ confidence: components["schemas"]["VanityNsCheckConfidence"];
11344
+ /**
11345
+ * Detail
11346
+ * @description Customer-facing explanation of the result
11347
+ */
11348
+ detail: string;
11349
+ /**
11350
+ * Id
11351
+ * @description Stable identifier for the individual check
11352
+ */
11353
+ id: string;
11354
+ /**
11355
+ * Label
11356
+ * @description Human-readable check name
11357
+ */
11358
+ label: string;
11359
+ /**
11360
+ * Observed
11361
+ * @description Structured observation (e.g. addresses seen, mismatches) for the customer
11362
+ */
11363
+ observed?: {
11364
+ [key: string]: unknown;
11365
+ } | null;
11366
+ /**
11367
+ * Remediation
11368
+ * @description Suggested next step when the check did not pass
11369
+ */
11370
+ remediation?: string | null;
11371
+ /** @description How much this check matters to the overall verdict */
11372
+ severity: components["schemas"]["VanityNsCheckSeverity"];
11373
+ /** @description Where the observation came from */
11374
+ source: components["schemas"]["VanityNsCheckSource"];
11375
+ /** @description Per-check verdict */
11376
+ status: components["schemas"]["VanityNsCheckStatus"];
11377
+ };
11378
+ /**
11379
+ * VanityNsCheckSeverity
11380
+ * @enum {string}
11381
+ */
11382
+ VanityNsCheckSeverity: "required" | "recommended" | "optional";
11383
+ /**
11384
+ * VanityNsCheckSource
11385
+ * @enum {string}
11386
+ */
11387
+ VanityNsCheckSource: "public_dns" | "authoritative_dns" | "registry_epp";
11388
+ /**
11389
+ * VanityNsCheckStatus
11390
+ * @enum {string}
11391
+ */
11392
+ VanityNsCheckStatus: "pass" | "fail" | "warn" | "info";
11393
+ /** VanityNsCheckSummaryDTO */
11394
+ VanityNsCheckSummaryDTO: {
11395
+ /**
11396
+ * Detail
11397
+ * @description Customer-facing summary of the overall verdict
11398
+ */
11399
+ detail: string;
11400
+ /** @description Overall verdict synthesized from the checks */
11401
+ state: components["schemas"]["VanityNsCheckSummaryState"];
11402
+ };
11403
+ /**
11404
+ * VanityNsCheckSummaryState
11405
+ * @description Top-level verdict synthesized from the individual checks.
11406
+ * @enum {string}
11407
+ */
11408
+ VanityNsCheckSummaryState: "ready" | "propagating" | "action_required" | "degraded";
11409
+ /**
11410
+ * VerificationClaimType
11411
+ * @enum {string}
11412
+ */
11413
+ VerificationClaimType: "name" | "address" | "email" | "phone";
11414
+ /** VerificationDeadline */
11415
+ VerificationDeadline: {
11416
+ /**
11417
+ * Date
11418
+ * Format: date-time
11419
+ */
11420
+ date: Date;
11421
+ type: components["schemas"]["VerificationDeadlineType"];
11422
+ };
11423
+ /**
11424
+ * VerificationDeadlineType
11425
+ * @enum {string}
11426
+ */
11427
+ VerificationDeadlineType: "dedelegation" | "deletion";
11428
+ /** VerificationRegistrantDetails */
11429
+ VerificationRegistrantDetails: {
11430
+ /** Contact Id */
11431
+ contact_id: string;
11432
+ /** Email */
11433
+ email: string;
11434
+ /** Name */
11435
+ name: string;
11436
+ };
11437
+ /** VerificationResponse */
11438
+ VerificationResponse: {
11439
+ /**
11440
+ * Claims
11441
+ * @description Verification claims
11442
+ */
11443
+ claims: components["schemas"]["VerificationClaimType"][];
11444
+ /**
11445
+ * Deadlines
11446
+ * @description Verification deadlines
11447
+ */
11448
+ deadlines?: components["schemas"]["VerificationDeadline"][];
11449
+ };
11450
+ /**
11451
+ * VerificationType
11452
+ * @enum {string}
11453
+ */
11454
+ VerificationType: "api" | "email";
11455
+ /** VisitsByKeyBucket */
11456
+ VisitsByKeyBucket: {
11457
+ /** Key */
11458
+ key: string;
11459
+ /** Total */
11460
+ total: number;
11461
+ /** Unique */
11462
+ unique: number;
11463
+ };
11464
+ /** WhoisBase */
11465
+ WhoisBase: {
11466
+ /**
11467
+ * Whois Server
11468
+ * @description WHOIS server
11469
+ */
11470
+ whois_server?: string | null;
11471
+ };
11472
+ /**
11473
+ * ZoneIncludeField
11474
+ * @enum {string}
11475
+ */
11476
+ ZoneIncludeField: "tags";
11477
+ /**
11478
+ * ZoneSortField
11479
+ * @enum {string}
11480
+ */
11481
+ ZoneSortField: "name" | "created_on" | "updated_on" | "dnssec_status";
11482
+ /**
11483
+ * ZoneVanitySetUpdate
11484
+ * @description Public request body for assigning/clearing a zone's vanity NS branding.
11485
+ */
11486
+ ZoneVanitySetUpdate: {
11487
+ /**
11488
+ * Vanity Nameserver Set Id
11489
+ * @description Vanity NS set to brand the zone's apex NS + SOA with, or null to unassign and restamp the apex back to OpusDNS system defaults.
11490
+ */
11491
+ vanity_nameserver_set_id?: TypeId<"vns"> | null;
11492
+ };
11493
+ /** RequestAuthcodeResponse */
11494
+ api__domain__tld_specific__be__models__RequestAuthcodeResponse: {
10976
11495
  /**
10977
11496
  * Detail
10978
11497
  * @description Additional information about the result in case of failure
@@ -14579,6 +15098,58 @@ export interface operations {
14579
15098
  };
14580
15099
  };
14581
15100
  };
15101
+ update_zone_vanity_set_v1_dns__zone_name__vanity_set_patch: {
15102
+ parameters: {
15103
+ query?: never;
15104
+ header?: never;
15105
+ path: {
15106
+ /** @description DNS zone name (trailing dot optional) */
15107
+ zone_name: string;
15108
+ };
15109
+ cookie?: never;
15110
+ };
15111
+ requestBody: {
15112
+ content: {
15113
+ "application/json": components["schemas"]["ZoneVanitySetUpdate"];
15114
+ };
15115
+ };
15116
+ responses: {
15117
+ /** @description Successful Response */
15118
+ 200: {
15119
+ headers: {
15120
+ [name: string]: unknown;
15121
+ };
15122
+ content: {
15123
+ "application/json": components["schemas"]["DnsZoneVanitySetUpdateRes"];
15124
+ };
15125
+ };
15126
+ /** @description Bad Request */
15127
+ 400: {
15128
+ headers: {
15129
+ [name: string]: unknown;
15130
+ };
15131
+ content: {
15132
+ /** @example {
15133
+ * "code": "ERROR_DNS",
15134
+ * "detail": "Additional error context.",
15135
+ * "status": 400,
15136
+ * "title": "DNS Error",
15137
+ * "type": "dns"
15138
+ * } */
15139
+ "application/problem+json": components["schemas"]["Problem"];
15140
+ };
15141
+ };
15142
+ /** @description Validation Error */
15143
+ 422: {
15144
+ headers: {
15145
+ [name: string]: unknown;
15146
+ };
15147
+ content: {
15148
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
15149
+ };
15150
+ };
15151
+ };
15152
+ };
14582
15153
  list_domain_forwards_v1_domain_forwards_get: {
14583
15154
  parameters: {
14584
15155
  query?: {
@@ -22535,4 +23106,289 @@ export interface operations {
22535
23106
  };
22536
23107
  };
22537
23108
  };
23109
+ list_vanity_nameserver_sets_v1_vanity_nameserver_sets_get: {
23110
+ parameters: {
23111
+ query?: {
23112
+ page?: number;
23113
+ page_size?: number;
23114
+ };
23115
+ header?: never;
23116
+ path?: never;
23117
+ cookie?: never;
23118
+ };
23119
+ requestBody?: never;
23120
+ responses: {
23121
+ /** @description Successful Response */
23122
+ 200: {
23123
+ headers: {
23124
+ [name: string]: unknown;
23125
+ };
23126
+ content: {
23127
+ "application/json": components["schemas"]["ListVanityNameserverSetsRes"];
23128
+ };
23129
+ };
23130
+ /** @description Validation Error */
23131
+ 422: {
23132
+ headers: {
23133
+ [name: string]: unknown;
23134
+ };
23135
+ content: {
23136
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23137
+ };
23138
+ };
23139
+ };
23140
+ };
23141
+ create_vanity_nameserver_set_v1_vanity_nameserver_sets_post: {
23142
+ parameters: {
23143
+ query?: never;
23144
+ header?: never;
23145
+ path?: never;
23146
+ cookie?: never;
23147
+ };
23148
+ requestBody: {
23149
+ content: {
23150
+ "application/json": components["schemas"]["VanityNameserverSetCreate"];
23151
+ };
23152
+ };
23153
+ responses: {
23154
+ /** @description The set was accepted and is provisioning asynchronously. */
23155
+ 202: {
23156
+ headers: {
23157
+ [name: string]: unknown;
23158
+ };
23159
+ content: {
23160
+ "application/json": components["schemas"]["VanityNameserverSetSummaryDTO"];
23161
+ };
23162
+ };
23163
+ /** @description Validation Error */
23164
+ 422: {
23165
+ headers: {
23166
+ [name: string]: unknown;
23167
+ };
23168
+ content: {
23169
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23170
+ };
23171
+ };
23172
+ };
23173
+ };
23174
+ check_vanity_nameserver_set_v1_vanity_nameserver_sets_check_post: {
23175
+ parameters: {
23176
+ query?: never;
23177
+ header?: never;
23178
+ path?: never;
23179
+ cookie?: never;
23180
+ };
23181
+ requestBody: {
23182
+ content: {
23183
+ "application/json": components["schemas"]["VanityNsCheckPublicReq"];
23184
+ };
23185
+ };
23186
+ responses: {
23187
+ /** @description Diagnostic report for the set. */
23188
+ 200: {
23189
+ headers: {
23190
+ [name: string]: unknown;
23191
+ };
23192
+ content: {
23193
+ "application/json": components["schemas"]["VanityNsCheckRes"];
23194
+ };
23195
+ };
23196
+ /** @description Validation Error */
23197
+ 422: {
23198
+ headers: {
23199
+ [name: string]: unknown;
23200
+ };
23201
+ content: {
23202
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23203
+ };
23204
+ };
23205
+ };
23206
+ };
23207
+ clear_vanity_nameserver_set_default_v1_vanity_nameserver_sets_default_delete: {
23208
+ parameters: {
23209
+ query?: never;
23210
+ header?: never;
23211
+ path?: never;
23212
+ cookie?: never;
23213
+ };
23214
+ requestBody?: never;
23215
+ responses: {
23216
+ /** @description Successful Response */
23217
+ 200: {
23218
+ headers: {
23219
+ [name: string]: unknown;
23220
+ };
23221
+ content: {
23222
+ "application/json": components["schemas"]["ClearVanityNameserverSetDefaultRes"];
23223
+ };
23224
+ };
23225
+ /** @description Validation Error */
23226
+ 422: {
23227
+ headers: {
23228
+ [name: string]: unknown;
23229
+ };
23230
+ content: {
23231
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23232
+ };
23233
+ };
23234
+ };
23235
+ };
23236
+ get_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__get: {
23237
+ parameters: {
23238
+ query?: never;
23239
+ header?: never;
23240
+ path: {
23241
+ set_id: TypeId<"vns">;
23242
+ };
23243
+ cookie?: never;
23244
+ };
23245
+ requestBody?: never;
23246
+ responses: {
23247
+ /** @description Successful Response */
23248
+ 200: {
23249
+ headers: {
23250
+ [name: string]: unknown;
23251
+ };
23252
+ content: {
23253
+ "application/json": components["schemas"]["VanityNameserverSetSummaryDTO"];
23254
+ };
23255
+ };
23256
+ /** @description Validation Error */
23257
+ 422: {
23258
+ headers: {
23259
+ [name: string]: unknown;
23260
+ };
23261
+ content: {
23262
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23263
+ };
23264
+ };
23265
+ };
23266
+ };
23267
+ delete_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__delete: {
23268
+ parameters: {
23269
+ query?: never;
23270
+ header?: never;
23271
+ path: {
23272
+ set_id: TypeId<"vns">;
23273
+ };
23274
+ cookie?: never;
23275
+ };
23276
+ requestBody?: never;
23277
+ responses: {
23278
+ /** @description Successful Response */
23279
+ 202: {
23280
+ headers: {
23281
+ [name: string]: unknown;
23282
+ };
23283
+ content: {
23284
+ "application/json": unknown;
23285
+ };
23286
+ };
23287
+ /** @description Validation Error */
23288
+ 422: {
23289
+ headers: {
23290
+ [name: string]: unknown;
23291
+ };
23292
+ content: {
23293
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23294
+ };
23295
+ };
23296
+ };
23297
+ };
23298
+ set_vanity_nameserver_set_default_v1_vanity_nameserver_sets__set_id__default_patch: {
23299
+ parameters: {
23300
+ query?: never;
23301
+ header?: never;
23302
+ path: {
23303
+ set_id: TypeId<"vns">;
23304
+ };
23305
+ cookie?: never;
23306
+ };
23307
+ requestBody?: never;
23308
+ responses: {
23309
+ /** @description Successful Response */
23310
+ 200: {
23311
+ headers: {
23312
+ [name: string]: unknown;
23313
+ };
23314
+ content: {
23315
+ "application/json": components["schemas"]["SetVanityNameserverSetDefaultRes"];
23316
+ };
23317
+ };
23318
+ /** @description Validation Error */
23319
+ 422: {
23320
+ headers: {
23321
+ [name: string]: unknown;
23322
+ };
23323
+ content: {
23324
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23325
+ };
23326
+ };
23327
+ };
23328
+ };
23329
+ restore_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__restore_post: {
23330
+ parameters: {
23331
+ query?: never;
23332
+ header?: never;
23333
+ path: {
23334
+ set_id: TypeId<"vns">;
23335
+ };
23336
+ cookie?: never;
23337
+ };
23338
+ requestBody?: never;
23339
+ responses: {
23340
+ /** @description Successful Response */
23341
+ 200: {
23342
+ headers: {
23343
+ [name: string]: unknown;
23344
+ };
23345
+ content: {
23346
+ "application/json": components["schemas"]["VanityNameserverSetSummaryDTO"];
23347
+ };
23348
+ };
23349
+ /** @description Validation Error */
23350
+ 422: {
23351
+ headers: {
23352
+ [name: string]: unknown;
23353
+ };
23354
+ content: {
23355
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23356
+ };
23357
+ };
23358
+ };
23359
+ };
23360
+ list_zones_referencing_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__zones_get: {
23361
+ parameters: {
23362
+ query?: {
23363
+ page?: number;
23364
+ page_size?: number;
23365
+ };
23366
+ header?: never;
23367
+ path: {
23368
+ set_id: TypeId<"vns">;
23369
+ };
23370
+ cookie?: never;
23371
+ };
23372
+ requestBody?: never;
23373
+ responses: {
23374
+ /** @description Successful Response */
23375
+ 200: {
23376
+ headers: {
23377
+ [name: string]: unknown;
23378
+ };
23379
+ content: {
23380
+ "application/json": components["schemas"]["ListZonesReferencingSetRes"];
23381
+ };
23382
+ };
23383
+ /** @description Validation Error */
23384
+ 422: {
23385
+ headers: {
23386
+ [name: string]: unknown;
23387
+ };
23388
+ content: {
23389
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
23390
+ };
23391
+ };
23392
+ };
23393
+ };
22538
23394
  }