@opusdns/api 0.317.0 → 0.319.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.317.0",
6
+ "version": "0.319.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -1628,6 +1628,7 @@ export const DOMAIN_AVAILABILITY_STATUS = {
1628
1628
  MARKET_AVAILABLE: "market_available",
1629
1629
  TMCH_CLAIM: "tmch_claim",
1630
1630
  ERROR: "error",
1631
+ UNKNOWN: "unknown",
1631
1632
  } as const satisfies Record<string, DomainAvailabilityStatus>;
1632
1633
 
1633
1634
  /**
@@ -1656,7 +1657,8 @@ export const DOMAIN_AVAILABILITY_STATUS_VALUES = [
1656
1657
  'unavailable',
1657
1658
  'market_available',
1658
1659
  'tmch_claim',
1659
- 'error'
1660
+ 'error',
1661
+ 'unknown'
1660
1662
  ] as const satisfies [string, ...string[]] | DomainAvailabilityStatus[];
1661
1663
 
1662
1664
  /**
@@ -3534,6 +3536,7 @@ export const METRICS_GROUPING = {
3534
3536
  FQDN: "fqdn",
3535
3537
  DOMAIN: "domain",
3536
3538
  FORWARD: "forward",
3539
+ RULE: "rule",
3537
3540
  } as const satisfies Record<string, MetricsGrouping>;
3538
3541
 
3539
3542
  /**
@@ -3561,7 +3564,8 @@ export const METRICS_GROUPING_VALUES = [
3561
3564
  'url',
3562
3565
  'fqdn',
3563
3566
  'domain',
3564
- 'forward'
3567
+ 'forward',
3568
+ 'rule'
3565
3569
  ] as const satisfies [string, ...string[]] | MetricsGrouping[];
3566
3570
 
3567
3571
  /**
@@ -5431,6 +5435,7 @@ export const TIME_RANGE = {
5431
5435
  "1D": "1d",
5432
5436
  "7D": "7d",
5433
5437
  "30D": "30d",
5438
+ "1Y": "1y",
5434
5439
  } as const satisfies Record<string, TimeRange>;
5435
5440
 
5436
5441
  /**
@@ -5458,7 +5463,8 @@ export const TIME_RANGE_VALUES = [
5458
5463
  '1h',
5459
5464
  '1d',
5460
5465
  '7d',
5461
- '30d'
5466
+ '30d',
5467
+ '1y'
5462
5468
  ] as const satisfies [string, ...string[]] | TimeRange[];
5463
5469
 
5464
5470
  /**
@@ -2978,7 +2978,7 @@ export type PUT_DomainForwardsHostnameProtocol_Request_Body = PUT_DomainForwards
2978
2978
  *
2979
2979
  * @path /v1/domain-forwards/metrics
2980
2980
  * @param protocol (query) - Filter by protocol: http or https
2981
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
2981
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
2982
2982
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
2983
2983
  *
2984
2984
  * @see {@link GET_DomainForwardsMetrics_Request_Query} - Query parameters type
@@ -3002,7 +3002,7 @@ export type GET_DomainForwardsMetrics_Request = {
3002
3002
  *
3003
3003
  * @path /v1/domain-forwards/metrics
3004
3004
  * @param protocol (query) - Filter by protocol: http or https
3005
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3005
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3006
3006
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3007
3007
  */
3008
3008
  export type GET_DomainForwardsMetrics_Request_Query = GET_DomainForwardsMetrics_Request['parameters']['query'];
@@ -3023,7 +3023,7 @@ export type GET_DomainForwardsMetrics_Request_Query = GET_DomainForwardsMetrics_
3023
3023
  *
3024
3024
  * @path /v1/domain-forwards/metrics/browser
3025
3025
  * @param protocol (query) - Filter by protocol: http or https
3026
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3026
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3027
3027
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3028
3028
  *
3029
3029
  * @see {@link GET_DomainForwardsMetricsBrowser_Request_Query} - Query parameters type
