@opusdns/api 0.206.0 → 0.208.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/src/schema.d.ts CHANGED
@@ -548,7 +548,10 @@ export interface paths {
548
548
  path?: never;
549
549
  cookie?: never;
550
550
  };
551
- /** Metrics */
551
+ /**
552
+ * Get domain forward metrics
553
+ * @description Retrieves overall metrics for domain forwards including total and unique visit counts.
554
+ */
552
555
  get: operations["metrics_v1_domain_forwards_metrics_get"];
553
556
  put?: never;
554
557
  post?: never;
@@ -565,7 +568,10 @@ export interface paths {
565
568
  path?: never;
566
569
  cookie?: never;
567
570
  };
568
- /** Browser Stats */
571
+ /**
572
+ * Get browser statistics
573
+ * @description Retrieves visitor traffic broken down by browser type (Chrome, Safari, Firefox, etc.) with total and unique visit counts.
574
+ */
569
575
  get: operations["browser_stats_v1_domain_forwards_metrics_browser_get"];
570
576
  put?: never;
571
577
  post?: never;
@@ -582,7 +588,10 @@ export interface paths {
582
588
  path?: never;
583
589
  cookie?: never;
584
590
  };
585
- /** Geo Stats */
591
+ /**
592
+ * Get geographic statistics
593
+ * @description Retrieves visitor traffic broken down by geographic location (country code) with visit counts.
594
+ */
586
595
  get: operations["geo_stats_v1_domain_forwards_metrics_geo_get"];
587
596
  put?: never;
588
597
  post?: never;
@@ -599,7 +608,10 @@ export interface paths {
599
608
  path?: never;
600
609
  cookie?: never;
601
610
  };
602
- /** Platform Stats */
611
+ /**
612
+ * Get platform statistics
613
+ * @description Retrieves visitor traffic broken down by platform (Windows, Macintosh, iOS, Android, Linux) with total and unique visit counts.
614
+ */
603
615
  get: operations["platform_stats_v1_domain_forwards_metrics_platform_get"];
604
616
  put?: never;
605
617
  post?: never;
@@ -616,7 +628,10 @@ export interface paths {
616
628
  path?: never;
617
629
  cookie?: never;
618
630
  };
619
- /** Referrer Stats */
631
+ /**
632
+ * Get referrer statistics
633
+ * @description Retrieves visitor referral sources (where traffic came from) with total and unique visit counts.
634
+ */
620
635
  get: operations["referrer_stats_v1_domain_forwards_metrics_referrer_get"];
621
636
  put?: never;
622
637
  post?: never;
@@ -633,7 +648,10 @@ export interface paths {
633
648
  path?: never;
634
649
  cookie?: never;
635
650
  };
636
- /** Status Code Stats */
651
+ /**
652
+ * Get HTTP status code statistics
653
+ * @description Retrieves distribution of HTTP redirect status codes (301, 302, 307, 308) used across forwards.
654
+ */
637
655
  get: operations["status_code_stats_v1_domain_forwards_metrics_status_code_get"];
638
656
  put?: never;
639
657
  post?: never;
@@ -650,7 +668,10 @@ export interface paths {
650
668
  path?: never;
651
669
  cookie?: never;
652
670
  };
653
- /** Time Series */
671
+ /**
672
+ * Get domain forward time series metrics
673
+ * @description Retrieves visit counts bucketed by time intervals (hourly, daily) for the specified time range.
674
+ */
654
675
  get: operations["time_series_v1_domain_forwards_metrics_time_series_get"];
655
676
  put?: never;
656
677
  post?: never;
@@ -667,7 +688,10 @@ export interface paths {
667
688
  path?: never;
668
689
  cookie?: never;
669
690
  };
670
- /** User Agent Stats */
691
+ /**
692
+ * Get user agent statistics
693
+ * @description Retrieves visitor traffic broken down by user agent string with total and unique visit counts.
694
+ */
671
695
  get: operations["user_agent_stats_v1_domain_forwards_metrics_user_agent_get"];
672
696
  put?: never;
673
697
  post?: never;
@@ -684,7 +708,10 @@ export interface paths {
684
708
  path?: never;
685
709
  cookie?: never;
686
710
  };
687
- /** Visits By Key */
711
+ /**
712
+ * Get visits grouped by key
713
+ * @description Retrieves visit metrics grouped by a specified key (url, fqdn, domain, or forward) with total and unique visit counts.
714
+ */
688
715
  get: operations["visits_by_key_v1_domain_forwards_metrics_visits_by_key_get"];
689
716
  put?: never;
690
717
  post?: never;
@@ -1150,14 +1177,14 @@ export interface paths {
1150
1177
  };
