@opusdns/api 0.294.0 → 0.296.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 +1 -1
- package/src/helpers/keys.ts +57 -8
- package/src/openapi.yaml +32 -27
- package/src/schema.d.ts +14 -30
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -12964,7 +12964,7 @@ export const KEYS_DOMAIN_CREATE_BULK_COMMAND = [
|
|
|
12964
12964
|
*/
|
|
12965
12965
|
export const KEY_DOMAIN_CREATE_BULK_INSTANCE_AUTH_CODE: keyof DomainCreateBulkInstance = 'auth_code';
|
|
12966
12966
|
/**
|
|
12967
|
-
*
|
|
12967
|
+
* contacts property
|
|
12968
12968
|
*
|
|
12969
12969
|
* Override contacts for this domain
|
|
12970
12970
|
*
|
|
@@ -13274,9 +13274,8 @@ export const KEYS_DOMAIN_CREATE_BULK_PAYLOAD = [
|
|
|
13274
13274
|
*/
|
|
13275
13275
|
export const KEY_DOMAIN_CREATE_BULK_TEMPLATE_AUTH_CODE: keyof DomainCreateBulkTemplate = 'auth_code';
|
|
13276
13276
|
/**
|
|
13277
|
-
*
|
|
13277
|
+
* contacts property
|
|
13278
13278
|
*
|
|
13279
|
-
* The contacts of the domain
|
|
13280
13279
|
*
|
|
13281
13280
|
*
|
|
13282
13281
|
*
|
|
@@ -18870,7 +18869,7 @@ export const KEY_DOMAIN_TRANSFER_BULK_INSTANCE_ATTRIBUTES: keyof DomainTransferB
|
|
|
18870
18869
|
*/
|
|
18871
18870
|
export const KEY_DOMAIN_TRANSFER_BULK_INSTANCE_AUTH_CODE: keyof DomainTransferBulkInstance = 'auth_code';
|
|
18872
18871
|
/**
|
|
18873
|
-
*
|
|
18872
|
+
* contacts property
|
|
18874
18873
|
*
|
|
18875
18874
|
* Override contacts for this domain
|
|
18876
18875
|
*
|
|
@@ -19181,9 +19180,8 @@ export const KEYS_DOMAIN_TRANSFER_BULK_PAYLOAD = [
|
|
|
19181
19180
|
*/
|
|
19182
19181
|
export const KEY_DOMAIN_TRANSFER_BULK_TEMPLATE_ATTRIBUTES: keyof DomainTransferBulkTemplate = 'attributes';
|
|
19183
19182
|
/**
|
|
19184
|
-
*
|
|
19183
|
+
* contacts property
|
|
19185
19184
|
*
|
|
19186
|
-
* The contacts of the domain
|
|
19187
19185
|
*
|
|
19188
19186
|
*
|
|
19189
19187
|
*
|
|
@@ -20552,7 +20550,7 @@ export const KEYS_DOMAIN_UPDATE_BULK_COMMAND = [
|
|
|
20552
20550
|
*/
|
|
20553
20551
|
export const KEY_DOMAIN_UPDATE_BULK_INSTANCE_AUTH_CODE: keyof DomainUpdateBulkInstance = 'auth_code';
|
|
20554
20552
|
/**
|
|
20555
|
-
*
|
|
20553
|
+
* contacts property
|
|
20556
20554
|
*
|
|
20557
20555
|
* Override contacts for this domain
|
|
20558
20556
|
*
|
|
@@ -20836,7 +20834,7 @@ export const KEYS_DOMAIN_UPDATE_BULK_PAYLOAD = [
|
|
|
20836
20834
|
] as const satisfies (keyof DomainUpdateBulkPayload)[];
|
|
20837
20835
|
|
|
20838
20836
|
/**
|
|
20839
|
-
*
|
|
20837
|
+
* contacts property
|
|
20840
20838
|
*
|
|
20841
20839
|
* The new contacts of the domain
|
|
20842
20840
|
*
|
|
@@ -43432,6 +43430,55 @@ export const KEYS_USER_WITH_RELATION_PERMISSIONS = [
|
|
|
43432
43430
|
KEY_USER_WITH_RELATION_PERMISSIONS_USERNAME,
|
|
43433
43431
|
] as const satisfies (keyof UserWithRelationPermissions)[];
|
|
43434
43432
|
|
|
43433
|
+
/**
|
|
43434
|
+
* Context
|
|
43435
|
+
*
|
|
43436
|
+
*
|
|
43437
|
+
* @type {object}
|
|
43438
|
+
*
|
|
43439
|
+
*
|
|
43440
|
+
* @remarks
|
|
43441
|
+
* This key constant provides type-safe access to the `ctx` property of ValidationError objects.
|
|
43442
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
43443
|
+
*
|
|
43444
|
+
* @example
|
|
43445
|
+
* ```typescript
|
|
43446
|
+
* // Direct property access
|
|
43447
|
+
* const value = validationerror[KEY_VALIDATION_ERROR_CTX];
|
|
43448
|
+
*
|
|
43449
|
+
* // Dynamic property access
|
|
43450
|
+
* const propertyName = KEY_VALIDATION_ERROR_CTX;
|
|
43451
|
+
* const value = validationerror[propertyName];
|
|
43452
|
+
* ```
|
|
43453
|
+
*
|
|
43454
|
+
* @see {@link ValidationError} - The TypeScript type definition
|
|
43455
|
+
* @see {@link KEYS_VALIDATION_ERROR} - Array of all keys for this type
|
|
43456
|
+
*/
|
|
43457
|
+
export const KEY_VALIDATION_ERROR_CTX: keyof ValidationError = 'ctx';
|
|
43458
|
+
/**
|
|
43459
|
+
* Input
|
|
43460
|
+
*
|
|
43461
|
+
*
|
|
43462
|
+
*
|
|
43463
|
+
*
|
|
43464
|
+
* @remarks
|
|
43465
|
+
* This key constant provides type-safe access to the `input` property of ValidationError objects.
|
|
43466
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
43467
|
+
*
|
|
43468
|
+
* @example
|
|
43469
|
+
* ```typescript
|
|
43470
|
+
* // Direct property access
|
|
43471
|
+
* const value = validationerror[KEY_VALIDATION_ERROR_INPUT];
|
|
43472
|
+
*
|
|
43473
|
+
* // Dynamic property access
|
|
43474
|
+
* const propertyName = KEY_VALIDATION_ERROR_INPUT;
|
|
43475
|
+
* const value = validationerror[propertyName];
|
|
43476
|
+
* ```
|
|
43477
|
+
*
|
|
43478
|
+
* @see {@link ValidationError} - The TypeScript type definition
|
|
43479
|
+
* @see {@link KEYS_VALIDATION_ERROR} - Array of all keys for this type
|
|
43480
|
+
*/
|
|
43481
|
+
export const KEY_VALIDATION_ERROR_INPUT: keyof ValidationError = 'input';
|
|
43435
43482
|
/**
|
|
43436
43483
|
* Location
|
|
43437
43484
|
*
|
|
@@ -43529,6 +43576,8 @@ export const KEY_VALIDATION_ERROR_TYPE: keyof ValidationError = 'type';
|
|
|
43529
43576
|
* @see {@link ValidationError} - The TypeScript type definition
|
|
43530
43577
|
*/
|
|
43531
43578
|
export const KEYS_VALIDATION_ERROR = [
|
|
43579
|
+
KEY_VALIDATION_ERROR_CTX,
|
|
43580
|
+
KEY_VALIDATION_ERROR_INPUT,
|
|
43532
43581
|
KEY_VALIDATION_ERROR_LOC,
|
|
43533
43582
|
KEY_VALIDATION_ERROR_MSG,
|
|
43534
43583
|
KEY_VALIDATION_ERROR_TYPE,
|
package/src/openapi.yaml
CHANGED
|
@@ -3080,10 +3080,8 @@ components:
|
|
|
3080
3080
|
contacts:
|
|
3081
3081
|
anyOf:
|
|
3082
3082
|
- $ref: '#/components/schemas/DomainContactHandles'
|
|
3083
|
-
- $ref: '#/components/schemas/ContactIdList'
|
|
3084
3083
|
- type: 'null'
|
|
3085
3084
|
description: Override contacts for this domain
|
|
3086
|
-
title: Contacts
|
|
3087
3085
|
create_zone:
|
|
3088
3086
|
anyOf:
|
|
3089
3087
|
- type: boolean
|
|
@@ -3152,11 +3150,7 @@ components:
|
|
|
3152
3150
|
description: The auth code used for the domain
|
|
3153
3151
|
title: Auth Code
|
|
3154
3152
|
contacts:
|
|
3155
|
-
|
|
3156
|
-
- $ref: '#/components/schemas/DomainContactHandles'
|
|
3157
|
-
- $ref: '#/components/schemas/ContactIdList'
|
|
3158
|
-
description: The contacts of the domain
|
|
3159
|
-
title: Contacts
|
|
3153
|
+
$ref: '#/components/schemas/DomainContactHandles'
|
|
3160
3154
|
create_zone:
|
|
3161
3155
|
default: false
|
|
3162
3156
|
description: Create a zone on OpusDNS nameserver infrastructure
|
|
@@ -4465,10 +4459,8 @@ components:
|
|
|
4465
4459
|
contacts:
|
|
4466
4460
|
anyOf:
|
|
4467
4461
|
- $ref: '#/components/schemas/DomainContactHandles'
|
|
4468
|
-
- $ref: '#/components/schemas/ContactIdList'
|
|
4469
4462
|
- type: 'null'
|
|
4470
4463
|
description: Override contacts for this domain
|
|
4471
|
-
title: Contacts
|
|
4472
4464
|
create_zone:
|
|
4473
4465
|
anyOf:
|
|
4474
4466
|
- type: boolean
|
|
@@ -4540,11 +4532,7 @@ components:
|
|
|
4540
4532
|
description: Additional attributes of the domain
|
|
4541
4533
|
title: Attributes
|
|
4542
4534
|
contacts:
|
|
4543
|
-
|
|
4544
|
-
- $ref: '#/components/schemas/DomainContactHandles'
|
|
4545
|
-
- $ref: '#/components/schemas/ContactIdList'
|
|
4546
|
-
description: The contacts of the domain
|
|
4547
|
-
title: Contacts
|
|
4535
|
+
$ref: '#/components/schemas/DomainContactHandles'
|
|
4548
4536
|
create_zone:
|
|
4549
4537
|
default: false
|
|
4550
4538
|
description: Create a zone on OpusDNS nameserver infrastructure
|
|
@@ -4853,10 +4841,8 @@ components:
|
|
|
4853
4841
|
contacts:
|
|
4854
4842
|
anyOf:
|
|
4855
4843
|
- $ref: '#/components/schemas/DomainContactHandles'
|
|
4856
|
-
- $ref: '#/components/schemas/ContactIdList'
|
|
4857
4844
|
- type: 'null'
|
|
4858
4845
|
description: Override contacts for this domain
|
|
4859
|
-
title: Contacts
|
|
4860
4846
|
domain_id:
|
|
4861
4847
|
anyOf:
|
|
4862
4848
|
- type: string
|
|
@@ -4920,10 +4906,8 @@ components:
|
|
|
4920
4906
|
contacts:
|
|
4921
4907
|
anyOf:
|
|
4922
4908
|
- $ref: '#/components/schemas/DomainContactHandles'
|
|
4923
|
-
- $ref: '#/components/schemas/ContactIdList'
|
|
4924
4909
|
- type: 'null'
|
|
4925
4910
|
description: The new contacts of the domain
|
|
4926
|
-
title: Contacts
|
|
4927
4911
|
nameservers:
|
|
4928
4912
|
anyOf:
|
|
4929
4913
|
- items:
|
|
@@ -10921,6 +10905,11 @@ components:
|
|
|
10921
10905
|
type: object
|
|
10922
10906
|
ValidationError:
|
|
10923
10907
|
properties:
|
|
10908
|
+
ctx:
|
|
10909
|
+
title: Context
|
|
10910
|
+
type: object
|
|
10911
|
+
input:
|
|
10912
|
+
title: Input
|
|
10924
10913
|
loc:
|
|
10925
10914
|
items:
|
|
10926
10915
|
anyOf:
|
|
@@ -11220,7 +11209,7 @@ info:
|
|
|
11220
11209
|
\n\n"
|
|
11221
11210
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
11222
11211
|
title: OpusDNS API
|
|
11223
|
-
version: 2026-05-
|
|
11212
|
+
version: 2026-05-12-132707
|
|
11224
11213
|
x-logo:
|
|
11225
11214
|
altText: OpusDNS API Reference
|
|
11226
11215
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -21188,10 +21177,18 @@ paths:
|
|
|
21188
21177
|
name: premium-domain.com
|
|
21189
21178
|
template:
|
|
21190
21179
|
contacts:
|
|
21191
|
-
admin:
|
|
21192
|
-
|
|
21193
|
-
|
|
21194
|
-
|
|
21180
|
+
admin:
|
|
21181
|
+
- attributes: {}
|
|
21182
|
+
contact_id: contact_01kc433yvre99af2wasxhtpswf
|
|
21183
|
+
billing:
|
|
21184
|
+
- attributes: {}
|
|
21185
|
+
contact_id: contact_01kc433yvre99af2wasxhtpswf
|
|
21186
|
+
registrant:
|
|
21187
|
+
- attributes: {}
|
|
21188
|
+
contact_id: contact_01kc433yvre99af2wasxhtpswf
|
|
21189
|
+
tech:
|
|
21190
|
+
- attributes: {}
|
|
21191
|
+
contact_id: contact_01kc433yvre99af2wasxhtpswf
|
|
21195
21192
|
create_zone: true
|
|
21196
21193
|
nameservers:
|
|
21197
21194
|
- hostname: ns1.example.com
|
|
@@ -21225,10 +21222,18 @@ paths:
|
|
|
21225
21222
|
name: premium-transfer.com
|
|
21226
21223
|
template:
|
|
21227
21224
|
contacts:
|
|
21228
|
-
admin:
|
|
21229
|
-
|
|
21230
|
-
|
|
21231
|
-
|
|
21225
|
+
admin:
|
|
21226
|
+
- attributes: {}
|
|
21227
|
+
contact_id: contact_01kc433yvre99af2wasxhtpswf
|
|
21228
|
+
billing:
|
|
21229
|
+
- attributes: {}
|
|
21230
|
+
contact_id: contact_01kc433yvre99af2wasxhtpswf
|
|
21231
|
+
registrant:
|
|
21232
|
+
- attributes: {}
|
|
21233
|
+
contact_id: contact_01kc433yvre99af2wasxhtpswf
|
|
21234
|
+
tech:
|
|
21235
|
+
- attributes: {}
|
|
21236
|
+
contact_id: contact_01kc433yvre99af2wasxhtpswf
|
|
21232
21237
|
create_zone: false
|
|
21233
21238
|
nameservers:
|
|
21234
21239
|
- hostname: ns1.example.com
|
package/src/schema.d.ts
CHANGED
|
@@ -4523,11 +4523,8 @@ export interface components {
|
|
|
4523
4523
|
* @description Override auth code for this domain
|
|
4524
4524
|
*/
|
|
4525
4525
|
auth_code?: string | null;
|
|
4526
|
-
/**
|
|
4527
|
-
|
|
4528
|
-
* @description Override contacts for this domain
|
|
4529
|
-
*/
|
|
4530
|
-
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
4526
|
+
/** @description Override contacts for this domain */
|
|
4527
|
+
contacts?: components["schemas"]["DomainContactHandles"] | null;
|
|
4531
4528
|
/**
|
|
4532
4529
|
* Create Zone
|
|
4533
4530
|
* @description Override create_zone for this domain
|
|
@@ -4567,11 +4564,7 @@ export interface components {
|
|
|
4567
4564
|
* @description The auth code used for the domain
|
|
4568
4565
|
*/
|
|
4569
4566
|
auth_code?: string | null;
|
|
4570
|
-
|
|
4571
|
-
* Contacts
|
|
4572
|
-
* @description The contacts of the domain
|
|
4573
|
-
*/
|
|
4574
|
-
contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
|
|
4567
|
+
contacts: components["schemas"]["DomainContactHandles"];
|
|
4575
4568
|
/**
|
|
4576
4569
|
* Create Zone
|
|
4577
4570
|
* @description Create a zone on OpusDNS nameserver infrastructure
|
|
@@ -5414,11 +5407,8 @@ export interface components {
|
|
|
5414
5407
|
* @description The auth code for this domain (required)
|
|
5415
5408
|
*/
|
|
5416
5409
|
auth_code: string;
|
|
5417
|
-
/**
|
|
5418
|
-
|
|
5419
|
-
* @description Override contacts for this domain
|
|
5420
|
-
*/
|
|
5421
|
-
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
5410
|
+
/** @description Override contacts for this domain */
|
|
5411
|
+
contacts?: components["schemas"]["DomainContactHandles"] | null;
|
|
5422
5412
|
/**
|
|
5423
5413
|
* Create Zone
|
|
5424
5414
|
* @description Override create_zone for this domain
|
|
@@ -5460,11 +5450,7 @@ export interface components {
|
|
|
5460
5450
|
attributes?: {
|
|
5461
5451
|
[key: string]: string;
|
|
5462
5452
|
} | null;
|
|
5463
|
-
|
|
5464
|
-
* Contacts
|
|
5465
|
-
* @description The contacts of the domain
|
|
5466
|
-
*/
|
|
5467
|
-
contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
|
|
5453
|
+
contacts: components["schemas"]["DomainContactHandles"];
|
|
5468
5454
|
/**
|
|
5469
5455
|
* Create Zone
|
|
5470
5456
|
* @description Create a zone on OpusDNS nameserver infrastructure
|
|
@@ -5685,11 +5671,8 @@ export interface components {
|
|
|
5685
5671
|
* @description Override auth code for this domain
|
|
5686
5672
|
*/
|
|
5687
5673
|
auth_code?: string | null;
|
|
5688
|
-
/**
|
|
5689
|
-
|
|
5690
|
-
* @description Override contacts for this domain
|
|
5691
|
-
*/
|
|
5692
|
-
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
5674
|
+
/** @description Override contacts for this domain */
|
|
5675
|
+
contacts?: components["schemas"]["DomainContactHandles"] | null;
|
|
5693
5676
|
/**
|
|
5694
5677
|
* Domain Id
|
|
5695
5678
|
* @description The domain ID to update
|
|
@@ -5727,11 +5710,8 @@ export interface components {
|
|
|
5727
5710
|
};
|
|
5728
5711
|
/** DomainUpdateBulkTemplate */
|
|
5729
5712
|
DomainUpdateBulkTemplate: {
|
|
5730
|
-
/**
|
|
5731
|
-
|
|
5732
|
-
* @description The new contacts of the domain
|
|
5733
|
-
*/
|
|
5734
|
-
contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
|
|
5713
|
+
/** @description The new contacts of the domain */
|
|
5714
|
+
contacts?: components["schemas"]["DomainContactHandles"] | null;
|
|
5735
5715
|
/**
|
|
5736
5716
|
* Nameservers
|
|
5737
5717
|
* @description The new name servers for the domain
|
|
@@ -9742,6 +9722,10 @@ export interface components {
|
|
|
9742
9722
|
};
|
|
9743
9723
|
/** ValidationError */
|
|
9744
9724
|
ValidationError: {
|
|
9725
|
+
/** Context */
|
|
9726
|
+
ctx?: Record<string, never>;
|
|
9727
|
+
/** Input */
|
|
9728
|
+
input?: unknown;
|
|
9745
9729
|
/** Location */
|
|
9746
9730
|
loc: (string | number)[];
|
|
9747
9731
|
/** Message */
|