@opusdns/api 0.316.0 → 0.318.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.316.0",
6
+ "version": "0.318.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -3534,6 +3534,7 @@ export const METRICS_GROUPING = {
3534
3534
  FQDN: "fqdn",
3535
3535
  DOMAIN: "domain",
3536
3536
  FORWARD: "forward",
3537
+ RULE: "rule",
3537
3538
  } as const satisfies Record<string, MetricsGrouping>;
3538
3539
 
3539
3540
  /**
@@ -3561,7 +3562,8 @@ export const METRICS_GROUPING_VALUES = [
3561
3562
  'url',
3562
3563
  'fqdn',
3563
3564
  'domain',
3564
- 'forward'
3565
+ 'forward',
3566
+ 'rule'
3565
3567
  ] as const satisfies [string, ...string[]] | MetricsGrouping[];
3566
3568
 
3567
3569
  /**
@@ -5431,6 +5433,7 @@ export const TIME_RANGE = {
5431
5433
  "1D": "1d",
5432
5434
  "7D": "7d",
5433
5435
  "30D": "30d",
5436
+ "1Y": "1y",
5434
5437
  } as const satisfies Record<string, TimeRange>;
5435
5438
 
5436
5439
  /**
@@ -5458,7 +5461,8 @@ export const TIME_RANGE_VALUES = [
5458
5461
  '1h',
5459
5462
  '1d',
5460
5463
  '7d',
5461
- '30d'
5464
+ '30d',
5465
+ '1y'
5462
5466
  ] as const satisfies [string, ...string[]] | TimeRange[];
5463
5467
 
5464
5468
  /**
@@ -28848,6 +28848,30 @@ export const KEYS_LEGAL_REQUIREMENT_BASE = [
28848
28848
  * @see {@link KEYS_LOCAL_PRESENCE_BASE} - Array of all keys for this type
28849
28849
  */
28850
28850
  export const KEY_LOCAL_PRESENCE_BASE_ELIGIBLE_COUNTRIES: keyof LocalPresenceBase = 'eligible_countries';
28851
+ /**
28852
+ * Exemptions
28853
+ *
28854
+ *
28855
+ *
28856
+ *
28857
+ * @remarks
28858
+ * This key constant provides type-safe access to the `exemptions` property of LocalPresenceBase objects.
28859
+ * Use this constant when you need to access properties dynamically or ensure type safety.
28860
+ *
28861
+ * @example
28862
+ * ```typescript
28863
+ * // Direct property access
28864
+ * const value = localpresencebase[KEY_LOCAL_PRESENCE_BASE_EXEMPTIONS];
28865
+ *
28866
+ * // Dynamic property access
28867
+ * const propertyName = KEY_LOCAL_PRESENCE_BASE_EXEMPTIONS;
28868
+ * const value = localpresencebase[propertyName];
28869
+ * ```
28870
+ *
28871
+ * @see {@link LocalPresenceBase} - The TypeScript type definition
28872
+ * @see {@link KEYS_LOCAL_PRESENCE_BASE} - Array of all keys for this type
28873
+ */
28874
+ export const KEY_LOCAL_PRESENCE_BASE_EXEMPTIONS: keyof LocalPresenceBase = 'exemptions';
28851
28875
  /**
28852
28876
  * Required
28853
28877
  *
@@ -28947,6 +28971,7 @@ export const KEY_LOCAL_PRESENCE_BASE_TYPE: keyof LocalPresenceBase = 'type';
28947
28971
  */
