@opusdns/api 0.269.0 → 0.271.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.
Files changed (4) hide show
  1. package/package.json +1 -1
  2. package/src/helpers/keys.ts +2 -7
  3. package/src/openapi.yaml +79 -58
  4. package/src/schema.d.ts +7 -7
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.269.0",
6
+ "version": "0.271.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
package/src/helpers/keys.ts CHANGED
@@ -10032,7 +10032,7 @@ export const KEY_DNS_ZONE_UPDATE_BULK_INSTANCE_NAME: keyof DnsZoneUpdateBulkInst
10032
10032
  /**
10033
10033
  * Rrsets
10034
10034
  *
10035
- * Override RRsets for this zone
10035
+ * Override RRsets for this zone. Omit to inherit the template (or leave records unchanged if the template also omits rrsets). Provide an empty list to delete all records.
10036
10036
  *
10037
10037
  *
10038
10038
  *
@@ -10186,9 +10186,8 @@ export const KEY_DNS_ZONE_UPDATE_BULK_TEMPLATE_DNSSEC_STATUS: keyof DnsZoneUpdat
10186
10186
  /**
10187
10187
  * Rrsets
10188
10188
  *
10189
- * DNS record sets to update
10189
+ * DNS record sets to apply to every zone. Omit to leave each zone's RRsets unchanged (useful for bulk DNSSEC toggles). Provide an empty list to delete all records.
10190
10190
  *
10191
- * @type {array}
10192
10191
  *
10193
10192
  *
10194
10193
  * @remarks
@@ -10899,7 +10898,6 @@ export const KEYS_DOMAIN_CONTACT = [
10899
10898
  *
10900
10899
  * Additional attributes of the domain
10901
10900
  *
10902
- * @type {object}
10903
10901
  *
10904
10902
  *
10905
10903
  * @remarks
@@ -11883,7 +11881,6 @@ export const KEYS_DOMAIN_CREATE_COMMAND = [
11883
11881
  *
11884
11882
  * Additional attributes of the domain
11885
11883
  *
11886
- * @type {object}
11887
11884
  *
11888
11885
  *
11889
11886
  * @remarks
@@ -17536,7 +17533,6 @@ export const KEYS_DOMAIN_TRANSFER_COMMAND = [
17536
17533
  *
17537
17534
  * Additional attributes of the domain
17538
17535
  *
17539
- * @type {object}
17540
17536
  *
17541
17537
  *
17542
17538
  * @remarks
@@ -17798,7 +17794,6 @@ export const KEYS_DOMAIN_TRANSFER_IN = [
17798
17794
  *
17799
17795
  * Additional attributes of the domain
17800
17796
  *
17801
- * @type {object}
17802
17797
  *
17803
17798
  *
17804
17799
  * @remarks
package/src/openapi.yaml CHANGED
@@ -2345,7 +2345,9 @@ components:
2345
2345
  $ref: '#/components/schemas/DnsRrsetCreate'
2346
2346
  type: array
2347
2347
  - type: 'null'
2348
- description: Override RRsets for this zone
2348
+ description: Override RRsets for this zone. Omit to inherit the template
2349
+ (or leave records unchanged if the template also omits rrsets). Provide
2350
+ an empty list to delete all records.
2349
2351
  title: Rrsets
2350
2352
  required:
2351
2353
  - name
@@ -2377,11 +2379,15 @@ components:
2377
2379
  - type: 'null'
2378
2380
  description: DNSSEC status for all zones
2379
2381
  rrsets:
2380
- description: DNS record sets to update
2381
- items:
2382
- $ref: '#/components/schemas/DnsRrsetCreate'
2382
+ anyOf:
2383
+ - items:
2384
+ $ref: '#/components/schemas/DnsRrsetCreate'
2385
+ type: array
2386
+ - type: 'null'
2387
+ description: DNS record sets to apply to every zone. Omit to leave each
2388
+ zone's RRsets unchanged (useful for bulk DNSSEC toggles). Provide an empty
2389
+ list to delete all records.
2383
2390
  title: Rrsets
2384
- type: array
2385
2391
  title: DnsZoneUpdateBulkTemplate
2386
2392
  type: object
2387
2393
  DnsZoneUpdateCommand:
@@ -2606,13 +2612,15 @@ components:
2606
2612
  DomainCreate:
2607
2613
  properties:
2608
2614
  attributes:
2609
- additionalProperties:
2610
- type: string
2615
+ anyOf:
2616
+ - additionalProperties:
2617
+ type: string
2618
+ propertyNames:
2619
+ $ref: '#/components/schemas/DomainAttributeKey'
2620
+ type: object
2621
+ - type: 'null'
2611
2622
  description: Additional attributes of the domain
2612
- propertyNames:
2613
- $ref: '#/components/schemas/DomainAttributeKey'
2614
2623
  title: Attributes
2615
- type: object
2616
2624
  auth_code:
2617
2625
  anyOf:
2618
2626
  - maxLength: 32
@@ -2824,13 +2832,15 @@ components:
2824
2832
  DomainCreatePayloadData:
2825
2833
  properties:
2826
2834
  attributes:
2827
- additionalProperties:
2828
- type: string
2835
+ anyOf:
2836
+ - additionalProperties:
2837
+ type: string
2838
+ propertyNames:
2839
+ $ref: '#/components/schemas/DomainAttributeKey'
2840
+ type: object
2841
+ - type: 'null'
2829
2842
  description: Additional attributes of the domain
2830
- propertyNames:
2831
- $ref: '#/components/schemas/DomainAttributeKey'
2832
2843
  title: Attributes
2833
- type: object
2834
2844
  auth_code:
2835
2845
  anyOf:
2836
2846
  - maxLength: 32
@@ -4152,13 +4162,15 @@ components:
4152
4162
  DomainTransferIn:
4153
4163
  properties:
4154
4164
  attributes:
4155
- additionalProperties:
4156
- type: string
4165
+ anyOf:
4166
+ - additionalProperties:
4167
+ type: string
4168
+ propertyNames:
4169
+ $ref: '#/components/schemas/DomainAttributeKey'
4170
+ type: object
4171
+ - type: 'null'
4157
4172
  description: Additional attributes of the domain
4158
- propertyNames:
4159
- $ref: '#/components/schemas/DomainAttributeKey'
4160
4173
  title: Attributes
4161
- type: object
4162
4174
  auth_code:
4163
4175
  description: The auth code for the domain
4164
4176
  maxLength: 32
@@ -4213,13 +4225,15 @@ components:
4213
4225
  DomainTransferPayloadData:
4214
4226
  properties:
4215
4227
  attributes:
4216
- additionalProperties:
4217
- type: string
4228
+ anyOf:
4229
+ - additionalProperties:
4230
+ type: string
4231
+ propertyNames:
4232
+ $ref: '#/components/schemas/DomainAttributeKey'
4233
+ type: object
4234
+ - type: 'null'
4218
4235
  description: Additional attributes of the domain
4219
- propertyNames:
4220
- $ref: '#/components/schemas/DomainAttributeKey'
4221
4236
  title: Attributes
4222
- type: object
4223
4237
  auth_code:
4224
4238
  description: The auth code for the domain
4225
4239
  maxLength: 32
@@ -10139,7 +10153,7 @@ info:
10139
10153
  \n\n"
10140
10154
  summary: OpusDNS - your gateway to a seamless domain management experience.
10141
10155
  title: OpusDNS API
10142
- version: 2026-04-24-162344
10156
+ version: 2026-04-27-130908
10143
10157
  x-logo:
10144
10158
  altText: OpusDNS API Reference
10145
10159
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -18868,7 +18882,6 @@ paths:
18868
18882
  - command: domain_create
18869
18883
  idempotency_key: scheduled-create-001
18870
18884
  payload:
18871
- attributes: {}
18872
18885
  contacts:
18873
18886
  admin: contact_01kc433yvre99af2wasxhtpswf
18874
18887
  billing: contact_01kc433yvre99af2wasxhtpswf
@@ -18908,7 +18921,6 @@ paths:
18908
18921
  - command: domain_create
18909
18922
  idempotency_key: create-example-com-001
18910
18923
  payload:
18911
- attributes: {}
18912
18924
  contacts:
18913
18925
  admin: contact_01kc433yvre99af2wasxhtpswf
18914
18926
  billing: contact_01kc433yvre99af2wasxhtpswf
@@ -22468,7 +22480,12 @@ tags:
22468
22480
  \ updates. For each zone, whatever rrsets you supply become the zone's rrsets\
22469
22481
  \ \u2014 anything not listed is removed. System-managed record types (SOA, DNSKEY,\
22470
22482
  \ DS) cannot be set via this command. This is also the command to flip DNSSEC\
22471
- \ on or off across many zones.\n\nPayload: `template` (shared `rrsets` and `dnssec_status`)\
22483
+ \ on or off across many zones.\n\nBoth `rrsets` and `dnssec_status` are partial-update\
22484
+ \ fields:\n\n| Value | Meaning |\n| --- | --- |\n| omitted (in both template and\
22485
+ \ instance) | leave that field unchanged on the zone |\n| `[]` (rrsets only) |\
22486
+ \ delete all records |\n| `[...]` / a status value | replace |\n\nAn instance\
22487
+ \ with neither `rrsets` nor `dnssec_status` (after the template is merged in)\
22488
+ \ is rejected as a no-op.\n\nPayload: `template` (shared `rrsets` and `dnssec_status`)\
22472
22489
  \ + `instances[]` (per-zone overrides).\n\n```json\n{\n \"command\": \"dns_zone_update_bulk\"\
22473
22490
  ,\n \"payload\": {\n \"template\": {\n \"rrsets\": [\n {\"name\"\
22474
22491
  : \"@\", \"type\": \"A\", \"ttl\": 300, \"records\": [{\"rdata\": \"203.0.113.10\"\
@@ -22476,35 +22493,39 @@ tags:
22476
22493
  : [\n { \"name\": \"example.com\" },\n {\n \"name\": \"example.net\"\
22477
22494
  ,\n \"rrsets\": [\n {\"name\": \"@\", \"type\": \"A\", \"ttl\"\
22478
22495
  : 300, \"records\": [{\"rdata\": \"203.0.113.20\"}]}\n ]\n }\n \
22479
- \ ]\n }\n}\n```\n\n#### `dns_zone_patch_rrsets_bulk`\n\nBulk equivalent of `PATCH\
22480
- \ /v1/dns/{zone_name}/rrsets`. Each instance is `{ zone_name, ops[] }`, where\
22481
- \ each op targets an rrset by `(name, type)`:\n\n- `op: \"upsert\"` \u2014 create\
22482
- \ or **replace** the rrset with the records you provide. Any prior records for\
22483
- \ that `(name, type)` are discarded.\n- `op: \"remove\"` \u2014 delete the entire\
22484
- \ rrset (pass `records: []`).\n\n```json\n{\n \"command\": \"dns_zone_patch_rrsets_bulk\"\
22485
- ,\n \"payload\": {\n \"instances\": [\n {\n \"zone_name\": \"\
22486
- example.com\",\n \"ops\": [\n {\n \"op\": \"upsert\"\
22487
- ,\n \"rrset\": {\n \"name\": \"www\", \"type\": \"A\"\
22488
- , \"ttl\": 300,\n \"records\": [\n {\"rdata\": \"\
22489
- 203.0.113.10\"},\n {\"rdata\": \"203.0.113.11\"}\n \
22490
- \ ]\n }\n },\n {\n \"op\": \"remove\"\
22491
- ,\n \"rrset\": {\"name\": \"old\", \"type\": \"CNAME\", \"ttl\": 300,\
22492
- \ \"records\": []}\n }\n ]\n }\n ]\n }\n}\n```\n\n####\
22493
- \ `dns_zone_patch_records_bulk`\n\nBulk equivalent of `PATCH /v1/dns/{zone_name}/records`.\
22494
- \ Each instance is `{ zone_name, ops[] }`, where each op targets a single `rdata`\
22495
- \ value inside an rrset. Note the op payload uses a single `rdata` field, not\
22496
- \ `records[]`.\n\n- `op: \"upsert\"` \u2014 add or update that one rdata value\
22497
- \ (creates the rrset if it doesn't exist). Sibling records in the rrset are untouched.\n\
22498
- - `op: \"remove\"` \u2014 remove just that one rdata value. Other records in the\
22499
- \ rrset remain.\n\n```json\n{\n \"command\": \"dns_zone_patch_records_bulk\"\
22500
- ,\n \"payload\": {\n \"instances\": [\n {\n \"zone_name\": \"\
22501
- example.com\",\n \"ops\": [\n {\n \"op\": \"upsert\"\
22502
- ,\n \"record\": {\n \"name\": \"@\", \"type\": \"MX\"\
22503
- , \"ttl\": 300,\n \"rdata\": \"5 new-mail.example.com.\"\n \
22504
- \ }\n },\n {\n \"op\": \"remove\",\n \
22505
- \ \"record\": {\n \"name\": \"@\", \"type\": \"MX\", \"ttl\"\
22506
- : 300,\n \"rdata\": \"10 old-mail.example.com.\"\n }\n\
22507
- \ }\n ]\n }\n ]\n }\n}\n```\n"
22496
+ \ ]\n }\n}\n```\n\nBulk-toggle DNSSEC across many zones without touching their\
22497
+ \ records \u2014 omit `rrsets` everywhere:\n\n```json\n{\n \"command\": \"dns_zone_update_bulk\"\
22498
+ ,\n \"payload\": {\n \"template\": { \"dnssec_status\": \"enabled\" },\n \
22499
+ \ \"instances\": [\n { \"name\": \"example.com\" },\n { \"name\":\
22500
+ \ \"example.net\" },\n { \"name\": \"example.org\" }\n ]\n }\n}\n```\n\
22501
+ \n#### `dns_zone_patch_rrsets_bulk`\n\nBulk equivalent of `PATCH /v1/dns/{zone_name}/rrsets`.\
22502
+ \ Each instance is `{ zone_name, ops[] }`, where each op targets an rrset by `(name,\
22503
+ \ type)`:\n\n- `op: \"upsert\"` \u2014 create or **replace** the rrset with the\
22504
+ \ records you provide. Any prior records for that `(name, type)` are discarded.\n\
22505
+ - `op: \"remove\"` \u2014 delete the entire rrset (pass `records: []`).\n\n```json\n\
22506
+ {\n \"command\": \"dns_zone_patch_rrsets_bulk\",\n \"payload\": {\n \"instances\"\
22507
+ : [\n {\n \"zone_name\": \"example.com\",\n \"ops\": [\n \
22508
+ \ {\n \"op\": \"upsert\",\n \"rrset\": {\n \
22509
+ \ \"name\": \"www\", \"type\": \"A\", \"ttl\": 300,\n \"records\"\
22510
+ : [\n {\"rdata\": \"203.0.113.10\"},\n {\"rdata\"\
22511
+ : \"203.0.113.11\"}\n ]\n }\n },\n {\n\
22512
+ \ \"op\": \"remove\",\n \"rrset\": {\"name\": \"old\", \"\
22513
+ type\": \"CNAME\", \"ttl\": 300, \"records\": []}\n }\n ]\n \
22514
+ \ }\n ]\n }\n}\n```\n\n#### `dns_zone_patch_records_bulk`\n\nBulk equivalent\
22515
+ \ of `PATCH /v1/dns/{zone_name}/records`. Each instance is `{ zone_name, ops[]\
22516
+ \ }`, where each op targets a single `rdata` value inside an rrset. Note the op\
22517
+ \ payload uses a single `rdata` field, not `records[]`.\n\n- `op: \"upsert\"`\
22518
+ \ \u2014 add or update that one rdata value (creates the rrset if it doesn't exist).\
22519
+ \ Sibling records in the rrset are untouched.\n- `op: \"remove\"` \u2014 remove\
22520
+ \ just that one rdata value. Other records in the rrset remain.\n\n```json\n{\n\
22521
+ \ \"command\": \"dns_zone_patch_records_bulk\",\n \"payload\": {\n \"instances\"\
22522
+ : [\n {\n \"zone_name\": \"example.com\",\n \"ops\": [\n \
22523
+ \ {\n \"op\": \"upsert\",\n \"record\": {\n \
22524
+ \ \"name\": \"@\", \"type\": \"MX\", \"ttl\": 300,\n \"rdata\"\
22525
+ : \"5 new-mail.example.com.\"\n }\n },\n {\n \
22526
+ \ \"op\": \"remove\",\n \"record\": {\n \"name\"\
22527
+ : \"@\", \"type\": \"MX\", \"ttl\": 300,\n \"rdata\": \"10 old-mail.example.com.\"\
22528
+ \n }\n }\n ]\n }\n ]\n }\n}\n```\n"
22508
22529
  name: jobs
22509
22530
  x-displayName: Jobs
22510
22531
  - description: 'Endpoints for creating and managing contacts.
package/src/schema.d.ts CHANGED
@@ -3849,7 +3849,7 @@ export interface components {
3849
3849
  name: string;
3850
3850
  /**
3851
3851
  * Rrsets
3852
- * @description Override RRsets for this zone
3852
+ * @description Override RRsets for this zone. Omit to inherit the template (or leave records unchanged if the template also omits rrsets). Provide an empty list to delete all records.
3853
3853
  */
