@opusdns/api 0.121.0 → 0.123.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 +389 -105
- package/src/helpers/requests.d.ts +78 -19
- package/src/helpers/responses.d.ts +222 -8
- package/src/helpers/schemas.d.ts +48 -16
- package/src/openapi.yaml +318 -35
- package/src/schema.d.ts +250 -27
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -69,6 +69,7 @@ import { DomainCreate } from './schemas';
|
|
|
69
69
|
import { DomainDnssecDataCreate } from './schemas';
|
|
70
70
|
import { DomainDnssecData } from './schemas';
|
|
71
71
|
import { DomainForward } from './schemas';
|
|
72
|
+
import { DomainForwardCreateRequest } from './schemas';
|
|
72
73
|
import { DomainForwardPatchOp } from './schemas';
|
|
73
74
|
import { DomainForwardPatchOps } from './schemas';
|
|
74
75
|
import { DomainForwardProtocolSetRequest } from './schemas';
|
|
@@ -147,7 +148,6 @@ import { PublicAuthRequestForm } from './schemas';
|
|
|
147
148
|
import { RdapBase } from './schemas';
|
|
148
149
|
import { RegistryLockBase } from './schemas';
|
|
149
150
|
import { RelationSet } from './schemas';
|
|
150
|
-
import { RequestAuthcode } from './schemas';
|
|
151
151
|
import { RequestHistory } from './schemas';
|
|
152
152
|
import { ReservedDomainsBase } from './schemas';
|
|
153
153
|
import { RgpOperations } from './schemas';
|
|
@@ -169,6 +169,8 @@ import { UserWithRelationPermissions } from './schemas';
|
|
|
169
169
|
import { ValidationError } from './schemas';
|
|
170
170
|
import { WhoisBase } from './schemas';
|
|
171
171
|
import { WildcardHttpRedirectRequest } from './schemas';
|
|
172
|
+
import { RequestAuthcode } from './schemas';
|
|
173
|
+
import { RequestAuthcode2 } from './schemas';
|
|
172
174
|
import { DomainAvailabilityList } from './schemas';
|
|
173
175
|
import { DomainAvailabilityCheck } from './schemas';
|
|
174
176
|
|
|
@@ -6587,6 +6589,132 @@ export const KEYS_DOMAIN_FORWARD = [
|
|
|
6587
6589
|
KEY_DOMAIN_FORWARD_WILDCARD,
|
|
6588
6590
|
] as const satisfies (keyof DomainForward)[];
|
|
6589
6591
|
|
|
6592
|
+
/**
|
|
6593
|
+
* Enabled
|
|
6594
|
+
*
|
|
6595
|
+
*
|
|
6596
|
+
* @type {boolean}
|
|
6597
|
+
*
|
|
6598
|
+
*
|
|
6599
|
+
* @remarks
|
|
6600
|
+
* This key constant provides type-safe access to the `enabled` property of DomainForwardCreateRequest objects.
|
|
6601
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6602
|
+
*
|
|
6603
|
+
* @example
|
|
6604
|
+
* ```typescript
|
|
6605
|
+
* // Direct property access
|
|
6606
|
+
* const value = domainforwardcreaterequest[KEY_DOMAIN_FORWARD_CREATE_REQUEST_ENABLED];
|
|
6607
|
+
*
|
|
6608
|
+
* // Dynamic property access
|
|
6609
|
+
* const propertyName = KEY_DOMAIN_FORWARD_CREATE_REQUEST_ENABLED;
|
|
6610
|
+
* const value = domainforwardcreaterequest[propertyName];
|
|
6611
|
+
* ```
|
|
6612
|
+
*
|
|
6613
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6614
|
+
* @see {@link KEYS_DOMAIN_FORWARD_CREATE_REQUEST} - Array of all keys for this type
|
|
6615
|
+
*/
|
|
6616
|
+
export const KEY_DOMAIN_FORWARD_CREATE_REQUEST_ENABLED = 'enabled' as keyof DomainForwardCreateRequest;
|
|
6617
|
+
/**
|
|
6618
|
+
* Hostname
|
|
6619
|
+
*
|
|
6620
|
+
*
|
|
6621
|
+
* @type {string}
|
|
6622
|
+
*
|
|
6623
|
+
*
|
|
6624
|
+
* @remarks
|
|
6625
|
+
* This key constant provides type-safe access to the `hostname` property of DomainForwardCreateRequest objects.
|
|
6626
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6627
|
+
*
|
|
6628
|
+
* @example
|
|
6629
|
+
* ```typescript
|
|
6630
|
+
* // Direct property access
|
|
6631
|
+
* const value = domainforwardcreaterequest[KEY_DOMAIN_FORWARD_CREATE_REQUEST_HOSTNAME];
|
|
6632
|
+
*
|
|
6633
|
+
* // Dynamic property access
|
|
6634
|
+
* const propertyName = KEY_DOMAIN_FORWARD_CREATE_REQUEST_HOSTNAME;
|
|
6635
|
+
* const value = domainforwardcreaterequest[propertyName];
|
|
6636
|
+
* ```
|
|
6637
|
+
*
|
|
6638
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6639
|
+
* @see {@link KEYS_DOMAIN_FORWARD_CREATE_REQUEST} - Array of all keys for this type
|
|
6640
|
+
*/
|
|
6641
|
+
export const KEY_DOMAIN_FORWARD_CREATE_REQUEST_HOSTNAME = 'hostname' as keyof DomainForwardCreateRequest;
|
|
6642
|
+
/**
|
|
6643
|
+
* http property
|
|
6644
|
+
*
|
|
6645
|
+
*
|
|
6646
|
+
*
|
|
6647
|
+
*
|
|
6648
|
+
* @remarks
|
|
6649
|
+
* This key constant provides type-safe access to the `http` property of DomainForwardCreateRequest objects.
|
|
6650
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6651
|
+
*
|
|
6652
|
+
* @example
|
|
6653
|
+
* ```typescript
|
|
6654
|
+
* // Direct property access
|
|
6655
|
+
* const value = domainforwardcreaterequest[KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTP];
|
|
6656
|
+
*
|
|
6657
|
+
* // Dynamic property access
|
|
6658
|
+
* const propertyName = KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTP;
|
|
6659
|
+
* const value = domainforwardcreaterequest[propertyName];
|
|
6660
|
+
* ```
|
|
6661
|
+
*
|
|
6662
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6663
|
+
* @see {@link KEYS_DOMAIN_FORWARD_CREATE_REQUEST} - Array of all keys for this type
|
|
6664
|
+
*/
|
|
6665
|
+
export const KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTP = 'http' as keyof DomainForwardCreateRequest;
|
|
6666
|
+
/**
|
|
6667
|
+
* https property
|
|
6668
|
+
*
|
|
6669
|
+
*
|
|
6670
|
+
*
|
|
6671
|
+
*
|
|
6672
|
+
* @remarks
|
|
6673
|
+
* This key constant provides type-safe access to the `https` property of DomainForwardCreateRequest objects.
|
|
6674
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6675
|
+
*
|
|
6676
|
+
* @example
|
|
6677
|
+
* ```typescript
|
|
6678
|
+
* // Direct property access
|
|
6679
|
+
* const value = domainforwardcreaterequest[KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTPS];
|
|
6680
|
+
*
|
|
6681
|
+
* // Dynamic property access
|
|
6682
|
+
* const propertyName = KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTPS;
|
|
6683
|
+
* const value = domainforwardcreaterequest[propertyName];
|
|
6684
|
+
* ```
|
|
6685
|
+
*
|
|
6686
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6687
|
+
* @see {@link KEYS_DOMAIN_FORWARD_CREATE_REQUEST} - Array of all keys for this type
|
|
6688
|
+
*/
|
|
6689
|
+
export const KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTPS = 'https' as keyof DomainForwardCreateRequest;
|
|
6690
|
+
|
|
6691
|
+
/**
|
|
6692
|
+
* Array of all DomainForwardCreateRequest property keys
|
|
6693
|
+
*
|
|
6694
|
+
* @remarks
|
|
6695
|
+
* This constant provides a readonly array containing all valid property keys for DomainForwardCreateRequest objects.
|
|
6696
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6697
|
+
*
|
|
6698
|
+
* @example
|
|
6699
|
+
* ```typescript
|
|
6700
|
+
* // Iterating through all keys
|
|
6701
|
+
* for (const key of KEYS_DOMAIN_FORWARD_CREATE_REQUEST) {
|
|
6702
|
+
* console.log(`Property: ${key}, Value: ${domainforwardcreaterequest[key]}`);
|
|
6703
|
+
* }
|
|
6704
|
+
*
|
|
6705
|
+
* // Validation
|
|
6706
|
+
* const isValidKey = KEYS_DOMAIN_FORWARD_CREATE_REQUEST.includes(someKey);
|
|
6707
|
+
* ```
|
|
6708
|
+
*
|
|
6709
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6710
|
+
*/
|
|
6711
|
+
export const KEYS_DOMAIN_FORWARD_CREATE_REQUEST = [
|
|
6712
|
+
KEY_DOMAIN_FORWARD_CREATE_REQUEST_ENABLED,
|
|
6713
|
+
KEY_DOMAIN_FORWARD_CREATE_REQUEST_HOSTNAME,
|
|
6714
|
+
KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTP,
|
|
6715
|
+
KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTPS,
|
|
6716
|
+
] as const satisfies (keyof DomainForwardCreateRequest)[];
|
|
6717
|
+
|
|
6590
6718
|
/**
|
|
6591
6719
|
* op property
|
|
6592
6720
|
*
|
|
@@ -18443,110 +18571,6 @@ export const KEYS_RELATION_SET = [
|
|
|
18443
18571
|
KEY_RELATION_SET_RELATIONS,
|
|
18444
18572
|
] as const satisfies (keyof RelationSet)[];
|
|
18445
18573
|
|
|
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
18574
|
/**
|
|
18551
18575
|
* Client Ip
|
|
18552
18576
|
*
|
|
@@ -22574,6 +22598,266 @@ export const KEYS_WILDCARD_HTTP_REDIRECT_REQUEST = [
|
|
|
22574
22598
|
KEY_WILDCARD_HTTP_REDIRECT_REQUEST_TARGET_PROTOCOL,
|
|
22575
22599
|
] as const satisfies (keyof WildcardHttpRedirectRequest)[];
|
|
22576
22600
|
|
|
22601
|
+
/**
|
|
22602
|
+
* Detail
|
|
22603
|
+
*
|
|
22604
|
+
* Additional information about the result in case of failure
|
|
22605
|
+
*
|
|
22606
|
+
*
|
|
22607
|
+
*
|
|
22608
|
+
* @remarks
|
|
22609
|
+
* This key constant provides type-safe access to the `detail` property of RequestAuthcode objects.
|
|
22610
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22611
|
+
*
|
|
22612
|
+
* @example
|
|
22613
|
+
* ```typescript
|
|
22614
|
+
* // Direct property access
|
|
22615
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_DETAIL];
|
|
22616
|
+
*
|
|
22617
|
+
* // Dynamic property access
|
|
22618
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_DETAIL;
|
|
22619
|
+
* const value = requestauthcode[propertyName];
|
|
22620
|
+
* ```
|
|
22621
|
+
*
|
|
22622
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
22623
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
22624
|
+
*/
|
|
22625
|
+
export const KEY_REQUEST_AUTHCODE_DETAIL = 'detail' as keyof RequestAuthcode;
|
|
22626
|
+
/**
|
|
22627
|
+
* Name
|
|
22628
|
+
*
|
|
22629
|
+
* The domain name that had the auth code requested
|
|
22630
|
+
*
|
|
22631
|
+
* @type {string}
|
|
22632
|
+
*
|
|
22633
|
+
*
|
|
22634
|
+
* @remarks
|
|
22635
|
+
* This key constant provides type-safe access to the `name` property of RequestAuthcode objects.
|
|
22636
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22637
|
+
*
|
|
22638
|
+
* @example
|
|
22639
|
+
* ```typescript
|
|
22640
|
+
* // Direct property access
|
|
22641
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_NAME];
|
|
22642
|
+
*
|
|
22643
|
+
* // Dynamic property access
|
|
22644
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_NAME;
|
|
22645
|
+
* const value = requestauthcode[propertyName];
|
|
22646
|
+
* ```
|
|
22647
|
+
*
|
|
22648
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
22649
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
22650
|
+
*/
|
|
22651
|
+
export const KEY_REQUEST_AUTHCODE_NAME = 'name' as keyof RequestAuthcode;
|
|
22652
|
+
/**
|
|
22653
|
+
* Success
|
|
22654
|
+
*
|
|
22655
|
+
* Whether the request had a successful result from DNS Belgium
|
|
22656
|
+
*
|
|
22657
|
+
* @type {boolean}
|
|
22658
|
+
*
|
|
22659
|
+
*
|
|
22660
|
+
* @remarks
|
|
22661
|
+
* This key constant provides type-safe access to the `success` property of RequestAuthcode objects.
|
|
22662
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22663
|
+
*
|
|
22664
|
+
* @example
|
|
22665
|
+
* ```typescript
|
|
22666
|
+
* // Direct property access
|
|
22667
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_SUCCESS];
|
|
22668
|
+
*
|
|
22669
|
+
* // Dynamic property access
|
|
22670
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_SUCCESS;
|
|
22671
|
+
* const value = requestauthcode[propertyName];
|
|
22672
|
+
* ```
|
|
22673
|
+
*
|
|
22674
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
22675
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
22676
|
+
*/
|
|
22677
|
+
export const KEY_REQUEST_AUTHCODE_SUCCESS = 'success' as keyof RequestAuthcode;
|
|
22678
|
+
|
|
22679
|
+
/**
|
|
22680
|
+
* Array of all RequestAuthcode property keys
|
|
22681
|
+
*
|
|
22682
|
+
* @remarks
|
|
22683
|
+
* This constant provides a readonly array containing all valid property keys for RequestAuthcode objects.
|
|
22684
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
22685
|
+
*
|
|
22686
|
+
* @example
|
|
22687
|
+
* ```typescript
|
|
22688
|
+
* // Iterating through all keys
|
|
22689
|
+
* for (const key of KEYS_REQUEST_AUTHCODE) {
|
|
22690
|
+
* console.log(`Property: ${key}, Value: ${requestauthcode[key]}`);
|
|
22691
|
+
* }
|
|
22692
|
+
*
|
|
22693
|
+
* // Validation
|
|
22694
|
+
* const isValidKey = KEYS_REQUEST_AUTHCODE.includes(someKey);
|
|
22695
|
+
* ```
|
|
22696
|
+
*
|
|
22697
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
22698
|
+
*/
|
|
22699
|
+
export const KEYS_REQUEST_AUTHCODE = [
|
|
22700
|
+
KEY_REQUEST_AUTHCODE_DETAIL,
|
|
22701
|
+
KEY_REQUEST_AUTHCODE_NAME,
|
|
22702
|
+
KEY_REQUEST_AUTHCODE_SUCCESS,
|
|
22703
|
+
] as const satisfies (keyof RequestAuthcode)[];
|
|
22704
|
+
|
|
22705
|
+
/**
|
|
22706
|
+
* Auth Code
|
|
22707
|
+
*
|
|
22708
|
+
* The auth code returned by EURid
|
|
22709
|
+
*
|
|
22710
|
+
*
|
|
22711
|
+
*
|
|
22712
|
+
* @remarks
|
|
22713
|
+
* This key constant provides type-safe access to the `auth_code` property of RequestAuthcode2 objects.
|
|
22714
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22715
|
+
*
|
|
22716
|
+
* @example
|
|
22717
|
+
* ```typescript
|
|
22718
|
+
* // Direct property access
|
|
22719
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_AUTH_CODE];
|
|
22720
|
+
*
|
|
22721
|
+
* // Dynamic property access
|
|
22722
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_AUTH_CODE;
|
|
22723
|
+
* const value = requestauthcode2[propertyName];
|
|
22724
|
+
* ```
|
|
22725
|
+
*
|
|
22726
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22727
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22728
|
+
*/
|
|
22729
|
+
export const KEY_REQUEST_AUTHCODE2_AUTH_CODE = 'auth_code' as keyof RequestAuthcode2;
|
|
22730
|
+
/**
|
|
22731
|
+
* Auth Code Expires On
|
|
22732
|
+
*
|
|
22733
|
+
* The expiry date of the auth code
|
|
22734
|
+
*
|
|
22735
|
+
*
|
|
22736
|
+
*
|
|
22737
|
+
* @remarks
|
|
22738
|
+
* This key constant provides type-safe access to the `auth_code_expires_on` property of RequestAuthcode2 objects.
|
|
22739
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22740
|
+
*
|
|
22741
|
+
* @example
|
|
22742
|
+
* ```typescript
|
|
22743
|
+
* // Direct property access
|
|
22744
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_AUTH_CODE_EXPIRES_ON];
|
|
22745
|
+
*
|
|
22746
|
+
* // Dynamic property access
|
|
22747
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_AUTH_CODE_EXPIRES_ON;
|
|
22748
|
+
* const value = requestauthcode2[propertyName];
|
|
22749
|
+
* ```
|
|
22750
|
+
*
|
|
22751
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22752
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22753
|
+
*/
|
|
22754
|
+
export const KEY_REQUEST_AUTHCODE2_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' as keyof RequestAuthcode2;
|
|
22755
|
+
/**
|
|
22756
|
+
* Detail
|
|
22757
|
+
*
|
|
22758
|
+
* Additional information about the result in case of failure
|
|
22759
|
+
*
|
|
22760
|
+
*
|
|
22761
|
+
*
|
|
22762
|
+
* @remarks
|
|
22763
|
+
* This key constant provides type-safe access to the `detail` property of RequestAuthcode2 objects.
|
|
22764
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22765
|
+
*
|
|
22766
|
+
* @example
|
|
22767
|
+
* ```typescript
|
|
22768
|
+
* // Direct property access
|
|
22769
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_DETAIL];
|
|
22770
|
+
*
|
|
22771
|
+
* // Dynamic property access
|
|
22772
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_DETAIL;
|
|
22773
|
+
* const value = requestauthcode2[propertyName];
|
|
22774
|
+
* ```
|
|
22775
|
+
*
|
|
22776
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22777
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22778
|
+
*/
|
|
22779
|
+
export const KEY_REQUEST_AUTHCODE2_DETAIL = 'detail' as keyof RequestAuthcode2;
|
|
22780
|
+
/**
|
|
22781
|
+
* Name
|
|
22782
|
+
*
|
|
22783
|
+
* The domain name that had the auth code requested
|
|
22784
|
+
*
|
|
22785
|
+
* @type {string}
|
|
22786
|
+
*
|
|
22787
|
+
*
|
|
22788
|
+
* @remarks
|
|
22789
|
+
* This key constant provides type-safe access to the `name` property of RequestAuthcode2 objects.
|
|
22790
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22791
|
+
*
|
|
22792
|
+
* @example
|
|
22793
|
+
* ```typescript
|
|
22794
|
+
* // Direct property access
|
|
22795
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_NAME];
|
|
22796
|
+
*
|
|
22797
|
+
* // Dynamic property access
|
|
22798
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_NAME;
|
|
22799
|
+
* const value = requestauthcode2[propertyName];
|
|
22800
|
+
* ```
|
|
22801
|
+
*
|
|
22802
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22803
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22804
|
+
*/
|
|
22805
|
+
export const KEY_REQUEST_AUTHCODE2_NAME = 'name' as keyof RequestAuthcode2;
|
|
22806
|
+
/**
|
|
22807
|
+
* Success
|
|
22808
|
+
*
|
|
22809
|
+
* Whether the request had a successful result from EURid
|
|
22810
|
+
*
|
|
22811
|
+
* @type {boolean}
|
|
22812
|
+
*
|
|
22813
|
+
*
|
|
22814
|
+
* @remarks
|
|
22815
|
+
* This key constant provides type-safe access to the `success` property of RequestAuthcode2 objects.
|
|
22816
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22817
|
+
*
|
|
22818
|
+
* @example
|
|
22819
|
+
* ```typescript
|
|
22820
|
+
* // Direct property access
|
|
22821
|
+
* const value = requestauthcode2[KEY_REQUEST_AUTHCODE2_SUCCESS];
|
|
22822
|
+
*
|
|
22823
|
+
* // Dynamic property access
|
|
22824
|
+
* const propertyName = KEY_REQUEST_AUTHCODE2_SUCCESS;
|
|
22825
|
+
* const value = requestauthcode2[propertyName];
|
|
22826
|
+
* ```
|
|
22827
|
+
*
|
|
22828
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22829
|
+
* @see {@link KEYS_REQUEST_AUTHCODE2} - Array of all keys for this type
|
|
22830
|
+
*/
|
|
22831
|
+
export const KEY_REQUEST_AUTHCODE2_SUCCESS = 'success' as keyof RequestAuthcode2;
|
|
22832
|
+
|
|
22833
|
+
/**
|
|
22834
|
+
* Array of all RequestAuthcode2 property keys
|
|
22835
|
+
*
|
|
22836
|
+
* @remarks
|
|
22837
|
+
* This constant provides a readonly array containing all valid property keys for RequestAuthcode2 objects.
|
|
22838
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
22839
|
+
*
|
|
22840
|
+
* @example
|
|
22841
|
+
* ```typescript
|
|
22842
|
+
* // Iterating through all keys
|
|
22843
|
+
* for (const key of KEYS_REQUEST_AUTHCODE2) {
|
|
22844
|
+
* console.log(`Property: ${key}, Value: ${requestauthcode2[key]}`);
|
|
22845
|
+
* }
|
|
22846
|
+
*
|
|
22847
|
+
* // Validation
|
|
22848
|
+
* const isValidKey = KEYS_REQUEST_AUTHCODE2.includes(someKey);
|
|
22849
|
+
* ```
|
|
22850
|
+
*
|
|
22851
|
+
* @see {@link RequestAuthcode2} - The TypeScript type definition
|
|
22852
|
+
*/
|
|
22853
|
+
export const KEYS_REQUEST_AUTHCODE2 = [
|
|
22854
|
+
KEY_REQUEST_AUTHCODE2_AUTH_CODE,
|
|
22855
|
+
KEY_REQUEST_AUTHCODE2_AUTH_CODE_EXPIRES_ON,
|
|
22856
|
+
KEY_REQUEST_AUTHCODE2_DETAIL,
|
|
22857
|
+
KEY_REQUEST_AUTHCODE2_NAME,
|
|
22858
|
+
KEY_REQUEST_AUTHCODE2_SUCCESS,
|
|
22859
|
+
] as const satisfies (keyof RequestAuthcode2)[];
|
|
22860
|
+
|
|
22577
22861
|
/**
|
|
22578
22862
|
* meta property
|
|
22579
22863
|
*
|
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
37
|
+
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
|
|
@@ -1487,6 +1487,43 @@ export type PATCH_DomainForwards_Request = {
|
|
|
1487
1487
|
*/
|
|
1488
1488
|
export type PATCH_DomainForwards_Request_Body = PATCH_DomainForwards_Request['requestBody'];
|
|
1489
1489
|
|
|
1490
|
+
/**
|
|
1491
|
+
* Request type for POST DomainForwards endpoint
|
|
1492
|
+
*
|
|
1493
|
+
* Create a domain forward
|
|
1494
|
+
* Creates a new domain forward configuration. Wildcard forwards can be created by using *.hostname (e.g., *.example.com).
|
|
1495
|
+
*
|
|
1496
|
+
* @remarks
|
|
1497
|
+
* This type defines the complete request structure for the POST DomainForwards endpoint.
|
|
1498
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1499
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1500
|
+
*
|
|
1501
|
+
* @example
|
|
1502
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1503
|
+
*
|
|
1504
|
+
* @path /v1/domain-forwards
|
|
1505
|
+
*
|
|
1506
|
+
* @see {@link POST_DomainForwards_Request_Query} - Query parameters type
|
|
1507
|
+
* @see {@link POST_DomainForwards_Request_Path} - Path parameters type
|
|
1508
|
+
* @see {@link POST_DomainForwards_Request_Body} - Request body type
|
|
1509
|
+
*/
|
|
1510
|
+
export type POST_DomainForwards_Request = {
|
|
1511
|
+
requestBody: DomainForwardCreateRequest;
|
|
1512
|
+
}
|
|
1513
|
+
/**
|
|
1514
|
+
* Request body for POST /v1/domain-forwards
|
|
1515
|
+
*
|
|
1516
|
+
* @remarks
|
|
1517
|
+
* This type defines the request body structure for the POST /v1/domain-forwards endpoint.
|
|
1518
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
1519
|
+
*
|
|
1520
|
+
* @example
|
|
1521
|
+
* Use this type to ensure type safety for request body structure.
|
|
1522
|
+
*
|
|
1523
|
+
* @path /v1/domain-forwards
|
|
1524
|
+
*/
|
|
1525
|
+
export type POST_DomainForwards_Request_Body = POST_DomainForwards_Request['requestBody'];
|
|
1526
|
+
|
|
1490
1527
|
/**
|
|
1491
1528
|
* Request type for DELETE DomainForwardsHostname endpoint
|
|
1492
1529
|
*
|
|
@@ -1572,8 +1609,8 @@ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname
|
|
|
1572
1609
|
/**
|
|
1573
1610
|
* Request type for POST DomainForwardsHostname endpoint
|
|
1574
1611
|
*
|
|
1575
|
-
* Create a domain forward
|
|
1576
|
-
* Creates a new domain forward configuration for the specified hostname
|
|
1612
|
+
* Create a domain forward (deprecated)
|
|
1613
|
+
* **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
|
|
1577
1614
|
*
|
|
1578
1615
|
* @remarks
|
|
1579
1616
|
* This type defines the complete request structure for the POST DomainForwardsHostname endpoint.
|
|
@@ -1681,7 +1718,6 @@ export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwa
|
|
|
1681
1718
|
*
|
|
1682
1719
|
* @path /v1/domain-forwards/{hostname}/enable
|
|
1683
1720
|
* @param hostname (path) - Hostname
|
|
1684
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
1685
1721
|
*
|
|
1686
1722
|
* @see {@link PATCH_DomainForwardsHostnameEnable_Request_Query} - Query parameters type
|
|
1687
1723
|
* @see {@link PATCH_DomainForwardsHostnameEnable_Request_Path} - Path parameters type
|
|
@@ -1689,24 +1725,9 @@ export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwa
|
|
|
1689
1725
|
*/
|
|
1690
1726
|
export type PATCH_DomainForwardsHostnameEnable_Request = {
|
|
1691
1727
|
parameters: {
|
|
1692
|
-
query: operations['enable_domain_forward_v1_domain_forwards__hostname__enable_patch']['parameters']['query'];
|
|
1693
1728
|
path: operations['enable_domain_forward_v1_domain_forwards__hostname__enable_patch']['parameters']['path'];
|
|
1694
1729
|
};
|
|
1695
1730
|
}
|
|
1696
|
-
/**
|
|
1697
|
-
* Query parameters for PATCH /v1/domain-forwards/{hostname}/enable
|
|
1698
|
-
*
|
|
1699
|
-
* @remarks
|
|
1700
|
-
* This type defines the query parameters for the PATCH /v1/domain-forwards/{hostname}/enable endpoint.
|
|
1701
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
1702
|
-
*
|
|
1703
|
-
* @example
|
|
1704
|
-
* Use this type to ensure type safety for query parameters.
|
|
1705
|
-
*
|
|
1706
|
-
* @path /v1/domain-forwards/{hostname}/enable
|
|
1707
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
1708
|
-
*/
|
|
1709
|
-
export type PATCH_DomainForwardsHostnameEnable_Request_Query = PATCH_DomainForwardsHostnameEnable_Request['parameters']['query'];
|
|
1710
1731
|
/**
|
|
1711
1732
|
* Path parameters for PATCH /v1/domain-forwards/{hostname}/enable
|
|
1712
1733
|
*
|
|
@@ -2734,6 +2755,44 @@ export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Path = POST_
|
|
|
2734
2755
|
*/
|
|
2735
2756
|
export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Body = POST_DomainsTldSpecificDeDomainReferenceTransit_Request['requestBody'];
|
|
2736
2757
|
|
|
2758
|
+
/**
|
|
2759
|
+
* Request type for POST DomainsTldSpecificEuDomainReferenceAuthCodeRequest endpoint
|
|
2760
|
+
*
|
|
2761
|
+
* Requests your auth code directly from EURid (registry)
|
|
2762
|
+
*
|
|
2763
|
+
* @remarks
|
|
2764
|
+
* This type defines the complete request structure for the POST DomainsTldSpecificEuDomainReferenceAuthCodeRequest endpoint.
|
|
2765
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2766
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2767
|
+
*
|
|
2768
|
+
* @example
|
|
2769
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2770
|
+
*
|
|
2771
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
2772
|
+
*
|
|
2773
|
+
* @see {@link POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request_Query} - Query parameters type
|
|
2774
|
+
* @see {@link POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request_Path} - Path parameters type
|
|
2775
|
+
* @see {@link POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request_Body} - Request body type
|
|
2776
|
+
*/
|
|
2777
|
+
export type POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request = {
|
|
2778
|
+
parameters: {
|
|
2779
|
+
path: operations['request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post']['parameters']['path'];
|
|
2780
|
+
};
|
|
2781
|
+
}
|
|
2782
|
+
/**
|
|
2783
|
+
* Path parameters for POST /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
2784
|
+
*
|
|
2785
|
+
* @remarks
|
|
2786
|
+
* This type defines the path parameters for the POST /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request endpoint.
|
|
2787
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2788
|
+
*
|
|
2789
|
+
* @example
|
|
2790
|
+
* Use this type to ensure type safety for path parameters.
|
|
2791
|
+
*
|
|
2792
|
+
* @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
|
|
2793
|
+
*/
|
|
2794
|
+
export type POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificEuDomainReferenceAuthCodeRequest_Request['parameters']['path'];
|
|
2795
|
+
|
|
2737
2796
|
/**
|
|
2738
2797
|
* Request type for POST DomainsTransfer endpoint
|
|
2739
2798
|
*
|