@opusdns/api 0.258.0 → 0.259.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 +814 -0
- package/src/helpers/requests.d.ts +300 -1
- package/src/helpers/responses.d.ts +649 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +144 -0
- package/src/openapi.yaml +716 -1
- package/src/schema.d.ts +722 -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, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, 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, 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, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, 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, 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, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -4599,6 +4599,110 @@ export const TAG_FILTER_MODE_VALUES = [
|
|
|
4599
4599
|
'match_all'
|
|
4600
4600
|
] as const satisfies [string, ...string[]] | TagFilterMode[];
|
|
4601
4601
|
|
|
4602
|
+
/**
|
|
4603
|
+
* TagSortField. Auto-generated enum for TagSortField
|
|
4604
|
+
*
|
|
4605
|
+
* @remarks
|
|
4606
|
+
* This constant provides both object and array forms for the TagSortField enum.
|
|
4607
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
4608
|
+
*
|
|
4609
|
+
* @example
|
|
4610
|
+
* ```typescript
|
|
4611
|
+
* // Using the object form for key-value access
|
|
4612
|
+
* const status = TAG_SORT_FIELD.SUCCESS;
|
|
4613
|
+
*
|
|
4614
|
+
* // Using the array form for iteration
|
|
4615
|
+
* const allStatuses = TAG_SORT_FIELD_VALUES;
|
|
4616
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
4617
|
+
* ```
|
|
4618
|
+
*
|
|
4619
|
+
* @see {@link TagSortField} - The TypeScript type definition
|
|
4620
|
+
*/
|
|
4621
|
+
export const TAG_SORT_FIELD = {
|
|
4622
|
+
LABEL: "label",
|
|
4623
|
+
CREATED_ON: "created_on",
|
|
4624
|
+
UPDATED_ON: "updated_on",
|
|
4625
|
+
} as const satisfies Record<string, TagSortField>;
|
|
4626
|
+
|
|
4627
|
+
/**
|
|
4628
|
+
* Array of all TagSortField enum values
|
|
4629
|
+
*
|
|
4630
|
+
* @remarks
|
|
4631
|
+
* This constant provides a array containing all valid TagSortField enum values.
|
|
4632
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
4633
|
+
*
|
|
4634
|
+
* @example
|
|
4635
|
+
* ```typescript
|
|
4636
|
+
* // Iterating through all values
|
|
4637
|
+
* for (const value of TAG_SORT_FIELD_VALUES) {
|
|
4638
|
+
* console.log(`Processing: ${value}`);
|
|
4639
|
+
* }
|
|
4640
|
+
*
|
|
4641
|
+
* // Validation
|
|
4642
|
+
* const isValid = TAG_SORT_FIELD_VALUES.includes(someValue);
|
|
4643
|
+
* ```
|
|
4644
|
+
*
|
|
4645
|
+
* @see {@link TagSortField} - The TypeScript type definition
|
|
4646
|
+
* @see {@link TAG_SORT_FIELD} - The object form of this enum
|
|
4647
|
+
*/
|
|
4648
|
+
export const TAG_SORT_FIELD_VALUES = [
|
|
4649
|
+
'label',
|
|
4650
|
+
'created_on',
|
|
4651
|
+
'updated_on'
|
|
4652
|
+
] as const satisfies [string, ...string[]] | TagSortField[];
|
|
4653
|
+
|
|
4654
|
+
/**
|
|
4655
|
+
* TagType. Auto-generated enum for TagType
|
|
4656
|
+
*
|
|
4657
|
+
* @remarks
|
|
4658
|
+
* This constant provides both object and array forms for the TagType enum.
|
|
4659
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
4660
|
+
*
|
|
4661
|
+
* @example
|
|
4662
|
+
* ```typescript
|
|
4663
|
+
* // Using the object form for key-value access
|
|
4664
|
+
* const status = TAG_TYPE.SUCCESS;
|
|
4665
|
+
*
|
|
4666
|
+
* // Using the array form for iteration
|
|
4667
|
+
* const allStatuses = TAG_TYPE_VALUES;
|
|
4668
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
4669
|
+
* ```
|
|
4670
|
+
*
|
|
4671
|
+
* @see {@link TagType} - The TypeScript type definition
|
|
4672
|
+
*/
|
|
4673
|
+
export const TAG_TYPE = {
|
|
4674
|
+
DOMAIN: "DOMAIN",
|
|
4675
|
+
CONTACT: "CONTACT",
|
|
4676
|
+
ZONE: "ZONE",
|
|
4677
|
+
} as const satisfies Record<string, TagType>;
|
|
4678
|
+
|
|
4679
|
+
/**
|
|
4680
|
+
* Array of all TagType enum values
|
|
4681
|
+
*
|
|
4682
|
+
* @remarks
|
|
4683
|
+
* This constant provides a array containing all valid TagType enum values.
|
|
4684
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
4685
|
+
*
|
|
4686
|
+
* @example
|
|
4687
|
+
* ```typescript
|
|
4688
|
+
* // Iterating through all values
|
|
4689
|
+
* for (const value of TAG_TYPE_VALUES) {
|
|
4690
|
+
* console.log(`Processing: ${value}`);
|
|
4691
|
+
* }
|
|
4692
|
+
*
|
|
4693
|
+
* // Validation
|
|
4694
|
+
* const isValid = TAG_TYPE_VALUES.includes(someValue);
|
|
4695
|
+
* ```
|
|
4696
|
+
*
|
|
4697
|
+
* @see {@link TagType} - The TypeScript type definition
|
|
4698
|
+
* @see {@link TAG_TYPE} - The object form of this enum
|
|
4699
|
+
*/
|
|
4700
|
+
export const TAG_TYPE_VALUES = [
|
|
4701
|
+
'DOMAIN',
|
|
4702
|
+
'CONTACT',
|
|
4703
|
+
'ZONE'
|
|
4704
|
+
] as const satisfies [string, ...string[]] | TagType[];
|
|
4705
|
+
|
|
4602
4706
|
/**
|
|
4603
4707
|
* TimeRange. Auto-generated enum for TimeRange
|
|
4604
4708
|
*
|