1151
1178
  /**
1152
1179
  * Get email forward configuration
1153
- * @description Retrieves the email forward configuration for the specified zone including all aliases
1180
+ * @description Retrieves the email forward configuration for the specified email forward including all aliases
1154
1181
  */
1155
1182
  get: operations["get_email_forward_v1_email_forwards__email_forward_id__get"];
1156
1183
  put?: never;
1157
1184
  post?: never;
1158
1185
  /**
1159
1186
  * Delete email forward configuration
1160
- * @description Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from ImprovMX).
1187
+ * @description Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from the email forwarding provider).
1161
1188
  */
1162
1189
  delete: operations["delete_email_forward_v1_email_forwards__email_forward_id__delete"];
1163
1190
  options?: never;
@@ -1176,7 +1203,7 @@ export interface paths {
1176
1203
  put?: never;
1177
1204
  /**
1178
1205
  * Create email forward alias
1179
- * @description Creates a new email forward alias for the specified hostname.
1206
+ * @description Creates a new email forward alias for the specified email forward. Use '*' as the alias name to configure a catch-all alias that forwards all unmatched emails for the domain.
1180
1207
  */
1181
1208
  post: operations["create_email_forward_alias_v1_email_forwards__email_forward_id__aliases_post"];
1182
1209
  delete?: never;
@@ -1195,13 +1222,13 @@ export interface paths {
1195
1222
  get?: never;
1196
1223
  /**
1197
1224
  * Update email forward alias
1198
- * @description Updates the forward_to address for a specific email forward alias
1225
+ * @description Updates the forward_to address for a specific email forward alias specified by email_forward_alias_id
1199
1226
  */
1200
1227
  put: operations["update_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__put"];
1201
1228
  post?: never;
1202
1229
  /**
1203
1230
  * Delete email forward alias
1204
- * @description Deletes a specific email forward alias for the specified zone
1231
+ * @description Deletes a specific email forward alias specified by email_forward_alias_id for the specified email forward
1205
1232
  */
1206
1233
  delete: operations["delete_email_forward_alias_v1_email_forwards__email_forward_id__aliases__alias_id__delete"];
1207
1234
  options?: never;
@@ -1224,7 +1251,7 @@ export interface paths {
1224
1251
  head?: never;
1225
1252
  /**
1226
1253
  * Disable email forwarding
1227
- * @description Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forward provider. The email forward configuration is preserved but disabled.
1254
+ * @description Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forwarding provider. The email forward configuration is preserved but disabled.
1228
1255
  */
1229
1256
  patch: operations["disable_email_forward_v1_email_forwards__email_forward_id__disable_patch"];
1230
1257
  trace?: never;
@@ -1244,7 +1271,7 @@ export interface paths {
1244
1271
  head?: never;
1245
1272
  /**
1246
1273
  * Enable email forwarding
1247
- * @description Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forward provider.
1274
+ * @description Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forwarding provider.
1248
1275
  */
1249
1276
  patch: operations["enable_email_forward_v1_email_forwards__email_forward_id__enable_patch"];
1250
1277
  trace?: never;
@@ -8825,7 +8852,7 @@ export interface operations {
8825
8852
  };
8826
8853
  requestBody?: never;
8827
8854
  responses: {
8828
- /** @description Successful Response */
8855
+ /** @description List of domain forwards retrieved successfully */
8829
8856
  200: {
8830
8857
  headers: {
8831
8858
  [name: string]: unknown;
@@ -8948,7 +8975,7 @@ export interface operations {
8948
8975
  "application/problem+json": components["schemas"]["Problem"];
8949
8976
  };
8950
8977
  };
8951
- /** @description Domain forward already exists */
8978
+ /** @description Domain forward already exists for this hostname */
8952
8979
  409: {
8953
8980
  headers: {
8954
8981
  [name: string]: unknown;
@@ -8988,7 +9015,7 @@ export interface operations {
8988
9015
  };
8989
9016
  };
8990
9017
  responses: {
8991
- /** @description Successful Response */
9018
+ /** @description Domain forward redirects updated successfully. */
8992
9019
  204: {
8993
9020
  headers: {
8994
9021
  [name: string]: unknown;
@@ -9072,7 +9099,7 @@ export interface operations {
9072
9099
  };
9073
9100
  requestBody?: never;
9074
9101
  responses: {
9075
- /** @description Successful Response */
9102
+ /** @description Domain forward metrics retrieved successfully */
9076
9103
  200: {
9077
9104
  headers: {
9078
9105
  [name: string]: unknown;
@@ -9081,6 +9108,50 @@ export interface operations {
9081
9108
  "application/json": components["schemas"]["DomainForwardMetricsResponse"];
9082
9109
  };
9083
9110
  };
9111
+ /** @description Invalid query parameters */
9112
+ 400: {
9113
+ headers: {
9114
+ [name: string]: unknown;
9115
+ };
9116
+ content: {
9117
+ /** @example {
9118
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9119
+ * } */
9120
+ "application/json": unknown;
9121
+ };
9122
+ };
9123
+ /** @description Unauthorized */
9124
+ 401: {
9125
+ headers: {
9126
+ [name: string]: unknown;
9127
+ };
9128
+ content: {
9129
+ /** @example {
9130
+ * "code": "ERROR_AUTHENTICATION",
9131
+ * "detail": "Additional error context.",
9132
+ * "status": 401,
9133
+ * "title": "Authentication Error",
9134
+ * "type": "authentication"
9135
+ * } */
9136
+ "application/problem+json": components["schemas"]["Problem"];
9137
+ };
9138
+ };
9139
+ /** @description Forbidden */
9140
+ 403: {
9141
+ headers: {
9142
+ [name: string]: unknown;
9143
+ };
9144
+ content: {
9145
+ /** @example {
9146
+ * "code": "ERROR_PERMISSION_DENIED",
9147
+ * "detail": "Insufficient permissions to perform this action",
9148
+ * "status": 403,
9149
+ * "title": "Permission Denied",
9150
+ * "type": "permission-denied"
9151
+ * } */
9152
+ "application/problem+json": components["schemas"]["Problem"];
9153
+ };
9154
+ };
9084
9155
  /** @description Validation Error */
9085
9156
  422: {
9086
9157
  headers: {
@@ -9110,7 +9181,7 @@ export interface operations {
9110
9181
  };
9111
9182
  requestBody?: never;
9112
9183
  responses: {
9113
- /** @description Successful Response */
9184
+ /** @description Browser statistics retrieved successfully */
9114
9185
  200: {
9115
9186
  headers: {
9116
9187
  [name: string]: unknown;
@@ -9119,6 +9190,50 @@ export interface operations {
9119
9190
  "application/json": components["schemas"]["DomainForwardBrowserStatsResponse"];
9120
9191
  };
9121
9192
  };
9193
+ /** @description Invalid query parameters */
9194
+ 400: {
9195
+ headers: {
9196
+ [name: string]: unknown;
9197
+ };
9198
+ content: {
9199
+ /** @example {
9200
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9201
+ * } */
9202
+ "application/json": unknown;
9203
+ };
9204
+ };
9205
+ /** @description Unauthorized */
9206
+ 401: {
9207
+ headers: {
9208
+ [name: string]: unknown;
9209
+ };
9210
+ content: {
9211
+ /** @example {
9212
+ * "code": "ERROR_AUTHENTICATION",
9213
+ * "detail": "Additional error context.",
9214
+ * "status": 401,
9215
+ * "title": "Authentication Error",
9216
+ * "type": "authentication"
9217
+ * } */
9218
+ "application/problem+json": components["schemas"]["Problem"];
9219
+ };
9220
+ };
9221
+ /** @description Forbidden */
9222
+ 403: {
9223
+ headers: {
9224
+ [name: string]: unknown;
9225
+ };
9226
+ content: {
9227
+ /** @example {
9228
+ * "code": "ERROR_PERMISSION_DENIED",
9229
+ * "detail": "Insufficient permissions to perform this action",
9230
+ * "status": 403,
9231
+ * "title": "Permission Denied",
9232
+ * "type": "permission-denied"
9233
+ * } */
9234
+ "application/problem+json": components["schemas"]["Problem"];
9235
+ };
9236
+ };
9122
9237
  /** @description Validation Error */
9123
9238
  422: {
9124
9239
  headers: {
@@ -9148,7 +9263,7 @@ export interface operations {
9148
9263
  };
9149
9264
  requestBody?: never;
9150
9265
  responses: {
9151
- /** @description Successful Response */
9266
+ /** @description Geographic statistics retrieved successfully */
9152
9267
  200: {
9153
9268
  headers: {
9154
9269
  [name: string]: unknown;
@@ -9157,6 +9272,50 @@ export interface operations {
9157
9272
  "application/json": components["schemas"]["DomainForwardGeoStatsResponse"];
9158
9273
  };
9159
9274
  };
9275
+ /** @description Invalid query parameters */
9276
+ 400: {
9277
+ headers: {
9278
+ [name: string]: unknown;
9279
+ };
9280
+ content: {
9281
+ /** @example {
9282
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9283
+ * } */
9284
+ "application/json": unknown;
9285
+ };
9286
+ };
9287
+ /** @description Unauthorized */
9288
+ 401: {
9289
+ headers: {
9290
+ [name: string]: unknown;
9291
+ };
9292
+ content: {
9293
+ /** @example {
9294
+ * "code": "ERROR_AUTHENTICATION",
9295
+ * "detail": "Additional error context.",
9296
+ * "status": 401,
9297
+ * "title": "Authentication Error",
9298
+ * "type": "authentication"
9299
+ * } */
9300
+ "application/problem+json": components["schemas"]["Problem"];
9301
+ };
9302
+ };
9303
+ /** @description Forbidden */
9304
+ 403: {
9305
+ headers: {
9306
+ [name: string]: unknown;
9307
+ };
9308
+ content: {
9309
+ /** @example {
9310
+ * "code": "ERROR_PERMISSION_DENIED",
9311
+ * "detail": "Insufficient permissions to perform this action",
9312
+ * "status": 403,
9313
+ * "title": "Permission Denied",
9314
+ * "type": "permission-denied"
9315
+ * } */
9316
+ "application/problem+json": components["schemas"]["Problem"];
9317
+ };
9318
+ };
9160
9319
  /** @description Validation Error */
9161
9320
  422: {
9162
9321
  headers: {
@@ -9186,7 +9345,7 @@ export interface operations {
9186
9345
  };
9187
9346
  requestBody?: never;
9188
9347
  responses: {
9189
- /** @description Successful Response */
9348
+ /** @description Platform statistics retrieved successfully */
9190
9349
  200: {
9191
9350
  headers: {
9192
9351
  [name: string]: unknown;
@@ -9195,6 +9354,50 @@ export interface operations {
9195
9354
  "application/json": components["schemas"]["DomainForwardPlatformStatsResponse"];
9196
9355
  };
9197
9356
  };
9357
+ /** @description Invalid query parameters */
9358
+ 400: {
9359
+ headers: {
9360
+ [name: string]: unknown;
9361
+ };
9362
+ content: {
9363
+ /** @example {
9364
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9365
+ * } */
9366
+ "application/json": unknown;
9367
+ };
9368
+ };
9369
+ /** @description Unauthorized */
9370
+ 401: {
9371
+ headers: {
9372
+ [name: string]: unknown;
9373
+ };
9374
+ content: {
9375
+ /** @example {
9376
+ * "code": "ERROR_AUTHENTICATION",
9377
+ * "detail": "Additional error context.",
9378
+ * "status": 401,
9379
+ * "title": "Authentication Error",
9380
+ * "type": "authentication"
9381
+ * } */
9382
+ "application/problem+json": components["schemas"]["Problem"];
9383
+ };
9384
+ };
9385
+ /** @description Forbidden */
9386
+ 403: {
9387
+ headers: {
9388
+ [name: string]: unknown;
9389
+ };
9390
+ content: {
9391
+ /** @example {
9392
+ * "code": "ERROR_PERMISSION_DENIED",
9393
+ * "detail": "Insufficient permissions to perform this action",
9394
+ * "status": 403,
9395
+ * "title": "Permission Denied",
9396
+ * "type": "permission-denied"
9397
+ * } */
9398
+ "application/problem+json": components["schemas"]["Problem"];
9399
+ };
9400
+ };
9198
9401
  /** @description Validation Error */
9199
9402
  422: {
9200
9403
  headers: {
@@ -9224,7 +9427,7 @@ export interface operations {
9224
9427
  };
9225
9428
  requestBody?: never;
9226
9429
  responses: {
9227
- /** @description Successful Response */
9430
+ /** @description Referrer statistics retrieved successfully */
9228
9431
  200: {
9229
9432
  headers: {
9230
9433
  [name: string]: unknown;
@@ -9233,6 +9436,50 @@ export interface operations {
9233
9436
  "application/json": components["schemas"]["DomainForwardReferrerStatsResponse"];
9234
9437
  };
9235
9438
  };
9439
+ /** @description Invalid query parameters */
9440
+ 400: {
9441
+ headers: {
9442
+ [name: string]: unknown;
9443
+ };
9444
+ content: {
9445
+ /** @example {
9446
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9447
+ * } */
9448
+ "application/json": unknown;
9449
+ };
9450
+ };
9451
+ /** @description Unauthorized */
9452
+ 401: {
9453
+ headers: {
9454
+ [name: string]: unknown;
9455
+ };
9456
+ content: {
9457
+ /** @example {
9458
+ * "code": "ERROR_AUTHENTICATION",
9459
+ * "detail": "Additional error context.",
9460
+ * "status": 401,
9461
+ * "title": "Authentication Error",
9462
+ * "type": "authentication"
9463
+ * } */
9464
+ "application/problem+json": components["schemas"]["Problem"];
9465
+ };
9466
+ };
9467
+ /** @description Forbidden */
9468
+ 403: {
9469
+ headers: {
9470
+ [name: string]: unknown;
9471
+ };
9472
+ content: {
9473
+ /** @example {
9474
+ * "code": "ERROR_PERMISSION_DENIED",
9475
+ * "detail": "Insufficient permissions to perform this action",
9476
+ * "status": 403,
9477
+ * "title": "Permission Denied",
9478
+ * "type": "permission-denied"
9479
+ * } */
9480
+ "application/problem+json": components["schemas"]["Problem"];
9481
+ };
9482
+ };
9236
9483
  /** @description Validation Error */
9237
9484
  422: {
9238
9485
  headers: {
@@ -9262,7 +9509,7 @@ export interface operations {
9262
9509
  };
9263
9510
  requestBody?: never;
9264
9511
  responses: {
9265
- /** @description Successful Response */
9512
+ /** @description Status code statistics retrieved successfully */
9266
9513
  200: {
9267
9514
  headers: {
9268
9515
  [name: string]: unknown;
@@ -9271,6 +9518,50 @@ export interface operations {
9271
9518
  "application/json": components["schemas"]["DomainForwardStatusCodeStatsResponse"];
9272
9519
  };
9273
9520
  };
9521
+ /** @description Invalid query parameters */
9522
+ 400: {
9523
+ headers: {
9524
+ [name: string]: unknown;
9525
+ };
9526
+ content: {
9527
+ /** @example {
9528
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9529
+ * } */
9530
+ "application/json": unknown;
9531
+ };
9532
+ };
9533
+ /** @description Unauthorized */
9534
+ 401: {
9535
+ headers: {
9536
+ [name: string]: unknown;
9537
+ };
9538
+ content: {
9539
+ /** @example {
9540
+ * "code": "ERROR_AUTHENTICATION",
9541
+ * "detail": "Additional error context.",
9542
+ * "status": 401,
9543
+ * "title": "Authentication Error",
9544
+ * "type": "authentication"
9545
+ * } */
9546
+ "application/problem+json": components["schemas"]["Problem"];
9547
+ };
9548
+ };
9549
+ /** @description Forbidden */
9550
+ 403: {
9551
+ headers: {
9552
+ [name: string]: unknown;
9553
+ };
9554
+ content: {
9555
+ /** @example {
9556
+ * "code": "ERROR_PERMISSION_DENIED",
9557
+ * "detail": "Insufficient permissions to perform this action",
9558
+ * "status": 403,
9559
+ * "title": "Permission Denied",
9560
+ * "type": "permission-denied"
9561
+ * } */
9562
+ "application/problem+json": components["schemas"]["Problem"];
9563
+ };
9564
+ };
9274
9565
  /** @description Validation Error */
9275
9566
  422: {
9276
9567
  headers: {
@@ -9300,7 +9591,7 @@ export interface operations {
9300
9591
  };
9301
9592
  requestBody?: never;
9302
9593
  responses: {
9303
- /** @description Successful Response */
9594
+ /** @description Time series metrics retrieved successfully */
9304
9595
  200: {
9305
9596
  headers: {
9306
9597
  [name: string]: unknown;
@@ -9309,6 +9600,50 @@ export interface operations {
9309
9600
  "application/json": components["schemas"]["DomainForwardMetricsTimeSeriesResponse"];
9310
9601
  };
9311
9602
  };
9603
+ /** @description Invalid query parameters */
9604
+ 400: {
9605
+ headers: {
9606
+ [name: string]: unknown;
9607
+ };
9608
+ content: {
9609
+ /** @example {
9610
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9611
+ * } */
9612
+ "application/json": unknown;
9613
+ };
9614
+ };
9615
+ /** @description Unauthorized */
9616
+ 401: {
9617
+ headers: {
9618
+ [name: string]: unknown;
9619
+ };
9620
+ content: {
9621
+ /** @example {
9622
+ * "code": "ERROR_AUTHENTICATION",
9623
+ * "detail": "Additional error context.",
9624
+ * "status": 401,
9625
+ * "title": "Authentication Error",
9626
+ * "type": "authentication"
9627
+ * } */
9628
+ "application/problem+json": components["schemas"]["Problem"];
9629
+ };
9630
+ };
9631
+ /** @description Forbidden */
9632
+ 403: {
9633
+ headers: {
9634
+ [name: string]: unknown;
9635
+ };
9636
+ content: {
9637
+ /** @example {
9638
+ * "code": "ERROR_PERMISSION_DENIED",
9639
+ * "detail": "Insufficient permissions to perform this action",
9640
+ * "status": 403,
9641
+ * "title": "Permission Denied",
9642
+ * "type": "permission-denied"
9643
+ * } */
9644
+ "application/problem+json": components["schemas"]["Problem"];
9645
+ };
9646
+ };
9312
9647
  /** @description Validation Error */
9313
9648
  422: {
9314
9649
  headers: {
@@ -9338,7 +9673,7 @@ export interface operations {
9338
9673
  };
9339
9674
  requestBody?: never;
9340
9675
  responses: {
9341
- /** @description Successful Response */
9676
+ /** @description User agent statistics retrieved successfully */
9342
9677
  200: {
9343
9678
  headers: {
9344
9679
  [name: string]: unknown;
@@ -9347,6 +9682,50 @@ export interface operations {
9347
9682
  "application/json": components["schemas"]["DomainForwardUserAgentStatsResponse"];
9348
9683
  };
9349
9684
  };
9685
+ /** @description Invalid query parameters */
9686
+ 400: {
9687
+ headers: {
9688
+ [name: string]: unknown;
9689
+ };
9690
+ content: {
9691
+ /** @example {
9692
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9693
+ * } */
9694
+ "application/json": unknown;
9695
+ };
9696
+ };
9697
+ /** @description Unauthorized */
9698
+ 401: {
9699
+ headers: {
9700
+ [name: string]: unknown;
9701
+ };
9702
+ content: {
9703
+ /** @example {
9704
+ * "code": "ERROR_AUTHENTICATION",
9705
+ * "detail": "Additional error context.",
9706
+ * "status": 401,
9707
+ * "title": "Authentication Error",
9708
+ * "type": "authentication"
9709
+ * } */
9710
+ "application/problem+json": components["schemas"]["Problem"];
9711
+ };
9712
+ };
9713
+ /** @description Forbidden */
9714
+ 403: {
9715
+ headers: {
9716
+ [name: string]: unknown;
9717
+ };
9718
+ content: {
9719
+ /** @example {
9720
+ * "code": "ERROR_PERMISSION_DENIED",
9721
+ * "detail": "Insufficient permissions to perform this action",
9722
+ * "status": 403,
9723
+ * "title": "Permission Denied",
9724
+ * "type": "permission-denied"
9725
+ * } */
9726
+ "application/problem+json": components["schemas"]["Problem"];
9727
+ };
9728
+ };
9350
9729
  /** @description Validation Error */
9351
9730
  422: {
9352
9731
  headers: {
@@ -9378,7 +9757,7 @@ export interface operations {
9378
9757
  };
9379
9758
  requestBody?: never;
9380
9759
  responses: {
9381
- /** @description Successful Response */
9760
+ /** @description Visits by key statistics retrieved successfully */
9382
9761
  200: {
9383
9762
  headers: {
9384
9763
  [name: string]: unknown;
@@ -9387,6 +9766,50 @@ export interface operations {
9387
9766
  "application/json": components["schemas"]["DomainForwardVisitsByKeyResponse"];
9388
9767
  };
9389
9768
  };
9769
+ /** @description Invalid query parameters */
9770
+ 400: {
9771
+ headers: {
9772
+ [name: string]: unknown;
9773
+ };
9774
+ content: {
9775
+ /** @example {
9776
+ * "detail": "Cannot specify both 'hostname' and 'domain'. Use 'hostname' for exact match or 'domain' to filter by domain including all subdomains."
9777
+ * } */
9778
+ "application/json": unknown;
9779
+ };
9780
+ };
9781
+ /** @description Unauthorized */
9782
+ 401: {
9783
+ headers: {
9784
+ [name: string]: unknown;
9785
+ };
9786
+ content: {
9787
+ /** @example {
9788
+ * "code": "ERROR_AUTHENTICATION",
9789
+ * "detail": "Additional error context.",
9790
+ * "status": 401,
9791
+ * "title": "Authentication Error",
9792
+ * "type": "authentication"
9793
+ * } */
9794
+ "application/problem+json": components["schemas"]["Problem"];
9795
+ };
9796
+ };
9797
+ /** @description Forbidden */
9798
+ 403: {
9799
+ headers: {
9800
+ [name: string]: unknown;
9801
+ };
9802
+ content: {
9803
+ /** @example {
9804
+ * "code": "ERROR_PERMISSION_DENIED",
9805
+ * "detail": "Insufficient permissions to perform this action",
9806
+ * "status": 403,
9807
+ * "title": "Permission Denied",
9808
+ * "type": "permission-denied"
9809
+ * } */
9810
+ "application/problem+json": components["schemas"]["Problem"];
9811
+ };
9812
+ };
9390
9813
  /** @description Validation Error */
9391
9814
  422: {
9392
9815
  headers: {
@@ -9410,7 +9833,7 @@ export interface operations {
9410
9833
  };
9411
9834
  requestBody?: never;
9412
9835
  responses: {
9413
- /** @description Successful Response */
9836
+ /** @description Domain forward retrieved successfully */
9414
9837
  200: {
9415
9838
  headers: {
9416
9839
  [name: string]: unknown;
@@ -9494,7 +9917,7 @@ export interface operations {
9494
9917
  };
9495
9918
  };
9496
9919
  responses: {
9497
- /** @description Successful Response */
9920
+ /** @description Domain forward protocol set created successfully */
9498
9921
  201: {
9499
9922
  headers: {
9500
9923
  [name: string]: unknown;
@@ -9590,7 +10013,7 @@ export interface operations {
9590
10013
  };
9591
10014
  requestBody?: never;
9592
10015
  responses: {
9593
- /** @description Successful Response */
10016
+ /** @description Domain forward deleted successfully. No content returned. */
9594
10017
  204: {
9595
10018
  headers: {
9596
10019
  [name: string]: unknown;
@@ -9668,7 +10091,7 @@ export interface operations {
9668
10091
  };
9669
10092
  requestBody?: never;
9670
10093
  responses: {
9671
- /** @description Successful Response */
10094
+ /** @description Domain forward disabled successfully. DNS records have been removed but configuration is preserved. */
9672
10095
  204: {
9673
10096
  headers: {
9674
10097
  [name: string]: unknown;
@@ -9730,7 +10153,7 @@ export interface operations {
9730
10153
  };
9731
10154
  requestBody?: never;
9732
10155
  responses: {
9733
- /** @description Successful Response */
10156
+ /** @description Domain forward enabled successfully. DNS records have been created. */
9734
10157
  204: {
9735
10158
  headers: {
9736
10159
  [name: string]: unknown;
@@ -9793,7 +10216,7 @@ export interface operations {
9793
10216
  };
9794
10217
  requestBody?: never;
9795
10218
  responses: {
9796
- /** @description Successful Response */
10219
+ /** @description Domain forward set retrieved successfully */
9797
10220
  200: {
9798
10221
  headers: {
9799
10222
  [name: string]: unknown;
@@ -9878,7 +10301,7 @@ export interface operations {
9878
10301
  };
9879
10302
  };
9880
10303
  responses: {
9881
- /** @description Successful Response */
10304
+ /** @description Domain forward protocol set updated successfully */
9882
10305
  200: {
9883
10306
  headers: {
9884
10307
  [name: string]: unknown;
@@ -9963,7 +10386,7 @@ export interface operations {
9963
10386
  };
9964
10387
  };
9965
10388
  responses: {
9966
- /** @description Successful Response */
10389
+ /** @description Domain forward protocol set created successfully */
9967
10390
  201: {
9968
10391
  headers: {
9969
10392
  [name: string]: unknown;
@@ -10060,7 +10483,7 @@ export interface operations {
10060
10483
  };
10061
10484
  requestBody?: never;
10062
10485
  responses: {
10063
- /** @description Successful Response */
10486
+ /** @description Domain forward protocol set deleted successfully. No content returned. */
10064
10487
  204: {
10065
10488
  headers: {
10066
10489
  [name: string]: unknown;
@@ -11330,7 +11753,7 @@ export interface operations {
11330
11753
  };
11331
11754
  };
11332
11755
  responses: {
11333
- /** @description Successful Response */
11756
+ /** @description Email forwarding created successfully */
11334
11757
  201: {
11335
11758
  headers: {
11336
11759
  [name: string]: unknown;
@@ -11371,23 +11794,24 @@ export interface operations {
11371
11794
  "application/problem+json": components["schemas"]["Problem"];
11372
11795
  };
11373
11796
  };
11374
- /** @description Not Found */
11797
+ /** @description DNS zone was not found */
11375
11798
  404: {
11376
11799
  headers: {
11377
11800
  [name: string]: unknown;
11378
11801
  };
11379
11802
  content: {
11380
11803
  /** @example {
11381
- * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11382
- * "detail": "Email forward not found for hostname: Additional error context.",
11804
+ * "code": "ERROR_ZONE_NOT_FOUND",
11805
+ * "detail": "Zone not found",
11383
11806
  * "status": 404,
11384
- * "title": "Email Forward Error",
11385
- * "type": "email-forward-not-found"
11807
+ * "title": "DNS Error",
11808
+ * "type": "dns-zone-not-found",
11809
+ * "zone_name": "Zone example.com. not found"
11386
11810
  * } */
11387
11811
  "application/problem+json": components["schemas"]["Problem"];
11388
11812
  };
11389
11813
  };
11390
- /** @description Conflict */
11814
+ /** @description Email forwarding configuration already exists */
11391
11815
  409: {
11392
11816
  headers: {
11393
11817
  [name: string]: unknown;
@@ -11395,7 +11819,7 @@ export interface operations {
11395
11819
  content: {
11396
11820
  /** @example {
11397
11821
  * "code": "ERROR_EMAIL_FORWARD_ALREADY_EXISTS",
11398
- * "detail": "Email forward already exists for hostname: Additional error context.",
11822
+ * "detail": "Email forward already exists for hostname: mail.example.com",
11399
11823
  * "status": 409,
11400
11824
  * "title": "Email Forward Error",
11401
11825
  * "type": "email-forward-already-exists"
@@ -11569,7 +11993,7 @@ export interface operations {
11569
11993
  };
11570
11994
  };
11571
11995
  responses: {
11572
- /** @description Successful Response */
11996
+ /** @description Email forwarding alias created successfully */
11573
11997
  201: {
11574
11998
  headers: {
11575
11999
  [name: string]: unknown;
@@ -11610,7 +12034,7 @@ export interface operations {
11610
12034
  "application/problem+json": components["schemas"]["Problem"];
11611
12035
  };
11612
12036
  };
11613
- /** @description Not Found */
12037
+ /** @description Email forwarding configuration was not found */
11614
12038
  404: {
11615
12039
  headers: {
11616
12040
  [name: string]: unknown;
@@ -11618,7 +12042,7 @@ export interface operations {
11618
12042
  content: {
11619
12043
  /** @example {
11620
12044
  * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11621
- * "detail": "Email forward not found for hostname: Additional error context.",
12045
+ * "detail": "Email forward not found for ID: email_forward_01jx0000000000000000000009",
11622
12046
  * "status": 404,
11623
12047
  * "title": "Email Forward Error",
11624
12048
  * "type": "email-forward-not-found"
@@ -11626,7 +12050,7 @@ export interface operations {
11626
12050
  "application/problem+json": components["schemas"]["Problem"];
11627
12051
  };
11628
12052
  };
11629
- /** @description Conflict */
12053
+ /** @description Email forwarding alias already exists */
11630
12054
  409: {
11631
12055
  headers: {
11632
12056
  [name: string]: unknown;
@@ -11634,7 +12058,7 @@ export interface operations {
11634
12058
  content: {
11635
12059
  /** @example {
11636
12060
  * "code": "ERROR_EMAIL_FORWARD_ALIAS_ALREADY_EXISTS",
11637
- * "detail": "Additional error context.",
12061
+ * "detail": "Alias already exists",
11638
12062
  * "status": 409,
11639
12063
  * "title": "Email Forward Error",
11640
12064
  * "type": "email-forward-alias-already-exists"
@@ -11717,11 +12141,12 @@ export interface operations {
11717
12141
  };
11718
12142
  content: {
11719
12143
  /** @example {
11720
- * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11721
- * "detail": "Email forward not found for hostname: Additional error context.",
12144
+ * "code": "ERROR_EMAIL_FORWARD_ALIAS_NOT_FOUND",
12145
+ * "detail": "Alias could not be found",
12146
+ * "email_forward_id": "Additional error context.",
11722
12147
  * "status": 404,
11723
12148
  * "title": "Email Forward Error",
11724
- * "type": "email-forward-not-found"
12149
+ * "type": "email-forward-alias-not-found"
11725
12150
  * } */
11726
12151
  "application/problem+json": components["schemas"]["Problem"];
11727
12152
  };
@@ -11795,11 +12220,12 @@ export interface operations {
11795
12220
  };
11796
12221
  content: {
11797
12222
  /** @example {
11798
- * "code": "ERROR_EMAIL_FORWARD_NOT_FOUND",
11799
- * "detail": "Email forward not found for hostname: Additional error context.",
12223
+ * "code": "ERROR_EMAIL_FORWARD_ALIAS_NOT_FOUND",
12224
+ * "detail": "Alias could not be found",
12225
+ * "email_forward_id": "Additional error context.",
11800
12226
  * "status": 404,
11801
12227
  * "title": "Email Forward Error",
11802
- * "type": "email-forward-not-found"
12228
+ * "type": "email-forward-alias-not-found"
11803
12229
  * } */
11804
12230
  "application/problem+json": components["schemas"]["Problem"];
11805
12231
  };