@opusdns/api 0.156.0 → 0.158.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 +55 -55
- package/src/helpers/keys.ts +369 -29
- package/src/helpers/requests.d.ts +53 -0
- package/src/helpers/responses.d.ts +111 -1
- package/src/helpers/schemas.d.ts +60 -12
- package/src/openapi.yaml +177 -19
- package/src/schema.d.ts +170 -17
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, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus,
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -1340,120 +1340,120 @@ export const DOMAIN_STATUS_VALUES = [
|
|
|
1340
1340
|
] as const satisfies [string, ...string[]] | DomainStatus[];
|
|
1341
1341
|
|
|
1342
1342
|
/**
|
|
1343
|
-
*
|
|
1343
|
+
* EmailForwardLogSortField. Auto-generated enum for EmailForwardLogSortField
|
|
1344
1344
|
*
|
|
1345
1345
|
* @remarks
|
|
1346
|
-
* This constant provides both object and array forms for the
|
|
1346
|
+
* This constant provides both object and array forms for the EmailForwardLogSortField enum.
|
|
1347
1347
|
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1348
1348
|
*
|
|
1349
1349
|
* @example
|
|
1350
1350
|
* ```typescript
|
|
1351
1351
|
* // Using the object form for key-value access
|
|
1352
|
-
* const status =
|
|
1352
|
+
* const status = EMAIL_FORWARD_LOG_SORT_FIELD.SUCCESS;
|
|
1353
1353
|
*
|
|
1354
1354
|
* // Using the array form for iteration
|
|
1355
|
-
* const allStatuses =
|
|
1355
|
+
* const allStatuses = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES;
|
|
1356
1356
|
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1357
1357
|
* ```
|
|
1358
1358
|
*
|
|
1359
|
-
* @see {@link
|
|
1359
|
+
* @see {@link EmailForwardLogSortField} - The TypeScript type definition
|
|
1360
1360
|
*/
|
|
1361
|
-
export const
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1361
|
+
export const EMAIL_FORWARD_LOG_SORT_FIELD = {
|
|
1362
|
+
LOG_ID: "log_id",
|
|
1363
|
+
SENDER_EMAIL: "sender_email",
|
|
1364
|
+
RECIPIENT_EMAIL: "recipient_email",
|
|
1365
|
+
FORWARD_EMAIL: "forward_email",
|
|
1366
|
+
FINAL_STATUS: "final_status",
|
|
1367
|
+
CREATED_ON: "created_on",
|
|
1368
|
+
SYNCED_ON: "synced_on",
|
|
1369
|
+
} as const satisfies Record<string, EmailForwardLogSortField>;
|
|
1368
1370
|
|
|
1369
1371
|
/**
|
|
1370
|
-
* Array of all
|
|
1372
|
+
* Array of all EmailForwardLogSortField enum values
|
|
1371
1373
|
*
|
|
1372
1374
|
* @remarks
|
|
1373
|
-
* This constant provides a array containing all valid
|
|
1375
|
+
* This constant provides a array containing all valid EmailForwardLogSortField enum values.
|
|
1374
1376
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1375
1377
|
*
|
|
1376
1378
|
* @example
|
|
1377
1379
|
* ```typescript
|
|
1378
1380
|
* // Iterating through all values
|
|
1379
|
-
* for (const value of
|
|
1381
|
+
* for (const value of EMAIL_FORWARD_LOG_SORT_FIELD_VALUES) {
|
|
1380
1382
|
* console.log(`Processing: ${value}`);
|
|
1381
1383
|
* }
|
|
1382
1384
|
*
|
|
1383
1385
|
* // Validation
|
|
1384
|
-
* const isValid =
|
|
1386
|
+
* const isValid = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES.includes(someValue);
|
|
1385
1387
|
* ```
|
|
1386
1388
|
*
|
|
1387
|
-
* @see {@link
|
|
1388
|
-
* @see {@link
|
|
1389
|
+
* @see {@link EmailForwardLogSortField} - The TypeScript type definition
|
|
1390
|
+
* @see {@link EMAIL_FORWARD_LOG_SORT_FIELD} - The object form of this enum
|
|
1389
1391
|
*/
|
|
1390
|
-
export const
|
|
1391
|
-
'
|
|
1392
|
-
'
|
|
1393
|
-
'
|
|
1394
|
-
'
|
|
1395
|
-
'
|
|
1396
|
-
|
|
1392
|
+
export const EMAIL_FORWARD_LOG_SORT_FIELD_VALUES = [
|
|
1393
|
+
'log_id',
|
|
1394
|
+
'sender_email',
|
|
1395
|
+
'recipient_email',
|
|
1396
|
+
'forward_email',
|
|
1397
|
+
'final_status',
|
|
1398
|
+
'created_on',
|
|
1399
|
+
'synced_on'
|
|
1400
|
+
] as const satisfies [string, ...string[]] | EmailForwardLogSortField[];
|
|
1397
1401
|
|
|
1398
1402
|
/**
|
|
1399
|
-
*
|
|
1403
|
+
* EmailForwardLogStatus. Auto-generated enum for EmailForwardLogStatus
|
|
1400
1404
|
*
|
|
1401
1405
|
* @remarks
|
|
1402
|
-
* This constant provides both object and array forms for the
|
|
1406
|
+
* This constant provides both object and array forms for the EmailForwardLogStatus enum.
|
|
1403
1407
|
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1404
1408
|
*
|
|
1405
1409
|
* @example
|
|
1406
1410
|
* ```typescript
|
|
1407
1411
|
* // Using the object form for key-value access
|
|
1408
|
-
* const status =
|
|
1412
|
+
* const status = EMAIL_FORWARD_LOG_STATUS.SUCCESS;
|
|
1409
1413
|
*
|
|
1410
1414
|
* // Using the array form for iteration
|
|
1411
|
-
* const allStatuses =
|
|
1415
|
+
* const allStatuses = EMAIL_FORWARD_LOG_STATUS_VALUES;
|
|
1412
1416
|
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1413
1417
|
* ```
|
|
1414
1418
|
*
|
|
1415
|
-
* @see {@link
|
|
1419
|
+
* @see {@link EmailForwardLogStatus} - The TypeScript type definition
|
|
1416
1420
|
*/
|
|
1417
|
-
export const
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
SYNCED_ON: "synced_on",
|
|
1425
|
-
} as const satisfies Record<string, EmailForwardLogSortField>;
|
|
1421
|
+
export const EMAIL_FORWARD_LOG_STATUS = {
|
|
1422
|
+
QUEUED: "QUEUED",
|
|
1423
|
+
DELIVERED: "DELIVERED",
|
|
1424
|
+
REFUSED: "REFUSED",
|
|
1425
|
+
SOFT_BOUNCE: "SOFT-BOUNCE",
|
|
1426
|
+
HARD_BOUNCE: "HARD-BOUNCE",
|
|
1427
|
+
} as const satisfies Record<string, EmailForwardLogStatus>;
|
|
1426
1428
|
|
|
1427
1429
|
/**
|
|
1428
|
-
* Array of all
|
|
1430
|
+
* Array of all EmailForwardLogStatus enum values
|
|
1429
1431
|
*
|
|
1430
1432
|
* @remarks
|
|
1431
|
-
* This constant provides a array containing all valid
|
|
1433
|
+
* This constant provides a array containing all valid EmailForwardLogStatus enum values.
|
|
1432
1434
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1433
1435
|
*
|
|
1434
1436
|
* @example
|
|
1435
1437
|
* ```typescript
|
|
1436
1438
|
* // Iterating through all values
|
|
1437
|
-
* for (const value of
|
|
1439
|
+
* for (const value of EMAIL_FORWARD_LOG_STATUS_VALUES) {
|
|
1438
1440
|
* console.log(`Processing: ${value}`);
|
|
1439
1441
|
* }
|
|
1440
1442
|
*
|
|
1441
1443
|
* // Validation
|
|
1442
|
-
* const isValid =
|
|
1444
|
+
* const isValid = EMAIL_FORWARD_LOG_STATUS_VALUES.includes(someValue);
|
|
1443
1445
|
* ```
|
|
1444
1446
|
*
|
|
1445
|
-
* @see {@link
|
|
1446
|
-
* @see {@link
|
|
1447
|
+
* @see {@link EmailForwardLogStatus} - The TypeScript type definition
|
|
1448
|
+
* @see {@link EMAIL_FORWARD_LOG_STATUS} - The object form of this enum
|
|
1447
1449
|
*/
|
|
1448
|
-
export const
|
|
1449
|
-
'
|
|
1450
|
-
'
|
|
1451
|
-
'
|
|
1452
|
-
'
|
|
1453
|
-
'
|
|
1454
|
-
|
|
1455
|
-
'synced_on'
|
|
1456
|
-
] as const satisfies [string, ...string[]] | EmailForwardLogSortField[];
|
|
1450
|
+
export const EMAIL_FORWARD_LOG_STATUS_VALUES = [
|
|
1451
|
+
'QUEUED',
|
|
1452
|
+
'DELIVERED',
|
|
1453
|
+
'REFUSED',
|
|
1454
|
+
'SOFT-BOUNCE',
|
|
1455
|
+
'HARD-BOUNCE'
|
|
1456
|
+
] as const satisfies [string, ...string[]] | EmailForwardLogStatus[];
|
|
1457
1457
|
|
|
1458
1458
|
/**
|
|
1459
1459
|
* EmailForwardSortField. Auto-generated enum for EmailForwardSortField
|
package/src/helpers/keys.ts
CHANGED
|
@@ -119,6 +119,9 @@ import { EmailForwardAliasUpdate } from './schemas';
|
|
|
119
119
|
import { EmailForwardCreate } from './schemas';
|
|
120
120
|
import { EmailForwardLog } from './schemas';
|
|
121
121
|
import { EmailForwardLogEvent } from './schemas';
|
|
122
|
+
import { EmailForwardMetrics } from './schemas';
|
|
123
|
+
import { EmailForwardMetricsFilters } from './schemas';
|
|
124
|
+
import { EmailForwardMetricsRates } from './schemas';
|
|
122
125
|
import { EmailForward } from './schemas';
|
|
123
126
|
import { EmailForwardZone } from './schemas';
|
|
124
127
|
import { EventResponse } from './schemas';
|
|
@@ -9504,32 +9507,6 @@ export const KEYS_DOMAIN = [
|
|
|
9504
9507
|
* @see {@link KEYS_DOMAIN_RESTORE_REQUEST} - Array of all keys for this type
|
|
9505
9508
|
*/
|
|
9506
9509
|
export const KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO: keyof DomainRestoreRequest = 'additional_info';
|
|
9507
|
-
/**
|
|
9508
|
-
* Auto Renew
|
|
9509
|
-
*
|
|
9510
|
-
* Whether to automatically renew the domain after restore
|
|
9511
|
-
*
|
|
9512
|
-
* @type {boolean}
|
|
9513
|
-
*
|
|
9514
|
-
*
|
|
9515
|
-
* @remarks
|
|
9516
|
-
* This key constant provides type-safe access to the `auto_renew` property of DomainRestoreRequest objects.
|
|
9517
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
9518
|
-
*
|
|
9519
|
-
* @example
|
|
9520
|
-
* ```typescript
|
|
9521
|
-
* // Direct property access
|
|
9522
|
-
* const value = domainrestorerequest[KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW];
|
|
9523
|
-
*
|
|
9524
|
-
* // Dynamic property access
|
|
9525
|
-
* const propertyName = KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW;
|
|
9526
|
-
* const value = domainrestorerequest[propertyName];
|
|
9527
|
-
* ```
|
|
9528
|
-
*
|
|
9529
|
-
* @see {@link DomainRestoreRequest} - The TypeScript type definition
|
|
9530
|
-
* @see {@link KEYS_DOMAIN_RESTORE_REQUEST} - Array of all keys for this type
|
|
9531
|
-
*/
|
|
9532
|
-
export const KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW: keyof DomainRestoreRequest = 'auto_renew';
|
|
9533
9510
|
/**
|
|
9534
9511
|
* Reason
|
|
9535
9512
|
*
|
|
@@ -9578,7 +9555,6 @@ export const KEY_DOMAIN_RESTORE_REQUEST_REASON: keyof DomainRestoreRequest = 're
|
|
|
9578
9555
|
*/
|
|
9579
9556
|
export const KEYS_DOMAIN_RESTORE_REQUEST = [
|
|
9580
9557
|
KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO,
|
|
9581
|
-
KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW,
|
|
9582
9558
|
KEY_DOMAIN_RESTORE_REQUEST_REASON,
|
|
9583
9559
|
] as const satisfies (keyof DomainRestoreRequest)[];
|
|
9584
9560
|
|
|
@@ -11589,11 +11565,10 @@ export const KEY_EMAIL_FORWARD_LOG_DOMAIN: keyof EmailForwardLog = 'domain';
|
|
|
11589
11565
|
*/
|
|
11590
11566
|
export const KEY_EMAIL_FORWARD_LOG_EVENTS: keyof EmailForwardLog = 'events';
|
|
11591
11567
|
/**
|
|
11592
|
-
*
|
|
11568
|
+
* final_status property
|
|
11593
11569
|
*
|
|
11594
11570
|
* Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
|
|
11595
11571
|
*
|
|
11596
|
-
* @type {string}
|
|
11597
11572
|
*
|
|
11598
11573
|
*
|
|
11599
11574
|
* @remarks
|
|
@@ -12176,6 +12151,371 @@ export const KEYS_EMAIL_FORWARD_LOG_EVENT = [
|
|
|
12176
12151
|
KEY_EMAIL_FORWARD_LOG_EVENT_STATUS,
|
|
12177
12152
|
] as const satisfies (keyof EmailForwardLogEvent)[];
|
|
12178
12153
|
|
|
12154
|
+
/**
|
|
12155
|
+
* By Status
|
|
12156
|
+
*
|
|
12157
|
+
* Log counts grouped by status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
|
|
12158
|
+
*
|
|
12159
|
+
* @type {object}
|
|
12160
|
+
*
|
|
12161
|
+
*
|
|
12162
|
+
* @remarks
|
|
12163
|
+
* This key constant provides type-safe access to the `by_status` property of EmailForwardMetrics objects.
|
|
12164
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12165
|
+
*
|
|
12166
|
+
* @example
|
|
12167
|
+
* ```typescript
|
|
12168
|
+
* // Direct property access
|
|
12169
|
+
* const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_BY_STATUS];
|
|
12170
|
+
*
|
|
12171
|
+
* // Dynamic property access
|
|
12172
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_BY_STATUS;
|
|
12173
|
+
* const value = emailforwardmetrics[propertyName];
|
|
12174
|
+
* ```
|
|
12175
|
+
*
|
|
12176
|
+
* @see {@link EmailForwardMetrics} - The TypeScript type definition
|
|
12177
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
|
|
12178
|
+
*/
|
|
12179
|
+
export const KEY_EMAIL_FORWARD_METRICS_BY_STATUS: keyof EmailForwardMetrics = 'by_status';
|
|
12180
|
+
/**
|
|
12181
|
+
* filters property
|
|
12182
|
+
*
|
|
12183
|
+
* Applied filters
|
|
12184
|
+
*
|
|
12185
|
+
*
|
|
12186
|
+
*
|
|
12187
|
+
* @remarks
|
|
12188
|
+
* This key constant provides type-safe access to the `filters` property of EmailForwardMetrics objects.
|
|
12189
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12190
|
+
*
|
|
12191
|
+
* @example
|
|
12192
|
+
* ```typescript
|
|
12193
|
+
* // Direct property access
|
|
12194
|
+
* const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_FILTERS];
|
|
12195
|
+
*
|
|
12196
|
+
* // Dynamic property access
|
|
12197
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS;
|
|
12198
|
+
* const value = emailforwardmetrics[propertyName];
|
|
12199
|
+
* ```
|
|
12200
|
+
*
|
|
12201
|
+
* @see {@link EmailForwardMetrics} - The TypeScript type definition
|
|
12202
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
|
|
12203
|
+
*/
|
|
12204
|
+
export const KEY_EMAIL_FORWARD_METRICS_FILTERS: keyof EmailForwardMetrics = 'filters';
|
|
12205
|
+
/**
|
|
12206
|
+
* rates property
|
|
12207
|
+
*
|
|
12208
|
+
* Rate percentages for each status
|
|
12209
|
+
*
|
|
12210
|
+
*
|
|
12211
|
+
*
|
|
12212
|
+
* @remarks
|
|
12213
|
+
* This key constant provides type-safe access to the `rates` property of EmailForwardMetrics objects.
|
|
12214
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12215
|
+
*
|
|
12216
|
+
* @example
|
|
12217
|
+
* ```typescript
|
|
12218
|
+
* // Direct property access
|
|
12219
|
+
* const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_RATES];
|
|
12220
|
+
*
|
|
12221
|
+
* // Dynamic property access
|
|
12222
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES;
|
|
12223
|
+
* const value = emailforwardmetrics[propertyName];
|
|
12224
|
+
* ```
|
|
12225
|
+
*
|
|
12226
|
+
* @see {@link EmailForwardMetrics} - The TypeScript type definition
|
|
12227
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
|
|
12228
|
+
*/
|
|
12229
|
+
export const KEY_EMAIL_FORWARD_METRICS_RATES: keyof EmailForwardMetrics = 'rates';
|
|
12230
|
+
/**
|
|
12231
|
+
* Total Logs
|
|
12232
|
+
*
|
|
12233
|
+
* Total number of email forward logs
|
|
12234
|
+
*
|
|
12235
|
+
* @type {integer}
|
|
12236
|
+
*
|
|
12237
|
+
*
|
|
12238
|
+
* @remarks
|
|
12239
|
+
* This key constant provides type-safe access to the `total_logs` property of EmailForwardMetrics objects.
|
|
12240
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12241
|
+
*
|
|
12242
|
+
* @example
|
|
12243
|
+
* ```typescript
|
|
12244
|
+
* // Direct property access
|
|
12245
|
+
* const value = emailforwardmetrics[KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS];
|
|
12246
|
+
*
|
|
12247
|
+
* // Dynamic property access
|
|
12248
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS;
|
|
12249
|
+
* const value = emailforwardmetrics[propertyName];
|
|
12250
|
+
* ```
|
|
12251
|
+
*
|
|
12252
|
+
* @see {@link EmailForwardMetrics} - The TypeScript type definition
|
|
12253
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS} - Array of all keys for this type
|
|
12254
|
+
*/
|
|
12255
|
+
export const KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS: keyof EmailForwardMetrics = 'total_logs';
|
|
12256
|
+
|
|
12257
|
+
/**
|
|
12258
|
+
* Array of all EmailForwardMetrics property keys
|
|
12259
|
+
*
|
|
12260
|
+
* @remarks
|
|
12261
|
+
* This constant provides a readonly array containing all valid property keys for EmailForwardMetrics objects.
|
|
12262
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
12263
|
+
*
|
|
12264
|
+
* @example
|
|
12265
|
+
* ```typescript
|
|
12266
|
+
* // Iterating through all keys
|
|
12267
|
+
* for (const key of KEYS_EMAIL_FORWARD_METRICS) {
|
|
12268
|
+
* console.log(`Property: ${key}, Value: ${emailforwardmetrics[key]}`);
|
|
12269
|
+
* }
|
|
12270
|
+
*
|
|
12271
|
+
* // Validation
|
|
12272
|
+
* const isValidKey = KEYS_EMAIL_FORWARD_METRICS.includes(someKey);
|
|
12273
|
+
* ```
|
|
12274
|
+
*
|
|
12275
|
+
* @see {@link EmailForwardMetrics} - The TypeScript type definition
|
|
12276
|
+
*/
|
|
12277
|
+
export const KEYS_EMAIL_FORWARD_METRICS = [
|
|
12278
|
+
KEY_EMAIL_FORWARD_METRICS_BY_STATUS,
|
|
12279
|
+
KEY_EMAIL_FORWARD_METRICS_FILTERS,
|
|
12280
|
+
KEY_EMAIL_FORWARD_METRICS_RATES,
|
|
12281
|
+
KEY_EMAIL_FORWARD_METRICS_TOTAL_LOGS,
|
|
12282
|
+
] as const satisfies (keyof EmailForwardMetrics)[];
|
|
12283
|
+
|
|
12284
|
+
/**
|
|
12285
|
+
* Domain
|
|
12286
|
+
*
|
|
12287
|
+
* Domain name
|
|
12288
|
+
*
|
|
12289
|
+
* @type {string}
|
|
12290
|
+
*
|
|
12291
|
+
*
|
|
12292
|
+
* @remarks
|
|
12293
|
+
* This key constant provides type-safe access to the `domain` property of EmailForwardMetricsFilters objects.
|
|
12294
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12295
|
+
*
|
|
12296
|
+
* @example
|
|
12297
|
+
* ```typescript
|
|
12298
|
+
* // Direct property access
|
|
12299
|
+
* const value = emailforwardmetricsfilters[KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN];
|
|
12300
|
+
*
|
|
12301
|
+
* // Dynamic property access
|
|
12302
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN;
|
|
12303
|
+
* const value = emailforwardmetricsfilters[propertyName];
|
|
12304
|
+
* ```
|
|
12305
|
+
*
|
|
12306
|
+
* @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
|
|
12307
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS_FILTERS} - Array of all keys for this type
|
|
12308
|
+
*/
|
|
12309
|
+
export const KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN: keyof EmailForwardMetricsFilters = 'domain';
|
|
12310
|
+
/**
|
|
12311
|
+
* End Time
|
|
12312
|
+
*
|
|
12313
|
+
* End time filter (RFC3339)
|
|
12314
|
+
*
|
|
12315
|
+
*
|
|
12316
|
+
*
|
|
12317
|
+
* @remarks
|
|
12318
|
+
* This key constant provides type-safe access to the `end_time` property of EmailForwardMetricsFilters objects.
|
|
12319
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12320
|
+
*
|
|
12321
|
+
* @example
|
|
12322
|
+
* ```typescript
|
|
12323
|
+
* // Direct property access
|
|
12324
|
+
* const value = emailforwardmetricsfilters[KEY_EMAIL_FORWARD_METRICS_FILTERS_END_TIME];
|
|
12325
|
+
*
|
|
12326
|
+
* // Dynamic property access
|
|
12327
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS_END_TIME;
|
|
12328
|
+
* const value = emailforwardmetricsfilters[propertyName];
|
|
12329
|
+
* ```
|
|
12330
|
+
*
|
|
12331
|
+
* @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
|
|
12332
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS_FILTERS} - Array of all keys for this type
|
|
12333
|
+
*/
|
|
12334
|
+
export const KEY_EMAIL_FORWARD_METRICS_FILTERS_END_TIME: keyof EmailForwardMetricsFilters = 'end_time';
|
|
12335
|
+
/**
|
|
12336
|
+
* Start Time
|
|
12337
|
+
*
|
|
12338
|
+
* Start time filter (RFC3339)
|
|
12339
|
+
*
|
|
12340
|
+
*
|
|
12341
|
+
*
|
|
12342
|
+
* @remarks
|
|
12343
|
+
* This key constant provides type-safe access to the `start_time` property of EmailForwardMetricsFilters objects.
|
|
12344
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12345
|
+
*
|
|
12346
|
+
* @example
|
|
12347
|
+
* ```typescript
|
|
12348
|
+
* // Direct property access
|
|
12349
|
+
* const value = emailforwardmetricsfilters[KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME];
|
|
12350
|
+
*
|
|
12351
|
+
* // Dynamic property access
|
|
12352
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME;
|
|
12353
|
+
* const value = emailforwardmetricsfilters[propertyName];
|
|
12354
|
+
* ```
|
|
12355
|
+
*
|
|
12356
|
+
* @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
|
|
12357
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS_FILTERS} - Array of all keys for this type
|
|
12358
|
+
*/
|
|
12359
|
+
export const KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME: keyof EmailForwardMetricsFilters = 'start_time';
|
|
12360
|
+
|
|
12361
|
+
/**
|
|
12362
|
+
* Array of all EmailForwardMetricsFilters property keys
|
|
12363
|
+
*
|
|
12364
|
+
* @remarks
|
|
12365
|
+
* This constant provides a readonly array containing all valid property keys for EmailForwardMetricsFilters objects.
|
|
12366
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
12367
|
+
*
|
|
12368
|
+
* @example
|
|
12369
|
+
* ```typescript
|
|
12370
|
+
* // Iterating through all keys
|
|
12371
|
+
* for (const key of KEYS_EMAIL_FORWARD_METRICS_FILTERS) {
|
|
12372
|
+
* console.log(`Property: ${key}, Value: ${emailforwardmetricsfilters[key]}`);
|
|
12373
|
+
* }
|
|
12374
|
+
*
|
|
12375
|
+
* // Validation
|
|
12376
|
+
* const isValidKey = KEYS_EMAIL_FORWARD_METRICS_FILTERS.includes(someKey);
|
|
12377
|
+
* ```
|
|
12378
|
+
*
|
|
12379
|
+
* @see {@link EmailForwardMetricsFilters} - The TypeScript type definition
|
|
12380
|
+
*/
|
|
12381
|
+
export const KEYS_EMAIL_FORWARD_METRICS_FILTERS = [
|
|
12382
|
+
KEY_EMAIL_FORWARD_METRICS_FILTERS_DOMAIN,
|
|
12383
|
+
KEY_EMAIL_FORWARD_METRICS_FILTERS_END_TIME,
|
|
12384
|
+
KEY_EMAIL_FORWARD_METRICS_FILTERS_START_TIME,
|
|
12385
|
+
] as const satisfies (keyof EmailForwardMetricsFilters)[];
|
|
12386
|
+
|
|
12387
|
+
/**
|
|
12388
|
+
* Delivered
|
|
12389
|
+
*
|
|
12390
|
+
* Delivery rate percentage
|
|
12391
|
+
*
|
|
12392
|
+
* @type {number}
|
|
12393
|
+
*
|
|
12394
|
+
*
|
|
12395
|
+
* @remarks
|
|
12396
|
+
* This key constant provides type-safe access to the `delivered` property of EmailForwardMetricsRates objects.
|
|
12397
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12398
|
+
*
|
|
12399
|
+
* @example
|
|
12400
|
+
* ```typescript
|
|
12401
|
+
* // Direct property access
|
|
12402
|
+
* const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERED];
|
|
12403
|
+
*
|
|
12404
|
+
* // Dynamic property access
|
|
12405
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERED;
|
|
12406
|
+
* const value = emailforwardmetricsrates[propertyName];
|
|
12407
|
+
* ```
|
|
12408
|
+
*
|
|
12409
|
+
* @see {@link EmailForwardMetricsRates} - The TypeScript type definition
|
|
12410
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS_RATES} - Array of all keys for this type
|
|
12411
|
+
*/
|
|
12412
|
+
export const KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERED: keyof EmailForwardMetricsRates = 'delivered';
|
|
12413
|
+
/**
|
|
12414
|
+
* Hard Bounce
|
|
12415
|
+
*
|
|
12416
|
+
* Hard bounce rate percentage
|
|
12417
|
+
*
|
|
12418
|
+
* @type {number}
|
|
12419
|
+
*
|
|
12420
|
+
*
|
|
12421
|
+
* @remarks
|
|
12422
|
+
* This key constant provides type-safe access to the `hard_bounce` property of EmailForwardMetricsRates objects.
|
|
12423
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12424
|
+
*
|
|
12425
|
+
* @example
|
|
12426
|
+
* ```typescript
|
|
12427
|
+
* // Direct property access
|
|
12428
|
+
* const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_HARD_BOUNCE];
|
|
12429
|
+
*
|
|
12430
|
+
* // Dynamic property access
|
|
12431
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_HARD_BOUNCE;
|
|
12432
|
+
* const value = emailforwardmetricsrates[propertyName];
|
|
12433
|
+
* ```
|
|
12434
|
+
*
|
|
12435
|
+
* @see {@link EmailForwardMetricsRates} - The TypeScript type definition
|
|
12436
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS_RATES} - Array of all keys for this type
|
|
12437
|
+
*/
|
|
12438
|
+
export const KEY_EMAIL_FORWARD_METRICS_RATES_HARD_BOUNCE: keyof EmailForwardMetricsRates = 'hard_bounce';
|
|
12439
|
+
/**
|
|
12440
|
+
* Refused
|
|
12441
|
+
*
|
|
12442
|
+
* Refused rate percentage
|
|
12443
|
+
*
|
|
12444
|
+
* @type {number}
|
|
12445
|
+
*
|
|
12446
|
+
*
|
|
12447
|
+
* @remarks
|
|
12448
|
+
* This key constant provides type-safe access to the `refused` property of EmailForwardMetricsRates objects.
|
|
12449
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12450
|
+
*
|
|
12451
|
+
* @example
|
|
12452
|
+
* ```typescript
|
|
12453
|
+
* // Direct property access
|
|
12454
|
+
* const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED];
|
|
12455
|
+
*
|
|
12456
|
+
* // Dynamic property access
|
|
12457
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED;
|
|
12458
|
+
* const value = emailforwardmetricsrates[propertyName];
|
|
12459
|
+
* ```
|
|
12460
|
+
*
|
|
12461
|
+
* @see {@link EmailForwardMetricsRates} - The TypeScript type definition
|
|
12462
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS_RATES} - Array of all keys for this type
|
|
12463
|
+
*/
|
|
12464
|
+
export const KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED: keyof EmailForwardMetricsRates = 'refused';
|
|
12465
|
+
/**
|
|
12466
|
+
* Soft Bounce
|
|
12467
|
+
*
|
|
12468
|
+
* Soft bounce rate percentage
|
|
12469
|
+
*
|
|
12470
|
+
* @type {number}
|
|
12471
|
+
*
|
|
12472
|
+
*
|
|
12473
|
+
* @remarks
|
|
12474
|
+
* This key constant provides type-safe access to the `soft_bounce` property of EmailForwardMetricsRates objects.
|
|
12475
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
12476
|
+
*
|
|
12477
|
+
* @example
|
|
12478
|
+
* ```typescript
|
|
12479
|
+
* // Direct property access
|
|
12480
|
+
* const value = emailforwardmetricsrates[KEY_EMAIL_FORWARD_METRICS_RATES_SOFT_BOUNCE];
|
|
12481
|
+
*
|
|
12482
|
+
* // Dynamic property access
|
|
12483
|
+
* const propertyName = KEY_EMAIL_FORWARD_METRICS_RATES_SOFT_BOUNCE;
|
|
12484
|
+
* const value = emailforwardmetricsrates[propertyName];
|
|
12485
|
+
* ```
|
|
12486
|
+
*
|
|
12487
|
+
* @see {@link EmailForwardMetricsRates} - The TypeScript type definition
|
|
12488
|
+
* @see {@link KEYS_EMAIL_FORWARD_METRICS_RATES} - Array of all keys for this type
|
|
12489
|
+
*/
|
|
12490
|
+
export const KEY_EMAIL_FORWARD_METRICS_RATES_SOFT_BOUNCE: keyof EmailForwardMetricsRates = 'soft_bounce';
|
|
12491
|
+
|
|
12492
|
+
/**
|
|
12493
|
+
* Array of all EmailForwardMetricsRates property keys
|
|
12494
|
+
*
|
|
12495
|
+
* @remarks
|
|
12496
|
+
* This constant provides a readonly array containing all valid property keys for EmailForwardMetricsRates objects.
|
|
12497
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
12498
|
+
*
|
|
12499
|
+
* @example
|
|
12500
|
+
* ```typescript
|
|
12501
|
+
* // Iterating through all keys
|
|
12502
|
+
* for (const key of KEYS_EMAIL_FORWARD_METRICS_RATES) {
|
|
12503
|
+
* console.log(`Property: ${key}, Value: ${emailforwardmetricsrates[key]}`);
|
|
12504
|
+
* }
|
|
12505
|
+
*
|
|
12506
|
+
* // Validation
|
|
12507
|
+
* const isValidKey = KEYS_EMAIL_FORWARD_METRICS_RATES.includes(someKey);
|
|
12508
|
+
* ```
|
|
12509
|
+
*
|
|
12510
|
+
* @see {@link EmailForwardMetricsRates} - The TypeScript type definition
|
|
12511
|
+
*/
|
|
12512
|
+
export const KEYS_EMAIL_FORWARD_METRICS_RATES = [
|
|
12513
|
+
KEY_EMAIL_FORWARD_METRICS_RATES_DELIVERED,
|
|
12514
|
+
KEY_EMAIL_FORWARD_METRICS_RATES_HARD_BOUNCE,
|
|
12515
|
+
KEY_EMAIL_FORWARD_METRICS_RATES_REFUSED,
|
|
12516
|
+
KEY_EMAIL_FORWARD_METRICS_RATES_SOFT_BOUNCE,
|
|
12517
|
+
] as const satisfies (keyof EmailForwardMetricsRates)[];
|
|
12518
|
+
|
|
12179
12519
|
/**
|
|
12180
12520
|
* Aliases
|
|
12181
12521
|
*
|