28948
28972
  export const KEYS_LOCAL_PRESENCE_BASE = [
28949
28973
  KEY_LOCAL_PRESENCE_BASE_ELIGIBLE_COUNTRIES,
28974
+ KEY_LOCAL_PRESENCE_BASE_EXEMPTIONS,
28950
28975
  KEY_LOCAL_PRESENCE_BASE_REQUIRED,
28951
28976
  KEY_LOCAL_PRESENCE_BASE_REQUIREMENT,
28952
28977
  KEY_LOCAL_PRESENCE_BASE_TYPE,
@@ -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
@@ -7048,6 +7048,13 @@ components:
7048
7048
  - type: 'null'
7049
7049
  description: ISO 3166-1 Alpha-2 country code
7050
7050
  title: Eligible Countries
7051
+ exemptions:
7052
+ anyOf:
7053
+ - items:
7054
+ $ref: '#/components/schemas/AttributeCondition'
7055
+ type: array
7056
+ - type: 'null'
7057
+ title: Exemptions
7051
7058
  required:
7052
7059
  description: Whether a local presence is required to register and maintain
7053
7060
  a domain name
@@ -7292,6 +7299,7 @@ components:
7292
7299
  - fqdn
7293
7300
  - domain
7294
7301
  - forward
7302
+ - rule
7295
7303
  title: MetricsGrouping
7296
7304
  type: string
7297
7305
  Nameserver:
@@ -10073,6 +10081,7 @@ components:
10073
10081
  - 1d
10074
10082
  - 7d
10075
10083
  - 30d
10084
+ - 1y
10076
10085
  title: TimeRange
10077
10086
  type: string
10078
10087
  TimeSeriesBucket:
@@ -11583,7 +11592,7 @@ info:
11583
11592
  \n\n"
11584
11593
  summary: OpusDNS - your gateway to a seamless domain management experience.
11585
11594
  title: OpusDNS API
11586
- version: 2026-05-29-142222
11595
+ version: 2026-06-02-110819
11587
11596
  x-logo:
11588
11597
  altText: OpusDNS API Reference
11589
11598
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -16719,14 +16728,14 @@ paths:
16719
16728
  - type: 'null'
16720
16729
  description: 'Filter by protocol: http or https'
16721
16730
  title: Protocol
16722
- - description: 'Time range: 1h, 1d, 7d, or 30d'
16731
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16723
16732
  in: query
16724
16733
  name: time_range
16725
16734
  required: false
16726
16735
  schema:
16727
16736
  $ref: '#/components/schemas/TimeRange'
16728
16737
  default: 1d
16729
- description: 'Time range: 1h, 1d, 7d, or 30d'
16738
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16730
16739
  - description: 'Exclude platform values: Unknown, Bot'
16731
16740
  in: query
16732
16741
  name: exclude_bots
@@ -16837,14 +16846,14 @@ paths:
16837
16846
  - type: 'null'
16838
16847
  description: 'Filter by protocol: http or https'
16839
16848
  title: Protocol
16840
- - description: 'Time range: 1h, 1d, 7d, or 30d'
16849
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16841
16850
  in: query
16842
16851
  name: time_range
16843
16852
  required: false
16844
16853
  schema:
16845
16854
  $ref: '#/components/schemas/TimeRange'
16846
16855
  default: 1d
16847
- description: 'Time range: 1h, 1d, 7d, or 30d'
16856
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16848
16857
  - description: 'Exclude platform values: Unknown, Bot'
16849
16858
  in: query
16850
16859
  name: exclude_bots
@@ -16978,14 +16987,14 @@ paths:
16978
16987
  - type: 'null'
16979
16988
  description: 'Filter by protocol: http or https'
16980
16989
  title: Protocol
16981
- - description: 'Time range: 1h, 1d, 7d, or 30d'
16990
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16982
16991
  in: query
16983
16992
  name: time_range
16984
16993
  required: false
16985
16994
  schema:
16986
16995
  $ref: '#/components/schemas/TimeRange'
16987
16996
  default: 1d
16988
- description: 'Time range: 1h, 1d, 7d, or 30d'
16997
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
16989
16998
  - description: 'Exclude platform values: Unknown, Bot'
16990
16999
  in: query
16991
17000
  name: exclude_bots
@@ -17112,14 +17121,14 @@ paths:
17112
17121
  - type: 'null'
17113
17122
  description: 'Filter by protocol: http or https'
17114
17123
  title: Protocol
17115
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17124
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17116
17125
  in: query
17117
17126
  name: time_range
17118
17127
  required: false
17119
17128
  schema:
17120
17129
  $ref: '#/components/schemas/TimeRange'
17121
17130
  default: 1d
17122
- description: 'Time range: 1h, 1d, 7d, or 30d'
17131
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17123
17132
  - description: 'Exclude platform values: Unknown, Bot'
17124
17133
  in: query
17125
17134
  name: exclude_bots
@@ -17251,14 +17260,14 @@ paths:
17251
17260
  - type: 'null'
17252
17261
  description: 'Filter by protocol: http or https'
17253
17262
  title: Protocol
17254
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17263
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17255
17264
  in: query
17256
17265
  name: time_range
17257
17266
  required: false
17258
17267
  schema:
17259
17268
  $ref: '#/components/schemas/TimeRange'
17260
17269
  default: 1d
17261
- description: 'Time range: 1h, 1d, 7d, or 30d'
17270
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17262
17271
  - description: 'Exclude platform values: Unknown, Bot'
17263
17272
  in: query
17264
17273
  name: exclude_bots
@@ -17392,14 +17401,14 @@ paths:
17392
17401
  - type: 'null'
17393
17402
  description: 'Filter by protocol: http or https'
17394
17403
  title: Protocol
17395
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17404
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17396
17405
  in: query
17397
17406
  name: time_range
17398
17407
  required: false
17399
17408
  schema:
17400
17409
  $ref: '#/components/schemas/TimeRange'
17401
17410
  default: 1d
17402
- description: 'Time range: 1h, 1d, 7d, or 30d'
17411
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17403
17412
  - description: 'Exclude platform values: Unknown, Bot'
17404
17413
  in: query
17405
17414
  name: exclude_bots
@@ -17519,14 +17528,14 @@ paths:
17519
17528
  - type: 'null'
17520
17529
  description: 'Filter by protocol: http or https'
17521
17530
  title: Protocol
17522
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17531
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17523
17532
  in: query
17524
17533
  name: time_range
17525
17534
  required: false
17526
17535
  schema:
17527
17536
  $ref: '#/components/schemas/TimeRange'
17528
17537
  default: 1d
17529
- description: 'Time range: 1h, 1d, 7d, or 30d'
17538
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17530
17539
  - description: 'Exclude platform values: Unknown, Bot'
17531
17540
  in: query
17532
17541
  name: exclude_bots
@@ -17692,14 +17701,14 @@ paths:
17692
17701
  - type: 'null'
17693
17702
  description: 'Filter by protocol: http or https'
17694
17703
  title: Protocol
17695
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17704
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17696
17705
  in: query
17697
17706
  name: time_range
17698
17707
  required: false
17699
17708
  schema:
17700
17709
  $ref: '#/components/schemas/TimeRange'
17701
17710
  default: 1d
17702
- description: 'Time range: 1h, 1d, 7d, or 30d'
17711
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17703
17712
  - description: 'Exclude platform values: Unknown, Bot'
17704
17713
  in: query
17705
17714
  name: exclude_bots
@@ -17796,17 +17805,17 @@ paths:
17796
17805
  /v1/domain-forwards/metrics/visits-by-key:
17797
17806
  get:
17798
17807
  description: Retrieves visit metrics grouped by a specified key (url, fqdn,
17799
- domain, or forward) with total and unique visit counts.
17808
+ domain, forward, or rule) with total and unique visit counts.
17800
17809
  operationId: visits_by_key_v1_domain_forwards_metrics_visits_by_key_get
