@opusdns/api 0.53.0 → 0.55.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 +57 -51
- package/src/helpers/keys.ts +50 -1273
- package/src/helpers/requests.d.ts +53 -255
- package/src/helpers/responses.d.ts +56 -295
- package/src/helpers/schemas-arrays.d.ts +1 -15
- package/src/helpers/schemas.d.ts +32 -128
- package/src/openapi.yaml +56 -503
- package/src/schema.d.ts +62 -492
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType,
|
|
24
|
+
import { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PlanRelation, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AgreementType. Auto-generated enum for AgreementType
|
|
@@ -1809,6 +1809,62 @@ export const PERMISSION_VALUES = [
|
|
|
1809
1809
|
'view_events'
|
|
1810
1810
|
] as const satisfies [string, ...string[]] | Permission[];
|
|
1811
1811
|
|
|
1812
|
+
/**
|
|
1813
|
+
* PlanRelation. Auto-generated enum for PlanRelation
|
|
1814
|
+
*
|
|
1815
|
+
* @remarks
|
|
1816
|
+
* This constant provides both object and array forms for the PlanRelation enum.
|
|
1817
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1818
|
+
*
|
|
1819
|
+
* @example
|
|
1820
|
+
* ```typescript
|
|
1821
|
+
* // Using the object form for key-value access
|
|
1822
|
+
* const status = PLAN_RELATION.SUCCESS;
|
|
1823
|
+
*
|
|
1824
|
+
* // Using the array form for iteration
|
|
1825
|
+
* const allStatuses = PLAN_RELATION_VALUES;
|
|
1826
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1827
|
+
* ```
|
|
1828
|
+
*
|
|
1829
|
+
* @see {@link PlanRelation} - The TypeScript type definition
|
|
1830
|
+
*/
|
|
1831
|
+
export const PLAN_RELATION = {
|
|
1832
|
+
BASIC: "basic",
|
|
1833
|
+
ENTERPRISE: "enterprise",
|
|
1834
|
+
CORPORATE: "corporate",
|
|
1835
|
+
PREMIUM: "premium",
|
|
1836
|
+
STARTER: "starter",
|
|
1837
|
+
} as const satisfies Record<string, PlanRelation>;
|
|
1838
|
+
|
|
1839
|
+
/**
|
|
1840
|
+
* Array of all PlanRelation enum values
|
|
1841
|
+
*
|
|
1842
|
+
* @remarks
|
|
1843
|
+
* This constant provides a array containing all valid PlanRelation enum values.
|
|
1844
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1845
|
+
*
|
|
1846
|
+
* @example
|
|
1847
|
+
* ```typescript
|
|
1848
|
+
* // Iterating through all values
|
|
1849
|
+
* for (const value of PLAN_RELATION_VALUES) {
|
|
1850
|
+
* console.log(`Processing: ${value}`);
|
|
1851
|
+
* }
|
|
1852
|
+
*
|
|
1853
|
+
* // Validation
|
|
1854
|
+
* const isValid = PLAN_RELATION_VALUES.includes(someValue);
|
|
1855
|
+
* ```
|
|
1856
|
+
*
|
|
1857
|
+
* @see {@link PlanRelation} - The TypeScript type definition
|
|
1858
|
+
* @see {@link PLAN_RELATION} - The object form of this enum
|
|
1859
|
+
*/
|
|
1860
|
+
export const PLAN_RELATION_VALUES = [
|
|
1861
|
+
'basic',
|
|
1862
|
+
'enterprise',
|
|
1863
|
+
'corporate',
|
|
1864
|
+
'premium',
|
|
1865
|
+
'starter'
|
|
1866
|
+
] as const satisfies [string, ...string[]] | PlanRelation[];
|
|
1867
|
+
|
|
1812
1868
|
/**
|
|
1813
1869
|
* PostTransferRequirements. Auto-generated enum for PostTransferRequirements
|
|
1814
1870
|
*
|
|
@@ -2509,56 +2565,6 @@ export const TRANSFER_ACK_TYPE_VALUES = [
|
|
|
2509
2565
|
'both'
|
|
2510
2566
|
] as const satisfies [string, ...string[]] | TransferAckType[];
|
|
2511
2567
|
|
|
2512
|
-
/**
|
|
2513
|
-
* UserNotificationStatus. Auto-generated enum for UserNotificationStatus
|
|
2514
|
-
*
|
|
2515
|
-
* @remarks
|
|
2516
|
-
* This constant provides both object and array forms for the UserNotificationStatus enum.
|
|
2517
|
-
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
2518
|
-
*
|
|
2519
|
-
* @example
|
|
2520
|
-
* ```typescript
|
|
2521
|
-
* // Using the object form for key-value access
|
|
2522
|
-
* const status = USER_NOTIFICATION_STATUS.SUCCESS;
|
|
2523
|
-
*
|
|
2524
|
-
* // Using the array form for iteration
|
|
2525
|
-
* const allStatuses = USER_NOTIFICATION_STATUS_VALUES;
|
|
2526
|
-
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
2527
|
-
* ```
|
|
2528
|
-
*
|
|
2529
|
-
* @see {@link UserNotificationStatus} - The TypeScript type definition
|
|
2530
|
-
*/
|
|
2531
|
-
export const USER_NOTIFICATION_STATUS = {
|
|
2532
|
-
READ: "read",
|
|
2533
|
-
UNREAD: "unread",
|
|
2534
|
-
} as const satisfies Record<string, UserNotificationStatus>;
|
|
2535
|
-
|
|
2536
|
-
/**
|
|
2537
|
-
* Array of all UserNotificationStatus enum values
|
|
2538
|
-
*
|
|
2539
|
-
* @remarks
|
|
2540
|
-
* This constant provides a array containing all valid UserNotificationStatus enum values.
|
|
2541
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2542
|
-
*
|
|
2543
|
-
* @example
|
|
2544
|
-
* ```typescript
|
|
2545
|
-
* // Iterating through all values
|
|
2546
|
-
* for (const value of USER_NOTIFICATION_STATUS_VALUES) {
|
|
2547
|
-
* console.log(`Processing: ${value}`);
|
|
2548
|
-
* }
|
|
2549
|
-
*
|
|
2550
|
-
* // Validation
|
|
2551
|
-
* const isValid = USER_NOTIFICATION_STATUS_VALUES.includes(someValue);
|
|
2552
|
-
* ```
|
|
2553
|
-
*
|
|
2554
|
-
* @see {@link UserNotificationStatus} - The TypeScript type definition
|
|
2555
|
-
* @see {@link USER_NOTIFICATION_STATUS} - The object form of this enum
|
|
2556
|
-
*/
|
|
2557
|
-
export const USER_NOTIFICATION_STATUS_VALUES = [
|
|
2558
|
-
'read',
|
|
2559
|
-
'unread'
|
|
2560
|
-
] as const satisfies [string, ...string[]] | UserNotificationStatus[];
|
|
2561
|
-
|
|
2562
2568
|
/**
|
|
2563
2569
|
* UserStatus. Auto-generated enum for UserStatus
|
|
2564
2570
|
*
|