@opusdns/api 0.121.0 → 0.122.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 +262 -105
- package/src/helpers/requests.d.ts +38 -0
- package/src/helpers/responses.d.ts +92 -1
- package/src/helpers/schemas.d.ts +32 -16
- package/src/openapi.yaml +120 -23
- package/src/schema.d.ts +130 -19
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -147,7 +147,6 @@ import { PublicAuthRequestForm } from './schemas';
|
|
|
147
147
|
import { RdapBase } from './schemas';
|
|
148
148
|
import { RegistryLockBase } from './schemas';
|
|
149
149
|
import { RelationSet } from './schemas';
|
|
150
|
-
import { RequestAuthcode } from './schemas';
|
|
151
150
|
import { RequestHistory } from './schemas';
|
|
152
151
|
import { ReservedDomainsBase } from './schemas';
|
|
153
152
|
import { RgpOperations } from './schemas';
|
|
@@ -169,6 +168,8 @@ import { UserWithRelationPermissions } from './schemas';
|
|
|
169
168
|
import { ValidationError } from './schemas';
|
|
170
169
|
import { WhoisBase } from './schemas';
|
|
171
170
|
import { WildcardHttpRedirectRequest } from './schemas';
|
|
171
|
+
import { RequestAuthcode } from './schemas';
|
|
172
|
+
import { RequestAuthcode2 } from './schemas';
|
|
172
173
|
import { DomainAvailabilityList } from './schemas';
|
|
173
174
|
import { DomainAvailabilityCheck } from './schemas';
|
|
174
175
|
|
|
@@ -18443,110 +18444,6 @@ export const KEYS_RELATION_SET = [
|
|
|
18443
18444
|
KEY_RELATION_SET_RELATIONS,
|
|
18444
18445
|
] as const satisfies (keyof RelationSet)[];
|
|
18445
18446
|
|
|
18446
|
-
/**
|
|
18447
|
-
* Detail
|
|
18448
|
-
*
|
|
18449
|
-
* Additional information about the result in case of failure
|
|
18450
|
-
*
|
|
18451
|
-
*
|
|
18452
|
-
*
|
|
18453
|
-
* @remarks
|
|
18454
|
-
* This key constant provides type-safe access to the `detail` property of RequestAuthcode objects.
|
|
18455
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18456
|
-
*
|
|
18457
|
-
* @example
|
|
18458
|
-
* ```typescript
|
|
18459
|
-
* // Direct property access
|
|
18460
|
-
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_DETAIL];
|
|
18461
|
-
*
|
|
18462
|
-
* // Dynamic property access
|
|
18463
|
-
* const propertyName = KEY_REQUEST_AUTHCODE_DETAIL;
|
|
18464
|
-
* const value = requestauthcode[propertyName];
|
|
18465
|
-
* ```
|
|
18466
|
-
*
|
|
18467
|
-
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
18468
|
-
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
18469
|
-
*/
|
|
18470
|
-
export const KEY_REQUEST_AUTHCODE_DETAIL = 'detail' as keyof RequestAuthcode;
|
|
18471
|
-
/**
|
|
18472
|
-
* Name
|
|
18473
|
-
*
|
|
18474
|
-
* The domain name that had the auth code requested
|
|
18475
|
-
*
|
|
18476
|
-
* @type {string}
|
|
18477
|
-
*
|
|
18478
|
-
*
|
|
18479
|
-
* @remarks
|
|
18480
|
-
* This key constant provides type-safe access to the `name` property of RequestAuthcode objects.
|
|
18481
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18482
|
-
*
|
|
18483
|
-
* @example
|
|
18484
|
-
* ```typescript
|
|
18485
|
-
* // Direct property access
|
|
18486
|
-
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_NAME];
|
|
18487
|
-
*
|
|
18488
|
-
* // Dynamic property access
|
|
18489
|
-
* const propertyName = KEY_REQUEST_AUTHCODE_NAME;
|
|
18490
|
-
* const value = requestauthcode[propertyName];
|
|
18491
|
-
* ```
|
|
18492
|
-
*
|
|
18493
|
-
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
18494
|
-
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
18495
|
-
*/
|
|
18496
|
-
export const KEY_REQUEST_AUTHCODE_NAME = 'name' as keyof RequestAuthcode;
|
|
18497
|
-
/**
|
|
18498
|
-
* Success
|
|
18499
|
-
*
|
|
18500
|
-
* Whether the request had a successful result from DNS Belgium
|
|
18501
|
-
*
|
|
18502
|
-
* @type {boolean}
|
|
18503
|
-
*
|
|
18504
|
-
*
|
|
18505
|
-
* @remarks
|
|
18506
|
-
* This key constant provides type-safe access to the `success` property of RequestAuthcode objects.
|
|
18507
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18508
|
-
*
|
|
18509
|
-
* @example
|
|
18510
|
-
* ```typescript
|
|
18511
|
-
* // Direct property access
|
|
18512
|
-
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_SUCCESS];
|
|
18513
|
-
*
|
|
18514
|
-
* // Dynamic property access
|
|
18515
|
-
* const propertyName = KEY_REQUEST_AUTHCODE_SUCCESS;
|
|
18516
|
-
* const value = requestauthcode[propertyName];
|
|
18517
|
-
* ```
|
|
18518
|
-
*
|
|
18519
|
-
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
18520
|
-
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
18521
|
-
*/
|
|
18522
|
-
export const KEY_REQUEST_AUTHCODE_SUCCESS = 'success' as keyof RequestAuthcode;
|
|
18523
|
-
|
|
18524
|
-
/**
|
|
18525
|
-
* Array of all RequestAuthcode property keys
|
|
18526
|
-
*
|
|
18527
|
-
* @remarks
|
|
18528
|
-
* This constant provides a readonly array containing all valid property keys for RequestAuthcode objects.
|
|
18529
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
18530
|
-
*
|
|
18531
|
-
* @example
|
|
18532
|
-
* ```typescript
|
|
18533
|
-
* // Iterating through all keys
|
|
18534
|
-
* for (const key of KEYS_REQUEST_AUTHCODE) {
|
|
18535
|
-
* console.log(`Property: ${key}, Value: ${requestauthcode[key]}`);
|
|
18536
|
-
* }
|
|
18537
|
-
*
|
|
18538
|
-
* // Validation
|
|
18539
|
-
* const isValidKey = KEYS_REQUEST_AUTHCODE.includes(someKey);
|
|
18540
|
-
* ```
|
|
18541
|
-
*
|
|
18542
|
-
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
18543
|
-
*/
|
|
18544
|
-
export const KEYS_REQUEST_AUTHCODE = [
|
|
18545
|
-
KEY_REQUEST_AUTHCODE_DETAIL,
|
|
18546
|
-
KEY_REQUEST_AUTHCODE_NAME,
|
|
18547
|
-
KEY_REQUEST_AUTHCODE_SUCCESS,
|
|
18548
|
-
] as const satisfies (keyof RequestAuthcode)[];
|
|
18549
|
-
|
|
18550
18447
|
/**
|
|
18551
18448
|
* Client Ip
|
|
18552
18449
|
*
|
|
@@ -22574,6 +22471,266 @@ export const KEYS_WILDCARD_HTTP_REDIRECT_REQUEST = [
|
|
|
22574
22471
|
KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PROTOCOL,
|
|
22575
22472
|
] as const satisfies (keyof WildcardHttpRedirectRequest)[];
|
|
22576
22473
|
|
|
22474
|
+
/**
|
|
22475
|
+
* Detail
|
|
22476
|
+
*
|
|
22477
|
+
* Additional information about the result in case of failure
|
|
22478
|
+
*
|
|
22479
|
+
*
|
|
22480
|
+
*
|
|
22481
|
+
* @remarks
|
|
22482
|
+
* This key constant provides type-safe access to the `detail` property of RequestAuthcode objects.
|
|
22483
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22484
|
+
*
|
|
22485
|
+
* @example
|
|
22486
|
+
* ```typescript
|
|
22487
|
+
* // Direct property access
|
|
22488
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_DETAIL];
|
|
22489
|
+
*
|
|
22490
|
+
* // Dynamic property access
|
|
22491
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_DETAIL;
|
|
22492
|
+
* const value = requestauthcode[propertyName];
|
|
22493
|
+
* ```
|
|
22494
|
+
*
|
|
22495
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
22496
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
22497
|
+
*/
|
|
22498
|
+
export const KEY_REQUEST_AUTHCODE_DETAIL = 'detail' as keyof RequestAuthcode;
|
|
22499
|
+
/**
|
|
22500
|
+
* Name
|
|
22501
|
+
*
|
|
22502
|
+
* The domain name that had the auth code requested
|
|
22503
|
+
*
|
|
22504
|
+
* @type {string}
|
|
22505
|
+
*
|
|
22506
|
+
*
|
|
22507
|
+
* @remarks
|
|
22508
|
+
* This key constant provides type-safe access to the `name` property of RequestAuthcode objects.
|
|
22509
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22510
|
+
*
|
|
22511
|
+
* @example
|
|
22512
|
+
* ```typescript
|
|
22513
|
+
* // Direct property access
|
|
22514
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_NAME];
|
|
22515
|
+
*
|
|
22516
|
+
* // Dynamic property access
|
|
22517
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_NAME;
|
|
22518
|
+
* const value = requestauthcode[propertyName];
|
|
22519
|
+
* ```
|
|
22520
|
+
*
|
|
22521
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
22522
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
22523
|
+
*/
|
|
22524
|
+
export const KEY_REQUEST_AUTHCODE_NAME = 'name' as keyof RequestAuthcode;
|
|
22525
|
+
/**
|
|
22526
|
+
* Success
|
|
22527
|
+
*
|
|
22528
|
+
* Whether the request had a successful result from DNS Belgium
|
|
22529
|
+
*
|
|
22530
|
+
* @type {boolean}
|
|
22531
|
+
*
|
|
22532
|
+
*
|
|
22533
|
+
* @remarks
|
|
22534
|
+
* This key constant provides type-safe access to the `success` property of RequestAuthcode objects.
|
|
22535
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22536
|
+
*
|
|
22537
|
+
* @example
|
|
22538
|
+
* ```typescript
|
|
22539
|
+
* // Direct property access
|
|
22540
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_SUCCESS];
|
|
22541
|
+
*
|
|
22542
|
+
* // Dynamic property access
|
|
22543
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_SUCCESS;
|
|
22544
|
+
* const value = requestauthcode[propertyName];
|
|
22545
|
+
* ```
|
|
22546
|
+
*
|
|
22547
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
22548
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
22549
|
+
*/
|
|
22550
|
+
export const KEY_REQUEST_AUTHCODE_SUCCESS = 'success' as keyof RequestAuthcode;
|
|
22551
|
+
|
|
22552
|
+
/**
|
|
22553
|
+
* Array of all RequestAuthcode property keys
|
|
22554
|
+
*
|
|
22555
|
+
* @remarks
|
|
22556
|
+
* This constant provides a readonly array containing all valid property keys for RequestAuthcode objects.
|
|
22557
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
22558
|
+
*
|
|
22559
|
+
* @example
|
|
22560
|
+
* ```typescript
|
|
22561
|
+
* // Iterating through all keys
|
|
22562
|
+
* for (const key of KEYS_REQUEST_AUTHCODE) {
|
|
22563
|
+
* console.log(`Property: ${key}, Value: ${requestauthcode[key]}`);
|
|
22564
|
+
* }
|
|
22565
|
+
*
|
|
22566
|
+
* // Validation
|
|
22567
|
+
* const isValidKey = KEYS_REQUEST_AUTHCODE.includes(someKey);
|
|
22568
|
+
* ```
|
|
22569
|
+
*
|
|
22570
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
22571
|
+
*/
|
|
22572
|
+
export const KEYS_REQUEST_AUTHCODE = [
|
|
22573
|
+
KEY_REQUEST_AUTHCODE_DETAIL,
|
|
22574
|
+
KEY_REQUEST_AUTHCODE_NAME,
|
|
22575
|
+
KEY_REQUEST_AUTHCODE_SUCCESS,
|
|
22576
|
+
] as const satisfies (keyof RequestAuthcode)[];
|
|
22577
|
+
|
|
22578
|
+
/**
|
|
22579
|
+
* Auth Code
|
|
22580
|
+
*
|
|
22581
|
+
* The auth code returned by EURid
|
|
22582
|
+
*
|
|
22583
|
+
*
|
|
22584
|
+
*
|
|
22585
|
+
* @remarks
|
|
22586
|
+
* This key constant provides type-safe access to the `auth_code` property of RequestAuthcode2 objects.
|
|
22587
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22588
|
+
*
|
|
22589
|
+
* @example
|
|
22590
|
+
* ```typescript
|
|
22591
|
+
* // Direct property access
|
|
22592
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_AUTH_CODE];
|
|
22593
|
+
*
|
|
22594
|
+
* // Dynamic property access
|
|
22595
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_AUTH_CODE;
|
|
22596
|
+
* const value = requestauthcode2[propertyName];
|
|
22597
|
+
* ```
|
|
22598
|
+
*
|
|
22599
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22600
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22601
|
+
*/
|
|
22602
|
+
export const KEY_REQUEST_AUTHCODE2_AUTH_CODE = 'auth_code' as keyof RequestAuthcode2;
|
|
22603
|
+
/**
|
|
22604
|
+
* Auth Code Expires On
|
|
22605
|
+
*
|
|
22606
|
+
* The expiry date of the auth code
|
|
22607
|
+
*
|
|
22608
|
+
*
|
|
22609
|
+
*
|
|
22610
|
+
* @remarks
|
|
22611
|
+
* This key constant provides type-safe access to the `auth_code_expires_on` property of RequestAuthcode2 objects.
|
|
22612
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22613
|
+
*
|
|
22614
|
+
* @example
|
|
22615
|
+
* ```typescript
|
|
22616
|
+
* // Direct property access
|
|
22617
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_AUTH_CODE_EXPIRES_ON];
|
|
22618
|
+
*
|
|
22619
|
+
* // Dynamic property access
|
|
22620
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_AUTH_CODE_EXPIRES_ON;
|
|
22621
|
+
* const value = requestauthcode2[propertyName];
|
|
22622
|
+
* ```
|
|
22623
|
+
*
|
|
22624
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22625
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22626
|
+
*/
|
|
22627
|
+
export const KEY_REQUEST_AUTHCODE2_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' as keyof RequestAuthcode2;
|
|
22628
|
+
/**
|
|
22629
|
+
* Detail
|
|
22630
|
+
*
|
|
22631
|
+
* Additional information about the result in case of failure
|
|
22632
|
+
*
|
|
22633
|
+
*
|
|
22634
|
+
*
|
|
22635
|
+
* @remarks
|
|
22636
|
+
* This key constant provides type-safe access to the `detail` property of RequestAuthcode2 objects.
|
|
22637
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22638
|
+
*
|
|
22639
|
+
* @example
|
|
22640
|
+
* ```typescript
|
|
22641
|
+
* // Direct property access
|
|
22642
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_DETAIL];
|
|
22643
|
+
*
|
|
22644
|
+
* // Dynamic property access
|
|
22645
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_DETAIL;
|
|
22646
|
+
* const value = requestauthcode2[propertyName];
|
|
22647
|
+
* ```
|
|
22648
|
+
*
|
|
22649
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22650
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22651
|
+
*/
|
|
22652
|
+
export const KEY_REQUEST_AUTHCODE2_DETAIL = 'detail' as keyof RequestAuthcode2;
|
|
22653
|
+
/**
|
|
22654
|
+
* Name
|
|
22655
|
+
*
|
|
22656
|
+
* The domain name that had the auth code requested
|
|
22657
|
+
*
|
|
22658
|
+
* @type {string}
|
|
22659
|
+
*
|
|
22660
|
+
*
|
|
22661
|
+
* @remarks
|
|
22662
|
+
* This key constant provides type-safe access to the `name` property of RequestAuthcode2 objects.
|
|
22663
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22664
|
+
*
|
|
22665
|
+
* @example
|
|
22666
|
+
* ```typescript
|
|
22667
|
+
* // Direct property access
|
|
22668
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_NAME];
|
|
22669
|
+
*
|
|
22670
|
+
* // Dynamic property access
|
|
22671
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_NAME;
|
|
22672
|
+
* const value = requestauthcode2[propertyName];
|
|
22673
|
+
* ```
|
|
22674
|
+
*
|
|
22675
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22676
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22677
|
+
*/
|
|
22678
|
+
export const KEY_REQUEST_AUTHCODE2_NAME = 'name' as keyof RequestAuthcode2;
|
|
22679
|
+
/**
|
|
22680
|
+
* Success
|
|
22681
|
+
*
|
|
22682
|
+
* Whether the request had a successful result from EURid
|
|
22683
|
+
*
|
|
22684
|
+
* @type {boolean}
|
|
22685
|
+
*
|
|
22686
|
+
*
|
|
22687
|
+
* @remarks
|
|
22688
|
+
* This key constant provides type-safe access to the `success` property of RequestAuthcode2 objects.
|
|
22689
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22690
|
+
*
|
|
22691
|
+
* @example
|
|
22692
|
+
* ```typescript
|
|
22693
|
+
* // Direct property access
|
|
22694
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_SUCCESS];
|
|
22695
|
+
*
|
|
22696
|
+
* // Dynamic property access
|
|
22697
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_SUCCESS;
|
|
22698
|
+
* const value = requestauthcode2[propertyName];
|
|
22699
|
+
* ```
|
|
22700
|
+
*
|
|
22701
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22702
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22703
|
+
*/
|
|
22704
|
+
export const KEY_REQUEST_AUTHCODE2_SUCCESS = 'success' as keyof RequestAuthcode2;
|
|
22705
|
+
|
|
22706
|
+
/**
|
|
22707
|
+
* Array of all RequestAuthcode2 property keys
|
|
22708
|
+
*
|
|
22709
|
+
* @remarks
|
|
22710
|
+
* This constant provides a readonly array containing all valid property keys for RequestAuthcode2 objects.
|
|
22711
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
22712
|
+
*
|
|
22713
|
+
* @example
|
|
22714
|
+
* ```typescript
|
|
22715
|
+
* // Iterating through all keys
|
|
22716
|
+
* for (const key of KEYS_REQUEST_AUTHCODE2) {
|
|
22717
|
+
* console.log(`Property: ${key}, Value: ${requestauthcode2[key]}`);
|
|
22718
|
+
* }
|
|
22719
|
+
*
|
|
22720
|
+
* // Validation
|
|
22721
|
+
* const isValidKey = KEYS_REQUEST_AUTHCODE2.includes(someKey);
|
|
22722
|
+
* ```
|
|
22723
|
+
*
|
|
22724
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22725
|
+
*/
|
|
22726
|
+
export const KEYS_REQUEST_AUTHCODE2 = [
|
|
22727
|
+
KEY_REQUEST_AUTHCODE2_AUTH_CODE,
|
|
22728
|
+
KEY_REQUEST_AUTHCODE2_AUTH_CODE_EXPIRES_ON,
|
|
22729
|
+
KEY_REQUEST_AUTHCODE2_DETAIL,
|
|
22730
|
+
KEY_REQUEST_AUTHCODE2_NAME,
|
|
22731
|
+
KEY_REQUEST_AUTHCODE2_SUCCESS,
|
|
22732
|
+
] as const satisfies (keyof RequestAuthcode2)[];
|
|
22733
|
+
|
|
22577
22734
|
/**
|
|
22578
22735
|
* meta property
|
|
22579
22736
|
*
|
|
@@ -2734,6 +2734,44 @@ export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Path = POST_
|
|
|
2734
2734
|
*/
|
|
2735
2735
|
export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Body = POST_DomainsTldSpecificDeDomainReferenceTransit_Request['requestBody'];
|
|
2736
2736
|
|
|
2737
|
+
/**
|
|
2738
|
+
* Request type for POST DomainsTldSpecificEuDomainReferenceAuthCodeRequest endpoint
|
|
2739
|
+
*
|
|
2740
|
+
* Requests your auth code directly from EURid (registry)
|
|
2741
|
+
*
|
|
2742
|
+
* @remarks
|
|
2743
|
+
* This type defines the complete request structure for the POST DomainsTldSpecificEuDomainReferenceAuthCodeRequest endpoint.
|
|
2744
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2745
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2746
|
+
*
|
|
2747
|
+
* @example
|
|
2748
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2749
|
+
*
|
|
2750
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
2751
|
+
*
|
|
2752
|
+
* @see {@link POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request_Query} - Query parameters type
|
|
2753
|
+
* @see {@link POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request_Path} - Path parameters type
|
|
2754
|
+
* @see {@link POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request_Body} - Request body type
|
|
2755
|
+
*/
|
|
2756
|
+
export type POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request = {
|
|
2757
|
+
parameters: {
|
|
2758
|
+
path: operations['request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post']['parameters']['path'];
|
|
2759
|
+
};
|
|
2760
|
+
}
|
|
2761
|
+
/**
|
|
2762
|
+
* Path parameters for POST /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
2763
|
+
*
|
|
2764
|
+
* @remarks
|
|
2765
|
+
* This type defines the path parameters for the POST /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request endpoint.
|
|
2766
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2767
|
+
*
|
|
2768
|
+
* @example
|
|
2769
|
+
* Use this type to ensure type safety for path parameters.
|
|
2770
|
+
*
|
|
2771
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
2772
|
+
*/
|
|
2773
|
+
export type POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request['parameters']['path'];
|
|
2774
|
+
|
|
2737
2775
|
/**
|
|
2738
2776
|
* Request type for POST DomainsTransfer endpoint
|
|
2739
2777
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
@@ -4896,6 +4896,97 @@ export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_404 = Pro
|
|
|
4896
4896
|
*/
|
|
4897
4897
|
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422 = HTTPValidationError
|
|
4898
4898
|
|
|
4899
|
+
/**
|
|
4900
|
+
* Response types for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
|
|
4901
|
+
*
|
|
4902
|
+
* Requests your auth code directly from EURid (registry)
|
|
4903
|
+
*
|
|
4904
|
+
* @remarks
|
|
4905
|
+
* This type defines all possible response structures for the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
|
|
4906
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4907
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4908
|
+
*
|
|
4909
|
+
|
|
4910
|
+
*
|
|
4911
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
4912
|
+
*
|
|
4913
|
+
* @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200} - 200 response type
|
|
4914
|
+
* @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_400} - 400 response type
|
|
4915
|
+
* @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_404} - 404 response type
|
|
4916
|
+
* @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_422} - 422 response type
|
|
4917
|
+
*
|
|
4918
|
+
|
|
4919
|
+
*/
|
|
4920
|
+
export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_422;
|
|
4921
|
+
|
|
4922
|
+
/**
|
|
4923
|
+
* 200 response for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
|
|
4924
|
+
*
|
|
4925
|
+
* @remarks
|
|
4926
|
+
* This type defines the response structure for the 200 status code
|
|
4927
|
+
* of the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
|
|
4928
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4929
|
+
*
|
|
4930
|
+
|
|
4931
|
+
*
|
|
4932
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
4933
|
+
*
|
|
4934
|
+
* @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4935
|
+
* @see {@link RequestAuthcode2} - The actual schema type definition
|
|
4936
|
+
*/
|
|
4937
|
+
export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode2
|
|
4938
|
+
|
|
4939
|
+
/**
|
|
4940
|
+
* 400 response for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
|
|
4941
|
+
*
|
|
4942
|
+
* @remarks
|
|
4943
|
+
* This type defines the response structure for the 400 status code
|
|
4944
|
+
* of the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
|
|
4945
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4946
|
+
*
|
|
4947
|
+
|
|
4948
|
+
*
|
|
4949
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
4950
|
+
*
|
|
4951
|
+
* @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4952
|
+
* @see {@link Problem} - The actual schema type definition
|
|
4953
|
+
*/
|
|
4954
|
+
export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_400 = Problem
|
|
4955
|
+
|
|
4956
|
+
/**
|
|
4957
|
+
* 404 response for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
|
|
4958
|
+
*
|
|
4959
|
+
* @remarks
|
|
4960
|
+
* This type defines the response structure for the 404 status code
|
|
4961
|
+
* of the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
|
|
4962
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4963
|
+
*
|
|
4964
|
+
|
|
4965
|
+
*
|
|
4966
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
4967
|
+
*
|
|
4968
|
+
* @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4969
|
+
* @see {@link Problem} - The actual schema type definition
|
|
4970
|
+
*/
|
|
4971
|
+
export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_404 = Problem
|
|
4972
|
+
|
|
4973
|
+
/**
|
|
4974
|
+
* 422 response for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
|
|
4975
|
+
*
|
|
4976
|
+
* @remarks
|
|
4977
|
+
* This type defines the response structure for the 422 status code
|
|
4978
|
+
* of the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
|
|
4979
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4980
|
+
*
|
|
4981
|
+
|
|
4982
|
+
*
|
|
4983
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
4984
|
+
*
|
|
4985
|
+
* @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4986
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4987
|
+
*/
|
|
4988
|
+
export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError
|
|
4989
|
+
|
|
4899
4990
|
/**
|
|
4900
4991
|
* Response types for POST DomainsTransfer endpoint
|
|
4901
4992
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -3119,22 +3119,6 @@ export type RelationSet = components['schemas']['RelationSet'];
|
|
|
3119
3119
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3120
3120
|
*/
|
|
3121
3121
|
export type RenewalMode = components['schemas']['RenewalMode'];
|
|
3122
|
-
/**
|
|
3123
|
-
* RequestAuthcodeResponse
|
|
3124
|
-
*
|
|
3125
|
-
* @remarks
|
|
3126
|
-
* Type alias for the `RequestAuthcodeResponse` OpenAPI schema.
|
|
3127
|
-
* This type represents requestauthcoderesponse data structures used in API requests and responses.
|
|
3128
|
-
*
|
|
3129
|
-
* @example
|
|
3130
|
-
* ```typescript
|
|
3131
|
-
* const response = await api.getRequestAuthcode();
|
|
3132
|
-
* const item: RequestAuthcode = response.results;
|
|
3133
|
-
* ```
|
|
3134
|
-
*
|
|
3135
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
3136
|
-
*/
|
|
3137
|
-
export type RequestAuthcode = components['schemas']['RequestAuthcodeResponse'];
|
|
3138
3122
|
/**
|
|
3139
3123
|
* RequestHistory
|
|
3140
3124
|
*
|
|
@@ -3615,6 +3599,38 @@ export type WildcardHttpRedirectRequest = components['schemas']['WildcardHttpRed
|
|
|
3615
3599
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3616
3600
|
*/
|
|
3617
3601
|
export type ZoneSortField = components['schemas']['ZoneSortField'];
|
|
3602
|
+
/**
|
|
3603
|
+
* RequestAuthcodeResponse
|
|
3604
|
+
*
|
|
3605
|
+
* @remarks
|
|
3606
|
+
* Type alias for the `api__domain__tld_specific__be__models__RequestAuthcodeResponse` OpenAPI schema.
|
|
3607
|
+
* This type represents requestauthcoderesponse data structures used in API requests and responses.
|
|
3608
|
+
*
|
|
3609
|
+
* @example
|
|
3610
|
+
* ```typescript
|
|
3611
|
+
* const response = await api.getRequestAuthcode();
|
|
3612
|
+
* const item: RequestAuthcode = response.results;
|
|
3613
|
+
* ```
|
|
3614
|
+
*
|
|
3615
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3616
|
+
*/
|
|
3617
|
+
export type RequestAuthcode = components['schemas']['api__domain__tld_specific__be__models__RequestAuthcodeResponse'];
|
|
3618
|
+
/**
|
|
3619
|
+
* RequestAuthcodeResponse
|
|
3620
|
+
*
|
|
3621
|
+
* @remarks
|
|
3622
|
+
* Type alias for the `api__domain__tld_specific__eu__models__RequestAuthcodeResponse` OpenAPI schema.
|
|
3623
|
+
* This type represents requestauthcoderesponse data structures used in API requests and responses.
|
|
3624
|
+
*
|
|
3625
|
+
* @example
|
|
3626
|
+
* ```typescript
|
|
3627
|
+
* const response = await api.getRequestAuthcode2();
|
|
3628
|
+
* const item: RequestAuthcode2 = response.results;
|
|
3629
|
+
* ```
|
|
3630
|
+
*
|
|
3631
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3632
|
+
*/
|
|
3633
|
+
export type RequestAuthcode2 = components['schemas']['api__domain__tld_specific__eu__models__RequestAuthcodeResponse'];
|
|
3618
3634
|
/**
|
|
3619
3635
|
* DomainAvailabilityResponse
|
|
3620
3636
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -4797,27 +4797,6 @@ components:
|
|
|
4797
4797
|
- delete
|
|
4798
4798
|
title: RenewalMode
|
|
4799
4799
|
type: string
|
|
4800
|
-
RequestAuthcodeResponse:
|
|
4801
|
-
properties:
|
|
4802
|
-
detail:
|
|
4803
|
-
anyOf:
|
|
4804
|
-
- type: string
|
|
4805
|
-
- type: 'null'
|
|
4806
|
-
description: Additional information about the result in case of failure
|
|
4807
|
-
title: Detail
|
|
4808
|
-
name:
|
|
4809
|
-
description: The domain name that had the auth code requested
|
|
4810
|
-
title: Name
|
|
4811
|
-
type: string
|
|
4812
|
-
success:
|
|
4813
|
-
description: Whether the request had a successful result from DNS Belgium
|
|
4814
|
-
title: Success
|
|
4815
|
-
type: boolean
|
|
4816
|
-
required:
|
|
4817
|
-
- name
|
|
4818
|
-
- success
|
|
4819
|
-
title: RequestAuthcodeResponse
|
|
4820
|
-
type: object
|
|
4821
4800
|
RequestHistory:
|
|
4822
4801
|
properties:
|
|
4823
4802
|
client_ip:
|
|
@@ -5812,6 +5791,61 @@ components:
|
|
|
5812
5791
|
- dnssec_status
|
|
5813
5792
|
title: ZoneSortField
|
|
5814
5793
|
type: string
|
|
5794
|
+
api__domain__tld_specific__be__models__RequestAuthcodeResponse:
|
|
5795
|
+
properties:
|
|
5796
|
+
detail:
|
|
5797
|
+
anyOf:
|
|
5798
|
+
- type: string
|
|
5799
|
+
- type: 'null'
|
|
5800
|
+
description: Additional information about the result in case of failure
|
|
5801
|
+
title: Detail
|
|
5802
|
+
name:
|
|
5803
|
+
description: The domain name that had the auth code requested
|
|
5804
|
+
title: Name
|
|
5805
|
+
type: string
|
|
5806
|
+
success:
|
|
5807
|
+
description: Whether the request had a successful result from DNS Belgium
|
|
5808
|
+
title: Success
|
|
5809
|
+
type: boolean
|
|
5810
|
+
required:
|
|
5811
|
+
- name
|
|
5812
|
+
- success
|
|
5813
|
+
title: RequestAuthcodeResponse
|
|
5814
|
+
type: object
|
|
5815
|
+
api__domain__tld_specific__eu__models__RequestAuthcodeResponse:
|
|
5816
|
+
properties:
|
|
5817
|
+
auth_code:
|
|
5818
|
+
anyOf:
|
|
5819
|
+
- type: string
|
|
5820
|
+
- type: 'null'
|
|
5821
|
+
description: The auth code returned by EURid
|
|
5822
|
+
title: Auth Code
|
|
5823
|
+
auth_code_expires_on:
|
|
5824
|
+
anyOf:
|
|
5825
|
+
- format: date-time
|
|
5826
|
+
type: string
|
|
5827
|
+
- type: 'null'
|
|
5828
|
+
description: The expiry date of the auth code
|
|
5829
|
+
title: Auth Code Expires On
|
|
5830
|
+
detail:
|
|
5831
|
+
anyOf:
|
|
5832
|
+
- type: string
|
|
5833
|
+
- type: 'null'
|
|
5834
|
+
description: Additional information about the result in case of failure
|
|
5835
|
+
title: Detail
|
|
5836
|
+
name:
|
|
5837
|
+
description: The domain name that had the auth code requested
|
|
5838
|
+
title: Name
|
|
5839
|
+
type: string
|
|
5840
|
+
success:
|
|
5841
|
+
description: Whether the request had a successful result from EURid
|
|
5842
|
+
title: Success
|
|
5843
|
+
type: boolean
|
|
5844
|
+
required:
|
|
5845
|
+
- name
|
|
5846
|
+
- success
|
|
5847
|
+
title: RequestAuthcodeResponse
|
|
5848
|
+
type: object
|
|
5815
5849
|
common__models__availability__datasource__DomainAvailabilityResponse:
|
|
5816
5850
|
properties:
|
|
5817
5851
|
meta:
|
|
@@ -5923,7 +5957,7 @@ info:
|
|
|
5923
5957
|
'
|
|
5924
5958
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5925
5959
|
title: OpusDNS API
|
|
5926
|
-
version: 2025-12-
|
|
5960
|
+
version: 2025-12-11-031623
|
|
5927
5961
|
x-logo:
|
|
5928
5962
|
altText: OpusDNS API Reference
|
|
5929
5963
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -10046,7 +10080,7 @@ paths:
|
|
|
10046
10080
|
content:
|
|
10047
10081
|
application/json:
|
|
10048
10082
|
schema:
|
|
10049
|
-
$ref: '#/components/schemas/
|
|
10083
|
+
$ref: '#/components/schemas/api__domain__tld_specific__be__models__RequestAuthcodeResponse'
|
|
10050
10084
|
description: Successful Response
|
|
10051
10085
|
'400':
|
|
10052
10086
|
content:
|
|
@@ -10142,6 +10176,69 @@ paths:
|
|
|
10142
10176
|
tags:
|
|
10143
10177
|
- domain
|
|
10144
10178
|
- domain_tld_specific
|
|
10179
|
+
/v1/domains/tld-specific/eu/{domain_reference}/auth_code/request:
|
|
10180
|
+
post:
|
|
10181
|
+
operationId: request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post
|
|
10182
|
+
parameters:
|
|
10183
|
+
- in: path
|
|
10184
|
+
name: domain_reference
|
|
10185
|
+
required: true
|
|
10186
|
+
schema:
|
|
10187
|
+
anyOf:
|
|
10188
|
+
- examples:
|
|
10189
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
10190
|
+
format: typeid
|
|
10191
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10192
|
+
type: string
|
|
10193
|
+
x-typeid-prefix: domain
|
|
10194
|
+
- type: string
|
|
10195
|
+
title: Domain Reference
|
|
10196
|
+
responses:
|
|
10197
|
+
'200':
|
|
10198
|
+
content:
|
|
10199
|
+
application/json:
|
|
10200
|
+
schema:
|
|
10201
|
+
$ref: '#/components/schemas/api__domain__tld_specific__eu__models__RequestAuthcodeResponse'
|
|
10202
|
+
description: Successful Response
|
|
10203
|
+
'400':
|
|
10204
|
+
content:
|
|
10205
|
+
application/problem+json:
|
|
10206
|
+
example:
|
|
10207
|
+
code: ERROR_DOMAIN_TRANSFER
|
|
10208
|
+
detail: There was an error transferring the domain
|
|
10209
|
+
domain_name: Additional error context.
|
|
10210
|
+
reason: An unspecified error occurred
|
|
10211
|
+
status: 400
|
|
10212
|
+
title: Domain Transfer Error
|
|
10213
|
+
type: domain-transfer
|
|
10214
|
+
schema:
|
|
10215
|
+
$ref: '#/components/schemas/Problem'
|
|
10216
|
+
description: Bad Request
|
|
10217
|
+
'404':
|
|
10218
|
+
content:
|
|
10219
|
+
application/problem+json:
|
|
10220
|
+
example:
|
|
10221
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
10222
|
+
detail: Domain not found
|
|
10223
|
+
domain_name: Additional error context.
|
|
10224
|
+
status: 404
|
|
10225
|
+
title: Domain Management Error
|
|
10226
|
+
type: domain-not-found
|
|
10227
|
+
schema:
|
|
10228
|
+
$ref: '#/components/schemas/Problem'
|
|
10229
|
+
description: Not Found
|
|
10230
|
+
'422':
|
|
10231
|
+
content:
|
|
10232
|
+
application/problem+json:
|
|
10233
|
+
schema:
|
|
10234
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
10235
|
+
description: Validation Error
|
|
10236
|
+
security:
|
|
10237
|
+
- OAuth2PasswordBearer: []
|
|
10238
|
+
summary: Requests your auth code directly from EURid (registry)
|
|
10239
|
+
tags:
|
|
10240
|
+
- domain
|
|
10241
|
+
- domain_tld_specific
|
|
10145
10242
|
/v1/domains/transfer:
|
|
10146
10243
|
post:
|
|
10147
10244
|
description: 'Start the transfer process for a domain <br>
|
package/src/schema.d.ts
CHANGED
|
@@ -718,6 +718,23 @@ export interface paths {
|
|
|
718
718
|
patch?: never;
|
|
719
719
|
trace?: never;
|
|
720
720
|
};
|
|
721
|
+
"/v1/domains/tld-specific/eu/{domain_reference}/auth_code/request": {
|
|
722
|
+
parameters: {
|
|
723
|
+
query?: never;
|
|
724
|
+
header?: never;
|
|
725
|
+
path?: never;
|
|
726
|
+
cookie?: never;
|
|
727
|
+
};
|
|
728
|
+
get?: never;
|
|
729
|
+
put?: never;
|
|
730
|
+
/** Requests your auth code directly from EURid (registry) */
|
|
731
|
+
post: operations["request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post"];
|
|
732
|
+
delete?: never;
|
|
733
|
+
options?: never;
|
|
734
|
+
head?: never;
|
|
735
|
+
patch?: never;
|
|
736
|
+
trace?: never;
|
|
737
|
+
};
|
|
721
738
|
"/v1/domains/transfer": {
|
|
722
739
|
parameters: {
|
|
723
740
|
query?: never;
|
|
@@ -4729,24 +4746,6 @@ export interface components {
|
|
|
4729
4746
|
* @enum {string}
|
|
4730
4747
|
*/
|
|
4731
4748
|
RenewalMode: "renew" | "expire" | "delete";
|
|
4732
|
-
/** RequestAuthcodeResponse */
|
|
4733
|
-
RequestAuthcodeResponse: {
|
|
4734
|
-
/**
|
|
4735
|
-
* Detail
|
|
4736
|
-
* @description Additional information about the result in case of failure
|
|
4737
|
-
*/
|
|
4738
|
-
detail?: string | null;
|
|
4739
|
-
/**
|
|
4740
|
-
* Name
|
|
4741
|
-
* @description The domain name that had the auth code requested
|
|
4742
|
-
*/
|
|
4743
|
-
name: string;
|
|
4744
|
-
/**
|
|
4745
|
-
* Success
|
|
4746
|
-
* @description Whether the request had a successful result from DNS Belgium
|
|
4747
|
-
*/
|
|
4748
|
-
success: boolean;
|
|
4749
|
-
};
|
|
4750
4749
|
/** RequestHistory */
|
|
4751
4750
|
RequestHistory: {
|
|
4752
4751
|
/**
|
|
@@ -5458,6 +5457,52 @@ export interface components {
|
|
|
5458
5457
|
* @enum {string}
|
|
5459
5458
|
*/
|
|
5460
5459
|
ZoneSortField: "name" | "created_on" | "updated_on" | "dnssec_status";
|
|
5460
|
+
/** RequestAuthcodeResponse */
|
|
5461
|
+
api__domain__tld_specific__be__models__RequestAuthcodeResponse: {
|
|
5462
|
+
/**
|
|
5463
|
+
* Detail
|
|
5464
|
+
* @description Additional information about the result in case of failure
|
|
5465
|
+
*/
|
|
5466
|
+
detail?: string | null;
|
|
5467
|
+
/**
|
|
5468
|
+
* Name
|
|
5469
|
+
* @description The domain name that had the auth code requested
|
|
5470
|
+
*/
|
|
5471
|
+
name: string;
|
|
5472
|
+
/**
|
|
5473
|
+
* Success
|
|
5474
|
+
* @description Whether the request had a successful result from DNS Belgium
|
|
5475
|
+
*/
|
|
5476
|
+
success: boolean;
|
|
5477
|
+
};
|
|
5478
|
+
/** RequestAuthcodeResponse */
|
|
5479
|
+
api__domain__tld_specific__eu__models__RequestAuthcodeResponse: {
|
|
5480
|
+
/**
|
|
5481
|
+
* Auth Code
|
|
5482
|
+
* @description The auth code returned by EURid
|
|
5483
|
+
*/
|
|
5484
|
+
auth_code?: string | null;
|
|
5485
|
+
/**
|
|
5486
|
+
* Auth Code Expires On
|
|
5487
|
+
* @description The expiry date of the auth code
|
|
5488
|
+
*/
|
|
5489
|
+
auth_code_expires_on?: Date | null;
|
|
5490
|
+
/**
|
|
5491
|
+
* Detail
|
|
5492
|
+
* @description Additional information about the result in case of failure
|
|
5493
|
+
*/
|
|
5494
|
+
detail?: string | null;
|
|
5495
|
+
/**
|
|
5496
|
+
* Name
|
|
5497
|
+
* @description The domain name that had the auth code requested
|
|
5498
|
+
*/
|
|
5499
|
+
name: string;
|
|
5500
|
+
/**
|
|
5501
|
+
* Success
|
|
5502
|
+
* @description Whether the request had a successful result from EURid
|
|
5503
|
+
*/
|
|
5504
|
+
success: boolean;
|
|
5505
|
+
};
|
|
5461
5506
|
/** DomainAvailabilityResponse */
|
|
5462
5507
|
common__models__availability__datasource__DomainAvailabilityResponse: {
|
|
5463
5508
|
meta: components["schemas"]["DomainAvailabilityMeta"];
|
|
@@ -8457,7 +8502,7 @@ export interface operations {
|
|
|
8457
8502
|
[name: string]: unknown;
|
|
8458
8503
|
};
|
|
8459
8504
|
content: {
|
|
8460
|
-
"application/json": components["schemas"]["
|
|
8505
|
+
"application/json": components["schemas"]["api__domain__tld_specific__be__models__RequestAuthcodeResponse"];
|
|
8461
8506
|
};
|
|
8462
8507
|
};
|
|
8463
8508
|
/** @description Bad Request */
|
|
@@ -8558,6 +8603,72 @@ export interface operations {
|
|
|
8558
8603
|
};
|
|
8559
8604
|
};
|
|
8560
8605
|
};
|
|
8606
|
+
request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post: {
|
|
8607
|
+
parameters: {
|
|
8608
|
+
query?: never;
|
|
8609
|
+
header?: never;
|
|
8610
|
+
path: {
|
|
8611
|
+
domain_reference: TypeId<"domain"> | string;
|
|
8612
|
+
};
|
|
8613
|
+
cookie?: never;
|
|
8614
|
+
};
|
|
8615
|
+
requestBody?: never;
|
|
8616
|
+
responses: {
|
|
8617
|
+
/** @description Successful Response */
|
|
8618
|
+
200: {
|
|
8619
|
+
headers: {
|
|
8620
|
+
[name: string]: unknown;
|
|
8621
|
+
};
|
|
8622
|
+
content: {
|
|
8623
|
+
"application/json": components["schemas"]["api__domain__tld_specific__eu__models__RequestAuthcodeResponse"];
|
|
8624
|
+
};
|
|
8625
|
+
};
|
|
8626
|
+
/** @description Bad Request */
|
|
8627
|
+
400: {
|
|
8628
|
+
headers: {
|
|
8629
|
+
[name: string]: unknown;
|
|
8630
|
+
};
|
|
8631
|
+
content: {
|
|
8632
|
+
/** @example {
|
|
8633
|
+
* "code": "ERROR_DOMAIN_TRANSFER",
|
|
8634
|
+
* "detail": "There was an error transferring the domain",
|
|
8635
|
+
* "domain_name": "Additional error context.",
|
|
8636
|
+
* "reason": "An unspecified error occurred",
|
|
8637
|
+
* "status": 400,
|
|
8638
|
+
* "title": "Domain Transfer Error",
|
|
8639
|
+
* "type": "domain-transfer"
|
|
8640
|
+
* } */
|
|
8641
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
8642
|
+
};
|
|
8643
|
+
};
|
|
8644
|
+
/** @description Not Found */
|
|
8645
|
+
404: {
|
|
8646
|
+
headers: {
|
|
8647
|
+
[name: string]: unknown;
|
|
8648
|
+
};
|
|
8649
|
+
content: {
|
|
8650
|
+
/** @example {
|
|
8651
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
8652
|
+
* "detail": "Domain not found",
|
|
8653
|
+
* "domain_name": "Additional error context.",
|
|
8654
|
+
* "status": 404,
|
|
8655
|
+
* "title": "Domain Management Error",
|
|
8656
|
+
* "type": "domain-not-found"
|
|
8657
|
+
* } */
|
|
8658
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
8659
|
+
};
|
|
8660
|
+
};
|
|
8661
|
+
/** @description Validation Error */
|
|
8662
|
+
422: {
|
|
8663
|
+
headers: {
|
|
8664
|
+
[name: string]: unknown;
|
|
8665
|
+
};
|
|
8666
|
+
content: {
|
|
8667
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8668
|
+
};
|
|
8669
|
+
};
|
|
8670
|
+
};
|
|
8671
|
+
};
|
|
8561
8672
|
transfer_domain_v1_domains_transfer_post: {
|
|
8562
8673
|
parameters: {
|
|
8563
8674
|
query?: never;
|