@opusdns/api 0.212.0 → 0.213.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/constants.ts +105 -1
- package/src/helpers/keys.ts +158 -0
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +48 -0
- package/src/openapi.yaml +52 -1
- package/src/schema.d.ts +35 -0
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -2494,6 +2494,110 @@ export const LAUNCH_PHASE_TYPE_VALUES = [
|
|
|
2494
2494
|
'eap'
|
|
2495
2495
|
] as const satisfies [string, ...string[]] | LaunchPhaseType[];
|
|
2496
2496
|
|
|
2497
|
+
/**
|
|
2498
|
+
* LegalRequirementOperationType. Auto-generated enum for LegalRequirementOperationType
|
|
2499
|
+
*
|
|
2500
|
+
* @remarks
|
|
2501
|
+
* This constant provides both object and array forms for the LegalRequirementOperationType enum.
|
|
2502
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
2503
|
+
*
|
|
2504
|
+
* @example
|
|
2505
|
+
* ```typescript
|
|
2506
|
+
* // Using the object form for key-value access
|
|
2507
|
+
* const status = LEGAL_REQUIREMENT_OPERATION_TYPE.SUCCESS;
|
|
2508
|
+
*
|
|
2509
|
+
* // Using the array form for iteration
|
|
2510
|
+
* const allStatuses = LEGAL_REQUIREMENT_OPERATION_TYPE_VALUES;
|
|
2511
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
2512
|
+
* ```
|
|
2513
|
+
*
|
|
2514
|
+
* @see {@link LegalRequirementOperationType} - The TypeScript type definition
|
|
2515
|
+
*/
|
|
2516
|
+
export const LEGAL_REQUIREMENT_OPERATION_TYPE = {
|
|
2517
|
+
REGISTRATION: "registration",
|
|
2518
|
+
TRANSFER: "transfer",
|
|
2519
|
+
RENEWAL: "renewal",
|
|
2520
|
+
REGISTRANT_CHANGE: "registrant_change",
|
|
2521
|
+
} as const satisfies Record<string, LegalRequirementOperationType>;
|
|
2522
|
+
|
|
2523
|
+
/**
|
|
2524
|
+
* Array of all LegalRequirementOperationType enum values
|
|
2525
|
+
*
|
|
2526
|
+
* @remarks
|
|
2527
|
+
* This constant provides a array containing all valid LegalRequirementOperationType enum values.
|
|
2528
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2529
|
+
*
|
|
2530
|
+
* @example
|
|
2531
|
+
* ```typescript
|
|
2532
|
+
* // Iterating through all values
|
|
2533
|
+
* for (const value of LEGAL_REQUIREMENT_OPERATION_TYPE_VALUES) {
|
|
2534
|
+
* console.log(`Processing: ${value}`);
|
|
2535
|
+
* }
|
|
2536
|
+
*
|
|
2537
|
+
* // Validation
|
|
2538
|
+
* const isValid = LEGAL_REQUIREMENT_OPERATION_TYPE_VALUES.includes(someValue);
|
|
2539
|
+
* ```
|
|
2540
|
+
*
|
|
2541
|
+
* @see {@link LegalRequirementOperationType} - The TypeScript type definition
|
|
2542
|
+
* @see {@link LEGAL_REQUIREMENT_OPERATION_TYPE} - The object form of this enum
|
|
2543
|
+
*/
|
|
2544
|
+
export const LEGAL_REQUIREMENT_OPERATION_TYPE_VALUES = [
|
|
2545
|
+
'registration',
|
|
2546
|
+
'transfer',
|
|
2547
|
+
'renewal',
|
|
2548
|
+
'registrant_change'
|
|
2549
|
+
] as const satisfies [string, ...string[]] | LegalRequirementOperationType[];
|
|
2550
|
+
|
|
2551
|
+
/**
|
|
2552
|
+
* LegalRequirementType. Auto-generated enum for LegalRequirementType
|
|
2553
|
+
*
|
|
2554
|
+
* @remarks
|
|
2555
|
+
* This constant provides both object and array forms for the LegalRequirementType enum.
|
|
2556
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
2557
|
+
*
|
|
2558
|
+
* @example
|
|
2559
|
+
* ```typescript
|
|
2560
|
+
* // Using the object form for key-value access
|
|
2561
|
+
* const status = LEGAL_REQUIREMENT_TYPE.SUCCESS;
|
|
2562
|
+
*
|
|
2563
|
+
* // Using the array form for iteration
|
|
2564
|
+
* const allStatuses = LEGAL_REQUIREMENT_TYPE_VALUES;
|
|
2565
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
2566
|
+
* ```
|
|
2567
|
+
*
|
|
2568
|
+
* @see {@link LegalRequirementType} - The TypeScript type definition
|
|
2569
|
+
*/
|
|
2570
|
+
export const LEGAL_REQUIREMENT_TYPE = {
|
|
2571
|
+
NOTICE: "notice",
|
|
2572
|
+
CONFIRMATION: "confirmation",
|
|
2573
|
+
} as const satisfies Record<string, LegalRequirementType>;
|
|
2574
|
+
|
|
2575
|
+
/**
|
|
2576
|
+
* Array of all LegalRequirementType enum values
|
|
2577
|
+
*
|
|
2578
|
+
* @remarks
|
|
2579
|
+
* This constant provides a array containing all valid LegalRequirementType enum values.
|
|
2580
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2581
|
+
*
|
|
2582
|
+
* @example
|
|
2583
|
+
* ```typescript
|
|
2584
|
+
* // Iterating through all values
|
|
2585
|
+
* for (const value of LEGAL_REQUIREMENT_TYPE_VALUES) {
|
|
2586
|
+
* console.log(`Processing: ${value}`);
|
|
2587
|
+
* }
|
|
2588
|
+
*
|
|
2589
|
+
* // Validation
|
|
2590
|
+
* const isValid = LEGAL_REQUIREMENT_TYPE_VALUES.includes(someValue);
|
|
2591
|
+
* ```
|
|
2592
|
+
*
|
|
2593
|
+
* @see {@link LegalRequirementType} - The TypeScript type definition
|
|
2594
|
+
* @see {@link LEGAL_REQUIREMENT_TYPE} - The object form of this enum
|
|
2595
|
+
*/
|
|
2596
|
+
export const LEGAL_REQUIREMENT_TYPE_VALUES = [
|
|
2597
|
+
'notice',
|
|
2598
|
+
'confirmation'
|
|
2599
|
+
] as const satisfies [string, ...string[]] | LegalRequirementType[];
|
|
2600
|
+
|
|
2497
2601
|
/**
|
|
2498
2602
|
* LocalPresenceRequirementType. Auto-generated enum for LocalPresenceRequirementType
|
|
2499
2603
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -148,6 +148,7 @@ import { IpRestriction } from './schemas';
|
|
|
148
148
|
import { IpRestrictionUpdate } from './schemas';
|
|
149
149
|
import { LaunchPhaseBase } from './schemas';
|
|
150
150
|
import { LaunchPhasesBase } from './schemas';
|
|
151
|
+
import { LegalRequirementBase } from './schemas';
|
|
151
152
|
import { LocalPresenceBase } from './schemas';
|
|
152
153
|
import { Nameserver } from './schemas';
|
|
153
154
|
import { ObjectLog } from './schemas';
|
|
@@ -16851,6 +16852,136 @@ export const KEYS_LAUNCH_PHASES_BASE = [
|
|
|
16851
16852
|
KEY_LAUNCH_PHASES_BASE_TRADEMARK_CLAIMS,
|
|
16852
16853
|
] as const satisfies (keyof LaunchPhasesBase)[];
|
|
16853
16854
|
|
|
16855
|
+
/**
|
|
16856
|
+
* Key
|
|
16857
|
+
*
|
|
16858
|
+
* Unique identifier for the legal requirement
|
|
16859
|
+
*
|
|
16860
|
+
* @type {string}
|
|
16861
|
+
*
|
|
16862
|
+
*
|
|
16863
|
+
* @remarks
|
|
16864
|
+
* This key constant provides type-safe access to the `key` property of LegalRequirementBase objects.
|
|
16865
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
16866
|
+
*
|
|
16867
|
+
* @example
|
|
16868
|
+
* ```typescript
|
|
16869
|
+
* // Direct property access
|
|
16870
|
+
* const value = legalrequirementbase[KEY_LEGAL_REQUIREMENT_BASE_KEY];
|
|
16871
|
+
*
|
|
16872
|
+
* // Dynamic property access
|
|
16873
|
+
* const propertyName = KEY_LEGAL_REQUIREMENT_BASE_KEY;
|
|
16874
|
+
* const value = legalrequirementbase[propertyName];
|
|
16875
|
+
* ```
|
|
16876
|
+
*
|
|
16877
|
+
* @see {@link LegalRequirementBase} - The TypeScript type definition
|
|
16878
|
+
* @see {@link KEYS_LEGAL_REQUIREMENT_BASE} - Array of all keys for this type
|
|
16879
|
+
*/
|
|
16880
|
+
export const KEY_LEGAL_REQUIREMENT_BASE_KEY: keyof LegalRequirementBase = 'key';
|
|
16881
|
+
/**
|
|
16882
|
+
* Operations
|
|
16883
|
+
*
|
|
16884
|
+
* Operations this requirement applies to
|
|
16885
|
+
*
|
|
16886
|
+
* @type {array}
|
|
16887
|
+
*
|
|
16888
|
+
*
|
|
16889
|
+
* @remarks
|
|
16890
|
+
* This key constant provides type-safe access to the `operations` property of LegalRequirementBase objects.
|
|
16891
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
16892
|
+
*
|
|
16893
|
+
* @example
|
|
16894
|
+
* ```typescript
|
|
16895
|
+
* // Direct property access
|
|
16896
|
+
* const value = legalrequirementbase[KEY_LEGAL_REQUIREMENT_BASE_OPERATIONS];
|
|
16897
|
+
*
|
|
16898
|
+
* // Dynamic property access
|
|
16899
|
+
* const propertyName = KEY_LEGAL_REQUIREMENT_BASE_OPERATIONS;
|
|
16900
|
+
* const value = legalrequirementbase[propertyName];
|
|
16901
|
+
* ```
|
|
16902
|
+
*
|
|
16903
|
+
* @see {@link LegalRequirementBase} - The TypeScript type definition
|
|
16904
|
+
* @see {@link KEYS_LEGAL_REQUIREMENT_BASE} - Array of all keys for this type
|
|
16905
|
+
*/
|
|
16906
|
+
export const KEY_LEGAL_REQUIREMENT_BASE_OPERATIONS: keyof LegalRequirementBase = 'operations';
|
|
16907
|
+
/**
|
|
16908
|
+
* type property
|
|
16909
|
+
*
|
|
16910
|
+
* Whether this is an informational notice or requires explicit confirmation
|
|
16911
|
+
*
|
|
16912
|
+
*
|
|
16913
|
+
*
|
|
16914
|
+
* @remarks
|
|
16915
|
+
* This key constant provides type-safe access to the `type` property of LegalRequirementBase objects.
|
|
16916
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
16917
|
+
*
|
|
16918
|
+
* @example
|
|
16919
|
+
* ```typescript
|
|
16920
|
+
* // Direct property access
|
|
16921
|
+
* const value = legalrequirementbase[KEY_LEGAL_REQUIREMENT_BASE_TYPE];
|
|
16922
|
+
*
|
|
16923
|
+
* // Dynamic property access
|
|
16924
|
+
* const propertyName = KEY_LEGAL_REQUIREMENT_BASE_TYPE;
|
|
16925
|
+
* const value = legalrequirementbase[propertyName];
|
|
16926
|
+
* ```
|
|
16927
|
+
*
|
|
16928
|
+
* @see {@link LegalRequirementBase} - The TypeScript type definition
|
|
16929
|
+
* @see {@link KEYS_LEGAL_REQUIREMENT_BASE} - Array of all keys for this type
|
|
16930
|
+
*/
|
|
16931
|
+
export const KEY_LEGAL_REQUIREMENT_BASE_TYPE: keyof LegalRequirementBase = 'type';
|
|
16932
|
+
/**
|
|
16933
|
+
* Url
|
|
16934
|
+
*
|
|
16935
|
+
* Link to the legal document
|
|
16936
|
+
*
|
|
16937
|
+
*
|
|
16938
|
+
*
|
|
16939
|
+
* @remarks
|
|
16940
|
+
* This key constant provides type-safe access to the `url` property of LegalRequirementBase objects.
|
|
16941
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
16942
|
+
*
|
|
16943
|
+
* @example
|
|
16944
|
+
* ```typescript
|
|
16945
|
+
* // Direct property access
|
|
16946
|
+
* const value = legalrequirementbase[KEY_LEGAL_REQUIREMENT_BASE_URL];
|
|
16947
|
+
*
|
|
16948
|
+
* // Dynamic property access
|
|
16949
|
+
* const propertyName = KEY_LEGAL_REQUIREMENT_BASE_URL;
|
|
16950
|
+
* const value = legalrequirementbase[propertyName];
|
|
16951
|
+
* ```
|
|
16952
|
+
*
|
|
16953
|
+
* @see {@link LegalRequirementBase} - The TypeScript type definition
|
|
16954
|
+
* @see {@link KEYS_LEGAL_REQUIREMENT_BASE} - Array of all keys for this type
|
|
16955
|
+
*/
|
|
16956
|
+
export const KEY_LEGAL_REQUIREMENT_BASE_URL: keyof LegalRequirementBase = 'url';
|
|
16957
|
+
|
|
16958
|
+
/**
|
|
16959
|
+
* Array of all LegalRequirementBase property keys
|
|
16960
|
+
*
|
|
16961
|
+
* @remarks
|
|
16962
|
+
* This constant provides a readonly array containing all valid property keys for LegalRequirementBase objects.
|
|
16963
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
16964
|
+
*
|
|
16965
|
+
* @example
|
|
16966
|
+
* ```typescript
|
|
16967
|
+
* // Iterating through all keys
|
|
16968
|
+
* for (const key of KEYS_LEGAL_REQUIREMENT_BASE) {
|
|
16969
|
+
* console.log(`Property: ${key}, Value: ${legalrequirementbase[key]}`);
|
|
16970
|
+
* }
|
|
16971
|
+
*
|
|
16972
|
+
* // Validation
|
|
16973
|
+
* const isValidKey = KEYS_LEGAL_REQUIREMENT_BASE.includes(someKey);
|
|
16974
|
+
* ```
|
|
16975
|
+
*
|
|
16976
|
+
* @see {@link LegalRequirementBase} - The TypeScript type definition
|
|
16977
|
+
*/
|
|
16978
|
+
export const KEYS_LEGAL_REQUIREMENT_BASE = [
|
|
16979
|
+
KEY_LEGAL_REQUIREMENT_BASE_KEY,
|
|
16980
|
+
KEY_LEGAL_REQUIREMENT_BASE_OPERATIONS,
|
|
16981
|
+
KEY_LEGAL_REQUIREMENT_BASE_TYPE,
|
|
16982
|
+
KEY_LEGAL_REQUIREMENT_BASE_URL,
|
|
16983
|
+
] as const satisfies (keyof LegalRequirementBase)[];
|
|
16984
|
+
|
|
16854
16985
|
/**
|
|
16855
16986
|
* Eligible Countries
|
|
16856
16987
|
*
|
|
@@ -23630,6 +23761,32 @@ export const KEY_TLD_SPECIFICATION_IDN: keyof TldSpecification = 'idn';
|
|
|
23630
23761
|
* @see {@link KEYS_TLD_SPECIFICATION} - Array of all keys for this type
|
|
23631
23762
|
*/
|
|
23632
23763
|
export const KEY_TLD_SPECIFICATION_LAUNCH_PHASES: keyof TldSpecification = 'launch_phases';
|
|
23764
|
+
/**
|
|
23765
|
+
* Legal Requirements
|
|
23766
|
+
*
|
|
23767
|
+
* Legal requirements that must be met for this TLD
|
|
23768
|
+
*
|
|
23769
|
+
* @type {array}
|
|
23770
|
+
*
|
|
23771
|
+
*
|
|
23772
|
+
* @remarks
|
|
23773
|
+
* This key constant provides type-safe access to the `legal_requirements` property of TldSpecification objects.
|
|
23774
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
23775
|
+
*
|
|
23776
|
+
* @example
|
|
23777
|
+
* ```typescript
|
|
23778
|
+
* // Direct property access
|
|
23779
|
+
* const value = tldspecification[KEY_TLD_SPECIFICATION_LEGAL_REQUIREMENTS];
|
|
23780
|
+
*
|
|
23781
|
+
* // Dynamic property access
|
|
23782
|
+
* const propertyName = KEY_TLD_SPECIFICATION_LEGAL_REQUIREMENTS;
|
|
23783
|
+
* const value = tldspecification[propertyName];
|
|
23784
|
+
* ```
|
|
23785
|
+
*
|
|
23786
|
+
* @see {@link TldSpecification} - The TypeScript type definition
|
|
23787
|
+
* @see {@link KEYS_TLD_SPECIFICATION} - Array of all keys for this type
|
|
23788
|
+
*/
|
|
23789
|
+
export const KEY_TLD_SPECIFICATION_LEGAL_REQUIREMENTS: keyof TldSpecification = 'legal_requirements';
|
|
23633
23790
|
/**
|
|
23634
23791
|
* local_presence property
|
|
23635
23792
|
*
|
|
@@ -23886,6 +24043,7 @@ export const KEYS_TLD_SPECIFICATION = [
|
|
|
23886
24043
|
KEY_TLD_SPECIFICATION_DOMAIN_STATUSES,
|
|
23887
24044
|
KEY_TLD_SPECIFICATION_IDN,
|
|
23888
24045
|
KEY_TLD_SPECIFICATION_LAUNCH_PHASES,
|
|
24046
|
+
KEY_TLD_SPECIFICATION_LEGAL_REQUIREMENTS,
|
|
23889
24047
|
KEY_TLD_SPECIFICATION_LOCAL_PRESENCE,
|
|
23890
24048
|
KEY_TLD_SPECIFICATION_PARKING_ENABLED,
|
|
23891
24049
|
KEY_TLD_SPECIFICATION_PREMIUM_DOMAINS,
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, AttributeCondition, DomainContactType, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, AttributeCondition, DomainContactType, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -709,6 +709,20 @@ export type ValidationErrorArray = ValidationError[];
|
|
|
709
709
|
* @see {@link LaunchPhaseBase} - The individual LaunchPhaseBase type definition
|
|
710
710
|
*/
|
|
711
711
|
export type LaunchPhaseBaseArray = LaunchPhaseBase[];
|
|
712
|
+
/**
|
|
713
|
+
* LegalRequirementOperationType
|
|
714
|
+
*
|
|
715
|
+
* @remarks
|
|
716
|
+
* Array type for LegalRequirementOperationType objects. Used when the API returns a collection of LegalRequirementOperationType instances.
|
|
717
|
+
*
|
|
718
|
+
* @example
|
|
719
|
+
* ```typescript
|
|
720
|
+
* const items: LegalRequirementOperationTypeArray = await api.getLegalRequirementOperationTypes();
|
|
721
|
+
* ```
|
|
722
|
+
*
|
|
723
|
+
* @see {@link LegalRequirementOperationType} - The individual LegalRequirementOperationType type definition
|
|
724
|
+
*/
|
|
725
|
+
export type LegalRequirementOperationTypeArray = LegalRequirementOperationType[];
|
|
712
726
|
/**
|
|
713
727
|
* LocalPresenceRequirementType
|
|
714
728
|
*
|
|
@@ -1045,6 +1059,20 @@ export type PremiumAffectsTypeArray = PremiumAffectsType[];
|
|
|
1045
1059
|
* @see {@link Relation} - The individual Relation type definition
|
|
1046
1060
|
*/
|
|
1047
1061
|
export type RelationArray = Relation[];
|
|
1062
|
+
/**
|
|
1063
|
+
* LegalRequirementBase
|
|
1064
|
+
*
|
|
1065
|
+
* @remarks
|
|
1066
|
+
* Array type for LegalRequirementBase objects. Used when the API returns a collection of LegalRequirementBase instances.
|
|
1067
|
+
*
|
|
1068
|
+
* @example
|
|
1069
|
+
* ```typescript
|
|
1070
|
+
* const items: LegalRequirementBaseArray = await api.getLegalRequirementBases();
|
|
1071
|
+
* ```
|
|
1072
|
+
*
|
|
1073
|
+
* @see {@link LegalRequirementBase} - The individual LegalRequirementBase type definition
|
|
1074
|
+
*/
|
|
1075
|
+
export type LegalRequirementBaseArray = LegalRequirementBase[];
|
|
1048
1076
|
/**
|
|
1049
1077
|
* TldBase
|
|
1050
1078
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -2740,6 +2740,54 @@ export type LaunchPhaseType = components['schemas']['LaunchPhaseType'];
|
|
|
2740
2740
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2741
2741
|
*/
|
|
2742
2742
|
export type LaunchPhasesBase = components['schemas']['LaunchPhasesBase'];
|
|
2743
|
+
/**
|
|
2744
|
+
* LegalRequirementBase
|
|
2745
|
+
*
|
|
2746
|
+
* @remarks
|
|
2747
|
+
* Type alias for the `LegalRequirementBase` OpenAPI schema.
|
|
2748
|
+
* This type represents legalrequirementbase data structures used in API requests and responses.
|
|
2749
|
+
*
|
|
2750
|
+
* @example
|
|
2751
|
+
* ```typescript
|
|
2752
|
+
* const response = await api.getLegalRequirementBase();
|
|
2753
|
+
* const item: LegalRequirementBase = response.results;
|
|
2754
|
+
* ```
|
|
2755
|
+
*
|
|
2756
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2757
|
+
*/
|
|
2758
|
+
export type LegalRequirementBase = components['schemas']['LegalRequirementBase'];
|
|
2759
|
+
/**
|
|
2760
|
+
* LegalRequirementOperationType
|
|
2761
|
+
*
|
|
2762
|
+
* @remarks
|
|
2763
|
+
* Type alias for the `LegalRequirementOperationType` OpenAPI schema.
|
|
2764
|
+
* This type represents legalrequirementoperationtype data structures used in API requests and responses.
|
|
2765
|
+
*
|
|
2766
|
+
* @example
|
|
2767
|
+
* ```typescript
|
|
2768
|
+
* const response = await api.getLegalRequirementOperationType();
|
|
2769
|
+
* const item: LegalRequirementOperationType = response.results;
|
|
2770
|
+
* ```
|
|
2771
|
+
*
|
|
2772
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2773
|
+
*/
|
|
2774
|
+
export type LegalRequirementOperationType = components['schemas']['LegalRequirementOperationType'];
|
|
2775
|
+
/**
|
|
2776
|
+
* LegalRequirementType
|
|
2777
|
+
*
|
|
2778
|
+
* @remarks
|
|
2779
|
+
* Type alias for the `LegalRequirementType` OpenAPI schema.
|
|
2780
|
+
* This type represents legalrequirementtype data structures used in API requests and responses.
|
|
2781
|
+
*
|
|
2782
|
+
* @example
|
|
2783
|
+
* ```typescript
|
|
2784
|
+
* const response = await api.getLegalRequirementType();
|
|
2785
|
+
* const item: LegalRequirementType = response.results;
|
|
2786
|
+
* ```
|
|
2787
|
+
*
|
|
2788
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2789
|
+
*/
|
|
2790
|
+
export type LegalRequirementType = components['schemas']['LegalRequirementType'];
|
|
2743
2791
|
/**
|
|
2744
2792
|
* LocalPresenceBase
|
|
2745
2793
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -4122,6 +4122,51 @@ components:
|
|
|
4122
4122
|
- general_availability
|
|
4123
4123
|
title: LaunchPhasesBase
|
|
4124
4124
|
type: object
|
|
4125
|
+
LegalRequirementBase:
|
|
4126
|
+
properties:
|
|
4127
|
+
key:
|
|
4128
|
+
description: Unique identifier for the legal requirement
|
|
4129
|
+
title: Key
|
|
4130
|
+
type: string
|
|
4131
|
+
operations:
|
|
4132
|
+
description: Operations this requirement applies to
|
|
4133
|
+
items:
|
|
4134
|
+
$ref: '#/components/schemas/LegalRequirementOperationType'
|
|
4135
|
+
title: Operations
|
|
4136
|
+
type: array
|
|
4137
|
+
type:
|
|
4138
|
+
$ref: '#/components/schemas/LegalRequirementType'
|
|
4139
|
+
description: Whether this is an informational notice or requires explicit
|
|
4140
|
+
confirmation
|
|
4141
|
+
url:
|
|
4142
|
+
anyOf:
|
|
4143
|
+
- format: uri
|
|
4144
|
+
maxLength: 2083
|
|
4145
|
+
minLength: 1
|
|
4146
|
+
type: string
|
|
4147
|
+
- type: 'null'
|
|
4148
|
+
description: Link to the legal document
|
|
4149
|
+
title: Url
|
|
4150
|
+
required:
|
|
4151
|
+
- key
|
|
4152
|
+
- type
|
|
4153
|
+
- operations
|
|
4154
|
+
title: LegalRequirementBase
|
|
4155
|
+
type: object
|
|
4156
|
+
LegalRequirementOperationType:
|
|
4157
|
+
enum:
|
|
4158
|
+
- registration
|
|
4159
|
+
- transfer
|
|
4160
|
+
- renewal
|
|
4161
|
+
- registrant_change
|
|
4162
|
+
title: LegalRequirementOperationType
|
|
4163
|
+
type: string
|
|
4164
|
+
LegalRequirementType:
|
|
4165
|
+
enum:
|
|
4166
|
+
- notice
|
|
4167
|
+
- confirmation
|
|
4168
|
+
title: LegalRequirementType
|
|
4169
|
+
type: string
|
|
4125
4170
|
LocalPresenceBase:
|
|
4126
4171
|
properties:
|
|
4127
4172
|
eligible_countries:
|
|
@@ -6160,6 +6205,12 @@ components:
|
|
|
6160
6205
|
- $ref: '#/components/schemas/LaunchPhasesBase'
|
|
6161
6206
|
- type: 'null'
|
|
6162
6207
|
description: Launch phases configuration
|
|
6208
|
+
legal_requirements:
|
|
6209
|
+
description: Legal requirements that must be met for this TLD
|
|
6210
|
+
items:
|
|
6211
|
+
$ref: '#/components/schemas/LegalRequirementBase'
|
|
6212
|
+
title: Legal Requirements
|
|
6213
|
+
type: array
|
|
6163
6214
|
local_presence:
|
|
6164
6215
|
anyOf:
|
|
6165
6216
|
- $ref: '#/components/schemas/LocalPresenceBase'
|
|
@@ -7226,7 +7277,7 @@ info:
|
|
|
7226
7277
|
'
|
|
7227
7278
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
7228
7279
|
title: OpusDNS API
|
|
7229
|
-
version: 2026-03-
|
|
7280
|
+
version: 2026-03-03-135652
|
|
7230
7281
|
x-logo:
|
|
7231
7282
|
altText: OpusDNS API Reference
|
|
7232
7283
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -4702,6 +4702,36 @@ export interface components {
|
|
|
4702
4702
|
phases: components["schemas"]["LaunchPhaseBase"][];
|
|
4703
4703
|
trademark_claims?: components["schemas"]["TrademarkClaimsBase"] | null;
|
|
4704
4704
|
};
|
|
4705
|
+
/** LegalRequirementBase */
|
|
4706
|
+
LegalRequirementBase: {
|
|
4707
|
+
/**
|
|
4708
|
+
* Key
|
|
4709
|
+
* @description Unique identifier for the legal requirement
|
|
4710
|
+
*/
|
|
4711
|
+
key: string;
|
|
4712
|
+
/**
|
|
4713
|
+
* Operations
|
|
4714
|
+
* @description Operations this requirement applies to
|
|
4715
|
+
*/
|
|
4716
|
+
operations: components["schemas"]["LegalRequirementOperationType"][];
|
|
4717
|
+
/** @description Whether this is an informational notice or requires explicit confirmation */
|
|
4718
|
+
type: components["schemas"]["LegalRequirementType"];
|
|
4719
|
+
/**
|
|
4720
|
+
* Url
|
|
4721
|
+
* @description Link to the legal document
|
|
4722
|
+
*/
|
|
4723
|
+
url?: string | null;
|
|
4724
|
+
};
|
|
4725
|
+
/**
|
|
4726
|
+
* LegalRequirementOperationType
|
|
4727
|
+
* @enum {string}
|
|
4728
|
+
*/
|
|
4729
|
+
LegalRequirementOperationType: "registration" | "transfer" | "renewal" | "registrant_change";
|
|
4730
|
+
/**
|
|
4731
|
+
* LegalRequirementType
|
|
4732
|
+
* @enum {string}
|
|
4733
|
+
*/
|
|
4734
|
+
LegalRequirementType: "notice" | "confirmation";
|
|
4705
4735
|
/** LocalPresenceBase */
|
|
4706
4736
|
LocalPresenceBase: {
|
|
4707
4737
|
/**
|
|
@@ -6005,6 +6035,11 @@ export interface components {
|
|
|
6005
6035
|
idn: components["schemas"]["IdnBase"];
|
|
6006
6036
|
/** @description Launch phases configuration */
|
|
6007
6037
|
launch_phases?: components["schemas"]["LaunchPhasesBase"] | null;
|
|
6038
|
+
/**
|
|
6039
|
+
* Legal Requirements
|
|
6040
|
+
* @description Legal requirements that must be met for this TLD
|
|
6041
|
+
*/
|
|
6042
|
+
legal_requirements?: components["schemas"]["LegalRequirementBase"][];
|
|
6008
6043
|
/** @description Local presence requirements */
|
|
6009
6044
|
local_presence?: components["schemas"]["LocalPresenceBase"] | null;
|
|
6010
6045
|
/**
|