@@ -3047,7 +3047,7 @@ export type GET_DomainForwardsMetricsBrowser_Request = {
3047
3047
  *
3048
3048
  * @path /v1/domain-forwards/metrics/browser
3049
3049
  * @param protocol (query) - Filter by protocol: http or https
3050
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3050
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3051
3051
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3052
3052
  */
3053
3053
  export type GET_DomainForwardsMetricsBrowser_Request_Query = GET_DomainForwardsMetricsBrowser_Request['parameters']['query'];
@@ -3068,7 +3068,7 @@ export type GET_DomainForwardsMetricsBrowser_Request_Query = GET_DomainForwardsM
3068
3068
  *
3069
3069
  * @path /v1/domain-forwards/metrics/geo
3070
3070
  * @param protocol (query) - Filter by protocol: http or https
3071
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3071
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3072
3072
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3073
3073
  *
3074
3074
  * @see {@link GET_DomainForwardsMetricsGeo_Request_Query} - Query parameters type
@@ -3092,7 +3092,7 @@ export type GET_DomainForwardsMetricsGeo_Request = {
3092
3092
  *
3093
3093
  * @path /v1/domain-forwards/metrics/geo
3094
3094
  * @param protocol (query) - Filter by protocol: http or https
3095
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3095
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3096
3096
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3097
3097
  */
3098
3098
  export type GET_DomainForwardsMetricsGeo_Request_Query = GET_DomainForwardsMetricsGeo_Request['parameters']['query'];
@@ -3113,7 +3113,7 @@ export type GET_DomainForwardsMetricsGeo_Request_Query = GET_DomainForwardsMetri
3113
3113
  *
3114
3114
  * @path /v1/domain-forwards/metrics/platform
3115
3115
  * @param protocol (query) - Filter by protocol: http or https
3116
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3116
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3117
3117
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3118
3118
  *
3119
3119
  * @see {@link GET_DomainForwardsMetricsPlatform_Request_Query} - Query parameters type
@@ -3137,7 +3137,7 @@ export type GET_DomainForwardsMetricsPlatform_Request = {
3137
3137
  *
3138
3138
  * @path /v1/domain-forwards/metrics/platform
3139
3139
  * @param protocol (query) - Filter by protocol: http or https
3140
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3140
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3141
3141
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3142
3142
  */
3143
3143
  export type GET_DomainForwardsMetricsPlatform_Request_Query = GET_DomainForwardsMetricsPlatform_Request['parameters']['query'];
@@ -3158,7 +3158,7 @@ export type GET_DomainForwardsMetricsPlatform_Request_Query = GET_DomainForwards
3158
3158
  *
3159
3159
  * @path /v1/domain-forwards/metrics/referrer
3160
3160
  * @param protocol (query) - Filter by protocol: http or https
3161
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3161
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3162
3162
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3163
3163
  *
3164
3164
  * @see {@link GET_DomainForwardsMetricsReferrer_Request_Query} - Query parameters type
@@ -3182,7 +3182,7 @@ export type GET_DomainForwardsMetricsReferrer_Request = {
3182
3182
  *
3183
3183
  * @path /v1/domain-forwards/metrics/referrer
3184
3184
  * @param protocol (query) - Filter by protocol: http or https
3185
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3185
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3186
3186
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3187
3187
  */
3188
3188
  export type GET_DomainForwardsMetricsReferrer_Request_Query = GET_DomainForwardsMetricsReferrer_Request['parameters']['query'];
@@ -3203,7 +3203,7 @@ export type GET_DomainForwardsMetricsReferrer_Request_Query = GET_DomainForwards
3203
3203
  *
3204
3204
  * @path /v1/domain-forwards/metrics/status-code
3205
3205
  * @param protocol (query) - Filter by protocol: http or https
3206
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3206
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3207
3207
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3208
3208
  *
3209
3209
  * @see {@link GET_DomainForwardsMetricsStatusCode_Request_Query} - Query parameters type
@@ -3227,7 +3227,7 @@ export type GET_DomainForwardsMetricsStatusCode_Request = {
3227
3227
  *
3228
3228
  * @path /v1/domain-forwards/metrics/status-code
3229
3229
  * @param protocol (query) - Filter by protocol: http or https
3230
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3230
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3231
3231
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3232
3232
  */
3233
3233
  export type GET_DomainForwardsMetricsStatusCode_Request_Query = GET_DomainForwardsMetricsStatusCode_Request['parameters']['query'];
@@ -3248,7 +3248,7 @@ export type GET_DomainForwardsMetricsStatusCode_Request_Query = GET_DomainForwar
3248
3248
  *
3249
3249
  * @path /v1/domain-forwards/metrics/time-series
3250
3250
  * @param protocol (query) - Filter by protocol: http or https
3251
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3251
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3252
3252
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3253
3253
  *
3254
3254
  * @see {@link GET_DomainForwardsMetricsTimeSeries_Request_Query} - Query parameters type
@@ -3272,7 +3272,7 @@ export type GET_DomainForwardsMetricsTimeSeries_Request = {
3272
3272
  *
3273
3273
  * @path /v1/domain-forwards/metrics/time-series
3274
3274
  * @param protocol (query) - Filter by protocol: http or https
3275
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3275
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3276
3276
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3277
3277
  */
3278
3278
  export type GET_DomainForwardsMetricsTimeSeries_Request_Query = GET_DomainForwardsMetricsTimeSeries_Request['parameters']['query'];
@@ -3293,7 +3293,7 @@ export type GET_DomainForwardsMetricsTimeSeries_Request_Query = GET_DomainForwar
3293
3293
  *
3294
3294
  * @path /v1/domain-forwards/metrics/user-agent
3295
3295
  * @param protocol (query) - Filter by protocol: http or https
3296
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3296
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3297
3297
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3298
3298
  *
3299
3299
  * @see {@link GET_DomainForwardsMetricsUserAgent_Request_Query} - Query parameters type
@@ -3317,7 +3317,7 @@ export type GET_DomainForwardsMetricsUserAgent_Request = {
3317
3317
  *
3318
3318
  * @path /v1/domain-forwards/metrics/user-agent
3319
3319
  * @param protocol (query) - Filter by protocol: http or https
3320
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3320
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3321
3321
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3322
3322
  */
3323
3323
  export type GET_DomainForwardsMetricsUserAgent_Request_Query = GET_DomainForwardsMetricsUserAgent_Request['parameters']['query'];
@@ -3326,7 +3326,7 @@ export type GET_DomainForwardsMetricsUserAgent_Request_Query = GET_DomainForward
3326
3326
  * Request type for GET DomainForwardsMetricsVisitsByKey endpoint
3327
3327
  *
3328
3328
  * Get visits grouped by key
3329
- * Retrieves visit metrics grouped by a specified key (url, fqdn, domain, or forward) with total and unique visit counts.
3329
+ * Retrieves visit metrics grouped by a specified key (url, fqdn, domain, forward, or rule) with total and unique visit counts.
3330
3330
  *
3331
3331
  * @remarks
3332
3332
  * This type defines the complete request structure for the GET DomainForwardsMetricsVisitsByKey endpoint.
@@ -3337,9 +3337,9 @@ export type GET_DomainForwardsMetricsUserAgent_Request_Query = GET_DomainForward
3337
3337
  * Use this type to ensure type safety when making API requests to this endpoint.
3338
3338
  *
3339
3339
  * @path /v1/domain-forwards/metrics/visits-by-key
3340
- * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
3340
+ * @param grouping (query) - Grouping key: url, fqdn, domain, forward, or rule
3341
3341
  * @param protocol (query) - Filter by protocol: http or https
3342
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3342
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3343
3343
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3344
3344
  *
3345
3345
  * @see {@link GET_DomainForwardsMetricsVisitsByKey_Request_Query} - Query parameters type
@@ -3362,9 +3362,9 @@ export type GET_DomainForwardsMetricsVisitsByKey_Request = {
3362
3362
  * Use this type to ensure type safety for query parameters.
3363
3363
  *
3364
3364
  * @path /v1/domain-forwards/metrics/visits-by-key
3365
- * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
3365
+ * @param grouping (query) - Grouping key: url, fqdn, domain, forward, or rule
3366
3366
  * @param protocol (query) - Filter by protocol: http or https
3367
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3367
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
3368
3368
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
3369
3369
  */
3370
3370
  export type GET_DomainForwardsMetricsVisitsByKey_Request_Query = GET_DomainForwardsMetricsVisitsByKey_Request['parameters']['query'];
@@ -5848,7 +5848,7 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_422 = HTTPValidationEr
5848
5848
  *
5849
5849
  * @path /v1/domain-forwards/metrics
5850
5850
  * @param protocol (query) - Filter by protocol: http or https
5851
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
5851
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
5852
5852
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
5853
5853
  *
5854
5854
  * @see {@link GET_DomainForwardsMetrics_Response_200} - 200 response type
@@ -5872,7 +5872,7 @@ export type GET_DomainForwardsMetrics_Response = GET_DomainForwardsMetrics_Respo
5872
5872
  *
5873
5873
  * @path /v1/domain-forwards/metrics
5874
5874
  * @param protocol (query) - Filter by protocol: http or https
5875
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
5875
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
5876
5876
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
5877
5877
  *
5878
5878
  * @see {@link GET_DomainForwardsMetrics_Response} - The main response type definition
@@ -5892,7 +5892,7 @@ export type GET_DomainForwardsMetrics_Response_200 = DomainForwardMetrics
5892
5892
  *
5893
5893
  * @path /v1/domain-forwards/metrics
5894
5894
  * @param protocol (query) - Filter by protocol: http or https
5895
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
5895
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
5896
5896
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
5897
5897
  *
5898
5898
  * @see {@link GET_DomainForwardsMetrics_Response} - The main response type definition
@@ -5912,7 +5912,7 @@ export type GET_DomainForwardsMetrics_Response_401 = Problem
5912
5912
  *
5913
5913
  * @path /v1/domain-forwards/metrics
5914
5914
  * @param protocol (query) - Filter by protocol: http or https
5915
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
5915
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
5916
5916
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
5917
5917
  *
5918
5918
  * @see {@link GET_DomainForwardsMetrics_Response} - The main response type definition
@@ -5932,7 +5932,7 @@ export type GET_DomainForwardsMetrics_Response_403 = Problem
5932
5932
  *
5933
5933
  * @path /v1/domain-forwards/metrics
5934
5934
  * @param protocol (query) - Filter by protocol: http or https
5935
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
5935
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
5936
5936
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
5937
5937
  *
5938
5938
  * @see {@link GET_DomainForwardsMetrics_Response} - The main response type definition
@@ -5955,7 +5955,7 @@ export type GET_DomainForwardsMetrics_Response_422 = HTTPValidationError
5955
5955
  *
5956
5956
  * @path /v1/domain-forwards/metrics/browser
5957
5957
  * @param protocol (query) - Filter by protocol: http or https
5958
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
5958
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
5959
5959
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
5960
5960
  *
5961
5961
  * @see {@link GET_DomainForwardsMetricsBrowser_Response_200} - 200 response type
@@ -5979,7 +5979,7 @@ export type GET_DomainForwardsMetricsBrowser_Response = GET_DomainForwardsMetric
5979
5979
  *
5980
5980
  * @path /v1/domain-forwards/metrics/browser
5981
5981
  * @param protocol (query) - Filter by protocol: http or https
5982
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
5982
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
5983
5983
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
5984
5984
  *
5985
5985
  * @see {@link GET_DomainForwardsMetricsBrowser_Response} - The main response type definition
@@ -5999,7 +5999,7 @@ export type GET_DomainForwardsMetricsBrowser_Response_200 = DomainForwardBrowser
5999
5999
  *
6000
6000
  * @path /v1/domain-forwards/metrics/browser
6001
6001
  * @param protocol (query) - Filter by protocol: http or https
6002
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6002
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6003
6003
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6004
6004
  *
6005
6005
  * @see {@link GET_DomainForwardsMetricsBrowser_Response} - The main response type definition
@@ -6019,7 +6019,7 @@ export type GET_DomainForwardsMetricsBrowser_Response_401 = Problem
6019
6019
  *
6020
6020
  * @path /v1/domain-forwards/metrics/browser
6021
6021
  * @param protocol (query) - Filter by protocol: http or https
6022
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6022
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6023
6023
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6024
6024
  *
6025
6025
  * @see {@link GET_DomainForwardsMetricsBrowser_Response} - The main response type definition
@@ -6039,7 +6039,7 @@ export type GET_DomainForwardsMetricsBrowser_Response_403 = Problem
6039
6039
  *
6040
6040
  * @path /v1/domain-forwards/metrics/browser
6041
6041
  * @param protocol (query) - Filter by protocol: http or https
6042
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6042
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6043
6043
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6044
6044
  *
6045
6045
  * @see {@link GET_DomainForwardsMetricsBrowser_Response} - The main response type definition
@@ -6062,7 +6062,7 @@ export type GET_DomainForwardsMetricsBrowser_Response_422 = HTTPValidationError
6062
6062
  *
6063
6063
  * @path /v1/domain-forwards/metrics/geo
6064
6064
  * @param protocol (query) - Filter by protocol: http or https
6065
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6065
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6066
6066
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6067
6067
  *
6068
6068
  * @see {@link GET_DomainForwardsMetricsGeo_Response_200} - 200 response type
@@ -6086,7 +6086,7 @@ export type GET_DomainForwardsMetricsGeo_Response = GET_DomainForwardsMetricsGeo
6086
6086
  *
6087
6087
  * @path /v1/domain-forwards/metrics/geo
6088
6088
  * @param protocol (query) - Filter by protocol: http or https
6089
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6089
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6090
6090
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6091
6091
  *
6092
6092
  * @see {@link GET_DomainForwardsMetricsGeo_Response} - The main response type definition
@@ -6106,7 +6106,7 @@ export type GET_DomainForwardsMetricsGeo_Response_200 = DomainForwardGeoStats
6106
6106
  *
6107
6107
  * @path /v1/domain-forwards/metrics/geo
6108
6108
  * @param protocol (query) - Filter by protocol: http or https
6109
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6109
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6110
6110
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6111
6111
  *
6112
6112
  * @see {@link GET_DomainForwardsMetricsGeo_Response} - The main response type definition
@@ -6126,7 +6126,7 @@ export type GET_DomainForwardsMetricsGeo_Response_401 = Problem
6126
6126
  *
6127
6127
  * @path /v1/domain-forwards/metrics/geo
6128
6128
  * @param protocol (query) - Filter by protocol: http or https
6129
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6129
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6130
6130
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6131
6131
  *
6132
6132
  * @see {@link GET_DomainForwardsMetricsGeo_Response} - The main response type definition
@@ -6146,7 +6146,7 @@ export type GET_DomainForwardsMetricsGeo_Response_403 = Problem
6146
6146
  *
6147
6147
  * @path /v1/domain-forwards/metrics/geo
6148
6148
  * @param protocol (query) - Filter by protocol: http or https
6149
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6149
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6150
6150
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6151
6151
  *
6152
6152
  * @see {@link GET_DomainForwardsMetricsGeo_Response} - The main response type definition
@@ -6169,7 +6169,7 @@ export type GET_DomainForwardsMetricsGeo_Response_422 = HTTPValidationError
6169
6169
  *
6170
6170
  * @path /v1/domain-forwards/metrics/platform
6171
6171
  * @param protocol (query) - Filter by protocol: http or https
6172
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6172
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6173
6173
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6174
6174
  *
6175
6175
  * @see {@link GET_DomainForwardsMetricsPlatform_Response_200} - 200 response type
@@ -6193,7 +6193,7 @@ export type GET_DomainForwardsMetricsPlatform_Response = GET_DomainForwardsMetri
6193
6193
  *
6194
6194
  * @path /v1/domain-forwards/metrics/platform
6195
6195
  * @param protocol (query) - Filter by protocol: http or https
6196
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6196
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6197
6197
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6198
6198
  *
6199
6199
  * @see {@link GET_DomainForwardsMetricsPlatform_Response} - The main response type definition
@@ -6213,7 +6213,7 @@ export type GET_DomainForwardsMetricsPlatform_Response_200 = DomainForwardPlatfo
6213
6213
  *
6214
6214
  * @path /v1/domain-forwards/metrics/platform
6215
6215
  * @param protocol (query) - Filter by protocol: http or https
6216
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6216
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6217
6217
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6218
6218
  *
6219
6219
  * @see {@link GET_DomainForwardsMetricsPlatform_Response} - The main response type definition
@@ -6233,7 +6233,7 @@ export type GET_DomainForwardsMetricsPlatform_Response_401 = Problem
6233
6233
  *
6234
6234
  * @path /v1/domain-forwards/metrics/platform
6235
6235
  * @param protocol (query) - Filter by protocol: http or https
6236
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6236
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6237
6237
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6238
6238
  *
6239
6239
  * @see {@link GET_DomainForwardsMetricsPlatform_Response} - The main response type definition
@@ -6253,7 +6253,7 @@ export type GET_DomainForwardsMetricsPlatform_Response_403 = Problem
6253
6253
  *
6254
6254
  * @path /v1/domain-forwards/metrics/platform
6255
6255
  * @param protocol (query) - Filter by protocol: http or https
6256
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6256
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6257
6257
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6258
6258
  *
6259
6259
  * @see {@link GET_DomainForwardsMetricsPlatform_Response} - The main response type definition
@@ -6276,7 +6276,7 @@ export type GET_DomainForwardsMetricsPlatform_Response_422 = HTTPValidationError
6276
6276
  *
6277
6277
  * @path /v1/domain-forwards/metrics/referrer
6278
6278
  * @param protocol (query) - Filter by protocol: http or https
6279
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6279
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6280
6280
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6281
6281
  *
6282
6282
  * @see {@link GET_DomainForwardsMetricsReferrer_Response_200} - 200 response type
@@ -6300,7 +6300,7 @@ export type GET_DomainForwardsMetricsReferrer_Response = GET_DomainForwardsMetri
6300
6300
  *
6301
6301
  * @path /v1/domain-forwards/metrics/referrer
6302
6302
  * @param protocol (query) - Filter by protocol: http or https
6303
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6303
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6304
6304
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6305
6305
  *
6306
6306
  * @see {@link GET_DomainForwardsMetricsReferrer_Response} - The main response type definition
@@ -6320,7 +6320,7 @@ export type GET_DomainForwardsMetricsReferrer_Response_200 = DomainForwardReferr
6320
6320
  *
6321
6321
  * @path /v1/domain-forwards/metrics/referrer
6322
6322
  * @param protocol (query) - Filter by protocol: http or https
6323
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6323
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6324
6324
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6325
6325
  *
6326
6326
  * @see {@link GET_DomainForwardsMetricsReferrer_Response} - The main response type definition
@@ -6340,7 +6340,7 @@ export type GET_DomainForwardsMetricsReferrer_Response_401 = Problem
6340
6340
  *
6341
6341
  * @path /v1/domain-forwards/metrics/referrer
6342
6342
  * @param protocol (query) - Filter by protocol: http or https
6343
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6343
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6344
6344
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6345
6345
  *
6346
6346
  * @see {@link GET_DomainForwardsMetricsReferrer_Response} - The main response type definition
@@ -6360,7 +6360,7 @@ export type GET_DomainForwardsMetricsReferrer_Response_403 = Problem
6360
6360
  *
6361
6361
  * @path /v1/domain-forwards/metrics/referrer
6362
6362
  * @param protocol (query) - Filter by protocol: http or https
6363
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6363
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6364
6364
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6365
6365
  *
6366
6366
  * @see {@link GET_DomainForwardsMetricsReferrer_Response} - The main response type definition
@@ -6383,7 +6383,7 @@ export type GET_DomainForwardsMetricsReferrer_Response_422 = HTTPValidationError
6383
6383
  *
6384
6384
  * @path /v1/domain-forwards/metrics/status-code
6385
6385
  * @param protocol (query) - Filter by protocol: http or https
6386
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6386
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6387
6387
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6388
6388
  *
6389
6389
  * @see {@link GET_DomainForwardsMetricsStatusCode_Response_200} - 200 response type
@@ -6407,7 +6407,7 @@ export type GET_DomainForwardsMetricsStatusCode_Response = GET_DomainForwardsMet
6407
6407
  *
6408
6408
  * @path /v1/domain-forwards/metrics/status-code
6409
6409
  * @param protocol (query) - Filter by protocol: http or https
6410
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6410
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6411
6411
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6412
6412
  *
6413
6413
  * @see {@link GET_DomainForwardsMetricsStatusCode_Response} - The main response type definition
@@ -6427,7 +6427,7 @@ export type GET_DomainForwardsMetricsStatusCode_Response_200 = DomainForwardStat
6427
6427
  *
6428
6428
  * @path /v1/domain-forwards/metrics/status-code
6429
6429
  * @param protocol (query) - Filter by protocol: http or https
6430
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6430
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6431
6431
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6432
6432
  *
6433
6433
  * @see {@link GET_DomainForwardsMetricsStatusCode_Response} - The main response type definition
@@ -6447,7 +6447,7 @@ export type GET_DomainForwardsMetricsStatusCode_Response_401 = Problem
6447
6447
  *
6448
6448
  * @path /v1/domain-forwards/metrics/status-code
6449
6449
  * @param protocol (query) - Filter by protocol: http or https
6450
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6450
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6451
6451
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6452
6452
  *
6453
6453
  * @see {@link GET_DomainForwardsMetricsStatusCode_Response} - The main response type definition
@@ -6467,7 +6467,7 @@ export type GET_DomainForwardsMetricsStatusCode_Response_403 = Problem
6467
6467
  *
6468
6468
  * @path /v1/domain-forwards/metrics/status-code
6469
6469
  * @param protocol (query) - Filter by protocol: http or https
6470
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6470
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6471
6471
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6472
6472
  *
6473
6473
  * @see {@link GET_DomainForwardsMetricsStatusCode_Response} - The main response type definition
@@ -6490,7 +6490,7 @@ export type GET_DomainForwardsMetricsStatusCode_Response_422 = HTTPValidationErr
6490
6490
  *
6491
6491
  * @path /v1/domain-forwards/metrics/time-series
6492
6492
  * @param protocol (query) - Filter by protocol: http or https
6493
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6493
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6494
6494
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6495
6495
  *
6496
6496
  * @see {@link GET_DomainForwardsMetricsTimeSeries_Response_200} - 200 response type
@@ -6514,7 +6514,7 @@ export type GET_DomainForwardsMetricsTimeSeries_Response = GET_DomainForwardsMet
6514
6514
  *
6515
6515
  * @path /v1/domain-forwards/metrics/time-series
6516
6516
  * @param protocol (query) - Filter by protocol: http or https
6517
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6517
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6518
6518
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6519
6519
  *
6520
6520
  * @see {@link GET_DomainForwardsMetricsTimeSeries_Response} - The main response type definition
@@ -6534,7 +6534,7 @@ export type GET_DomainForwardsMetricsTimeSeries_Response_200 = DomainForwardMetr
6534
6534
  *
6535
6535
  * @path /v1/domain-forwards/metrics/time-series
6536
6536
  * @param protocol (query) - Filter by protocol: http or https
6537
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6537
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6538
6538
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6539
6539
  *
6540
6540
  * @see {@link GET_DomainForwardsMetricsTimeSeries_Response} - The main response type definition
@@ -6554,7 +6554,7 @@ export type GET_DomainForwardsMetricsTimeSeries_Response_401 = Problem
6554
6554
  *
6555
6555
  * @path /v1/domain-forwards/metrics/time-series
6556
6556
  * @param protocol (query) - Filter by protocol: http or https
6557
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6557
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6558
6558
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6559
6559
  *
6560
6560
  * @see {@link GET_DomainForwardsMetricsTimeSeries_Response} - The main response type definition
@@ -6574,7 +6574,7 @@ export type GET_DomainForwardsMetricsTimeSeries_Response_403 = Problem
6574
6574
  *
6575
6575
  * @path /v1/domain-forwards/metrics/time-series
6576
6576
  * @param protocol (query) - Filter by protocol: http or https
6577
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6577
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6578
6578
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6579
6579
  *
6580
6580
  * @see {@link GET_DomainForwardsMetricsTimeSeries_Response} - The main response type definition
@@ -6597,7 +6597,7 @@ export type GET_DomainForwardsMetricsTimeSeries_Response_422 = HTTPValidationErr
6597
6597
  *
6598
6598
  * @path /v1/domain-forwards/metrics/user-agent
6599
6599
  * @param protocol (query) - Filter by protocol: http or https
6600
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6600
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6601
6601
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6602
6602
  *
6603
6603
  * @see {@link GET_DomainForwardsMetricsUserAgent_Response_200} - 200 response type
@@ -6621,7 +6621,7 @@ export type GET_DomainForwardsMetricsUserAgent_Response = GET_DomainForwardsMetr
6621
6621
  *
6622
6622
  * @path /v1/domain-forwards/metrics/user-agent
6623
6623
  * @param protocol (query) - Filter by protocol: http or https
6624
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6624
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6625
6625
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6626
6626
  *
6627
6627
  * @see {@link GET_DomainForwardsMetricsUserAgent_Response} - The main response type definition
@@ -6641,7 +6641,7 @@ export type GET_DomainForwardsMetricsUserAgent_Response_200 = DomainForwardUserA
6641
6641
  *
6642
6642
  * @path /v1/domain-forwards/metrics/user-agent
6643
6643
  * @param protocol (query) - Filter by protocol: http or https
6644
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6644
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6645
6645
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6646
6646
  *
6647
6647
  * @see {@link GET_DomainForwardsMetricsUserAgent_Response} - The main response type definition
@@ -6661,7 +6661,7 @@ export type GET_DomainForwardsMetricsUserAgent_Response_401 = Problem
6661
6661
  *
6662
6662
  * @path /v1/domain-forwards/metrics/user-agent
6663
6663
  * @param protocol (query) - Filter by protocol: http or https
6664
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6664
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6665
6665
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6666
6666
  *
6667
6667
  * @see {@link GET_DomainForwardsMetricsUserAgent_Response} - The main response type definition
@@ -6681,7 +6681,7 @@ export type GET_DomainForwardsMetricsUserAgent_Response_403 = Problem
6681
6681
  *
6682
6682
  * @path /v1/domain-forwards/metrics/user-agent
6683
6683
  * @param protocol (query) - Filter by protocol: http or https
6684
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6684
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6685
6685
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6686
6686
  *
6687
6687
  * @see {@link GET_DomainForwardsMetricsUserAgent_Response} - The main response type definition
@@ -6693,7 +6693,7 @@ export type GET_DomainForwardsMetricsUserAgent_Response_422 = HTTPValidationErro
6693
6693
  * Response types for GET DomainForwardsMetricsVisitsByKey endpoint
6694
6694
  *
6695
6695
  * Get visits grouped by key
6696
- * Retrieves visit metrics grouped by a specified key (url, fqdn, domain, or forward) with total and unique visit counts.
6696
+ * Retrieves visit metrics grouped by a specified key (url, fqdn, domain, forward, or rule) with total and unique visit counts.
6697
6697
  *
6698
6698
  * @remarks
6699
6699
  * This type defines all possible response structures for the GET DomainForwardsMetricsVisitsByKey endpoint.
@@ -6703,9 +6703,9 @@ export type GET_DomainForwardsMetricsUserAgent_Response_422 = HTTPValidationErro
6703
6703
 
6704
6704
  *
6705
6705
  * @path /v1/domain-forwards/metrics/visits-by-key
6706
- * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
6706
+ * @param grouping (query) - Grouping key: url, fqdn, domain, forward, or rule
6707
6707
  * @param protocol (query) - Filter by protocol: http or https
6708
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6708
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6709
6709
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6710
6710
  *
6711
6711
  * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response_200} - 200 response type
@@ -6728,9 +6728,9 @@ export type GET_DomainForwardsMetricsVisitsByKey_Response = GET_DomainForwardsMe
6728
6728
 
6729
6729
  *
6730
6730
  * @path /v1/domain-forwards/metrics/visits-by-key
6731
- * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
6731
+ * @param grouping (query) - Grouping key: url, fqdn, domain, forward, or rule
6732
6732
  * @param protocol (query) - Filter by protocol: http or https
6733
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6733
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6734
6734
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6735
6735
  *
6736
6736
  * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response} - The main response type definition
@@ -6749,9 +6749,9 @@ export type GET_DomainForwardsMetricsVisitsByKey_Response_200 = DomainForwardVis
6749
6749
 
6750
6750
  *
6751
6751
  * @path /v1/domain-forwards/metrics/visits-by-key
6752
- * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
6752
+ * @param grouping (query) - Grouping key: url, fqdn, domain, forward, or rule
6753
6753
  * @param protocol (query) - Filter by protocol: http or https
6754
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6754
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6755
6755
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6756
6756
  *
6757
6757
  * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response} - The main response type definition
@@ -6770,9 +6770,9 @@ export type GET_DomainForwardsMetricsVisitsByKey_Response_401 = Problem
6770
6770
 
6771
6771
  *
6772
6772
  * @path /v1/domain-forwards/metrics/visits-by-key
6773
- * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
6773
+ * @param grouping (query) - Grouping key: url, fqdn, domain, forward, or rule
6774
6774
  * @param protocol (query) - Filter by protocol: http or https
6775
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6775
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6776
6776
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6777
6777
  *
6778
6778
  * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response} - The main response type definition
@@ -6791,9 +6791,9 @@ export type GET_DomainForwardsMetricsVisitsByKey_Response_403 = Problem
6791
6791
 
6792
6792
  *
6793
6793
  * @path /v1/domain-forwards/metrics/visits-by-key
6794
- * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
6794
+ * @param grouping (query) - Grouping key: url, fqdn, domain, forward, or rule
6795
6795
  * @param protocol (query) - Filter by protocol: http or https
6796
- * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
6796
+ * @param time_range (query) - Time range: 1h, 1d, 7d, 30d, or 1y
6797
6797
  * @param exclude_bots (query) - Exclude platform values: Unknown, Bot
6798
6798
  *
6799
6799
  * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response} - The main response type definition
package/src/openapi.yaml CHANGED
@@ -3139,6 +3139,7 @@ components:
3139
3139
  - market_available
3140
3140
  - tmch_claim
3141
3141
  - error
3142
+ - unknown
3142
3143
  title: DomainAvailabilityStatus
3143
3144
  type: string
3144
3145
  DomainCheckResponse:
@@ -7299,6 +7300,7 @@ components:
7299
7300
  - fqdn
7300
7301
  - domain
7301
7302
  - forward
7303
+ - rule
7302
7304
  title: MetricsGrouping
7303
7305
  type: string
7304
7306
  Nameserver:
@@ -10080,6 +10082,7 @@ components:
10080
10082
  - 1d
10081
10083
  - 7d
10082
10084
  - 30d
10085
+ - 1y
10083
10086
  title: TimeRange
10084
10087
  type: string
10085
10088
  TimeSeriesBucket:
@@ -11590,7 +11593,7 @@ info:
11590
11593
  \n\n"
11591
11594
  summary: OpusDNS - your gateway to a seamless domain management experience.
11592
11595
  title: OpusDNS API
11593
- version: 2026-06-01-184117
11596
+ version: 2026-06-02-180210
11594
11597
  x-logo:
11595
11598
  altText: OpusDNS API Reference
11596
11599
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -16726,14 +16729,14 @@ paths:
16726
16729
  - type: 'null'
16727
16730
  description: 'Filter by protocol: http or https'
16728
16731
  title: Protocol
16729
- - description: 'Time range: 1h, 1d, 7d, or 30d'
16732
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16730
16733
  in: query
16731
16734
  name: time_range
16732
16735
  required: false
16733
16736
  schema:
16734
16737
  $ref: '#/components/schemas/TimeRange'
16735
16738
  default: 1d
16736
- description: 'Time range: 1h, 1d, 7d, or 30d'
16739
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16737
16740
  - description: 'Exclude platform values: Unknown, Bot'
16738
16741
  in: query
16739
16742
  name: exclude_bots
@@ -16844,14 +16847,14 @@ paths:
16844
16847
  - type: 'null'
16845
16848
  description: 'Filter by protocol: http or https'
16846
16849
  title: Protocol
16847
- - description: 'Time range: 1h, 1d, 7d, or 30d'
16850
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16848
16851
  in: query
16849
16852
  name: time_range
16850
16853
  required: false
16851
16854
  schema:
16852
16855
  $ref: '#/components/schemas/TimeRange'
16853
16856
  default: 1d
16854
- description: 'Time range: 1h, 1d, 7d, or 30d'
16857
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16855
16858
  - description: 'Exclude platform values: Unknown, Bot'
16856
16859
  in: query
16857
16860
  name: exclude_bots
@@ -16985,14 +16988,14 @@ paths:
16985
16988
  - type: 'null'
16986
16989
  description: 'Filter by protocol: http or https'
16987
16990
  title: Protocol
16988
- - description: 'Time range: 1h, 1d, 7d, or 30d'
16991
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16989
16992
  in: query
16990
16993
  name: time_range
16991
16994
  required: false
16992
16995
  schema:
16993
16996
  $ref: '#/components/schemas/TimeRange'
16994
16997
  default: 1d
16995
- description: 'Time range: 1h, 1d, 7d, or 30d'
16998
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16996
16999
  - description: 'Exclude platform values: Unknown, Bot'
16997
17000
  in: query
16998
17001
  name: exclude_bots
@@ -17119,14 +17122,14 @@ paths:
17119
17122
  - type: 'null'
17120
17123
  description: 'Filter by protocol: http or https'
17121
17124
  title: Protocol
17122
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17125
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17123
17126
  in: query
17124
17127
  name: time_range
17125
17128
  required: false
17126
17129
  schema:
17127
17130
  $ref: '#/components/schemas/TimeRange'
17128
17131
  default: 1d
17129
- description: 'Time range: 1h, 1d, 7d, or 30d'
17132
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17130
17133
  - description: 'Exclude platform values: Unknown, Bot'
17131
17134
  in: query
17132
17135
  name: exclude_bots
@@ -17258,14 +17261,14 @@ paths:
17258
17261
  - type: 'null'
17259
17262
  description: 'Filter by protocol: http or https'
17260
17263
  title: Protocol
17261
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17264
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17262
17265
  in: query
17263
17266
  name: time_range
17264
17267
  required: false
17265
17268
  schema:
17266
17269
  $ref: '#/components/schemas/TimeRange'
17267
17270
  default: 1d
17268
- description: 'Time range: 1h, 1d, 7d, or 30d'
17271
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17269
17272
  - description: 'Exclude platform values: Unknown, Bot'
17270
17273
  in: query
17271
17274
  name: exclude_bots
@@ -17399,14 +17402,14 @@ paths:
17399
17402
  - type: 'null'
17400
17403
  description: 'Filter by protocol: http or https'
17401
17404
  title: Protocol
17402
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17405
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17403
17406
  in: query
17404
17407
  name: time_range
17405
17408
  required: false
17406
17409
  schema:
17407
17410
  $ref: '#/components/schemas/TimeRange'
17408
17411
  default: 1d
17409
- description: 'Time range: 1h, 1d, 7d, or 30d'
17412
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17410
17413
  - description: 'Exclude platform values: Unknown, Bot'
17411
17414
  in: query
17412
17415
  name: exclude_bots
@@ -17526,14 +17529,14 @@ paths:
17526
17529
  - type: 'null'
17527
17530
  description: 'Filter by protocol: http or https'
17528
17531
  title: Protocol
17529
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17532
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17530
17533
  in: query
17531
17534
  name: time_range
17532
17535
  required: false
17533
17536
  schema:
17534
17537
  $ref: '#/components/schemas/TimeRange'
17535
17538
  default: 1d
17536
- description: 'Time range: 1h, 1d, 7d, or 30d'
17539
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17537
17540
  - description: 'Exclude platform values: Unknown, Bot'
17538
17541
  in: query
17539
17542
  name: exclude_bots
@@ -17699,14 +17702,14 @@ paths:
17699
17702
  - type: 'null'
17700
17703
  description: 'Filter by protocol: http or https'
17701
17704
  title: Protocol
17702
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17705
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17703
17706
  in: query
17704
17707
  name: time_range
17705
17708
  required: false
17706
17709
  schema:
17707
17710
  $ref: '#/components/schemas/TimeRange'
17708
17711
  default: 1d
17709
- description: 'Time range: 1h, 1d, 7d, or 30d'
17712
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17710
17713
  - description: 'Exclude platform values: Unknown, Bot'
17711
17714
  in: query
17712
17715
  name: exclude_bots
@@ -17803,17 +17806,17 @@ paths:
17803
17806
  /v1/domain-forwards/metrics/visits-by-key:
17804
17807
  get:
17805
17808
  description: Retrieves visit metrics grouped by a specified key (url, fqdn,
17806
- domain, or forward) with total and unique visit counts.
17809
+ domain, forward, or rule) with total and unique visit counts.
17807
17810
  operationId: visits_by_key_v1_domain_forwards_metrics_visits_by_key_get
17808
17811
  parameters:
17809
- - description: 'Grouping key: url, fqdn, domain, or forward'
17812
+ - description: 'Grouping key: url, fqdn, domain, forward, or rule'
17810
17813
  in: query
17811
17814
  name: grouping
17812
17815
  required: false
17813
17816
  schema:
17814
17817
  $ref: '#/components/schemas/MetricsGrouping'
17815
17818
  default: domain
17816
- description: 'Grouping key: url, fqdn, domain, or forward'
17819
+ description: 'Grouping key: url, fqdn, domain, forward, or rule'
17817
17820
  - in: query
17818
17821
  name: hostname
17819
17822
  required: false
@@ -17840,14 +17843,14 @@ paths:
17840
17843
  - type: 'null'
17841
17844
  description: 'Filter by protocol: http or https'
17842
17845
  title: Protocol
17843
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17846
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17844
17847
  in: query
17845
17848
  name: time_range
17846
17849
  required: false
17847
17850
  schema:
17848
17851
  $ref: '#/components/schemas/TimeRange'
17849
17852
  default: 1d
17850
- description: 'Time range: 1h, 1d, 7d, or 30d'
17853
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17851
17854
  - description: 'Exclude platform values: Unknown, Bot'
17852
17855
  in: query
17853
17856
  name: exclude_bots
package/src/schema.d.ts CHANGED
@@ -910,7 +910,7 @@ export interface paths {
910
910
  };
911
911
  /**
912
912
  * Get visits grouped by key
913
- * @description Retrieves visit metrics grouped by a specified key (url, fqdn, domain, or forward) with total and unique visit counts.
913
+ * @description Retrieves visit metrics grouped by a specified key (url, fqdn, domain, forward, or rule) with total and unique visit counts.
914
914
  */
915
915
  get: operations["visits_by_key_v1_domain_forwards_metrics_visits_by_key_get"];
916
916
  put?: never;
@@ -4558,7 +4558,7 @@ export interface components {
4558
4558
  * DomainAvailabilityStatus
4559
4559
  * @enum {string}
4560
4560
  */
4561
- DomainAvailabilityStatus: "available" | "unavailable" | "market_available" | "tmch_claim" | "error";
4561
+ DomainAvailabilityStatus: "available" | "unavailable" | "market_available" | "tmch_claim" | "error" | "unknown";
4562
4562
  /** DomainCheckResponse */
4563
4563
  DomainCheckResponse: {
4564
4564
  /** Results */
@@ -7303,7 +7303,7 @@ export interface components {
7303
7303
  * MetricsGrouping
7304
7304
  * @enum {string}
7305
7305
  */
7306
- MetricsGrouping: "url" | "fqdn" | "domain" | "forward";
7306
+ MetricsGrouping: "url" | "fqdn" | "domain" | "forward" | "rule";
7307
7307
  /** Nameserver */
7308
7308
  Nameserver: {
7309
7309
  /**
@@ -9070,7 +9070,7 @@ export interface components {
9070
9070
  * TimeRange
9071
9071
  * @enum {string}
9072
9072
  */
9073
- TimeRange: "1h" | "1d" | "7d" | "30d";
9073
+ TimeRange: "1h" | "1d" | "7d" | "30d" | "1y";
9074
9074
  /** TimeSeriesBucket */
9075
9075
  TimeSeriesBucket: {
9076
9076
  /**
@@ -13821,7 +13821,7 @@ export interface operations {
13821
13821
  domain?: string | null;
13822
13822
  /** @description Filter by protocol: http or https */
13823
13823
  protocol?: components["schemas"]["Protocol"] | null;
13824
- /** @description Time range: 1h, 1d, 7d, or 30d */
13824
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
13825
13825
  time_range?: components["schemas"]["TimeRange"];
13826
13826
  /** @description Exclude platform values: Unknown, Bot */
13827
13827
  exclude_bots?: boolean;
@@ -13903,7 +13903,7 @@ export interface operations {
13903
13903
  domain?: string | null;
13904
13904
  /** @description Filter by protocol: http or https */
13905
13905
  protocol?: components["schemas"]["Protocol"] | null;
13906
- /** @description Time range: 1h, 1d, 7d, or 30d */
13906
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
13907
13907
  time_range?: components["schemas"]["TimeRange"];
13908
13908
  /** @description Exclude platform values: Unknown, Bot */
13909
13909
  exclude_bots?: boolean;
@@ -13985,7 +13985,7 @@ export interface operations {
13985
13985
  domain?: string | null;
13986
13986
  /** @description Filter by protocol: http or https */
13987
13987
  protocol?: components["schemas"]["Protocol"] | null;
13988
- /** @description Time range: 1h, 1d, 7d, or 30d */
13988
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
13989
13989
  time_range?: components["schemas"]["TimeRange"];
13990
13990
  /** @description Exclude platform values: Unknown, Bot */
13991
13991
  exclude_bots?: boolean;
@@ -14067,7 +14067,7 @@ export interface operations {
14067
14067
  domain?: string | null;
14068
14068
  /** @description Filter by protocol: http or https */
14069
14069
  protocol?: components["schemas"]["Protocol"] | null;
14070
- /** @description Time range: 1h, 1d, 7d, or 30d */
14070
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14071
14071
  time_range?: components["schemas"]["TimeRange"];
14072
14072
  /** @description Exclude platform values: Unknown, Bot */
14073
14073
  exclude_bots?: boolean;
@@ -14149,7 +14149,7 @@ export interface operations {
14149
14149
  domain?: string | null;
14150
14150
  /** @description Filter by protocol: http or https */
14151
14151
  protocol?: components["schemas"]["Protocol"] | null;
14152
- /** @description Time range: 1h, 1d, 7d, or 30d */
14152
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14153
14153
  time_range?: components["schemas"]["TimeRange"];
14154
14154
  /** @description Exclude platform values: Unknown, Bot */
14155
14155
  exclude_bots?: boolean;
@@ -14231,7 +14231,7 @@ export interface operations {
14231
14231
  domain?: string | null;
14232
14232
  /** @description Filter by protocol: http or https */
14233
14233
  protocol?: components["schemas"]["Protocol"] | null;
14234
- /** @description Time range: 1h, 1d, 7d, or 30d */
14234
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14235
14235
  time_range?: components["schemas"]["TimeRange"];
14236
14236
  /** @description Exclude platform values: Unknown, Bot */
14237
14237
  exclude_bots?: boolean;
@@ -14313,7 +14313,7 @@ export interface operations {
14313
14313
  domain?: string | null;
14314
14314
  /** @description Filter by protocol: http or https */
14315
14315
  protocol?: components["schemas"]["Protocol"] | null;
14316
- /** @description Time range: 1h, 1d, 7d, or 30d */
14316
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14317
14317
  time_range?: components["schemas"]["TimeRange"];
14318
14318
  /** @description Exclude platform values: Unknown, Bot */
14319
14319
  exclude_bots?: boolean;
@@ -14395,7 +14395,7 @@ export interface operations {
14395
14395
  domain?: string | null;
14396
14396
  /** @description Filter by protocol: http or https */
14397
14397
  protocol?: components["schemas"]["Protocol"] | null;
14398
- /** @description Time range: 1h, 1d, 7d, or 30d */
14398
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14399
14399
  time_range?: components["schemas"]["TimeRange"];
14400
14400
  /** @description Exclude platform values: Unknown, Bot */
14401
14401
  exclude_bots?: boolean;
@@ -14473,13 +14473,13 @@ export interface operations {
14473
14473
  visits_by_key_v1_domain_forwards_metrics_visits_by_key_get: {
14474
14474
  parameters: {
14475
14475
  query?: {
14476
- /** @description Grouping key: url, fqdn, domain, or forward */
14476
+ /** @description Grouping key: url, fqdn, domain, forward, or rule */
14477
14477
  grouping?: components["schemas"]["MetricsGrouping"];
14478
14478
  hostname?: string | null;
14479
14479
  domain?: string | null;
14480
14480
  /** @description Filter by protocol: http or https */
14481
14481
  protocol?: components["schemas"]["Protocol"] | null;
14482
- /** @description Time range: 1h, 1d, 7d, or 30d */
14482
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14483
14483
  time_range?: components["schemas"]["TimeRange"];
14484
14484
  /** @description Exclude platform values: Unknown, Bot */
14485
14485
  exclude_bots?: boolean;