3854
3854
  rrsets?: components["schemas"]["DnsRrsetCreate"][] | null;
3855
3855
  };
@@ -3869,9 +3869,9 @@ export interface components {
3869
3869
  dnssec_status?: components["schemas"]["DnssecStatus"] | null;
3870
3870
  /**
3871
3871
  * Rrsets
3872
- * @description DNS record sets to update
3872
+ * @description DNS record sets to apply to every zone. Omit to leave each zone's RRsets unchanged (useful for bulk DNSSEC toggles). Provide an empty list to delete all records.
3873
3873
  */
3874
- rrsets?: components["schemas"]["DnsRrsetCreate"][];
3874
+ rrsets?: components["schemas"]["DnsRrsetCreate"][] | null;
3875
3875
  };
3876
3876
  /** DnsZoneUpdateCommand */
3877
3877
  DnsZoneUpdateCommand: {
@@ -4005,7 +4005,7 @@ export interface components {
4005
4005
  */
4006
4006
  attributes?: {
4007
4007
  [key: string]: string;
4008
- };
4008
+ } | null;
4009
4009
  /**
4010
4010
  * Auth Code
4011
4011
  * @description The auth code used for the domain
@@ -4162,7 +4162,7 @@ export interface components {
4162
4162
  */
4163
4163
  attributes?: {
4164
4164
  [key: string]: string;
4165
- };
4165
+ } | null;
4166
4166
  /**
4167
4167
  * Auth Code
4168
4168
  * @description The auth code used for the domain
@@ -5019,7 +5019,7 @@ export interface components {
5019
5019
  */
5020
5020
  attributes?: {
5021
5021
  [key: string]: string;
5022
- };
5022
+ } | null;
5023
5023
  /**
5024
5024
  * Auth Code
5025
5025
  * @description The auth code for the domain
@@ -5064,7 +5064,7 @@ export interface components {
5064
5064
  */
5065
5065
  attributes?: {
5066
5066
  [key: string]: string;
5067
- };
5067
+ } | null;
5068
5068
  /**
5069
5069
  * Auth Code
5070
5070
  * @description The auth code for the domain