@opusdns/api 0.157.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.157.0",
6
+ "version": "0.158.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -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, EmailForwardLogFinalStatus, EmailForwardLogSortField, 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';
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
- * EmailForwardLogFinalStatus. Auto-generated enum for EmailForwardLogFinalStatus
1343
+ * EmailForwardLogSortField. Auto-generated enum for EmailForwardLogSortField
1344
1344
  *
1345
1345
  * @remarks
1346
- * This constant provides both object and array forms for the EmailForwardLogFinalStatus enum.
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 = EMAIL_FORWARD_LOG_FINAL_STATUS.SUCCESS;
1352
+ * const status = EMAIL_FORWARD_LOG_SORT_FIELD.SUCCESS;
1353
1353
  *
1354
1354
  * // Using the array form for iteration
1355
- * const allStatuses = EMAIL_FORWARD_LOG_FINAL_STATUS_VALUES;
1355
+ * const allStatuses = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES;
1356
1356
  * console.log(`Available statuses: ${allStatuses.join(', ')}`);
1357
1357
  * ```
1358
1358
  *
1359
- * @see {@link EmailForwardLogFinalStatus} - The TypeScript type definition
1359
+ * @see {@link EmailForwardLogSortField} - The TypeScript type definition
1360
1360
  */
1361
- export const EMAIL_FORWARD_LOG_FINAL_STATUS = {
1362
- QUEUED: "QUEUED",
1363
- DELIVERED: "DELIVERED",
1364
- REFUSED: "REFUSED",
1365
- SOFT_BOUNCE: "SOFT-BOUNCE",
1366
- HARD_BOUNCE: "HARD-BOUNCE",
1367
- } as const satisfies Record<string, EmailForwardLogFinalStatus>;
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 EmailForwardLogFinalStatus enum values
1372
+ * Array of all EmailForwardLogSortField enum values
1371
1373
  *
1372
1374
  * @remarks
1373
- * This constant provides a array containing all valid EmailForwardLogFinalStatus enum values.
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 EMAIL_FORWARD_LOG_FINAL_STATUS_VALUES) {
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 = EMAIL_FORWARD_LOG_FINAL_STATUS_VALUES.includes(someValue);
1386
+ * const isValid = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES.includes(someValue);
1385
1387
  * ```
1386
1388
  *
1387
- * @see {@link EmailForwardLogFinalStatus} - The TypeScript type definition
1388
- * @see {@link EMAIL_FORWARD_LOG_FINAL_STATUS} - The object form of this enum
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 EMAIL_FORWARD_LOG_FINAL_STATUS_VALUES = [
1391
- 'QUEUED',
1392
- 'DELIVERED',
1393
- 'REFUSED',
1394
- 'SOFT-BOUNCE',
1395
- 'HARD-BOUNCE'
1396
- ] as const satisfies [string, ...string[]] | EmailForwardLogFinalStatus[];
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
- * EmailForwardLogSortField. Auto-generated enum for EmailForwardLogSortField
1403
+ * EmailForwardLogStatus. Auto-generated enum for EmailForwardLogStatus
1400
1404
  *
1401
1405
  * @remarks
1402
- * This constant provides both object and array forms for the EmailForwardLogSortField enum.
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 = EMAIL_FORWARD_LOG_SORT_FIELD.SUCCESS;
1412
+ * const status = EMAIL_FORWARD_LOG_STATUS.SUCCESS;
1409
1413
  *
1410
1414
  * // Using the array form for iteration
1411
- * const allStatuses = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES;
1415
+ * const allStatuses = EMAIL_FORWARD_LOG_STATUS_VALUES;
1412
1416
  * console.log(`Available statuses: ${allStatuses.join(', ')}`);
1413
1417
  * ```
1414
1418
  *
1415
- * @see {@link EmailForwardLogSortField} - The TypeScript type definition
1419
+ * @see {@link EmailForwardLogStatus} - The TypeScript type definition
1416
1420
  */
1417
- export const EMAIL_FORWARD_LOG_SORT_FIELD = {
1418
- LOG_ID: "log_id",
1419
- SENDER_EMAIL: "sender_email",
1420
- RECIPIENT_EMAIL: "recipient_email",
1421
- FORWARD_EMAIL: "forward_email",
1422
- FINAL_STATUS: "final_status",
1423
- CREATED_ON: "created_on",
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 EmailForwardLogSortField enum values
1430
+ * Array of all EmailForwardLogStatus enum values
1429
1431
  *
1430
1432
  * @remarks
1431
- * This constant provides a array containing all valid EmailForwardLogSortField enum values.
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 EMAIL_FORWARD_LOG_SORT_FIELD_VALUES) {
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 = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES.includes(someValue);
1444
+ * const isValid = EMAIL_FORWARD_LOG_STATUS_VALUES.includes(someValue);
1443
1445
  * ```
