@opusdns/api 0.112.0 → 0.114.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 +107 -1
- package/src/helpers/keys.ts +490 -0
- package/src/helpers/requests.d.ts +245 -164
- package/src/helpers/responses.d.ts +896 -139
- package/src/helpers/schemas-arrays.d.ts +48 -6
- package/src/helpers/schemas.d.ts +118 -6
- package/src/openapi.yaml +805 -189
- package/src/schema.d.ts +896 -120
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, 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, 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,112 @@ export const DOMAIN_STATUS_VALUES = [
|
|
|
1391
1391
|
'invalid'
|
|
1392
1392
|
] as const satisfies [string, ...string[]] | DomainStatus[];
|
|
1393
1393
|
|
|
1394
|
+
/**
|
|
1395
|
+
* EmailForwardSortField. Auto-generated enum for EmailForwardSortField
|
|
1396
|
+
*
|
|
1397
|
+
* @remarks
|
|
1398
|
+
* This constant provides both object and array forms for the EmailForwardSortField 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_SORT_FIELD.SUCCESS;
|
|
1405
|
+
*
|
|
1406
|
+
* // Using the array form for iteration
|
|
1407
|
+
* const allStatuses = EMAIL_FORWARD_SORT_FIELD_VALUES;
|
|
1408
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1409
|
+
* ```
|
|
1410
|
+
*
|
|
1411
|
+
* @see {@link EmailForwardSortField} - The TypeScript type definition
|
|
1412
|
+
*/
|
|
1413
|
+
export const EMAIL_FORWARD_SORT_FIELD = {
|
|
1414
|
+
HOSTNAME: "hostname",
|
|
1415
|
+
ENABLED: "enabled",
|
|
1416
|
+
CREATED_ON: "created_on",
|
|
1417
|
+
UPDATED_ON: "updated_on",
|
|
1418
|
+
} as const satisfies Record<string, EmailForwardSortField>;
|
|
1419
|
+
|
|
1420
|
+
/**
|
|
1421
|
+
* Array of all EmailForwardSortField enum values
|
|
1422
|
+
*
|
|
1423
|
+
* @remarks
|
|
1424
|
+
* This constant provides a array containing all valid EmailForwardSortField enum values.
|
|
1425
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1426
|
+
*
|
|
1427
|
+
* @example
|
|
1428
|
+
* ```typescript
|
|
1429
|
+
* // Iterating through all values
|
|
1430
|
+
* for (const value of EMAIL_FORWARD_SORT_FIELD_VALUES) {
|
|
1431
|
+
* console.log(`Processing: ${value}`);
|
|
1432
|
+
* }
|
|
1433
|
+
*
|
|
1434
|
+
* // Validation
|
|
1435
|
+
* const isValid = EMAIL_FORWARD_SORT_FIELD_VALUES.includes(someValue);
|
|
1436
|
+
* ```
|
|
1437
|
+
*
|
|
1438
|
+
* @see {@link EmailForwardSortField} - The TypeScript type definition
|
|
1439
|
+
* @see {@link EMAIL_FORWARD_SORT_FIELD} - The object form of this enum
|
|
1440
|
+
*/
|
|
1441
|
+
export const EMAIL_FORWARD_SORT_FIELD_VALUES = [
|
|
1442
|
+
'hostname',
|
|
1443
|
+
'enabled',
|
|
1444
|
+
'created_on',
|
|
1445
|
+
'updated_on'
|
|
1446
|
+
] as const satisfies [string, ...string[]] | EmailForwardSortField[];
|
|
1447
|
+
|
|
1448
|
+
/**
|
|
1449
|
+
* EmailForwardZoneSortField. Auto-generated enum for EmailForwardZoneSortField
|
|
1450
|
+
*
|
|
1451
|
+
* @remarks
|
|
1452
|
+
* This constant provides both object and array forms for the EmailForwardZoneSortField enum.
|
|
1453
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1454
|
+
*
|
|
1455
|
+
* @example
|
|
1456
|
+
* ```typescript
|
|
1457
|
+
* // Using the object form for key-value access
|
|
1458
|
+
* const status = EMAIL_FORWARD_ZONE_SORT_FIELD.SUCCESS;
|
|
1459
|
+
*
|
|
1460
|
+
* // Using the array form for iteration
|
|
1461
|
+
* const allStatuses = EMAIL_FORWARD_ZONE_SORT_FIELD_VALUES;
|
|
1462
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1463
|
+
* ```
|
|
1464
|
+
*
|
|
1465
|
+
* @see {@link EmailForwardZoneSortField} - The TypeScript type definition
|
|
1466
|
+
*/
|
|
1467
|
+
export const EMAIL_FORWARD_ZONE_SORT_FIELD = {
|
|
1468
|
+
NAME: "name",
|
|
1469
|
+
CREATED_ON: "created_on",
|
|
1470
|
+
UPDATED_ON: "updated_on",
|
|
1471
|
+
} as const satisfies Record<string, EmailForwardZoneSortField>;
|
|
1472
|
+
|
|
1473
|
+
/**
|
|
1474
|
+
* Array of all EmailForwardZoneSortField enum values
|
|
1475
|
+
*
|
|
1476
|
+
* @remarks
|
|
1477
|
+
* This constant provides a array containing all valid EmailForwardZoneSortField enum values.
|
|
1478
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1479
|
+
*
|
|
1480
|
+
* @example
|
|
1481
|
+
* ```typescript
|
|
1482
|
+
* // Iterating through all values
|
|
1483
|
+
* for (const value of EMAIL_FORWARD_ZONE_SORT_FIELD_VALUES) {
|
|
1484
|
+
* console.log(`Processing: ${value}`);
|
|
1485
|
+
* }
|
|
1486
|
+
*
|
|
1487
|
+
* // Validation
|
|
1488
|
+
* const isValid = EMAIL_FORWARD_ZONE_SORT_FIELD_VALUES.includes(someValue);
|
|
1489
|
+
* ```
|
|
1490
|
+
*
|
|
1491
|
+
* @see {@link EmailForwardZoneSortField} - The TypeScript type definition
|
|
1492
|
+
* @see {@link EMAIL_FORWARD_ZONE_SORT_FIELD} - The object form of this enum
|
|
1493
|
+
*/
|
|
1494
|
+
export const EMAIL_FORWARD_ZONE_SORT_FIELD_VALUES = [
|
|
1495
|
+
'name',
|
|
1496
|
+
'created_on',
|
|
1497
|
+
'updated_on'
|
|
1498
|
+
] as const satisfies [string, ...string[]] | EmailForwardZoneSortField[];
|
|
1499
|
+
|
|
1394
1500
|
/**
|
|
1395
1501
|
* EmailVerificationStatus. Auto-generated enum for EmailVerificationStatus
|
|
1396
1502
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -100,7 +100,11 @@ import { DomainWithdrawRequest } from './schemas';
|
|
|
100
100
|
import { DomainWithdraw } from './schemas';
|
|
101
101
|
import { DomainsExpiringSoon } from './schemas';
|
|
102
102
|
import { EmailForwardAlias } from './schemas';
|
|
103
|
+
import { EmailForwardAliasCreate } from './schemas';
|
|
103
104
|
import { EmailForwardAliasUpdate } from './schemas';
|
|
105
|
+
import { EmailForwardCreate } from './schemas';
|
|
106
|
+
import { EmailForward } from './schemas';
|
|
107
|
+
import { EmailForwardZone } from './schemas';
|
|
104
108
|
import { EventResponse } from './schemas';
|
|
105
109
|
import { EventSchema } from './schemas';
|
|
106
110
|
import { GeneralAvailabilityBase } from './schemas';
|
|
@@ -10315,6 +10319,31 @@ export const KEYS_DOMAINS_EXPIRING_SOON = [
|
|
|
10315
10319
|
* @see {@link KEYS_EMAIL_FORWARD_ALIAS} - Array of all keys for this type
|
|
10316
10320
|
*/
|
|
10317
10321
|
export const KEY_EMAIL_FORWARD_ALIAS_ALIAS = 'alias' as keyof EmailForwardAlias;
|
|
10322
|
+
/**
|
|
10323
|
+
* Email Forward Alias Id
|
|
10324
|
+
*
|
|
10325
|
+
*
|
|
10326
|
+
* @type {string}
|
|
10327
|
+
*
|
|
10328
|
+
*
|
|
10329
|
+
* @remarks
|
|
10330
|
+
* This key constant provides type-safe access to the `email_forward_alias_id` property of EmailForwardAlias objects.
|
|
10331
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10332
|
+
*
|
|
10333
|
+
* @example
|
|
10334
|
+
* ```typescript
|
|
10335
|
+
* // Direct property access
|
|
10336
|
+
* const value = emailforwardalias[KEY_EMAIL_FORWARD_ALIAS_EMAIL_FORWARD_ALIAS_ID];
|
|
10337
|
+
*
|
|
10338
|
+
* // Dynamic property access
|
|
10339
|
+
* const propertyName = KEY_EMAIL_FORWARD_ALIAS_EMAIL_FORWARD_ALIAS_ID;
|
|
10340
|
+
* const value = emailforwardalias[propertyName];
|
|
10341
|
+
* ```
|
|
10342
|
+
*
|
|
10343
|
+
* @see {@link EmailForwardAlias} - The TypeScript type definition
|
|
10344
|
+
* @see {@link KEYS_EMAIL_FORWARD_ALIAS} - Array of all keys for this type
|
|
10345
|
+
*/
|
|
10346
|
+
export const KEY_EMAIL_FORWARD_ALIAS_EMAIL_FORWARD_ALIAS_ID = 'email_forward_alias_id' as keyof EmailForwardAlias;
|
|
10318
10347
|
/**
|
|
10319
10348
|
* Forward To
|
|
10320
10349
|
*
|
|
@@ -10363,9 +10392,86 @@ export const KEY_EMAIL_FORWARD_ALIAS_FORWARD_TO = 'forward_to' as keyof EmailFor
|
|
|
10363
10392
|
*/
|
|
10364
10393
|
export const KEYS_EMAIL_FORWARD_ALIAS = [
|
|
10365
10394
|
KEY_EMAIL_FORWARD_ALIAS_ALIAS,
|
|
10395
|
+
KEY_EMAIL_FORWARD_ALIAS_EMAIL_FORWARD_ALIAS_ID,
|
|
10366
10396
|
KEY_EMAIL_FORWARD_ALIAS_FORWARD_TO,
|
|
10367
10397
|
] as const satisfies (keyof EmailForwardAlias)[];
|
|
10368
10398
|
|
|
10399
|
+
/**
|
|
10400
|
+
* Alias
|
|
10401
|
+
*
|
|
10402
|
+
*
|
|
10403
|
+
* @type {string}
|
|
10404
|
+
*
|
|
10405
|
+
*
|
|
10406
|
+
* @remarks
|
|
10407
|
+
* This key constant provides type-safe access to the `alias` property of EmailForwardAliasCreate objects.
|
|
10408
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10409
|
+
*
|
|
10410
|
+
* @example
|
|
10411
|
+
* ```typescript
|
|
10412
|
+
* // Direct property access
|
|
10413
|
+
* const value = emailforwardaliascreate[KEY_EMAIL_FORWARD_ALIAS_CREATE_ALIAS];
|
|
10414
|
+
*
|
|
10415
|
+
* // Dynamic property access
|
|
10416
|
+
* const propertyName = KEY_EMAIL_FORWARD_ALIAS_CREATE_ALIAS;
|
|
10417
|
+
* const value = emailforwardaliascreate[propertyName];
|
|
10418
|
+
* ```
|
|
10419
|
+
*
|
|
10420
|
+
* @see {@link EmailForwardAliasCreate} - The TypeScript type definition
|
|
10421
|
+
* @see {@link KEYS_EMAIL_FORWARD_ALIAS_CREATE} - Array of all keys for this type
|
|
10422
|
+
*/
|
|
10423
|
+
export const KEY_EMAIL_FORWARD_ALIAS_CREATE_ALIAS = 'alias' as keyof EmailForwardAliasCreate;
|
|
10424
|
+
/**
|
|
10425
|
+
* Forward To
|
|
10426
|
+
*
|
|
10427
|
+
*
|
|
10428
|
+
* @type {string}
|
|
10429
|
+
*
|
|
10430
|
+
*
|
|
10431
|
+
* @remarks
|
|
10432
|
+
* This key constant provides type-safe access to the `forward_to` property of EmailForwardAliasCreate objects.
|
|
10433
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10434
|
+
*
|
|
10435
|
+
* @example
|
|
10436
|
+
* ```typescript
|
|
10437
|
+
* // Direct property access
|
|
10438
|
+
* const value = emailforwardaliascreate[KEY_EMAIL_FORWARD_ALIAS_CREATE_FORWARD_TO];
|
|
10439
|
+
*
|
|
10440
|
+
* // Dynamic property access
|
|
10441
|
+
* const propertyName = KEY_EMAIL_FORWARD_ALIAS_CREATE_FORWARD_TO;
|
|
10442
|
+
* const value = emailforwardaliascreate[propertyName];
|
|
10443
|
+
* ```
|
|
10444
|
+
*
|
|
10445
|
+
* @see {@link EmailForwardAliasCreate} - The TypeScript type definition
|
|
10446
|
+
* @see {@link KEYS_EMAIL_FORWARD_ALIAS_CREATE} - Array of all keys for this type
|
|
10447
|
+
*/
|
|
10448
|
+
export const KEY_EMAIL_FORWARD_ALIAS_CREATE_FORWARD_TO = 'forward_to' as keyof EmailForwardAliasCreate;
|
|
10449
|
+
|
|
10450
|
+
/**
|
|
10451
|
+
* Array of all EmailForwardAliasCreate property keys
|
|
10452
|
+
*
|
|
10453
|
+
* @remarks
|
|
10454
|
+
* This constant provides a readonly array containing all valid property keys for EmailForwardAliasCreate objects.
|
|
10455
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
10456
|
+
*
|
|
10457
|
+
* @example
|
|
10458
|
+
* ```typescript
|
|
10459
|
+
* // Iterating through all keys
|
|
10460
|
+
* for (const key of KEYS_EMAIL_FORWARD_ALIAS_CREATE) {
|
|
10461
|
+
* console.log(`Property: ${key}, Value: ${emailforwardaliascreate[key]}`);
|
|
10462
|
+
* }
|
|
10463
|
+
*
|
|
10464
|
+
* // Validation
|
|
10465
|
+
* const isValidKey = KEYS_EMAIL_FORWARD_ALIAS_CREATE.includes(someKey);
|
|
10466
|
+
* ```
|
|
10467
|
+
*
|
|
10468
|
+
* @see {@link EmailForwardAliasCreate} - The TypeScript type definition
|
|
10469
|
+
*/
|
|
10470
|
+
export const KEYS_EMAIL_FORWARD_ALIAS_CREATE = [
|
|
10471
|
+
KEY_EMAIL_FORWARD_ALIAS_CREATE_ALIAS,
|
|
10472
|
+
KEY_EMAIL_FORWARD_ALIAS_CREATE_FORWARD_TO,
|
|
10473
|
+
] as const satisfies (keyof EmailForwardAliasCreate)[];
|
|
10474
|
+
|
|
10369
10475
|
/**
|
|
10370
10476
|
* Forward To
|
|
10371
10477
|
*
|
|
@@ -10416,6 +10522,390 @@ export const KEYS_EMAIL_FORWARD_ALIAS_UPDATE = [
|
|
|
10416
10522
|
KEY_EMAIL_FORWARD_ALIAS_UPDATE_FORWARD_TO,
|
|
10417
10523
|
] as const satisfies (keyof EmailForwardAliasUpdate)[];
|
|
10418
10524
|
|
|
10525
|
+
/**
|
|
10526
|
+
* Aliases
|
|
10527
|
+
*
|
|
10528
|
+
*
|
|
10529
|
+
* @type {array}
|
|
10530
|
+
*
|
|
10531
|
+
*
|
|
10532
|
+
* @remarks
|
|
10533
|
+
* This key constant provides type-safe access to the `aliases` property of EmailForwardCreate objects.
|
|
10534
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10535
|
+
*
|
|
10536
|
+
* @example
|
|
10537
|
+
* ```typescript
|
|
10538
|
+
* // Direct property access
|
|
10539
|
+
* const value = emailforwardcreate[KEY_EMAIL_FORWARD_CREATE_ALIASES];
|
|
10540
|
+
*
|
|
10541
|
+
* // Dynamic property access
|
|
10542
|
+
* const propertyName = KEY_EMAIL_FORWARD_CREATE_ALIASES;
|
|
10543
|
+
* const value = emailforwardcreate[propertyName];
|
|
10544
|
+
* ```
|
|
10545
|
+
*
|
|
10546
|
+
* @see {@link EmailForwardCreate} - The TypeScript type definition
|
|
10547
|
+
* @see {@link KEYS_EMAIL_FORWARD_CREATE} - Array of all keys for this type
|
|
10548
|
+
*/
|
|
10549
|
+
export const KEY_EMAIL_FORWARD_CREATE_ALIASES = 'aliases' as keyof EmailForwardCreate;
|
|
10550
|
+
/**
|
|
10551
|
+
* Enabled
|
|
10552
|
+
*
|
|
10553
|
+
*
|
|
10554
|
+
* @type {boolean}
|
|
10555
|
+
*
|
|
10556
|
+
*
|
|
10557
|
+
* @remarks
|
|
10558
|
+
* This key constant provides type-safe access to the `enabled` property of EmailForwardCreate objects.
|
|
10559
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10560
|
+
*
|
|
10561
|
+
* @example
|
|
10562
|
+
* ```typescript
|
|
10563
|
+
* // Direct property access
|
|
10564
|
+
* const value = emailforwardcreate[KEY_EMAIL_FORWARD_CREATE_ENABLED];
|
|
10565
|
+
*
|
|
10566
|
+
* // Dynamic property access
|
|
10567
|
+
* const propertyName = KEY_EMAIL_FORWARD_CREATE_ENABLED;
|
|
10568
|
+
* const value = emailforwardcreate[propertyName];
|
|
10569
|
+
* ```
|
|
10570
|
+
*
|
|
10571
|
+
* @see {@link EmailForwardCreate} - The TypeScript type definition
|
|
10572
|
+
* @see {@link KEYS_EMAIL_FORWARD_CREATE} - Array of all keys for this type
|
|
10573
|
+
*/
|
|
10574
|
+
export const KEY_EMAIL_FORWARD_CREATE_ENABLED = 'enabled' as keyof EmailForwardCreate;
|
|
10575
|
+
/**
|
|
10576
|
+
* Hostname
|
|
10577
|
+
*
|
|
10578
|
+
*
|
|
10579
|
+
* @type {string}
|
|
10580
|
+
*
|
|
10581
|
+
*
|
|
10582
|
+
* @remarks
|
|
10583
|
+
* This key constant provides type-safe access to the `hostname` property of EmailForwardCreate objects.
|
|
10584
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10585
|
+
*
|
|
10586
|
+
* @example
|
|
10587
|
+
* ```typescript
|
|
10588
|
+
* // Direct property access
|
|
10589
|
+
* const value = emailforwardcreate[KEY_EMAIL_FORWARD_CREATE_HOSTNAME];
|
|
10590
|
+
*
|
|
10591
|
+
* // Dynamic property access
|
|
10592
|
+
* const propertyName = KEY_EMAIL_FORWARD_CREATE_HOSTNAME;
|
|
10593
|
+
* const value = emailforwardcreate[propertyName];
|
|
10594
|
+
* ```
|
|
10595
|
+
*
|
|
10596
|
+
* @see {@link EmailForwardCreate} - The TypeScript type definition
|
|
10597
|
+
* @see {@link KEYS_EMAIL_FORWARD_CREATE} - Array of all keys for this type
|
|
10598
|
+
*/
|
|
10599
|
+
export const KEY_EMAIL_FORWARD_CREATE_HOSTNAME = 'hostname' as keyof EmailForwardCreate;
|
|
10600
|
+
|
|
10601
|
+
/**
|
|
10602
|
+
* Array of all EmailForwardCreate property keys
|
|
10603
|
+
*
|
|
10604
|
+
* @remarks
|
|
10605
|
+
* This constant provides a readonly array containing all valid property keys for EmailForwardCreate objects.
|
|
10606
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
10607
|
+
*
|
|
10608
|
+
* @example
|
|
10609
|
+
* ```typescript
|
|
10610
|
+
* // Iterating through all keys
|
|
10611
|
+
* for (const key of KEYS_EMAIL_FORWARD_CREATE) {
|
|
10612
|
+
* console.log(`Property: ${key}, Value: ${emailforwardcreate[key]}`);
|
|
10613
|
+
* }
|
|
10614
|
+
*
|
|
10615
|
+
* // Validation
|
|
10616
|
+
* const isValidKey = KEYS_EMAIL_FORWARD_CREATE.includes(someKey);
|
|
10617
|
+
* ```
|
|
10618
|
+
*
|
|
10619
|
+
* @see {@link EmailForwardCreate} - The TypeScript type definition
|
|
10620
|
+
*/
|
|
10621
|
+
export const KEYS_EMAIL_FORWARD_CREATE = [
|
|
10622
|
+
KEY_EMAIL_FORWARD_CREATE_ALIASES,
|
|
10623
|
+
KEY_EMAIL_FORWARD_CREATE_ENABLED,
|
|
10624
|
+
KEY_EMAIL_FORWARD_CREATE_HOSTNAME,
|
|
10625
|
+
] as const satisfies (keyof EmailForwardCreate)[];
|
|
10626
|
+
|
|
10627
|
+
/**
|
|
10628
|
+
* Aliases
|
|
10629
|
+
*
|
|
10630
|
+
*
|
|
10631
|
+
* @type {array}
|
|
10632
|
+
*
|
|
10633
|
+
*
|
|
10634
|
+
* @remarks
|
|
10635
|
+
* This key constant provides type-safe access to the `aliases` property of EmailForward objects.
|
|
10636
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10637
|
+
*
|
|
10638
|
+
* @example
|
|
10639
|
+
* ```typescript
|
|
10640
|
+
* // Direct property access
|
|
10641
|
+
* const value = emailforward[KEY_EMAIL_FORWARD_ALIASES];
|
|
10642
|
+
*
|
|
10643
|
+
* // Dynamic property access
|
|
10644
|
+
* const propertyName = KEY_EMAIL_FORWARD_ALIASES;
|
|
10645
|
+
* const value = emailforward[propertyName];
|
|
10646
|
+
* ```
|
|
10647
|
+
*
|
|
10648
|
+
* @see {@link EmailForward} - The TypeScript type definition
|
|
10649
|
+
* @see {@link KEYS_EMAIL_FORWARD} - Array of all keys for this type
|
|
10650
|
+
*/
|
|
10651
|
+
export const KEY_EMAIL_FORWARD_ALIASES = 'aliases' as keyof EmailForward;
|
|
10652
|
+
/**
|
|
10653
|
+
* Created On
|
|
10654
|
+
*
|
|
10655
|
+
*
|
|
10656
|
+
* @type {string}
|
|
10657
|
+
*
|
|
10658
|
+
*
|
|
10659
|
+
* @remarks
|
|
10660
|
+
* This key constant provides type-safe access to the `created_on` property of EmailForward objects.
|
|
10661
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10662
|
+
*
|
|
10663
|
+
* @example
|
|
10664
|
+
* ```typescript
|
|
10665
|
+
* // Direct property access
|
|
10666
|
+
* const value = emailforward[KEY_EMAIL_FORWARD_CREATED_ON];
|
|
10667
|
+
*
|
|
10668
|
+
* // Dynamic property access
|
|
10669
|
+
* const propertyName = KEY_EMAIL_FORWARD_CREATED_ON;
|
|
10670
|
+
* const value = emailforward[propertyName];
|
|
10671
|
+
* ```
|
|
10672
|
+
*
|
|
10673
|
+
* @see {@link EmailForward} - The TypeScript type definition
|
|
10674
|
+
* @see {@link KEYS_EMAIL_FORWARD} - Array of all keys for this type
|
|
10675
|
+
*/
|
|
10676
|
+
export const KEY_EMAIL_FORWARD_CREATED_ON = 'created_on' as keyof EmailForward;
|
|
10677
|
+
/**
|
|
10678
|
+
* Email Forward Id
|
|
10679
|
+
*
|
|
10680
|
+
*
|
|
10681
|
+
* @type {string}
|
|
10682
|
+
*
|
|
10683
|
+
*
|
|
10684
|
+
* @remarks
|
|
10685
|
+
* This key constant provides type-safe access to the `email_forward_id` property of EmailForward objects.
|
|
10686
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10687
|
+
*
|
|
10688
|
+
* @example
|
|
10689
|
+
* ```typescript
|
|
10690
|
+
* // Direct property access
|
|
10691
|
+
* const value = emailforward[KEY_EMAIL_FORWARD_EMAIL_FORWARD_ID];
|
|
10692
|
+
*
|
|
10693
|
+
* // Dynamic property access
|
|
10694
|
+
* const propertyName = KEY_EMAIL_FORWARD_EMAIL_FORWARD_ID;
|
|
10695
|
+
* const value = emailforward[propertyName];
|
|
10696
|
+
* ```
|
|
10697
|
+
*
|
|
10698
|
+
* @see {@link EmailForward} - The TypeScript type definition
|
|
10699
|
+
* @see {@link KEYS_EMAIL_FORWARD} - Array of all keys for this type
|
|
10700
|
+
*/
|
|
10701
|
+
export const KEY_EMAIL_FORWARD_EMAIL_FORWARD_ID = 'email_forward_id' as keyof EmailForward;
|
|
10702
|
+
/**
|
|
10703
|
+
* Enabled
|
|
10704
|
+
*
|
|
10705
|
+
*
|
|
10706
|
+
* @type {boolean}
|
|
10707
|
+
*
|
|
10708
|
+
*
|
|
10709
|
+
* @remarks
|
|
10710
|
+
* This key constant provides type-safe access to the `enabled` property of EmailForward objects.
|
|
10711
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10712
|
+
*
|
|
10713
|
+
* @example
|
|
10714
|
+
* ```typescript
|
|
10715
|
+
* // Direct property access
|
|
10716
|
+
* const value = emailforward[KEY_EMAIL_FORWARD_ENABLED];
|
|
10717
|
+
*
|
|
10718
|
+
* // Dynamic property access
|
|
10719
|
+
* const propertyName = KEY_EMAIL_FORWARD_ENABLED;
|
|
10720
|
+
* const value = emailforward[propertyName];
|
|
10721
|
+
* ```
|
|
10722
|
+
*
|
|
10723
|
+
* @see {@link EmailForward} - The TypeScript type definition
|
|
10724
|
+
* @see {@link KEYS_EMAIL_FORWARD} - Array of all keys for this type
|
|
10725
|
+
*/
|
|
10726
|
+
export const KEY_EMAIL_FORWARD_ENABLED = 'enabled' as keyof EmailForward;
|
|
10727
|
+
/**
|
|
10728
|
+
* Hostname
|
|
10729
|
+
*
|
|
10730
|
+
*
|
|
10731
|
+
* @type {string}
|
|
10732
|
+
*
|
|
10733
|
+
*
|
|
10734
|
+
* @remarks
|
|
10735
|
+
* This key constant provides type-safe access to the `hostname` property of EmailForward objects.
|
|
10736
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10737
|
+
*
|
|
10738
|
+
* @example
|
|
10739
|
+
* ```typescript
|
|
10740
|
+
* // Direct property access
|
|
10741
|
+
* const value = emailforward[KEY_EMAIL_FORWARD_HOSTNAME];
|
|
10742
|
+
*
|
|
10743
|
+
* // Dynamic property access
|
|
10744
|
+
* const propertyName = KEY_EMAIL_FORWARD_HOSTNAME;
|
|
10745
|
+
* const value = emailforward[propertyName];
|
|
10746
|
+
* ```
|
|
10747
|
+
*
|
|
10748
|
+
* @see {@link EmailForward} - The TypeScript type definition
|
|
10749
|
+
* @see {@link KEYS_EMAIL_FORWARD} - Array of all keys for this type
|
|
10750
|
+
*/
|
|
10751
|
+
export const KEY_EMAIL_FORWARD_HOSTNAME = 'hostname' as keyof EmailForward;
|
|
10752
|
+
/**
|
|
10753
|
+
* Updated On
|
|
10754
|
+
*
|
|
10755
|
+
*
|
|
10756
|
+
* @type {string}
|
|
10757
|
+
*
|
|
10758
|
+
*
|
|
10759
|
+
* @remarks
|
|
10760
|
+
* This key constant provides type-safe access to the `updated_on` property of EmailForward objects.
|
|
10761
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10762
|
+
*
|
|
10763
|
+
* @example
|
|
10764
|
+
* ```typescript
|
|
10765
|
+
* // Direct property access
|
|
10766
|
+
* const value = emailforward[KEY_EMAIL_FORWARD_UPDATED_ON];
|
|
10767
|
+
*
|
|
10768
|
+
* // Dynamic property access
|
|
10769
|
+
* const propertyName = KEY_EMAIL_FORWARD_UPDATED_ON;
|
|
10770
|
+
* const value = emailforward[propertyName];
|
|
10771
|
+
* ```
|
|
10772
|
+
*
|
|
10773
|
+
* @see {@link EmailForward} - The TypeScript type definition
|
|
10774
|
+
* @see {@link KEYS_EMAIL_FORWARD} - Array of all keys for this type
|
|
10775
|
+
*/
|
|
10776
|
+
export const KEY_EMAIL_FORWARD_UPDATED_ON = 'updated_on' as keyof EmailForward;
|
|
10777
|
+
|
|
10778
|
+
/**
|
|
10779
|
+
* Array of all EmailForward property keys
|
|
10780
|
+
*
|
|
10781
|
+
* @remarks
|
|
10782
|
+
* This constant provides a readonly array containing all valid property keys for EmailForward objects.
|
|
10783
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
10784
|
+
*
|
|
10785
|
+
* @example
|
|
10786
|
+
* ```typescript
|
|
10787
|
+
* // Iterating through all keys
|
|
10788
|
+
* for (const key of KEYS_EMAIL_FORWARD) {
|
|
10789
|
+
* console.log(`Property: ${key}, Value: ${emailforward[key]}`);
|
|
10790
|
+
* }
|
|
10791
|
+
*
|
|
10792
|
+
* // Validation
|
|
10793
|
+
* const isValidKey = KEYS_EMAIL_FORWARD.includes(someKey);
|
|
10794
|
+
* ```
|
|
10795
|
+
*
|
|
10796
|
+
* @see {@link EmailForward} - The TypeScript type definition
|
|
10797
|
+
*/
|
|
10798
|
+
export const KEYS_EMAIL_FORWARD = [
|
|
10799
|
+
KEY_EMAIL_FORWARD_ALIASES,
|
|
10800
|
+
KEY_EMAIL_FORWARD_CREATED_ON,
|
|
10801
|
+
KEY_EMAIL_FORWARD_EMAIL_FORWARD_ID,
|
|
10802
|
+
KEY_EMAIL_FORWARD_ENABLED,
|
|
10803
|
+
KEY_EMAIL_FORWARD_HOSTNAME,
|
|
10804
|
+
KEY_EMAIL_FORWARD_UPDATED_ON,
|
|
10805
|
+
] as const satisfies (keyof EmailForward)[];
|
|
10806
|
+
|
|
10807
|
+
/**
|
|
10808
|
+
* Email Forwards
|
|
10809
|
+
*
|
|
10810
|
+
*
|
|
10811
|
+
* @type {array}
|
|
10812
|
+
*
|
|
10813
|
+
*
|
|
10814
|
+
* @remarks
|
|
10815
|
+
* This key constant provides type-safe access to the `email_forwards` property of EmailForwardZone objects.
|
|
10816
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10817
|
+
*
|
|
10818
|
+
* @example
|
|
10819
|
+
* ```typescript
|
|
10820
|
+
* // Direct property access
|
|
10821
|
+
* const value = emailforwardzone[KEY_EMAIL_FORWARD_ZONE_EMAIL_FORWARDS];
|
|
10822
|
+
*
|
|
10823
|
+
* // Dynamic property access
|
|
10824
|
+
* const propertyName = KEY_EMAIL_FORWARD_ZONE_EMAIL_FORWARDS;
|
|
10825
|
+
* const value = emailforwardzone[propertyName];
|
|
10826
|
+
* ```
|
|
10827
|
+
*
|
|
10828
|
+
* @see {@link EmailForwardZone} - The TypeScript type definition
|
|
10829
|
+
* @see {@link KEYS_EMAIL_FORWARD_ZONE} - Array of all keys for this type
|
|
10830
|
+
*/
|
|
10831
|
+
export const KEY_EMAIL_FORWARD_ZONE_EMAIL_FORWARDS = 'email_forwards' as keyof EmailForwardZone;
|
|
10832
|
+
/**
|
|
10833
|
+
* Zone Id
|
|
10834
|
+
*
|
|
10835
|
+
*
|
|
10836
|
+
* @type {string}
|
|
10837
|
+
*
|
|
10838
|
+
*
|
|
10839
|
+
* @remarks
|
|
10840
|
+
* This key constant provides type-safe access to the `zone_id` property of EmailForwardZone objects.
|
|
10841
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10842
|
+
*
|
|
10843
|
+
* @example
|
|
10844
|
+
* ```typescript
|
|
10845
|
+
* // Direct property access
|
|
10846
|
+
* const value = emailforwardzone[KEY_EMAIL_FORWARD_ZONE_ZONE_ID];
|
|
10847
|
+
*
|
|
10848
|
+
* // Dynamic property access
|
|
10849
|
+
* const propertyName = KEY_EMAIL_FORWARD_ZONE_ZONE_ID;
|
|
10850
|
+
* const value = emailforwardzone[propertyName];
|
|
10851
|
+
* ```
|
|
10852
|
+
*
|
|
10853
|
+
* @see {@link EmailForwardZone} - The TypeScript type definition
|
|
10854
|
+
* @see {@link KEYS_EMAIL_FORWARD_ZONE} - Array of all keys for this type
|
|
10855
|
+
*/
|
|
10856
|
+
export const KEY_EMAIL_FORWARD_ZONE_ZONE_ID = 'zone_id' as keyof EmailForwardZone;
|
|
10857
|
+
/**
|
|
10858
|
+
* Zone Name
|
|
10859
|
+
*
|
|
10860
|
+
*
|
|
10861
|
+
* @type {string}
|
|
10862
|
+
*
|
|
10863
|
+
*
|
|
10864
|
+
* @remarks
|
|
10865
|
+
* This key constant provides type-safe access to the `zone_name` property of EmailForwardZone objects.
|
|
10866
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10867
|
+
*
|
|
10868
|
+
* @example
|
|
10869
|
+
* ```typescript
|
|
10870
|
+
* // Direct property access
|
|
10871
|
+
* const value = emailforwardzone[KEY_EMAIL_FORWARD_ZONE_ZONE_NAME];
|
|
10872
|
+
*
|
|
10873
|
+
* // Dynamic property access
|
|
10874
|
+
* const propertyName = KEY_EMAIL_FORWARD_ZONE_ZONE_NAME;
|
|
10875
|
+
* const value = emailforwardzone[propertyName];
|
|
10876
|
+
* ```
|
|
10877
|
+
*
|
|
10878
|
+
* @see {@link EmailForwardZone} - The TypeScript type definition
|
|
10879
|
+
* @see {@link KEYS_EMAIL_FORWARD_ZONE} - Array of all keys for this type
|
|
10880
|
+
*/
|
|
10881
|
+
export const KEY_EMAIL_FORWARD_ZONE_ZONE_NAME = 'zone_name' as keyof EmailForwardZone;
|
|
10882
|
+
|
|
10883
|
+
/**
|
|
10884
|
+
* Array of all EmailForwardZone property keys
|
|
10885
|
+
*
|
|
10886
|
+
* @remarks
|
|
10887
|
+
* This constant provides a readonly array containing all valid property keys for EmailForwardZone objects.
|
|
10888
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
10889
|
+
*
|
|
10890
|
+
* @example
|
|
10891
|
+
* ```typescript
|
|
10892
|
+
* // Iterating through all keys
|
|
10893
|
+
* for (const key of KEYS_EMAIL_FORWARD_ZONE) {
|
|
10894
|
+
* console.log(`Property: ${key}, Value: ${emailforwardzone[key]}`);
|
|
10895
|
+
* }
|
|
10896
|
+
*
|
|
10897
|
+
* // Validation
|
|
10898
|
+
* const isValidKey = KEYS_EMAIL_FORWARD_ZONE.includes(someKey);
|
|
10899
|
+
* ```
|
|
10900
|
+
*
|
|
10901
|
+
* @see {@link EmailForwardZone} - The TypeScript type definition
|
|
10902
|
+
*/
|
|
10903
|
+
export const KEYS_EMAIL_FORWARD_ZONE = [
|
|
10904
|
+
KEY_EMAIL_FORWARD_ZONE_EMAIL_FORWARDS,
|
|
10905
|
+
KEY_EMAIL_FORWARD_ZONE_ZONE_ID,
|
|
10906
|
+
KEY_EMAIL_FORWARD_ZONE_ZONE_NAME,
|
|
10907
|
+
] as const satisfies (keyof EmailForwardZone)[];
|
|
10908
|
+
|
|
10419
10909
|
/**
|
|
10420
10910
|
* Event Data
|
|
10421
10911
|
*
|