@opusdns/api 0.126.0 → 0.128.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 +2 -2
- package/src/helpers/constants.ts +107 -51
- package/src/helpers/keys.ts +1288 -744
- package/src/helpers/schemas.d.ts +131 -19
- package/src/openapi.yaml +168 -23
- package/src/schema.d.ts +113 -16
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"devDependencies": {
|
|
3
|
-
"@opusdns/api-spec-ts-generator": "^0.
|
|
3
|
+
"@opusdns/api-spec-ts-generator": "^0.19.0"
|
|
4
4
|
},
|
|
5
5
|
"name": "@opusdns/api",
|
|
6
|
-
"version": "0.
|
|
6
|
+
"version": "0.128.0",
|
|
7
7
|
"description": "TypeScript types for the OpusDNS OpenAPI specification",
|
|
8
8
|
"main": "./src/index.ts",
|
|
9
9
|
"module": "./src/index.ts",
|
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, ObjectEventType, ObjectLogSortField, OrganizationStatus,
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, ObjectEventType, ObjectLogSortField, OrganizationStatus, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField, common__schemas__dns__PatchOp } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -1879,6 +1879,62 @@ export const GRANT_TYPE_VALUES = [
|
|
|
1879
1879
|
'refresh_token'
|
|
1880
1880
|
] as const satisfies [string, ...string[]] | GrantType[];
|
|
1881
1881
|
|
|
1882
|
+
/**
|
|
1883
|
+
* HostStatus. Auto-generated enum for HostStatus
|
|
1884
|
+
*
|
|
1885
|
+
* @remarks
|
|
1886
|
+
* This constant provides both object and array forms for the HostStatus enum.
|
|
1887
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1888
|
+
*
|
|
1889
|
+
* @example
|
|
1890
|
+
* ```typescript
|
|
1891
|
+
* // Using the object form for key-value access
|
|
1892
|
+
* const status = HOST_STATUS.SUCCESS;
|
|
1893
|
+
*
|
|
1894
|
+
* // Using the array form for iteration
|
|
1895
|
+
* const allStatuses = HOST_STATUS_VALUES;
|
|
1896
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1897
|
+
* ```
|
|
1898
|
+
*
|
|
1899
|
+
* @see {@link HostStatus} - The TypeScript type definition
|
|
1900
|
+
*/
|
|
1901
|
+
export const HOST_STATUS = {
|
|
1902
|
+
REQUESTED_CREATE: "requested_create",
|
|
1903
|
+
PENDING_CREATE: "pending_create",
|
|
1904
|
+
ACTIVE: "active",
|
|
1905
|
+
INACTIVE: "inactive",
|
|
1906
|
+
PENDING_DELETE: "pending_delete",
|
|
1907
|
+
} as const satisfies Record<string, HostStatus>;
|
|
1908
|
+
|
|
1909
|
+
/**
|
|
1910
|
+
* Array of all HostStatus enum values
|
|
1911
|
+
*
|
|
1912
|
+
* @remarks
|
|
1913
|
+
* This constant provides a array containing all valid HostStatus enum values.
|
|
1914
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1915
|
+
*
|
|
1916
|
+
* @example
|
|
1917
|
+
* ```typescript
|
|
1918
|
+
* // Iterating through all values
|
|
1919
|
+
* for (const value of HOST_STATUS_VALUES) {
|
|
1920
|
+
* console.log(`Processing: ${value}`);
|
|
1921
|
+
* }
|
|
1922
|
+
*
|
|
1923
|
+
* // Validation
|
|
1924
|
+
* const isValid = HOST_STATUS_VALUES.includes(someValue);
|
|
1925
|
+
* ```
|
|
1926
|
+
*
|
|
1927
|
+
* @see {@link HostStatus} - The TypeScript type definition
|
|
1928
|
+
* @see {@link HOST_STATUS} - The object form of this enum
|
|
1929
|
+
*/
|
|
1930
|
+
export const HOST_STATUS_VALUES = [
|
|
1931
|
+
'requested_create',
|
|
1932
|
+
'pending_create',
|
|
1933
|
+
'active',
|
|
1934
|
+
'inactive',
|
|
1935
|
+
'pending_delete'
|
|
1936
|
+
] as const satisfies [string, ...string[]] | HostStatus[];
|
|
1937
|
+
|
|
1882
1938
|
/**
|
|
1883
1939
|
* HttpProtocol. Auto-generated enum for HttpProtocol
|
|
1884
1940
|
*
|
|
@@ -2381,56 +2437,6 @@ export const ORGANIZATION_STATUS_VALUES = [
|
|
|
2381
2437
|
'inactive'
|
|
2382
2438
|
] as const satisfies [string, ...string[]] | OrganizationStatus[];
|
|
2383
2439
|
|
|
2384
|
-
/**
|
|
2385
|
-
* PatchOp. Auto-generated enum for PatchOp
|
|
2386
|
-
*
|
|
2387
|
-
* @remarks
|
|
2388
|
-
* This constant provides both object and array forms for the PatchOp enum.
|
|
2389
|
-
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
2390
|
-
*
|
|
2391
|
-
* @example
|
|
2392
|
-
* ```typescript
|
|
2393
|
-
* // Using the object form for key-value access
|
|
2394
|
-
* const status = PATCH_OP.SUCCESS;
|
|
2395
|
-
*
|
|
2396
|
-
* // Using the array form for iteration
|
|
2397
|
-
* const allStatuses = PATCH_OP_VALUES;
|
|
2398
|
-
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
2399
|
-
* ```
|
|
2400
|
-
*
|
|
2401
|
-
* @see {@link PatchOp} - The TypeScript type definition
|
|
2402
|
-
*/
|
|
2403
|
-
export const PATCH_OP = {
|
|
2404
|
-
UPSERT: "upsert",
|
|
2405
|
-
REMOVE: "remove",
|
|
2406
|
-
} as const satisfies Record<string, PatchOp>;
|
|
2407
|
-
|
|
2408
|
-
/**
|
|
2409
|
-
* Array of all PatchOp enum values
|
|
2410
|
-
*
|
|
2411
|
-
* @remarks
|
|
2412
|
-
* This constant provides a array containing all valid PatchOp enum values.
|
|
2413
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2414
|
-
*
|
|
2415
|
-
* @example
|
|
2416
|
-
* ```typescript
|
|
2417
|
-
* // Iterating through all values
|
|
2418
|
-
* for (const value of PATCH_OP_VALUES) {
|
|
2419
|
-
* console.log(`Processing: ${value}`);
|
|
2420
|
-
* }
|
|
2421
|
-
*
|
|
2422
|
-
* // Validation
|
|
2423
|
-
* const isValid = PATCH_OP_VALUES.includes(someValue);
|
|
2424
|
-
* ```
|
|
2425
|
-
*
|
|
2426
|
-
* @see {@link PatchOp} - The TypeScript type definition
|
|
2427
|
-
* @see {@link PATCH_OP} - The object form of this enum
|
|
2428
|
-
*/
|
|
2429
|
-
export const PATCH_OP_VALUES = [
|
|
2430
|
-
'upsert',
|
|
2431
|
-
'remove'
|
|
2432
|
-
] as const satisfies [string, ...string[]] | PatchOp[];
|
|
2433
|
-
|
|
2434
2440
|
/**
|
|
2435
2441
|
* PeriodUnit. Auto-generated enum for PeriodUnit
|
|
2436
2442
|
*
|
|
@@ -3558,3 +3564,53 @@ export const ZONE_SORT_FIELD_VALUES = [
|
|
|
3558
3564
|
'dnssec_status'
|
|
3559
3565
|
] as const satisfies [string, ...string[]] | ZoneSortField[];
|
|
3560
3566
|
|
|
3567
|
+
/**
|
|
3568
|
+
* PatchOp. Auto-generated enum for common__schemas__dns__PatchOp
|
|
3569
|
+
*
|
|
3570
|
+
* @remarks
|
|
3571
|
+
* This constant provides both object and array forms for the common__schemas__dns__PatchOp enum.
|
|
3572
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
3573
|
+
*
|
|
3574
|
+
* @example
|
|
3575
|
+
* ```typescript
|
|
3576
|
+
* // Using the object form for key-value access
|
|
3577
|
+
* const status = COMMON_SCHEMAS_DNS_PATCH_OP.SUCCESS;
|
|
3578
|
+
*
|
|
3579
|
+
* // Using the array form for iteration
|
|
3580
|
+
* const allStatuses = COMMON_SCHEMAS_DNS_PATCH_OP_VALUES;
|
|
3581
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
3582
|
+
* ```
|
|
3583
|
+
*
|
|
3584
|
+
* @see {@link common__schemas__dns__PatchOp} - The TypeScript type definition
|
|
3585
|
+
*/
|
|
3586
|
+
export const COMMON_SCHEMAS_DNS_PATCH_OP = {
|
|
3587
|
+
UPSERT: "upsert",
|
|
3588
|
+
REMOVE: "remove",
|
|
3589
|
+
} as const satisfies Record<string, common__schemas__dns__PatchOp>;
|
|
3590
|
+
|
|
3591
|
+
/**
|
|
3592
|
+
* Array of all common__schemas__dns__PatchOp enum values
|
|
3593
|
+
*
|
|
3594
|
+
* @remarks
|
|
3595
|
+
* This constant provides a array containing all valid common__schemas__dns__PatchOp enum values.
|
|
3596
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
3597
|
+
*
|
|
3598
|
+
* @example
|
|
3599
|
+
* ```typescript
|
|
3600
|
+
* // Iterating through all values
|
|
3601
|
+
* for (const value of COMMON_SCHEMAS_DNS_PATCH_OP_VALUES) {
|
|
3602
|
+
* console.log(`Processing: ${value}`);
|
|
3603
|
+
* }
|
|
3604
|
+
*
|
|
3605
|
+
* // Validation
|
|
3606
|
+
* const isValid = COMMON_SCHEMAS_DNS_PATCH_OP_VALUES.includes(someValue);
|
|
3607
|
+
* ```
|
|
3608
|
+
*
|
|
3609
|
+
* @see {@link common__schemas__dns__PatchOp} - The TypeScript type definition
|
|
3610
|
+
* @see {@link COMMON_SCHEMAS_DNS_PATCH_OP} - The object form of this enum
|
|
3611
|
+
*/
|
|
3612
|
+
export const COMMON_SCHEMAS_DNS_PATCH_OP_VALUES = [
|
|
3613
|
+
'upsert',
|
|
3614
|
+
'remove'
|
|
3615
|
+
] as const satisfies [string, ...string[]] | common__schemas__dns__PatchOp[];
|
|
3616
|
+
|