17801
17810
  parameters:
17802
- - description: 'Grouping key: url, fqdn, domain, or forward'
17811
+ - description: 'Grouping key: url, fqdn, domain, forward, or rule'
17803
17812
  in: query
17804
17813
  name: grouping
17805
17814
  required: false
17806
17815
  schema:
17807
17816
  $ref: '#/components/schemas/MetricsGrouping'
17808
17817
  default: domain
17809
- description: 'Grouping key: url, fqdn, domain, or forward'
17818
+ description: 'Grouping key: url, fqdn, domain, forward, or rule'
17810
17819
  - in: query
17811
17820
  name: hostname
17812
17821
  required: false
@@ -17833,14 +17842,14 @@ paths:
17833
17842
  - type: 'null'
17834
17843
  description: 'Filter by protocol: http or https'
17835
17844
  title: Protocol
17836
- - description: 'Time range: 1h, 1d, 7d, or 30d'
17845
+ - description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17837
17846
  in: query
17838
17847
  name: time_range
17839
17848
  required: false
17840
17849
  schema:
17841
17850
  $ref: '#/components/schemas/TimeRange'
17842
17851
  default: 1d
17843
- description: 'Time range: 1h, 1d, 7d, or 30d'
17852
+ description: 'Time range: 1h, 1d, 7d, 30d, or 1y'
17844
17853
  - description: 'Exclude platform values: Unknown, Bot'
