@opusdns/api 0.267.0 → 0.269.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.267.0",
6
+ "version": "0.269.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -1214,6 +1214,7 @@ export const DNSSEC_STATUS_VALUES = [
1214
1214
  */
1215
1215
  export const DOMAIN_ATTRIBUTE_KEY = {
1216
1216
  AUTO_RENEW_PERIOD: "auto_renew_period",
1217
+ MUSIC_REGISTRANT_ATTESTATION: "music_registrant_attestation",
1217
1218
  } as const satisfies Record<string, DomainAttributeKey>;
1218
1219
 
1219
1220
  /**
@@ -1238,7 +1239,8 @@ export const DOMAIN_ATTRIBUTE_KEY = {
1238
1239
  * @see {@link DOMAIN_ATTRIBUTE_KEY} - The object form of this enum
1239
1240
  */
1240
1241
  export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
1241
- 'auto_renew_period'
1242
+ 'auto_renew_period',
1243
+ 'music_registrant_attestation'
1242
1244
  ] as const satisfies [string, ...string[]] | DomainAttributeKey[];
1243
1245
 
1244
1246
  /**
@@ -10894,6 +10894,32 @@ export const KEYS_DOMAIN_CONTACT = [
10894
10894
  KEY_DOMAIN_CONTACT_CONTACT_TYPE,
10895
10895
  ] as const satisfies (keyof DomainContact)[];
10896
10896
 
10897
+ /**
10898
+ * Attributes
10899
+ *
10900
+ * Additional attributes of the domain
10901
+ *
10902
+ * @type {object}
10903
+ *
10904
+ *
10905
+ * @remarks
10906
+ * This key constant provides type-safe access to the `attributes` property of DomainCreate objects.
10907
+ * Use this constant when you need to access properties dynamically or ensure type safety.
10908
+ *
10909
+ * @example
10910
+ * ```typescript
10911
+ * // Direct property access
10912
+ * const value = domaincreate[KEY_DOMAIN_CREATE_ATTRIBUTES];
10913
+ *
10914
+ * // Dynamic property access
10915
+ * const propertyName = KEY_DOMAIN_CREATE_ATTRIBUTES;
10916
+ * const value = domaincreate[propertyName];
10917
+ * ```
10918
+ *
10919
+ * @see {@link DomainCreate} - The TypeScript type definition
10920
+ * @see {@link KEYS_DOMAIN_CREATE} - Array of all keys for this type
10921
+ */
10922
+ export const KEY_DOMAIN_CREATE_ATTRIBUTES: keyof DomainCreate = 'attributes';
10897
10923
  /**
10898
10924
  * Auth Code
10899
10925
  *
@@ -11118,6 +11144,7 @@ export const KEY_DOMAIN_CREATE_RENEWAL_MODE: keyof DomainCreate = 'renewal_mode'
11118
11144
  * @see {@link DomainCreate} - The TypeScript type definition
11119
11145
  */
