@opusdns/api 0.114.0 → 0.116.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 +61 -1
- package/src/helpers/keys.ts +668 -0
- package/src/helpers/requests.d.ts +106 -0
- package/src/helpers/responses.d.ts +113 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +64 -0
- package/src/openapi.yaml +340 -1
- package/src/schema.d.ts +253 -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, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, ObjectEventType, ObjectLogSortField, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
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, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -1391,6 +1391,66 @@ export const DOMAIN_STATUS_VALUES = [
|
|
|
1391
1391
|
'invalid'
|
|
1392
1392
|
] as const satisfies [string, ...string[]] | DomainStatus[];
|
|
1393
1393
|
|
|
1394
|
+
/**
|
|
1395
|
+
* EmailForwardLogSortField. Auto-generated enum for EmailForwardLogSortField
|
|
1396
|
+
*
|
|
1397
|
+
* @remarks
|
|
1398
|
+
* This constant provides both object and array forms for the EmailForwardLogSortField enum.
|
|
1399
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1400
|
+
*
|
|
1401
|
+
* @example
|
|
1402
|
+
* ```typescript
|
|
1403
|
+
* // Using the object form for key-value access
|
|
1404
|
+
* const status = EMAIL_FORWARD_LOG_SORT_FIELD.SUCCESS;
|
|
1405
|
+
*
|
|
1406
|
+
* // Using the array form for iteration
|
|
1407
|
+
* const allStatuses = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES;
|
|
1408
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1409
|
+
* ```
|
|
1410
|
+
*
|
|
1411
|
+
* @see {@link EmailForwardLogSortField} - The TypeScript type definition
|
|
1412
|
+
*/
|
|
1413
|
+
export const EMAIL_FORWARD_LOG_SORT_FIELD = {
|
|
1414
|
+
LOG_ID: "log_id",
|
|
1415
|
+
SENDER_EMAIL: "sender_email",
|
|
1416
|
+
RECIPIENT_EMAIL: "recipient_email",
|
|
1417
|
+
FORWARD_EMAIL: "forward_email",
|
|
1418
|
+
FINAL_STATUS: "final_status",
|
|
1419
|
+
CREATED_ON: "created_on",
|
|
1420
|
+
SYNCED_ON: "synced_on",
|
|
1421
|
+
} as const satisfies Record<string, EmailForwardLogSortField>;
|
|
1422
|
+
|
|
1423
|
+
/**
|
|
1424
|
+
* Array of all EmailForwardLogSortField enum values
|
|
1425
|
+
*
|
|
1426
|
+
* @remarks
|
|
1427
|
+
* This constant provides a array containing all valid EmailForwardLogSortField enum values.
|
|
1428
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1429
|
+
*
|
|
1430
|
+
* @example
|
|
1431
|
+
* ```typescript
|
|
1432
|
+
* // Iterating through all values
|
|
1433
|
+
* for (const value of EMAIL_FORWARD_LOG_SORT_FIELD_VALUES) {
|
|
1434
|
+
* console.log(`Processing: ${value}`);
|
|
1435
|
+
* }
|
|
1436
|
+
*
|
|
1437
|
+
* // Validation
|
|
1438
|
+
* const isValid = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES.includes(someValue);
|
|
1439
|
+
* ```
|
|
1440
|
+
*
|
|
1441
|
+
* @see {@link EmailForwardLogSortField} - The TypeScript type definition
|
|
1442
|
+
* @see {@link EMAIL_FORWARD_LOG_SORT_FIELD} - The object form of this enum
|
|
1443
|
+
*/
|
|
1444
|
+
export const EMAIL_FORWARD_LOG_SORT_FIELD_VALUES = [
|
|
1445
|
+
'log_id',
|
|
1446
|
+
'sender_email',
|
|
1447
|
+
'recipient_email',
|
|
1448
|
+
'forward_email',
|
|
1449
|
+
'final_status',
|
|
1450
|
+
'created_on',
|
|
1451
|
+
'synced_on'
|
|
1452
|
+
] as const satisfies [string, ...string[]] | EmailForwardLogSortField[];
|
|
1453
|
+
|
|
1394
1454
|
/**
|
|
1395
1455
|
* EmailForwardSortField. Auto-generated enum for EmailForwardSortField
|
|
1396
1456
|
*
|