17845
17854
  in: query
17846
17855
  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;
@@ -7147,6 +7147,8 @@ export interface components {
7147
7147
  * @description ISO 3166-1 Alpha-2 country code
7148
7148
  */
7149
7149
  eligible_countries?: string[] | null;
7150
+ /** Exemptions */
7151
+ exemptions?: components["schemas"]["AttributeCondition"][] | null;
7150
7152
  /**
7151
7153
  * Required
7152
7154
  * @description Whether a local presence is required to register and maintain a domain name
@@ -7301,7 +7303,7 @@ export interface components {
7301
7303
  * MetricsGrouping
7302
7304
  * @enum {string}
7303
7305
  */
7304
- MetricsGrouping: "url" | "fqdn" | "domain" | "forward";
7306
+ MetricsGrouping: "url" | "fqdn" | "domain" | "forward" | "rule";
7305
7307
  /** Nameserver */
7306
7308
  Nameserver: {
7307
7309
  /**
@@ -9068,7 +9070,7 @@ export interface components {
9068
9070
  * TimeRange
9069
9071
  * @enum {string}
9070
9072
  */
9071
- TimeRange: "1h" | "1d" | "7d" | "30d";
9073
+ TimeRange: "1h" | "1d" | "7d" | "30d" | "1y";
9072
9074
  /** TimeSeriesBucket */
9073
9075
  TimeSeriesBucket: {
9074
9076
  /**
@@ -13819,7 +13821,7 @@ export interface operations {
13819
13821
  domain?: string | null;
13820
13822
  /** @description Filter by protocol: http or https */
13821
13823
  protocol?: components["schemas"]["Protocol"] | null;
13822
- /** @description Time range: 1h, 1d, 7d, or 30d */
13824
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
13823
13825
  time_range?: components["schemas"]["TimeRange"];
13824
13826
  /** @description Exclude platform values: Unknown, Bot */
13825
13827
  exclude_bots?: boolean;
@@ -13901,7 +13903,7 @@ export interface operations {
13901
13903
  domain?: string | null;
13902
13904
  /** @description Filter by protocol: http or https */
13903
13905
  protocol?: components["schemas"]["Protocol"] | null;
13904
- /** @description Time range: 1h, 1d, 7d, or 30d */
13906
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
13905
13907
  time_range?: components["schemas"]["TimeRange"];
13906
13908
  /** @description Exclude platform values: Unknown, Bot */
13907
13909
  exclude_bots?: boolean;
@@ -13983,7 +13985,7 @@ export interface operations {
13983
13985
  domain?: string | null;
13984
13986
  /** @description Filter by protocol: http or https */
13985
13987
  protocol?: components["schemas"]["Protocol"] | null;
13986
- /** @description Time range: 1h, 1d, 7d, or 30d */
13988
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
13987
13989
  time_range?: components["schemas"]["TimeRange"];
13988
13990
  /** @description Exclude platform values: Unknown, Bot */
13989
13991
  exclude_bots?: boolean;
@@ -14065,7 +14067,7 @@ export interface operations {
14065
14067
  domain?: string | null;
14066
14068
  /** @description Filter by protocol: http or https */
14067
14069
  protocol?: components["schemas"]["Protocol"] | null;
14068
- /** @description Time range: 1h, 1d, 7d, or 30d */
14070
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14069
14071
  time_range?: components["schemas"]["TimeRange"];
14070
14072
  /** @description Exclude platform values: Unknown, Bot */
14071
14073
  exclude_bots?: boolean;
@@ -14147,7 +14149,7 @@ export interface operations {
14147
14149
  domain?: string | null;
14148
14150
  /** @description Filter by protocol: http or https */
14149
14151
  protocol?: components["schemas"]["Protocol"] | null;
14150
- /** @description Time range: 1h, 1d, 7d, or 30d */
14152
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14151
14153
  time_range?: components["schemas"]["TimeRange"];
14152
14154
  /** @description Exclude platform values: Unknown, Bot */
14153
14155
  exclude_bots?: boolean;
@@ -14229,7 +14231,7 @@ export interface operations {
14229
14231
  domain?: string | null;
14230
14232
  /** @description Filter by protocol: http or https */
14231
14233
  protocol?: components["schemas"]["Protocol"] | null;
14232
- /** @description Time range: 1h, 1d, 7d, or 30d */
14234
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14233
14235
  time_range?: components["schemas"]["TimeRange"];
14234
14236
  /** @description Exclude platform values: Unknown, Bot */
14235
14237
  exclude_bots?: boolean;
@@ -14311,7 +14313,7 @@ export interface operations {
14311
14313
  domain?: string | null;
14312
14314
  /** @description Filter by protocol: http or https */
14313
14315
  protocol?: components["schemas"]["Protocol"] | null;
14314
- /** @description Time range: 1h, 1d, 7d, or 30d */
14316
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14315
14317
  time_range?: components["schemas"]["TimeRange"];
14316
14318
  /** @description Exclude platform values: Unknown, Bot */
14317
14319
  exclude_bots?: boolean;
@@ -14393,7 +14395,7 @@ export interface operations {
14393
14395
  domain?: string | null;
14394
14396
  /** @description Filter by protocol: http or https */
14395
14397
  protocol?: components["schemas"]["Protocol"] | null;
14396
- /** @description Time range: 1h, 1d, 7d, or 30d */
14398
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14397
14399
  time_range?: components["schemas"]["TimeRange"];
14398
14400
  /** @description Exclude platform values: Unknown, Bot */
14399
14401
  exclude_bots?: boolean;
@@ -14471,13 +14473,13 @@ export interface operations {
14471
14473
  visits_by_key_v1_domain_forwards_metrics_visits_by_key_get: {
14472
14474
  parameters: {
14473
14475
  query?: {
14474
- /** @description Grouping key: url, fqdn, domain, or forward */
14476
+ /** @description Grouping key: url, fqdn, domain, forward, or rule */
14475
14477
  grouping?: components["schemas"]["MetricsGrouping"];
14476
14478
  hostname?: string | null;
14477
14479
  domain?: string | null;
14478
14480
  /** @description Filter by protocol: http or https */
14479
14481
  protocol?: components["schemas"]["Protocol"] | null;
14480
- /** @description Time range: 1h, 1d, 7d, or 30d */
14482
+ /** @description Time range: 1h, 1d, 7d, 30d, or 1y */
14481
14483
  time_range?: components["schemas"]["TimeRange"];
14482
14484
  /** @description Exclude platform values: Unknown, Bot */
14483
14485
  exclude_bots?: boolean;