11120
11146
  export const KEYS_DOMAIN_CREATE = [
11147
+ KEY_DOMAIN_CREATE_ATTRIBUTES,
11121
11148
  KEY_DOMAIN_CREATE_AUTH_CODE,
11122
11149
  KEY_DOMAIN_CREATE_CONTACTS,
11123
11150
  KEY_DOMAIN_CREATE_CREATE_ZONE,
@@ -11851,6 +11878,32 @@ export const KEYS_DOMAIN_CREATE_COMMAND = [
11851
11878
  KEY_DOMAIN_CREATE_COMMAND_VERSION,
11852
11879
  ] as const satisfies (keyof DomainCreateCommand)[];
11853
11880
 
11881
+ /**
11882
+ * Attributes
11883
+ *
11884
+ * Additional attributes of the domain
11885
+ *
11886
+ * @type {object}
11887
+ *
11888
+ *
11889
+ * @remarks
11890
+ * This key constant provides type-safe access to the `attributes` property of DomainCreatePayloadData objects.
11891
+ * Use this constant when you need to access properties dynamically or ensure type safety.
11892
+ *
11893
+ * @example
11894
+ * ```typescript
11895
+ * // Direct property access
11896
+ * const value = domaincreatepayloaddata[KEY_DOMAIN_CREATE_PAYLOAD_DATA_ATTRIBUTES];
11897
+ *
11898
+ * // Dynamic property access
11899
+ * const propertyName = KEY_DOMAIN_CREATE_PAYLOAD_DATA_ATTRIBUTES;
11900
+ * const value = domaincreatepayloaddata[propertyName];
11901
+ * ```
11902
+ *
11903
+ * @see {@link DomainCreatePayloadData} - The TypeScript type definition
11904
+ * @see {@link KEYS_DOMAIN_CREATE_PAYLOAD_DATA} - Array of all keys for this type
11905
+ */
11906
+ export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_ATTRIBUTES: keyof DomainCreatePayloadData = 'attributes';
11854
11907
  /**
11855
11908
  * Auth Code
11856
11909
  *
@@ -12075,6 +12128,7 @@ export const KEY_DOMAIN_CREATE_PAYLOAD_DATA_RENEWAL_MODE: keyof DomainCreatePayl
12075
12128
  * @see {@link DomainCreatePayloadData} - The TypeScript type definition
12076
12129
  */
12077
12130
  export const KEYS_DOMAIN_CREATE_PAYLOAD_DATA = [
12131
+ KEY_DOMAIN_CREATE_PAYLOAD_DATA_ATTRIBUTES,
12078
12132
  KEY_DOMAIN_CREATE_PAYLOAD_DATA_AUTH_CODE,
12079
12133
  KEY_DOMAIN_CREATE_PAYLOAD_DATA_CONTACTS,
12080
12134
  KEY_DOMAIN_CREATE_PAYLOAD_DATA_CREATE_ZONE,
@@ -17482,6 +17536,7 @@ export const KEYS_DOMAIN_TRANSFER_COMMAND = [
17482
17536
  *
17483
17537
  * Additional attributes of the domain
17484
17538
  *
17539
+ * @type {object}
17485
17540
  *
17486
17541
  *
17487
17542
  * @remarks
@@ -17743,6 +17798,7 @@ export const KEYS_DOMAIN_TRANSFER_IN = [
17743
17798
  *
17744
17799
  * Additional attributes of the domain
17745
17800
  *
17801
+ * @type {object}
17746
17802
  *
17747
17803
  *
17748
17804
  * @remarks
@@ -1363,37 +1363,37 @@ export type DELETE_DnsZoneName_Request_Path = DELETE_DnsZoneName_Request['parame
1363
1363
  */
1364
1364
  export type GET_DnsZoneName_Request = {
1365
1365
  parameters: {
1366
+ query: operations['get_zone_v1_dns__zone_name__get']['parameters']['query'];
1366
1367
  path: operations['get_zone_v1_dns__zone_name__get']['parameters']['path'];
1367
1368
  };
1368
- requestBody: unknown;
1369
1369
  }
1370
1370
  /**
1371
- * Path parameters for GET /v1/dns/{zone_name}
1371
+ * Query parameters for GET /v1/dns/{zone_name}
1372
1372
  *
1373
1373
  * @remarks
1374
- * This type defines the path parameters for the GET /v1/dns/{zone_name} endpoint.
1375
- * It provides type safety for all path parameters as defined in the OpenAPI specification.
1374
+ * This type defines the query parameters for the GET /v1/dns/{zone_name} endpoint.
1375
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
1376
1376
  *
1377
1377
  * @example
1378
- * Use this type to ensure type safety for path parameters.
1378
+ * Use this type to ensure type safety for query parameters.
1379
1379
  *
1380
1380
  * @path /v1/dns/{zone_name}
1381
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1382
1381
  */
1383
- export type GET_DnsZoneName_Request_Path = GET_DnsZoneName_Request['parameters']['path'];
1382
+ export type GET_DnsZoneName_Request_Query = GET_DnsZoneName_Request['parameters']['query'];
1384
1383
  /**
1385
- * Request body for GET /v1/dns/{zone_name}
1384
+ * Path parameters for GET /v1/dns/{zone_name}
1386
1385
  *
1387
1386
  * @remarks
1388
- * This type defines the request body structure for the GET /v1/dns/{zone_name} endpoint.
1389
- * It provides type safety for the request body as defined in the OpenAPI specification.
1387
+ * This type defines the path parameters for the GET /v1/dns/{zone_name} endpoint.
1388
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1390
1389
  *
1391
1390
  * @example
1392
- * Use this type to ensure type safety for request body structure.
1391
+ * Use this type to ensure type safety for path parameters.
1393
1392
  *
1394
1393
  * @path /v1/dns/{zone_name}
1394
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1395
1395
  */
1396
- export type GET_DnsZoneName_Request_Body = GET_DnsZoneName_Request['requestBody'];
1396
+ export type GET_DnsZoneName_Request_Path = GET_DnsZoneName_Request['parameters']['path'];
1397
1397
 
1398
1398
  /**
1399
1399
  * Request type for POST DnsZoneNameDnssecDisable endpoint
package/src/openapi.yaml CHANGED
@@ -2497,6 +2497,7 @@ components:
2497
2497
  DomainAttributeKey:
2498
2498
  enum:
2499
2499
  - auto_renew_period
2500
+ - music_registrant_attestation
2500
2501
  title: DomainAttributeKey
2501
2502
  type: string
2502
2503
  DomainAvailability:
@@ -2604,6 +2605,14 @@ components:
2604
2605
  type: string
2605
2606
  DomainCreate:
2606
2607
  properties:
2608
+ attributes:
2609
+ additionalProperties:
2610
+ type: string
2611
+ description: Additional attributes of the domain
2612
+ propertyNames:
2613
+ $ref: '#/components/schemas/DomainAttributeKey'
2614
+ title: Attributes
2615
+ type: object
2607
2616
  auth_code:
2608
2617
  anyOf:
2609
2618
  - maxLength: 32
@@ -2814,6 +2823,14 @@ components:
2814
2823
  type: object
2815
2824
  DomainCreatePayloadData:
2816
2825
  properties:
2826
+ attributes:
2827
+ additionalProperties:
2828
+ type: string
2829
+ description: Additional attributes of the domain
2830
+ propertyNames:
2831
+ $ref: '#/components/schemas/DomainAttributeKey'
2832
+ title: Attributes
2833
+ type: object
2817
2834
  auth_code:
2818
2835
  anyOf:
2819
2836
  - maxLength: 32
@@ -4135,15 +4152,13 @@ components:
4135
4152
  DomainTransferIn:
4136
4153
  properties:
4137
4154
  attributes:
4138
- anyOf:
4139
- - additionalProperties:
4140
- type: string
4141
- propertyNames:
4142
- $ref: '#/components/schemas/DomainAttributeKey'
4143
- type: object
4144
- - type: 'null'
4155
+ additionalProperties:
4156
+ type: string
4145
4157
  description: Additional attributes of the domain
4158
+ propertyNames:
4159
+ $ref: '#/components/schemas/DomainAttributeKey'
4146
4160
  title: Attributes
4161
+ type: object
4147
4162
  auth_code:
4148
4163
  description: The auth code for the domain
4149
4164
  maxLength: 32
@@ -4198,15 +4213,13 @@ components:
4198
4213
  DomainTransferPayloadData:
4199
4214
  properties:
4200
4215
  attributes:
4201
- anyOf:
4202
- - additionalProperties:
4203
- type: string
4204
- propertyNames:
4205
- $ref: '#/components/schemas/DomainAttributeKey'
4206
- type: object
4207
- - type: 'null'
4216
+ additionalProperties:
4217
+ type: string
4208
4218
  description: Additional attributes of the domain
4219
+ propertyNames:
4220
+ $ref: '#/components/schemas/DomainAttributeKey'
4209
4221
  title: Attributes
4222
+ type: object
4210
4223
  auth_code:
4211
4224
  description: The auth code for the domain
4212
4225
  maxLength: 32
@@ -10126,7 +10139,7 @@ info:
10126
10139
  \n\n"
10127
10140
  summary: OpusDNS - your gateway to a seamless domain management experience.
10128
10141
  title: OpusDNS API
10129
- version: 2026-04-24-122704
10142
+ version: 2026-04-24-162344
10130
10143
  x-logo:
10131
10144
  altText: OpusDNS API Reference
10132
10145
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -12690,16 +12703,16 @@ paths:
12690
12703
  description: DNS zone name (trailing dot optional)
12691
12704
  title: Zone Name
12692
12705
  type: string
12693
- requestBody:
12694
- content:
12695
- application/json:
12696
- schema:
12697
- anyOf:
12698
- - items:
12699
- $ref: '#/components/schemas/ZoneIncludeField'
12700
- type: array
12701
- - type: 'null'
12702
- title: Include
12706
+ - in: query
12707
+ name: include
12708
+ required: false
12709
+ schema:
12710
+ anyOf:
12711
+ - items:
12712
+ $ref: '#/components/schemas/ZoneIncludeField'
12713
+ type: array
12714
+ - type: 'null'
12715
+ title: Include
12703
12716
  responses:
12704
12717
  '200':
12705
12718
  content:
@@ -18855,6 +18868,7 @@ paths:
18855
18868
  - command: domain_create
18856
18869
  idempotency_key: scheduled-create-001
18857
18870
  payload:
18871
+ attributes: {}
18858
18872
  contacts:
18859
18873
  admin: contact_01kc433yvre99af2wasxhtpswf
18860
18874
  billing: contact_01kc433yvre99af2wasxhtpswf
@@ -18894,6 +18908,7 @@ paths:
18894
18908
  - command: domain_create
18895
18909
  idempotency_key: create-example-com-001
18896
18910
  payload:
18911
+ attributes: {}
18897
18912
  contacts:
18898
18913
  admin: contact_01kc433yvre99af2wasxhtpswf
18899
18914
  billing: contact_01kc433yvre99af2wasxhtpswf
package/src/schema.d.ts CHANGED
@@ -3942,7 +3942,7 @@ export interface components {
3942
3942
  * DomainAttributeKey
3943
3943
  * @enum {string}
3944
3944
  */
3945
- DomainAttributeKey: "auto_renew_period";
3945
+ DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation";
3946
3946
  /** DomainAvailability */
3947
3947
  DomainAvailability: {
3948
3948
  /** Domain */
@@ -3999,6 +3999,13 @@ export interface components {
3999
3999
  DomainContactType: "registrant" | "admin" | "tech" | "billing";
4000
4000
  /** DomainCreate */
4001
4001
  DomainCreate: {
4002
+ /**
4003
+ * Attributes
4004
+ * @description Additional attributes of the domain
4005
+ */
4006
+ attributes?: {
4007
+ [key: string]: string;
4008
+ };
4002
4009
  /**
4003
4010
  * Auth Code
4004
4011
  * @description The auth code used for the domain
@@ -4149,6 +4156,13 @@ export interface components {
4149
4156
  };
4150
4157
  /** DomainCreatePayloadData */
4151
4158
  DomainCreatePayloadData: {
4159
+ /**
4160
+ * Attributes
4161
+ * @description Additional attributes of the domain
4162
+ */
4163
+ attributes?: {
4164
+ [key: string]: string;
4165
+ };
4152
4166
  /**
4153
4167
  * Auth Code
4154
4168
  * @description The auth code used for the domain
@@ -5005,7 +5019,7 @@ export interface components {
5005
5019
  */
5006
5020
  attributes?: {
5007
5021
  [key: string]: string;
5008
- } | null;
5022
+ };
5009
5023
  /**
5010
5024
  * Auth Code
5011
5025
  * @description The auth code for the domain
@@ -5050,7 +5064,7 @@ export interface components {
5050
5064
  */
5051
5065
  attributes?: {
5052
5066
  [key: string]: string;
5053
- } | null;
5067
+ };
5054
5068
  /**
5055
5069
  * Auth Code
5056
5070
  * @description The auth code for the domain
@@ -10633,7 +10647,9 @@ export interface operations {
10633
10647
  };
10634
10648
  get_zone_v1_dns__zone_name__get: {
10635
10649
  parameters: {
10636
- query?: never;
10650
+ query?: {
10651
+ include?: components["schemas"]["ZoneIncludeField"][] | null;
10652
+ };
10637
10653
  header?: never;
10638
10654
  path: {
10639
10655
  /** @description DNS zone name (trailing dot optional) */
@@ -10641,11 +10657,7 @@ export interface operations {
10641
10657
  };
10642
10658
  cookie?: never;
10643
10659
  };
10644
- requestBody?: {
10645
- content: {
10646
- "application/json": components["schemas"]["ZoneIncludeField"][] | null;
10647
- };
10648
- };
10660
+ requestBody?: never;
10649
10661
  responses: {
10650
10662
  /** @description Successful Response */
10651
10663
  200: {