1444
1446
  *
1445
- * @see {@link EmailForwardLogSortField} - The TypeScript type definition
1446
- * @see {@link EMAIL_FORWARD_LOG_SORT_FIELD} - The object form of this enum
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 EMAIL_FORWARD_LOG_SORT_FIELD_VALUES = [
1449
- 'log_id',
1450
- 'sender_email',
1451
- 'recipient_email',
1452
- 'forward_email',
1453
- 'final_status',
1454
- 'created_on',
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
@@ -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';
@@ -11562,11 +11565,10 @@ export const KEY_EMAIL_FORWARD_LOG_DOMAIN: keyof EmailForwardLog = 'domain';
11562
11565
  */
11563
11566
  export const KEY_EMAIL_FORWARD_LOG_EVENTS: keyof EmailForwardLog = 'events';
11564
11567
  /**
11565
- * Final Status
11568
+ * final_status property
11566
11569
  *
11567
11570
  * Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
11568
11571
  *
11569
- * @type {string}
11570
11572
  *
11571
11573
  *
11572
11574
  * @remarks
@@ -12149,6 +12151,371 @@ export const KEYS_EMAIL_FORWARD_LOG_EVENT = [
12149
12151
  KEY_EMAIL_FORWARD_LOG_EVENT_STATUS,
12150
12152
  ] as const satisfies (keyof EmailForwardLogEvent)[];
12151
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
+
12152
12519
  /**
12153
12520
  * Aliases
12154
12521
  *
@@ -3589,6 +3589,59 @@ export type PATCH_EmailForwardsEmailForwardIdEnable_Request = {
3589
3589
  */
3590
3590
  export type PATCH_EmailForwardsEmailForwardIdEnable_Request_Path = PATCH_EmailForwardsEmailForwardIdEnable_Request['parameters']['path'];
3591
3591
 
3592
+ /**
3593
+ * Request type for GET EmailForwardsEmailForwardIdMetrics endpoint
3594
+ *
3595
+ * Retrieve email forward metrics
3596
+ * Retrieves metrics and statistics for a specific email forward, including delivery rates and status counts.
3597
+ *
3598
+ * @remarks
3599
+ * This type defines the complete request structure for the GET EmailForwardsEmailForwardIdMetrics endpoint.
3600
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3601
+ * Use this type to ensure type safety when making API requests to this endpoint.
3602
+ *
3603
+ * @example
3604
+ * Use this type to ensure type safety when making API requests to this endpoint.
3605
+ *
3606
+ * @path /v1/email-forwards/{email_forward_id}/metrics
3607
+ *
3608
+ * @see {@link GET_EmailForwardsEmailForwardIdMetrics_Request_Query} - Query parameters type
3609
+ * @see {@link GET_EmailForwardsEmailForwardIdMetrics_Request_Path} - Path parameters type
3610
+ * @see {@link GET_EmailForwardsEmailForwardIdMetrics_Request_Body} - Request body type
3611
+ */
3612
+ export type GET_EmailForwardsEmailForwardIdMetrics_Request = {
3613
+ parameters: {
3614
+ query: operations['get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get']['parameters']['query'];
3615
+ path: operations['get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get']['parameters']['path'];
3616
+ };
3617
+ }
3618
+ /**
3619
+ * Query parameters for GET /v1/email-forwards/{email_forward_id}/metrics
3620
+ *
3621
+ * @remarks
3622
+ * This type defines the query parameters for the GET /v1/email-forwards/{email_forward_id}/metrics endpoint.
3623
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
3624
+ *
3625
+ * @example
3626
+ * Use this type to ensure type safety for query parameters.
3627
+ *
3628
+ * @path /v1/email-forwards/{email_forward_id}/metrics
3629
+ */
3630
+ export type GET_EmailForwardsEmailForwardIdMetrics_Request_Query = GET_EmailForwardsEmailForwardIdMetrics_Request['parameters']['query'];
3631
+ /**
3632
+ * Path parameters for GET /v1/email-forwards/{email_forward_id}/metrics
3633
+ *
3634
+ * @remarks
3635
+ * This type defines the path parameters for the GET /v1/email-forwards/{email_forward_id}/metrics endpoint.
3636
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3637
+ *
3638
+ * @example
3639
+ * Use this type to ensure type safety for path parameters.
3640
+ *
3641
+ * @path /v1/email-forwards/{email_forward_id}/metrics
3642
+ */
3643
+ export type GET_EmailForwardsEmailForwardIdMetrics_Request_Path = GET_EmailForwardsEmailForwardIdMetrics_Request['parameters']['path'];
3644
+
3592
3645
  /**
3593
3646
  * Request type for GET Events endpoint
3594
3647
  *
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -6728,6 +6728,116 @@ export type PATCH_EmailForwardsByEmailForwardIdEnable_Response_404 = Problem
6728
6728
  */
6729
6729
  export type PATCH_EmailForwardsByEmailForwardIdEnable_Response_422 = HTTPValidationError
6730
6730
 
6731
+ /**
6732
+ * Response types for GET EmailForwardsByEmailForwardIdMetrics endpoint
6733
+ *
6734
+ * Retrieve email forward metrics
6735
+ * Retrieves metrics and statistics for a specific email forward, including delivery rates and status counts.
6736
+ *
6737
+ * @remarks
6738
+ * This type defines all possible response structures for the GET EmailForwardsByEmailForwardIdMetrics endpoint.
6739
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
6740
+ * Use this type to ensure type safety when handling API responses from this endpoint.
6741
+ *
6742
+
6743
+ *
6744
+ * @path /v1/email-forwards/{email_forward_id}/metrics
6745
+ *
6746
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_200} - 200 response type
6747
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_401} - 401 response type
6748
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_403} - 403 response type
6749
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_404} - 404 response type
6750
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response_422} - 422 response type
6751
+ *
6752
+
6753
+ */
6754
+ export type GET_EmailForwardsByEmailForwardIdMetrics_Response = GET_EmailForwardsByEmailForwardIdMetrics_Response_200 | GET_EmailForwardsByEmailForwardIdMetrics_Response_401 | GET_EmailForwardsByEmailForwardIdMetrics_Response_403 | GET_EmailForwardsByEmailForwardIdMetrics_Response_404 | GET_EmailForwardsByEmailForwardIdMetrics_Response_422;
6755
+
6756
+ /**
6757
+ * 200 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
6758
+ *
6759
+ * @remarks
6760
+ * This type defines the response structure for the 200 status code
6761
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
6762
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6763
+ *
6764
+
6765
+ *
6766
+ * @path /v1/email-forwards/{email_forward_id}/metrics
6767
+ *
6768
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
6769
+ * @see {@link EmailForwardMetrics} - The actual schema type definition
6770
+ */
6771
+ export type GET_EmailForwardsByEmailForwardIdMetrics_Response_200 = EmailForwardMetrics
6772
+
6773
+ /**
6774
+ * 401 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
6775
+ *
6776
+ * @remarks
6777
+ * This type defines the response structure for the 401 status code
6778
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
6779
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6780
+ *
6781
+
6782
+ *
6783
+ * @path /v1/email-forwards/{email_forward_id}/metrics
6784
+ *
6785
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
6786
+ * @see {@link Problem} - The actual schema type definition
6787
+ */
6788
+ export type GET_EmailForwardsByEmailForwardIdMetrics_Response_401 = Problem
6789
+
6790
+ /**
6791
+ * 403 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
6792
+ *
6793
+ * @remarks
6794
+ * This type defines the response structure for the 403 status code
6795
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
6796
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6797
+ *
6798
+
6799
+ *
6800
+ * @path /v1/email-forwards/{email_forward_id}/metrics
6801
+ *
6802
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
6803
+ * @see {@link Problem} - The actual schema type definition
6804
+ */
6805
+ export type GET_EmailForwardsByEmailForwardIdMetrics_Response_403 = Problem
6806
+
6807
+ /**
6808
+ * 404 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
6809
+ *
6810
+ * @remarks
6811
+ * This type defines the response structure for the 404 status code
6812
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
6813
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6814
+ *
6815
+
6816
+ *
6817
+ * @path /v1/email-forwards/{email_forward_id}/metrics
6818
+ *
6819
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
6820
+ * @see {@link Problem} - The actual schema type definition
6821
+ */
6822
+ export type GET_EmailForwardsByEmailForwardIdMetrics_Response_404 = Problem
6823
+
6824
+ /**
6825
+ * 422 response for GET EmailForwardsByEmailForwardIdMetrics endpoint
6826
+ *
6827
+ * @remarks
6828
+ * This type defines the response structure for the 422 status code
6829
+ * of the GET EmailForwardsByEmailForwardIdMetrics endpoint.
6830
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6831
+ *
6832
+
6833
+ *
6834
+ * @path /v1/email-forwards/{email_forward_id}/metrics
6835
+ *
6836
+ * @see {@link GET_EmailForwardsByEmailForwardIdMetrics_Response} - The main response type definition
6837
+ * @see {@link HTTPValidationError} - The actual schema type definition
6838
+ */
6839
+ export type GET_EmailForwardsByEmailForwardIdMetrics_Response_422 = HTTPValidationError
6840
+
6731
6841
  /**
6732
6842
  * Response types for GET Events endpoint
6733
6843
  *
@@ -1883,37 +1883,85 @@ export type EmailForwardLog = components['schemas']['EmailForwardLog'];
1883
1883
  */
1884
1884
  export type EmailForwardLogEvent = components['schemas']['EmailForwardLogEvent'];
1885
1885
  /**
1886
- * EmailForwardLogFinalStatus
1886
+ * EmailForwardLogSortField
1887
1887
  *
1888
1888
  * @remarks
1889
- * Type alias for the `EmailForwardLogFinalStatus` OpenAPI schema.
1890
- * This type represents emailforwardlogfinalstatus data structures used in API requests and responses.
1889
+ * Type alias for the `EmailForwardLogSortField` OpenAPI schema.
1890
+ * This type represents emailforwardlogsortfield data structures used in API requests and responses.
1891
1891
  *
1892
1892
  * @example
1893
1893
  * ```typescript
1894
- * const response = await api.getEmailForwardLogFinalStatus();
1895
- * const item: EmailForwardLogFinalStatus = response.results;
1894
+ * const response = await api.getEmailForwardLogSortField();
1895
+ * const item: EmailForwardLogSortField = response.results;
1896
1896
  * ```
1897
1897
  *
1898
1898
  * @see {@link components} - The OpenAPI components schema definition
1899
1899
  */
1900
- export type EmailForwardLogFinalStatus = components['schemas']['EmailForwardLogFinalStatus'];
1900
+ export type EmailForwardLogSortField = components['schemas']['EmailForwardLogSortField'];
1901
1901
  /**
1902
- * EmailForwardLogSortField
1902
+ * EmailForwardLogStatus
1903
1903
  *
1904
1904
  * @remarks
1905
- * Type alias for the `EmailForwardLogSortField` OpenAPI schema.
1906
- * This type represents emailforwardlogsortfield data structures used in API requests and responses.
1905
+ * Type alias for the `EmailForwardLogStatus` OpenAPI schema.
1906
+ * This type represents emailforwardlogstatus data structures used in API requests and responses.
1907
1907
  *
1908
1908
  * @example
1909
1909
  * ```typescript
1910
- * const response = await api.getEmailForwardLogSortField();
1911
- * const item: EmailForwardLogSortField = response.results;
1910
+ * const response = await api.getEmailForwardLogStatus();
1911
+ * const item: EmailForwardLogStatus = response.results;
1912
1912
  * ```
1913
1913
  *
1914
1914
  * @see {@link components} - The OpenAPI components schema definition
1915
1915
  */
1916
- export type EmailForwardLogSortField = components['schemas']['EmailForwardLogSortField'];
1916
+ export type EmailForwardLogStatus = components['schemas']['EmailForwardLogStatus'];
1917
+ /**
1918
+ * EmailForwardMetrics
1919
+ *
1920
+ * @remarks
1921
+ * Type alias for the `EmailForwardMetrics` OpenAPI schema.
1922
+ * This type represents emailforwardmetrics data structures used in API requests and responses.
1923
+ *
1924
+ * @example
1925
+ * ```typescript
1926
+ * const response = await api.getEmailForwardMetrics();
1927
+ * const item: EmailForwardMetrics = response.results;
1928
+ * ```
1929
+ *
1930
+ * @see {@link components} - The OpenAPI components schema definition
1931
+ */
1932
+ export type EmailForwardMetrics = components['schemas']['EmailForwardMetrics'];
1933
+ /**
1934
+ * EmailForwardMetricsFilters
1935
+ *
1936
+ * @remarks
1937
+ * Type alias for the `EmailForwardMetricsFilters` OpenAPI schema.
1938
+ * This type represents emailforwardmetricsfilters data structures used in API requests and responses.
1939
+ *
1940
+ * @example
1941
+ * ```typescript
1942
+ * const response = await api.getEmailForwardMetricsFilters();
1943
+ * const item: EmailForwardMetricsFilters = response.results;
1944
+ * ```
1945
+ *
1946
+ * @see {@link components} - The OpenAPI components schema definition
1947
+ */
1948
+ export type EmailForwardMetricsFilters = components['schemas']['EmailForwardMetricsFilters'];
1949
+ /**
1950
+ * EmailForwardMetricsRates
1951
+ *
1952
+ * @remarks
1953
+ * Type alias for the `EmailForwardMetricsRates` OpenAPI schema.
1954
+ * This type represents emailforwardmetricsrates data structures used in API requests and responses.
1955
+ *
1956
+ * @example
1957
+ * ```typescript
1958
+ * const response = await api.getEmailForwardMetricsRates();
1959
+ * const item: EmailForwardMetricsRates = response.results;
1960
+ * ```
1961
+ *
1962
+ * @see {@link components} - The OpenAPI components schema definition
1963
+ */
1964
+ export type EmailForwardMetricsRates = components['schemas']['EmailForwardMetricsRates'];
1917
1965
  /**
1918
1966
  * EmailForwardResponse
1919
1967
  *
package/src/openapi.yaml CHANGED
@@ -2755,10 +2755,9 @@ components:
2755
2755
  title: Events
2756
2756
  type: array
2757
2757
  final_status:
2758
+ $ref: '#/components/schemas/EmailForwardLogStatus'
2758
2759
  description: Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
2759
2760
  HARD-BOUNCE)
2760
- title: Final Status
2761
- type: string
2762
2761
  forward_email:
2763
2762
  description: Forward destination email address
2764
2763
  title: Forward Email
@@ -2870,15 +2869,6 @@ components:
2870
2869
  - status
2871
2870
  title: EmailForwardLogEvent
2872
2871
  type: object
2873
- EmailForwardLogFinalStatus:
2874
- enum:
2875
- - QUEUED
2876
- - DELIVERED
2877
- - REFUSED
2878
- - SOFT-BOUNCE
2879
- - HARD-BOUNCE
2880
- title: EmailForwardLogFinalStatus
2881
- type: string
2882
2872
  EmailForwardLogSortField:
2883
2873
  enum:
2884
2874
  - log_id
@@ -2890,6 +2880,90 @@ components:
2890
2880
  - synced_on
2891
2881
  title: EmailForwardLogSortField
2892
2882
  type: string
2883
+ EmailForwardLogStatus:
2884
+ enum:
2885
+ - QUEUED
2886
+ - DELIVERED
2887
+ - REFUSED
2888
+ - SOFT-BOUNCE
2889
+ - HARD-BOUNCE
2890
+ title: EmailForwardLogStatus
2891
+ type: string
2892
+ EmailForwardMetrics:
2893
+ properties:
2894
+ by_status:
2895
+ additionalProperties:
2896
+ type: integer
2897
+ description: Log counts grouped by status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
2898
+ HARD-BOUNCE)
2899
+ propertyNames:
2900
+ $ref: '#/components/schemas/EmailForwardLogStatus'
2901
+ title: By Status
2902
+ type: object
2903
+ filters:
2904
+ $ref: '#/components/schemas/EmailForwardMetricsFilters'
2905
+ description: Applied filters
2906
+ rates:
2907
+ $ref: '#/components/schemas/EmailForwardMetricsRates'
2908
+ description: Rate percentages for each status
2909
+ total_logs:
2910
+ description: Total number of email forward logs
2911
+ title: Total Logs
2912
+ type: integer
2913
+ required:
2914
+ - total_logs
2915
+ - by_status
2916
+ - rates
2917
+ - filters
2918
+ title: EmailForwardMetrics
2919
+ type: object
2920
+ EmailForwardMetricsFilters:
2921
+ properties:
2922
+ domain:
2923
+ description: Domain name
2924
+ title: Domain
2925
+ type: string
2926
+ end_time:
2927
+ anyOf:
2928
+ - type: string
2929
+ - type: 'null'
2930
+ description: End time filter (RFC3339)
2931
+ title: End Time
2932
+ start_time:
2933
+ anyOf:
2934
+ - type: string
2935
+ - type: 'null'
2936
+ description: Start time filter (RFC3339)
2937
+ title: Start Time
2938
+ required:
2939
+ - domain
2940
+ title: EmailForwardMetricsFilters
2941
+ type: object
2942
+ EmailForwardMetricsRates:
2943
+ properties:
2944
+ delivered:
2945
+ description: Delivery rate percentage
2946
+ title: Delivered
2947
+ type: number
2948
+ hard_bounce:
2949
+ description: Hard bounce rate percentage
2950
+ title: Hard Bounce
2951
+ type: number
2952
+ refused:
2953
+ description: Refused rate percentage
2954
+ title: Refused
2955
+ type: number
2956
+ soft_bounce:
2957
+ description: Soft bounce rate percentage
2958
+ title: Soft Bounce
2959
+ type: number
2960
+ required:
2961
+ - delivered
2962
+ - refused
2963
+ - soft_bounce
2964
+ - hard_bounce
2965
+ title: EmailForwardMetricsRates
2966
+ type: object
2893
2967
  EmailForwardResponse:
2894
2968
  properties:
2895
2969
  aliases:
@@ -6539,7 +6613,7 @@ info:
6539
6613
  '
6540
6614
  summary: OpusDNS - your gateway to a seamless domain management experience.
6541
6615
  title: OpusDNS API
6542
- version: 2026-01-14-103335
6616
+ version: 2026-01-15-094311
6543
6617
  x-logo:
6544
6618
  altText: OpusDNS API Reference
6545
6619
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6608,7 +6682,7 @@ paths:
6608
6682
  required: false
6609
6683
  schema:
6610
6684
  anyOf:
6611
- - $ref: '#/components/schemas/EmailForwardLogFinalStatus'
6685
+ - $ref: '#/components/schemas/EmailForwardLogStatus'
6612
6686
  - type: 'null'
6613
6687
  title: Final Status
6614
6688
  - in: query
@@ -6698,7 +6772,7 @@ paths:
6698
6772
  required: false
6699
6773
  schema:
6700
6774
  anyOf:
6701
- - $ref: '#/components/schemas/EmailForwardLogFinalStatus'
6775
+ - $ref: '#/components/schemas/EmailForwardLogStatus'
6702
6776
  - type: 'null'
6703
6777
  title: Final Status
6704
6778
  - in: query
@@ -12695,6 +12769,95 @@ paths:
12695
12769
  summary: Enable email forwarding
12696
12770
  tags:
12697
12771
  - email_forward
12772
+ /v1/email-forwards/{email_forward_id}/metrics:
12773
+ get:
12774
+ description: Retrieves metrics and statistics for a specific email forward,
12775
+ including delivery rates and status counts.
12776
+ operationId: get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get
12777
+ parameters:
12778
+ - in: path
12779
+ name: email_forward_id
12780
+ required: true
12781
+ schema:
12782
+ examples:
12783
+ - email_forward_01h45ytscbebyvny4gc8cr8ma2
12784
+ format: typeid
12785
+ pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
12786
+ title: Email Forward Id
12787
+ type: string
12788
+ x-typeid-prefix: email_forward
12789
+ - in: query
12790
+ name: start_time
12791
+ required: false
12792
+ schema:
12793
+ anyOf:
12794
+ - format: date-time
12795
+ type: string
12796
+ - type: 'null'
12797
+ title: Start Time
12798
+ - in: query
12799
+ name: end_time
12800
+ required: false
12801
+ schema:
12802
+ anyOf:
12803
+ - format: date-time
12804
+ type: string
12805
+ - type: 'null'
12806
+ title: End Time
12807
+ responses:
12808
+ '200':
12809
+ content:
12810
+ application/json:
12811
+ schema:
12812
+ $ref: '#/components/schemas/EmailForwardMetrics'
12813
+ description: Successful Response
12814
+ '401':
12815
+ content:
12816
+ application/problem+json:
12817
+ example:
12818
+ code: ERROR_AUTHENTICATION
12819
+ detail: Additional error context.
12820
+ status: 401
12821
+ title: Authentication Error
12822
+ type: authentication
12823
+ schema:
12824
+ $ref: '#/components/schemas/Problem'
12825
+ description: Unauthorized
12826
+ '403':
12827
+ content:
12828
+ application/problem+json:
12829
+ example:
12830
+ code: ERROR_PERMISSION_DENIED
12831
+ detail: Insufficient permissions to perform this action
12832
+ status: 403
12833
+ title: Permission Denied
12834
+ type: permission-denied
12835
+ schema:
12836
+ $ref: '#/components/schemas/Problem'
12837
+ description: Forbidden
12838
+ '404':
12839
+ content:
12840
+ application/problem+json:
12841
+ example:
12842
+ code: ERROR_EMAIL_FORWARD_NOT_FOUND
12843
+ detail: 'Email forward not found for hostname: Additional error context.'
12844
+ status: 404
12845
+ title: Email Forward Error
12846
+ type: email-forward-not-found
12847
+ schema:
12848
+ $ref: '#/components/schemas/Problem'
12849
+ description: Not Found
12850
+ '422':
12851
+ content:
12852
+ application/problem+json:
12853
+ schema:
12854
+ $ref: '#/components/schemas/HTTPValidationError'
12855
+ description: Validation Error
12856
+ security:
12857
+ - OAuth2PasswordBearer: []
12858
+ summary: Retrieve email forward metrics
12859
+ tags:
12860
+ - email_forward
12698
12861
  /v1/events:
12699
12862
  get:
12700
12863
  description: Retrieves a paginated list of events for the organization
package/src/schema.d.ts CHANGED
@@ -1198,6 +1198,26 @@ export interface paths {
1198
1198
  patch: operations["enable_email_forward_v1_email_forwards__email_forward_id__enable_patch"];
1199
1199
  trace?: never;
1200
1200
  };
1201
+ "/v1/email-forwards/{email_forward_id}/metrics": {
1202
+ parameters: {
1203
+ query?: never;
1204
+ header?: never;
1205
+ path?: never;
1206
+ cookie?: never;
1207
+ };
1208
+ /**
1209
+ * Retrieve email forward metrics
1210
+ * @description Retrieves metrics and statistics for a specific email forward, including delivery rates and status counts.
1211
+ */
1212
+ get: operations["get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get"];
1213
+ put?: never;
1214
+ post?: never;
1215
+ delete?: never;
1216
+ options?: never;
1217
+ head?: never;
1218
+ patch?: never;
1219
+ trace?: never;
1220
+ };
1201
1221
  "/v1/events": {
1202
1222
  parameters: {
1203
1223
  query?: never;
@@ -3551,11 +3571,8 @@ export interface components {
3551
3571
  * @description List of processing events
3552
3572
  */
3553
3573
  events?: components["schemas"]["EmailForwardLogEvent"][];
3554
- /**
3555
- * Final Status
3556
- * @description Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
3557
- */
3558
- final_status: string;
3574
+ /** @description Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE) */
3575
+ final_status: components["schemas"]["EmailForwardLogStatus"];
3559
3576
  /**
3560
3577
  * Forward Email
3561
3578
  * @description Forward destination email address
@@ -3658,15 +3675,75 @@ export interface components {
3658
3675
  status: string;
3659
3676
  };
3660
3677
  /**
3661
- * EmailForwardLogFinalStatus
3678
+ * EmailForwardLogSortField
3662
3679
  * @enum {string}
3663
3680
  */
3664
- EmailForwardLogFinalStatus: "QUEUED" | "DELIVERED" | "REFUSED" | "SOFT-BOUNCE" | "HARD-BOUNCE";
3681
+ EmailForwardLogSortField: "log_id" | "sender_email" | "recipient_email" | "forward_email" | "final_status" | "created_on" | "synced_on";
3665
3682
  /**
3666
- * EmailForwardLogSortField
3683
+ * EmailForwardLogStatus
3667
3684
  * @enum {string}
3668
3685
  */
3669
- EmailForwardLogSortField: "log_id" | "sender_email" | "recipient_email" | "forward_email" | "final_status" | "created_on" | "synced_on";
3686
+ EmailForwardLogStatus: "QUEUED" | "DELIVERED" | "REFUSED" | "SOFT-BOUNCE" | "HARD-BOUNCE";
3687
+ /** EmailForwardMetrics */
3688
+ EmailForwardMetrics: {
3689
+ /**
3690
+ * By Status
3691
+ * @description Log counts grouped by status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
3692
+ */
3693
+ by_status: {
3694
+ [key: string]: number;
3695
+ };
3696
+ /** @description Applied filters */
3697
+ filters: components["schemas"]["EmailForwardMetricsFilters"];
3698
+ /** @description Rate percentages for each status */
3699
+ rates: components["schemas"]["EmailForwardMetricsRates"];
3700
+ /**
3701
+ * Total Logs
3702
+ * @description Total number of email forward logs
3703
+ */
3704
+ total_logs: number;
3705
+ };
3706
+ /** EmailForwardMetricsFilters */
3707
+ EmailForwardMetricsFilters: {
3708
+ /**
3709
+ * Domain
3710
+ * @description Domain name
3711
+ */
3712
+ domain: string;
3713
+ /**
3714
+ * End Time
3715
+ * @description End time filter (RFC3339)
3716
+ */
3717
+ end_time?: string | null;
3718
+ /**
3719
+ * Start Time
3720
+ * @description Start time filter (RFC3339)
3721
+ */
3722
+ start_time?: string | null;
3723
+ };
3724
+ /** EmailForwardMetricsRates */
3725
+ EmailForwardMetricsRates: {
3726
+ /**
3727
+ * Delivered
3728
+ * @description Delivery rate percentage
3729
+ */
3730
+ delivered: number;
3731
+ /**
3732
+ * Hard Bounce
3733
+ * @description Hard bounce rate percentage
3734
+ */
3735
+ hard_bounce: number;
3736
+ /**
3737
+ * Refused
3738
+ * @description Refused rate percentage
3739
+ */
3740
+ refused: number;
3741
+ /**
3742
+ * Soft Bounce
3743
+ * @description Soft bounce rate percentage
3744
+ */
3745
+ soft_bounce: number;
3746
+ };
3670
3747
  /** EmailForwardResponse */
3671
3748
  EmailForwardResponse: {
3672
3749
  /** Aliases */
@@ -6024,7 +6101,7 @@ export interface operations {
6024
6101
  sort_order?: components["schemas"]["SortOrder"];
6025
6102
  page_size?: number;
6026
6103
  page?: number;
6027
- final_status?: components["schemas"]["EmailForwardLogFinalStatus"] | null;
6104
+ final_status?: components["schemas"]["EmailForwardLogStatus"] | null;
6028
6105
  start_time?: Date | null;
6029
6106
  end_time?: Date | null;
6030
6107
  };
@@ -6063,7 +6140,7 @@ export interface operations {
6063
6140
  sort_order?: components["schemas"]["SortOrder"];
6064
6141
  page_size?: number;
6065
6142
  page?: number;
6066
- final_status?: components["schemas"]["EmailForwardLogFinalStatus"] | null;
6143
+ final_status?: components["schemas"]["EmailForwardLogStatus"] | null;
6067
6144
  start_time?: Date | null;
6068
6145
  end_time?: Date | null;
6069
6146
  };
@@ -10922,6 +10999,88 @@ export interface operations {
10922
10999
  };
10923
11000
  };
10924
11001
  };
11002
+ get_email_forward_metrics_v1_email_forwards__email_forward_id__metrics_get: {
11003
+ parameters: {
11004
+ query?: {
11005
+ start_time?: Date | null;
11006
+ end_time?: Date | null;
11007
+ };
11008
+ header?: never;
11009
+ path: {
11010
+ email_forward_id: TypeId<"email_forward">;
11011
+ };
11012
+ cookie?: never;
11013
+ };
11014
+ requestBody?: never;
11015
+ responses: {
11016
+ /** @description Successful Response */
11017
+ 200: {
11018
+ headers: {
11019
+ [name: string]: unknown;
11020
+ };
11021
+ content: {
11022
+ "application/json": components["schemas"]["EmailForwardMetrics"];
11023
+ };
11024
+ };
11025
+ /** @description Unauthorized */
11026
+ 401: {
11027
+ headers: {
11028
+ [name: string]: unknown;
11029
+ };
11030
+ content: {
11031
+ /** @example {
11032
+ * "code": "ERROR_AUTHENTICATION",
11033
+ * "detail": "Additional error context.",
11034
+ * "status": 401,
11035
+ * "title": "Authentication Error",
11036
+ * "type": "authentication"
11037
+ * } */
11038
+ "application/problem+json": components["schemas"]["Problem"];
11039
+ };
11040
+ };
11041
+ /** @description Forbidden */
11042
+ 403: {
11043
+ headers: {
11044
+ [name: string]: unknown;
11045
+ };
11046
+ content: {
11047
+ /** @example {
11048
+ * "code": "ERROR_PERMISSION_DENIED",
11049
+ * "detail": "Insufficient permissions to perform this action",
11050
+ * "status": 403,
11051
+ * "title": "Permission Denied",
11052
+ * "type": "permission-denied"
11053
+ * } */
11054
+ "application/problem+json": components["schemas"]["Problem"];
11055
+ };
11056
+ };
11057
+ /** @description Not Found */
11058
+ 404: {
11059
+ headers: {
11060
+ [name: string]: unknown;
11061
+ };
11062
+ content: {
11063
+ /** @example {
11064
+ * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11065
+ * "detail": "Email forward not found for hostname: Additional error context.",
11066
+ * "status": 404,
11067
+ * "title": "Email Forward Error",
11068
+ * "type": "email-forward-not-found"
11069
+ * } */
11070
+ "application/problem+json": components["schemas"]["Problem"];
11071
+ };
11072
+ };
11073
+ /** @description Validation Error */
11074
+ 422: {
11075
+ headers: {
11076
+ [name: string]: unknown;
11077
+ };
11078
+ content: {
11079
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
11080
+ };
11081
+ };
11082
+ };
11083
+ };
10925
11084
  get_events_v1_events_get: {
10926
11085
  parameters: {
10927
11086
  query?: {