@opusdns/api 0.90.0 → 0.91.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 +507 -0
- package/src/helpers/requests.d.ts +75 -1
- package/src/helpers/responses.d.ts +111 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +112 -0
- package/src/openapi.yaml +264 -1
- package/src/schema.d.ts +155 -0
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -69,7 +69,11 @@ import { DomainCreate } from './schemas';
|
|
|
69
69
|
import { DomainDnssecDataCreate } from './schemas';
|
|
70
70
|
import { DomainDnssecData } from './schemas';
|
|
71
71
|
import { DomainForward } from './schemas';
|
|
72
|
+
import { DomainForwardPatchOp } from './schemas';
|
|
73
|
+
import { DomainForwardPatchOps } from './schemas';
|
|
74
|
+
import { DomainForwardProtocols } from './schemas';
|
|
72
75
|
import { DomainForwardRequest } from './schemas';
|
|
76
|
+
import { DomainForwardZone } from './schemas';
|
|
73
77
|
import { DomainLifecycleBase } from './schemas';
|
|
74
78
|
import { DomainNameParts } from './schemas';
|
|
75
79
|
import { DomainPeriod } from './schemas';
|
|
@@ -96,6 +100,7 @@ import { GeneralAvailabilityBase } from './schemas';
|
|
|
96
100
|
import { GetPrices } from './schemas';
|
|
97
101
|
import { HTTPValidationError } from './schemas';
|
|
98
102
|
import { HttpRedirect } from './schemas';
|
|
103
|
+
import { HttpRedirectRemove } from './schemas';
|
|
99
104
|
import { IdnBase } from './schemas';
|
|
100
105
|
import { Invoice } from './schemas';
|
|
101
106
|
import { IpRestrictionCreate } from './schemas';
|
|
@@ -122,6 +127,7 @@ import { PremiumDomainsBase } from './schemas';
|
|
|
122
127
|
import { PriceInfo } from './schemas';
|
|
123
128
|
import { PricingPeriod } from './schemas';
|
|
124
129
|
import { Problem } from './schemas';
|
|
130
|
+
import { ProtocolRedirects } from './schemas';
|
|
125
131
|
import { PublicAuthRequestForm } from './schemas';
|
|
126
132
|
import { RdapBase } from './schemas';
|
|
127
133
|
import { RegistryLockBase } from './schemas';
|
|
@@ -6511,6 +6517,255 @@ export const KEYS_DOMAIN_FORWARD = [
|
|
|
6511
6517
|
KEY_DOMAIN_FORWARD_ZONE_NAME,
|
|
6512
6518
|
] as const satisfies (keyof DomainForward)[];
|
|
6513
6519
|
|
|
6520
|
+
/**
|
|
6521
|
+
* op property
|
|
6522
|
+
*
|
|
6523
|
+
*
|
|
6524
|
+
*
|
|
6525
|
+
*
|
|
6526
|
+
* @remarks
|
|
6527
|
+
* This key constant provides type-safe access to the `op` property of DomainForwardPatchOp objects.
|
|
6528
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6529
|
+
*
|
|
6530
|
+
* @example
|
|
6531
|
+
* ```typescript
|
|
6532
|
+
* // Direct property access
|
|
6533
|
+
* const value = domainforwardpatchop[KEY_DOMAIN_FORWARD_PATCH_OP_OP];
|
|
6534
|
+
*
|
|
6535
|
+
* // Dynamic property access
|
|
6536
|
+
* const propertyName = KEY_DOMAIN_FORWARD_PATCH_OP_OP;
|
|
6537
|
+
* const value = domainforwardpatchop[propertyName];
|
|
6538
|
+
* ```
|
|
6539
|
+
*
|
|
6540
|
+
* @see {@link DomainForwardPatchOp} - The TypeScript type definition
|
|
6541
|
+
* @see {@link KEYS_DOMAIN_FORWARD_PATCH_OP} - Array of all keys for this type
|
|
6542
|
+
*/
|
|
6543
|
+
export const KEY_DOMAIN_FORWARD_PATCH_OP_OP = 'op' as keyof DomainForwardPatchOp;
|
|
6544
|
+
/**
|
|
6545
|
+
* Redirect
|
|
6546
|
+
*
|
|
6547
|
+
*
|
|
6548
|
+
*
|
|
6549
|
+
*
|
|
6550
|
+
* @remarks
|
|
6551
|
+
* This key constant provides type-safe access to the `redirect` property of DomainForwardPatchOp objects.
|
|
6552
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6553
|
+
*
|
|
6554
|
+
* @example
|
|
6555
|
+
* ```typescript
|
|
6556
|
+
* // Direct property access
|
|
6557
|
+
* const value = domainforwardpatchop[KEY_DOMAIN_FORWARD_PATCH_OP_REDIRECT];
|
|
6558
|
+
*
|
|
6559
|
+
* // Dynamic property access
|
|
6560
|
+
* const propertyName = KEY_DOMAIN_FORWARD_PATCH_OP_REDIRECT;
|
|
6561
|
+
* const value = domainforwardpatchop[propertyName];
|
|
6562
|
+
* ```
|
|
6563
|
+
*
|
|
6564
|
+
* @see {@link DomainForwardPatchOp} - The TypeScript type definition
|
|
6565
|
+
* @see {@link KEYS_DOMAIN_FORWARD_PATCH_OP} - Array of all keys for this type
|
|
6566
|
+
*/
|
|
6567
|
+
export const KEY_DOMAIN_FORWARD_PATCH_OP_REDIRECT = 'redirect' as keyof DomainForwardPatchOp;
|
|
6568
|
+
/**
|
|
6569
|
+
* request_protocol property
|
|
6570
|
+
*
|
|
6571
|
+
*
|
|
6572
|
+
*
|
|
6573
|
+
*
|
|
6574
|
+
* @remarks
|
|
6575
|
+
* This key constant provides type-safe access to the `request_protocol` property of DomainForwardPatchOp objects.
|
|
6576
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6577
|
+
*
|
|
6578
|
+
* @example
|
|
6579
|
+
* ```typescript
|
|
6580
|
+
* // Direct property access
|
|
6581
|
+
* const value = domainforwardpatchop[KEY_DOMAIN_FORWARD_PATCH_OP_REQUEST_PROTOCOL];
|
|
6582
|
+
*
|
|
6583
|
+
* // Dynamic property access
|
|
6584
|
+
* const propertyName = KEY_DOMAIN_FORWARD_PATCH_OP_REQUEST_PROTOCOL;
|
|
6585
|
+
* const value = domainforwardpatchop[propertyName];
|
|
6586
|
+
* ```
|
|
6587
|
+
*
|
|
6588
|
+
* @see {@link DomainForwardPatchOp} - The TypeScript type definition
|
|
6589
|
+
* @see {@link KEYS_DOMAIN_FORWARD_PATCH_OP} - Array of all keys for this type
|
|
6590
|
+
*/
|
|
6591
|
+
export const KEY_DOMAIN_FORWARD_PATCH_OP_REQUEST_PROTOCOL = 'request_protocol' as keyof DomainForwardPatchOp;
|
|
6592
|
+
/**
|
|
6593
|
+
* Zone Name
|
|
6594
|
+
*
|
|
6595
|
+
*
|
|
6596
|
+
* @type {string}
|
|
6597
|
+
*
|
|
6598
|
+
*
|
|
6599
|
+
* @remarks
|
|
6600
|
+
* This key constant provides type-safe access to the `zone_name` property of DomainForwardPatchOp 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 = domainforwardpatchop[KEY_DOMAIN_FORWARD_PATCH_OP_ZONE_NAME];
|
|
6607
|
+
*
|
|
6608
|
+
* // Dynamic property access
|
|
6609
|
+
* const propertyName = KEY_DOMAIN_FORWARD_PATCH_OP_ZONE_NAME;
|
|
6610
|
+
* const value = domainforwardpatchop[propertyName];
|
|
6611
|
+
* ```
|
|
6612
|
+
*
|
|
6613
|
+
* @see {@link DomainForwardPatchOp} - The TypeScript type definition
|
|
6614
|
+
* @see {@link KEYS_DOMAIN_FORWARD_PATCH_OP} - Array of all keys for this type
|
|
6615
|
+
*/
|
|
6616
|
+
export const KEY_DOMAIN_FORWARD_PATCH_OP_ZONE_NAME = 'zone_name' as keyof DomainForwardPatchOp;
|
|
6617
|
+
|
|
6618
|
+
/**
|
|
6619
|
+
* Array of all DomainForwardPatchOp property keys
|
|
6620
|
+
*
|
|
6621
|
+
* @remarks
|
|
6622
|
+
* This constant provides a readonly array containing all valid property keys for DomainForwardPatchOp objects.
|
|
6623
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6624
|
+
*
|
|
6625
|
+
* @example
|
|
6626
|
+
* ```typescript
|
|
6627
|
+
* // Iterating through all keys
|
|
6628
|
+
* for (const key of KEYS_DOMAIN_FORWARD_PATCH_OP) {
|
|
6629
|
+
* console.log(`Property: ${key}, Value: ${domainforwardpatchop[key]}`);
|
|
6630
|
+
* }
|
|
6631
|
+
*
|
|
6632
|
+
* // Validation
|
|
6633
|
+
* const isValidKey = KEYS_DOMAIN_FORWARD_PATCH_OP.includes(someKey);
|
|
6634
|
+
* ```
|
|
6635
|
+
*
|
|
6636
|
+
* @see {@link DomainForwardPatchOp} - The TypeScript type definition
|
|
6637
|
+
*/
|
|
6638
|
+
export const KEYS_DOMAIN_FORWARD_PATCH_OP = [
|
|
6639
|
+
KEY_DOMAIN_FORWARD_PATCH_OP_OP,
|
|
6640
|
+
KEY_DOMAIN_FORWARD_PATCH_OP_REDIRECT,
|
|
6641
|
+
KEY_DOMAIN_FORWARD_PATCH_OP_REQUEST_PROTOCOL,
|
|
6642
|
+
KEY_DOMAIN_FORWARD_PATCH_OP_ZONE_NAME,
|
|
6643
|
+
] as const satisfies (keyof DomainForwardPatchOp)[];
|
|
6644
|
+
|
|
6645
|
+
/**
|
|
6646
|
+
* Ops
|
|
6647
|
+
*
|
|
6648
|
+
*
|
|
6649
|
+
* @type {array}
|
|
6650
|
+
*
|
|
6651
|
+
*
|
|
6652
|
+
* @remarks
|
|
6653
|
+
* This key constant provides type-safe access to the `ops` property of DomainForwardPatchOps objects.
|
|
6654
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6655
|
+
*
|
|
6656
|
+
* @example
|
|
6657
|
+
* ```typescript
|
|
6658
|
+
* // Direct property access
|
|
6659
|
+
* const value = domainforwardpatchops[KEY_DOMAIN_FORWARD_PATCH_OPS_OPS];
|
|
6660
|
+
*
|
|
6661
|
+
* // Dynamic property access
|
|
6662
|
+
* const propertyName = KEY_DOMAIN_FORWARD_PATCH_OPS_OPS;
|
|
6663
|
+
* const value = domainforwardpatchops[propertyName];
|
|
6664
|
+
* ```
|
|
6665
|
+
*
|
|
6666
|
+
* @see {@link DomainForwardPatchOps} - The TypeScript type definition
|
|
6667
|
+
* @see {@link KEYS_DOMAIN_FORWARD_PATCH_OPS} - Array of all keys for this type
|
|
6668
|
+
*/
|
|
6669
|
+
export const KEY_DOMAIN_FORWARD_PATCH_OPS_OPS = 'ops' as keyof DomainForwardPatchOps;
|
|
6670
|
+
|
|
6671
|
+
/**
|
|
6672
|
+
* Array of all DomainForwardPatchOps property keys
|
|
6673
|
+
*
|
|
6674
|
+
* @remarks
|
|
6675
|
+
* This constant provides a readonly array containing all valid property keys for DomainForwardPatchOps objects.
|
|
6676
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6677
|
+
*
|
|
6678
|
+
* @example
|
|
6679
|
+
* ```typescript
|
|
6680
|
+
* // Iterating through all keys
|
|
6681
|
+
* for (const key of KEYS_DOMAIN_FORWARD_PATCH_OPS) {
|
|
6682
|
+
* console.log(`Property: ${key}, Value: ${domainforwardpatchops[key]}`);
|
|
6683
|
+
* }
|
|
6684
|
+
*
|
|
6685
|
+
* // Validation
|
|
6686
|
+
* const isValidKey = KEYS_DOMAIN_FORWARD_PATCH_OPS.includes(someKey);
|
|
6687
|
+
* ```
|
|
6688
|
+
*
|
|
6689
|
+
* @see {@link DomainForwardPatchOps} - The TypeScript type definition
|
|
6690
|
+
*/
|
|
6691
|
+
export const KEYS_DOMAIN_FORWARD_PATCH_OPS = [
|
|
6692
|
+
KEY_DOMAIN_FORWARD_PATCH_OPS_OPS,
|
|
6693
|
+
] as const satisfies (keyof DomainForwardPatchOps)[];
|
|
6694
|
+
|
|
6695
|
+
/**
|
|
6696
|
+
* http property
|
|
6697
|
+
*
|
|
6698
|
+
*
|
|
6699
|
+
*
|
|
6700
|
+
*
|
|
6701
|
+
* @remarks
|
|
6702
|
+
* This key constant provides type-safe access to the `http` property of DomainForwardProtocols objects.
|
|
6703
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6704
|
+
*
|
|
6705
|
+
* @example
|
|
6706
|
+
* ```typescript
|
|
6707
|
+
* // Direct property access
|
|
6708
|
+
* const value = domainforwardprotocols[KEY_DOMAIN_FORWARD_PROTOCOLS_HTTP];
|
|
6709
|
+
*
|
|
6710
|
+
* // Dynamic property access
|
|
6711
|
+
* const propertyName = KEY_DOMAIN_FORWARD_PROTOCOLS_HTTP;
|
|
6712
|
+
* const value = domainforwardprotocols[propertyName];
|
|
6713
|
+
* ```
|
|
6714
|
+
*
|
|
6715
|
+
* @see {@link DomainForwardProtocols} - The TypeScript type definition
|
|
6716
|
+
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOLS} - Array of all keys for this type
|
|
6717
|
+
*/
|
|
6718
|
+
export const KEY_DOMAIN_FORWARD_PROTOCOLS_HTTP = 'http' as keyof DomainForwardProtocols;
|
|
6719
|
+
/**
|
|
6720
|
+
* https property
|
|
6721
|
+
*
|
|
6722
|
+
*
|
|
6723
|
+
*
|
|
6724
|
+
*
|
|
6725
|
+
* @remarks
|
|
6726
|
+
* This key constant provides type-safe access to the `https` property of DomainForwardProtocols objects.
|
|
6727
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6728
|
+
*
|
|
6729
|
+
* @example
|
|
6730
|
+
* ```typescript
|
|
6731
|
+
* // Direct property access
|
|
6732
|
+
* const value = domainforwardprotocols[KEY_DOMAIN_FORWARD_PROTOCOLS_HTTPS];
|
|
6733
|
+
*
|
|
6734
|
+
* // Dynamic property access
|
|
6735
|
+
* const propertyName = KEY_DOMAIN_FORWARD_PROTOCOLS_HTTPS;
|
|
6736
|
+
* const value = domainforwardprotocols[propertyName];
|
|
6737
|
+
* ```
|
|
6738
|
+
*
|
|
6739
|
+
* @see {@link DomainForwardProtocols} - The TypeScript type definition
|
|
6740
|
+
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOLS} - Array of all keys for this type
|
|
6741
|
+
*/
|
|
6742
|
+
export const KEY_DOMAIN_FORWARD_PROTOCOLS_HTTPS = 'https' as keyof DomainForwardProtocols;
|
|
6743
|
+
|
|
6744
|
+
/**
|
|
6745
|
+
* Array of all DomainForwardProtocols property keys
|
|
6746
|
+
*
|
|
6747
|
+
* @remarks
|
|
6748
|
+
* This constant provides a readonly array containing all valid property keys for DomainForwardProtocols objects.
|
|
6749
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6750
|
+
*
|
|
6751
|
+
* @example
|
|
6752
|
+
* ```typescript
|
|
6753
|
+
* // Iterating through all keys
|
|
6754
|
+
* for (const key of KEYS_DOMAIN_FORWARD_PROTOCOLS) {
|
|
6755
|
+
* console.log(`Property: ${key}, Value: ${domainforwardprotocols[key]}`);
|
|
6756
|
+
* }
|
|
6757
|
+
*
|
|
6758
|
+
* // Validation
|
|
6759
|
+
* const isValidKey = KEYS_DOMAIN_FORWARD_PROTOCOLS.includes(someKey);
|
|
6760
|
+
* ```
|
|
6761
|
+
*
|
|
6762
|
+
* @see {@link DomainForwardProtocols} - The TypeScript type definition
|
|
6763
|
+
*/
|
|
6764
|
+
export const KEYS_DOMAIN_FORWARD_PROTOCOLS = [
|
|
6765
|
+
KEY_DOMAIN_FORWARD_PROTOCOLS_HTTP,
|
|
6766
|
+
KEY_DOMAIN_FORWARD_PROTOCOLS_HTTPS,
|
|
6767
|
+
] as const satisfies (keyof DomainForwardProtocols)[];
|
|
6768
|
+
|
|
6514
6769
|
/**
|
|
6515
6770
|
* Redirects
|
|
6516
6771
|
*
|
|
@@ -6587,6 +6842,133 @@ export const KEYS_DOMAIN_FORWARD_REQUEST = [
|
|
|
6587
6842
|
KEY_DOMAIN_FORWARD_REQUEST_WILDCARD,
|
|
6588
6843
|
] as const satisfies (keyof DomainForwardRequest)[];
|
|
6589
6844
|
|
|
6845
|
+
/**
|
|
6846
|
+
* Enabled
|
|
6847
|
+
*
|
|
6848
|
+
*
|
|
6849
|
+
* @type {boolean}
|
|
6850
|
+
*
|
|
6851
|
+
*
|
|
6852
|
+
* @remarks
|
|
6853
|
+
* This key constant provides type-safe access to the `enabled` property of DomainForwardZone objects.
|
|
6854
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6855
|
+
*
|
|
6856
|
+
* @example
|
|
6857
|
+
* ```typescript
|
|
6858
|
+
* // Direct property access
|
|
6859
|
+
* const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_ENABLED];
|
|
6860
|
+
*
|
|
6861
|
+
* // Dynamic property access
|
|
6862
|
+
* const propertyName = KEY_DOMAIN_FORWARD_ZONE_ENABLED;
|
|
6863
|
+
* const value = domainforwardzone[propertyName];
|
|
6864
|
+
* ```
|
|
6865
|
+
*
|
|
6866
|
+
* @see {@link DomainForwardZone} - The TypeScript type definition
|
|
6867
|
+
* @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
|
|
6868
|
+
*/
|
|
6869
|
+
export const KEY_DOMAIN_FORWARD_ZONE_ENABLED = 'enabled' as keyof DomainForwardZone;
|
|
6870
|
+
/**
|
|
6871
|
+
* protocols property
|
|
6872
|
+
*
|
|
6873
|
+
*
|
|
6874
|
+
*
|
|
6875
|
+
*
|
|
6876
|
+
* @remarks
|
|
6877
|
+
* This key constant provides type-safe access to the `protocols` property of DomainForwardZone objects.
|
|
6878
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6879
|
+
*
|
|
6880
|
+
* @example
|
|
6881
|
+
* ```typescript
|
|
6882
|
+
* // Direct property access
|
|
6883
|
+
* const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_PROTOCOLS];
|
|
6884
|
+
*
|
|
6885
|
+
* // Dynamic property access
|
|
6886
|
+
* const propertyName = KEY_DOMAIN_FORWARD_ZONE_PROTOCOLS;
|
|
6887
|
+
* const value = domainforwardzone[propertyName];
|
|
6888
|
+
* ```
|
|
6889
|
+
*
|
|
6890
|
+
* @see {@link DomainForwardZone} - The TypeScript type definition
|
|
6891
|
+
* @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
|
|
6892
|
+
*/
|
|
6893
|
+
export const KEY_DOMAIN_FORWARD_ZONE_PROTOCOLS = 'protocols' as keyof DomainForwardZone;
|
|
6894
|
+
/**
|
|
6895
|
+
* Wildcard
|
|
6896
|
+
*
|
|
6897
|
+
*
|
|
6898
|
+
* @type {boolean}
|
|
6899
|
+
*
|
|
6900
|
+
*
|
|
6901
|
+
* @remarks
|
|
6902
|
+
* This key constant provides type-safe access to the `wildcard` property of DomainForwardZone objects.
|
|
6903
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6904
|
+
*
|
|
6905
|
+
* @example
|
|
6906
|
+
* ```typescript
|
|
6907
|
+
* // Direct property access
|
|
6908
|
+
* const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_WILDCARD];
|
|
6909
|
+
*
|
|
6910
|
+
* // Dynamic property access
|
|
6911
|
+
* const propertyName = KEY_DOMAIN_FORWARD_ZONE_WILDCARD;
|
|
6912
|
+
* const value = domainforwardzone[propertyName];
|
|
6913
|
+
* ```
|
|
6914
|
+
*
|
|
6915
|
+
* @see {@link DomainForwardZone} - The TypeScript type definition
|
|
6916
|
+
* @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
|
|
6917
|
+
*/
|
|
6918
|
+
export const KEY_DOMAIN_FORWARD_ZONE_WILDCARD = 'wildcard' as keyof DomainForwardZone;
|
|
6919
|
+
/**
|
|
6920
|
+
* Zone Name
|
|
6921
|
+
*
|
|
6922
|
+
*
|
|
6923
|
+
* @type {string}
|
|
6924
|
+
*
|
|
6925
|
+
*
|
|
6926
|
+
* @remarks
|
|
6927
|
+
* This key constant provides type-safe access to the `zone_name` property of DomainForwardZone objects.
|
|
6928
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6929
|
+
*
|
|
6930
|
+
* @example
|
|
6931
|
+
* ```typescript
|
|
6932
|
+
* // Direct property access
|
|
6933
|
+
* const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME];
|
|
6934
|
+
*
|
|
6935
|
+
* // Dynamic property access
|
|
6936
|
+
* const propertyName = KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME;
|
|
6937
|
+
* const value = domainforwardzone[propertyName];
|
|
6938
|
+
* ```
|
|
6939
|
+
*
|
|
6940
|
+
* @see {@link DomainForwardZone} - The TypeScript type definition
|
|
6941
|
+
* @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
|
|
6942
|
+
*/
|
|
6943
|
+
export const KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME = 'zone_name' as keyof DomainForwardZone;
|
|
6944
|
+
|
|
6945
|
+
/**
|
|
6946
|
+
* Array of all DomainForwardZone property keys
|
|
6947
|
+
*
|
|
6948
|
+
* @remarks
|
|
6949
|
+
* This constant provides a readonly array containing all valid property keys for DomainForwardZone objects.
|
|
6950
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6951
|
+
*
|
|
6952
|
+
* @example
|
|
6953
|
+
* ```typescript
|
|
6954
|
+
* // Iterating through all keys
|
|
6955
|
+
* for (const key of KEYS_DOMAIN_FORWARD_ZONE) {
|
|
6956
|
+
* console.log(`Property: ${key}, Value: ${domainforwardzone[key]}`);
|
|
6957
|
+
* }
|
|
6958
|
+
*
|
|
6959
|
+
* // Validation
|
|
6960
|
+
* const isValidKey = KEYS_DOMAIN_FORWARD_ZONE.includes(someKey);
|
|
6961
|
+
* ```
|
|
6962
|
+
*
|
|
6963
|
+
* @see {@link DomainForwardZone} - The TypeScript type definition
|
|
6964
|
+
*/
|
|
6965
|
+
export const KEYS_DOMAIN_FORWARD_ZONE = [
|
|
6966
|
+
KEY_DOMAIN_FORWARD_ZONE_ENABLED,
|
|
6967
|
+
KEY_DOMAIN_FORWARD_ZONE_PROTOCOLS,
|
|
6968
|
+
KEY_DOMAIN_FORWARD_ZONE_WILDCARD,
|
|
6969
|
+
KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME,
|
|
6970
|
+
] as const satisfies (keyof DomainForwardZone)[];
|
|
6971
|
+
|
|
6590
6972
|
/**
|
|
6591
6973
|
* Add Grace Period
|
|
6592
6974
|
*
|
|
@@ -10331,6 +10713,81 @@ export const KEYS_HTTP_REDIRECT = [
|
|
|
10331
10713
|
KEY_HTTP_REDIRECT_TARGET_SUBDOMAIN,
|
|
10332
10714
|
] as const satisfies (keyof HttpRedirect)[];
|
|
10333
10715
|
|
|
10716
|
+
/**
|
|
10717
|
+
* Request Path
|
|
10718
|
+
*
|
|
10719
|
+
*
|
|
10720
|
+
* @type {string}
|
|
10721
|
+
*
|
|
10722
|
+
*
|
|
10723
|
+
* @remarks
|
|
10724
|
+
* This key constant provides type-safe access to the `request_path` property of HttpRedirectRemove objects.
|
|
10725
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10726
|
+
*
|
|
10727
|
+
* @example
|
|
10728
|
+
* ```typescript
|
|
10729
|
+
* // Direct property access
|
|
10730
|
+
* const value = httpredirectremove[KEY_HTTP_REDIRECT_REMOVE_REQUEST_PATH];
|
|
10731
|
+
*
|
|
10732
|
+
* // Dynamic property access
|
|
10733
|
+
* const propertyName = KEY_HTTP_REDIRECT_REMOVE_REQUEST_PATH;
|
|
10734
|
+
* const value = httpredirectremove[propertyName];
|
|
10735
|
+
* ```
|
|
10736
|
+
*
|
|
10737
|
+
* @see {@link HttpRedirectRemove} - The TypeScript type definition
|
|
10738
|
+
* @see {@link KEYS_HTTP_REDIRECT_REMOVE} - Array of all keys for this type
|
|
10739
|
+
*/
|
|
10740
|
+
export const KEY_HTTP_REDIRECT_REMOVE_REQUEST_PATH = 'request_path' as keyof HttpRedirectRemove;
|
|
10741
|
+
/**
|
|
10742
|
+
* Request Subdomain
|
|
10743
|
+
*
|
|
10744
|
+
*
|
|
10745
|
+
*
|
|
10746
|
+
*
|
|
10747
|
+
* @remarks
|
|
10748
|
+
* This key constant provides type-safe access to the `request_subdomain` property of HttpRedirectRemove objects.
|
|
10749
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10750
|
+
*
|
|
10751
|
+
* @example
|
|
10752
|
+
* ```typescript
|
|
10753
|
+
* // Direct property access
|
|
10754
|
+
* const value = httpredirectremove[KEY_HTTP_REDIRECT_REMOVE_REQUEST_SUBDOMAIN];
|
|
10755
|
+
*
|
|
10756
|
+
* // Dynamic property access
|
|
10757
|
+
* const propertyName = KEY_HTTP_REDIRECT_REMOVE_REQUEST_SUBDOMAIN;
|
|
10758
|
+
* const value = httpredirectremove[propertyName];
|
|
10759
|
+
* ```
|
|
10760
|
+
*
|
|
10761
|
+
* @see {@link HttpRedirectRemove} - The TypeScript type definition
|
|
10762
|
+
* @see {@link KEYS_HTTP_REDIRECT_REMOVE} - Array of all keys for this type
|
|
10763
|
+
*/
|
|
10764
|
+
export const KEY_HTTP_REDIRECT_REMOVE_REQUEST_SUBDOMAIN = 'request_subdomain' as keyof HttpRedirectRemove;
|
|
10765
|
+
|
|
10766
|
+
/**
|
|
10767
|
+
* Array of all HttpRedirectRemove property keys
|
|
10768
|
+
*
|
|
10769
|
+
* @remarks
|
|
10770
|
+
* This constant provides a readonly array containing all valid property keys for HttpRedirectRemove objects.
|
|
10771
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
10772
|
+
*
|
|
10773
|
+
* @example
|
|
10774
|
+
* ```typescript
|
|
10775
|
+
* // Iterating through all keys
|
|
10776
|
+
* for (const key of KEYS_HTTP_REDIRECT_REMOVE) {
|
|
10777
|
+
* console.log(`Property: ${key}, Value: ${httpredirectremove[key]}`);
|
|
10778
|
+
* }
|
|
10779
|
+
*
|
|
10780
|
+
* // Validation
|
|
10781
|
+
* const isValidKey = KEYS_HTTP_REDIRECT_REMOVE.includes(someKey);
|
|
10782
|
+
* ```
|
|
10783
|
+
*
|
|
10784
|
+
* @see {@link HttpRedirectRemove} - The TypeScript type definition
|
|
10785
|
+
*/
|
|
10786
|
+
export const KEYS_HTTP_REDIRECT_REMOVE = [
|
|
10787
|
+
KEY_HTTP_REDIRECT_REMOVE_REQUEST_PATH,
|
|
10788
|
+
KEY_HTTP_REDIRECT_REMOVE_REQUEST_SUBDOMAIN,
|
|
10789
|
+
] as const satisfies (keyof HttpRedirectRemove)[];
|
|
10790
|
+
|
|
10334
10791
|
/**
|
|
10335
10792
|
* Idn Capable
|
|
10336
10793
|
*
|
|
@@ -15122,6 +15579,56 @@ export const KEYS_PROBLEM = [
|
|
|
15122
15579
|
KEY_PROBLEM_TYPE,
|
|
15123
15580
|
] as const satisfies (keyof Problem)[];
|
|
15124
15581
|
|
|
15582
|
+
/**
|
|
15583
|
+
* Redirects
|
|
15584
|
+
*
|
|
15585
|
+
*
|
|
15586
|
+
* @type {array}
|
|
15587
|
+
*
|
|
15588
|
+
*
|
|
15589
|
+
* @remarks
|
|
15590
|
+
* This key constant provides type-safe access to the `redirects` property of ProtocolRedirects objects.
|
|
15591
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
15592
|
+
*
|
|
15593
|
+
* @example
|
|
15594
|
+
* ```typescript
|
|
15595
|
+
* // Direct property access
|
|
15596
|
+
* const value = protocolredirects[KEY_PROTOCOL_REDIRECTS_REDIRECTS];
|
|
15597
|
+
*
|
|
15598
|
+
* // Dynamic property access
|
|
15599
|
+
* const propertyName = KEY_PROTOCOL_REDIRECTS_REDIRECTS;
|
|
15600
|
+
* const value = protocolredirects[propertyName];
|
|
15601
|
+
* ```
|
|
15602
|
+
*
|
|
15603
|
+
* @see {@link ProtocolRedirects} - The TypeScript type definition
|
|
15604
|
+
* @see {@link KEYS_PROTOCOL_REDIRECTS} - Array of all keys for this type
|
|
15605
|
+
*/
|
|
15606
|
+
export const KEY_PROTOCOL_REDIRECTS_REDIRECTS = 'redirects' as keyof ProtocolRedirects;
|
|
15607
|
+
|
|
15608
|
+
/**
|
|
15609
|
+
* Array of all ProtocolRedirects property keys
|
|
15610
|
+
*
|
|
15611
|
+
* @remarks
|
|
15612
|
+
* This constant provides a readonly array containing all valid property keys for ProtocolRedirects objects.
|
|
15613
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
15614
|
+
*
|
|
15615
|
+
* @example
|
|
15616
|
+
* ```typescript
|
|
15617
|
+
* // Iterating through all keys
|
|
15618
|
+
* for (const key of KEYS_PROTOCOL_REDIRECTS) {
|
|
15619
|
+
* console.log(`Property: ${key}, Value: ${protocolredirects[key]}`);
|
|
15620
|
+
* }
|
|
15621
|
+
*
|
|
15622
|
+
* // Validation
|
|
15623
|
+
* const isValidKey = KEYS_PROTOCOL_REDIRECTS.includes(someKey);
|
|
15624
|
+
* ```
|
|
15625
|
+
*
|
|
15626
|
+
* @see {@link ProtocolRedirects} - The TypeScript type definition
|
|
15627
|
+
*/
|
|
15628
|
+
export const KEYS_PROTOCOL_REDIRECTS = [
|
|
15629
|
+
KEY_PROTOCOL_REDIRECTS_REDIRECTS,
|
|
15630
|
+
] as const satisfies (keyof ProtocolRedirects)[];
|
|
15631
|
+
|
|
15125
15632
|
/**
|
|
15126
15633
|
* Client Id
|
|
15127
15634
|
*
|
|
@@ -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, DomainForwardRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
37
|
+
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for POST AuthToken endpoint
|
|
@@ -1014,6 +1014,80 @@ export type PUT_DnsZoneNameRrsets_Request_Path = PUT_DnsZoneNameRrsets_Request['
|
|
|
1014
1014
|
*/
|
|
1015
1015
|
export type PUT_DnsZoneNameRrsets_Request_Body = PUT_DnsZoneNameRrsets_Request['requestBody'];
|
|
1016
1016
|
|
|
1017
|
+
/**
|
|
1018
|
+
* Request type for GET DomainForwards endpoint
|
|
1019
|
+
*
|
|
1020
|
+
* List Domain Forwards
|
|
1021
|
+
*
|
|
1022
|
+
* @remarks
|
|
1023
|
+
* This type defines the complete request structure for the GET DomainForwards endpoint.
|
|
1024
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1025
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1026
|
+
*
|
|
1027
|
+
* @example
|
|
1028
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1029
|
+
*
|
|
1030
|
+
* @path /v1/domain-forwards
|
|
1031
|
+
*
|
|
1032
|
+
* @see {@link GET_DomainForwards_Request_Query} - Query parameters type
|
|
1033
|
+
* @see {@link GET_DomainForwards_Request_Path} - Path parameters type
|
|
1034
|
+
* @see {@link GET_DomainForwards_Request_Body} - Request body type
|
|
1035
|
+
*/
|
|
1036
|
+
export type GET_DomainForwards_Request = {
|
|
1037
|
+
parameters: {
|
|
1038
|
+
query: operations['list_domain_forwards_v1_domain_forwards_get']['parameters']['query'];
|
|
1039
|
+
};
|
|
1040
|
+
}
|
|
1041
|
+
/**
|
|
1042
|
+
* Query parameters for GET /v1/domain-forwards
|
|
1043
|
+
*
|
|
1044
|
+
* @remarks
|
|
1045
|
+
* This type defines the query parameters for the GET /v1/domain-forwards endpoint.
|
|
1046
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
1047
|
+
*
|
|
1048
|
+
* @example
|
|
1049
|
+
* Use this type to ensure type safety for query parameters.
|
|
1050
|
+
*
|
|
1051
|
+
* @path /v1/domain-forwards
|
|
1052
|
+
*/
|
|
1053
|
+
export type GET_DomainForwards_Request_Query = GET_DomainForwards_Request['parameters']['query'];
|
|
1054
|
+
|
|
1055
|
+
/**
|
|
1056
|
+
* Request type for PATCH DomainForwards endpoint
|
|
1057
|
+
*
|
|
1058
|
+
* Patch Redirects
|
|
1059
|
+
*
|
|
1060
|
+
* @remarks
|
|
1061
|
+
* This type defines the complete request structure for the PATCH DomainForwards endpoint.
|
|
1062
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1063
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1064
|
+
*
|
|
1065
|
+
* @example
|
|
1066
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1067
|
+
*
|
|
1068
|
+
* @path /v1/domain-forwards
|
|
1069
|
+
*
|
|
1070
|
+
* @see {@link PATCH_DomainForwards_Request_Query} - Query parameters type
|
|
1071
|
+
* @see {@link PATCH_DomainForwards_Request_Path} - Path parameters type
|
|
1072
|
+
* @see {@link PATCH_DomainForwards_Request_Body} - Request body type
|
|
1073
|
+
*/
|
|
1074
|
+
export type PATCH_DomainForwards_Request = {
|
|
1075
|
+
requestBody: DomainForwardPatchOps;
|
|
1076
|
+
}
|
|
1077
|
+
/**
|
|
1078
|
+
* Request body for PATCH /v1/domain-forwards
|
|
1079
|
+
*
|
|
1080
|
+
* @remarks
|
|
1081
|
+
* This type defines the request body structure for the PATCH /v1/domain-forwards endpoint.
|
|
1082
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
1083
|
+
*
|
|
1084
|
+
* @example
|
|
1085
|
+
* Use this type to ensure type safety for request body structure.
|
|
1086
|
+
*
|
|
1087
|
+
* @path /v1/domain-forwards
|
|
1088
|
+
*/
|
|
1089
|
+
export type PATCH_DomainForwards_Request_Body = PATCH_DomainForwards_Request['requestBody'];
|
|
1090
|
+
|
|
1017
1091
|
/**
|
|
1018
1092
|
* Request type for PATCH DomainForwardsZoneNameDisable endpoint
|
|
1019
1093
|
*
|