@opusdns/api 0.289.0 → 0.290.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 +1641 -0
- package/src/helpers/requests.d.ts +45 -5
- package/src/helpers/responses.d.ts +121 -8
- package/src/helpers/schemas-arrays.d.ts +99 -1
- package/src/helpers/schemas.d.ts +224 -0
- package/src/openapi.yaml +507 -40
- package/src/schema.d.ts +377 -27
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MemoryFactKind, MessageContextKind, MessageRole, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, ContactSortField, ContactType, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HolderEntitlement, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MemoryFactKind, MessageContextKind, MessageRole, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -729,6 +729,58 @@ export const CONTACT_SORT_FIELD_VALUES = [
|
|
|
729
729
|
'created_on'
|
|
730
730
|
] as const satisfies [string, ...string[]] | ContactSortField[];
|
|
731
731
|
|
|
732
|
+
/**
|
|
733
|
+
* ContactType. Auto-generated enum for ContactType
|
|
734
|
+
*
|
|
735
|
+
* @remarks
|
|
736
|
+
* This constant provides both object and array forms for the ContactType enum.
|
|
737
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
738
|
+
*
|
|
739
|
+
* @example
|
|
740
|
+
* ```typescript
|
|
741
|
+
* // Using the object form for key-value access
|
|
742
|
+
* const status = CONTACT_TYPE.SUCCESS;
|
|
743
|
+
*
|
|
744
|
+
* // Using the array form for iteration
|
|
745
|
+
* const allStatuses = CONTACT_TYPE_VALUES;
|
|
746
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
747
|
+
* ```
|
|
748
|
+
*
|
|
749
|
+
* @see {@link ContactType} - The TypeScript type definition
|
|
750
|
+
*/
|
|
751
|
+
export const CONTACT_TYPE = {
|
|
752
|
+
OWNER: "owner",
|
|
753
|
+
AGENT: "agent",
|
|
754
|
+
THIRD_PARTY: "third party",
|
|
755
|
+
} as const satisfies Record<string, ContactType>;
|
|
756
|
+
|
|
757
|
+
/**
|
|
758
|
+
* Array of all ContactType enum values
|
|
759
|
+
*
|
|
760
|
+
* @remarks
|
|
761
|
+
* This constant provides a array containing all valid ContactType enum values.
|
|
762
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
763
|
+
*
|
|
764
|
+
* @example
|
|
765
|
+
* ```typescript
|
|
766
|
+
* // Iterating through all values
|
|
767
|
+
* for (const value of CONTACT_TYPE_VALUES) {
|
|
768
|
+
* console.log(`Processing: ${value}`);
|
|
769
|
+
* }
|
|
770
|
+
*
|
|
771
|
+
* // Validation
|
|
772
|
+
* const isValid = CONTACT_TYPE_VALUES.includes(someValue);
|
|
773
|
+
* ```
|
|
774
|
+
*
|
|
775
|
+
* @see {@link ContactType} - The TypeScript type definition
|
|
776
|
+
* @see {@link CONTACT_TYPE} - The object form of this enum
|
|
777
|
+
*/
|
|
778
|
+
export const CONTACT_TYPE_VALUES = [
|
|
779
|
+
'owner',
|
|
780
|
+
'agent',
|
|
781
|
+
'third party'
|
|
782
|
+
] as const satisfies [string, ...string[]] | ContactType[];
|
|
783
|
+
|
|
732
784
|
/**
|
|
733
785
|
* Currency. Auto-generated enum for Currency
|
|
734
786
|
*
|
|
@@ -2394,6 +2446,58 @@ export const HTTP_METHOD_VALUES = [
|
|
|
2394
2446
|
'TRACE'
|
|
2395
2447
|
] as const satisfies [string, ...string[]] | HTTPMethod[];
|
|
2396
2448
|
|
|
2449
|
+
/**
|
|
2450
|
+
* HolderEntitlement. Auto-generated enum for HolderEntitlement
|
|
2451
|
+
*
|
|
2452
|
+
* @remarks
|
|
2453
|
+
* This constant provides both object and array forms for the HolderEntitlement enum.
|
|
2454
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
2455
|
+
*
|
|
2456
|
+
* @example
|
|
2457
|
+
* ```typescript
|
|
2458
|
+
* // Using the object form for key-value access
|
|
2459
|
+
* const status = HOLDER_ENTITLEMENT.SUCCESS;
|
|
2460
|
+
*
|
|
2461
|
+
* // Using the array form for iteration
|
|
2462
|
+
* const allStatuses = HOLDER_ENTITLEMENT_VALUES;
|
|
2463
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
2464
|
+
* ```
|
|
2465
|
+
*
|
|
2466
|
+
* @see {@link HolderEntitlement} - The TypeScript type definition
|
|
2467
|
+
*/
|
|
2468
|
+
export const HOLDER_ENTITLEMENT = {
|
|
2469
|
+
OWNER: "owner",
|
|
2470
|
+
ASSIGNEE: "assignee",
|
|
2471
|
+
LICENSEE: "licensee",
|
|
2472
|
+
} as const satisfies Record<string, HolderEntitlement>;
|
|
2473
|
+
|
|
2474
|
+
/**
|
|
2475
|
+
* Array of all HolderEntitlement enum values
|
|
2476
|
+
*
|
|
2477
|
+
* @remarks
|
|
2478
|
+
* This constant provides a array containing all valid HolderEntitlement enum values.
|
|
2479
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2480
|
+
*
|
|
2481
|
+
* @example
|
|
2482
|
+
* ```typescript
|
|
2483
|
+
* // Iterating through all values
|
|
2484
|
+
* for (const value of HOLDER_ENTITLEMENT_VALUES) {
|
|
2485
|
+
* console.log(`Processing: ${value}`);
|
|
2486
|
+
* }
|
|
2487
|
+
*
|
|
2488
|
+
* // Validation
|
|
2489
|
+
* const isValid = HOLDER_ENTITLEMENT_VALUES.includes(someValue);
|
|
2490
|
+
* ```
|
|
2491
|
+
*
|
|
2492
|
+
* @see {@link HolderEntitlement} - The TypeScript type definition
|
|
2493
|
+
* @see {@link HOLDER_ENTITLEMENT} - The object form of this enum
|
|
2494
|
+
*/
|
|
2495
|
+
export const HOLDER_ENTITLEMENT_VALUES = [
|
|
2496
|
+
'owner',
|
|
2497
|
+
'assignee',
|
|
2498
|
+
'licensee'
|
|
2499
|
+
] as const satisfies [string, ...string[]] | HolderEntitlement[];
|
|
2500
|
+
|
|
2397
2501
|
/**
|
|
2398
2502
|
* HostStatus. Auto-generated enum for HostStatus
|
|
2399
2503
|
*
|