diff --git a/.stats.yml b/.stats.yml index 97a2d9aecb8..a65e40c11eb 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 1542 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-948db90b67e56eee030c84195a5836541eb93a4bc6b46571f1b00d4cf069eb10.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-fc5b966b698b287edea83ecae20186c967fd805bfd665e0b1d0aec760ee85636.yml diff --git a/src/cloudflare/resources/radar/ai/bots/summary.py b/src/cloudflare/resources/radar/ai/bots/summary.py index 1076459c8c1..9547fb5c7e3 100644 --- a/src/cloudflare/resources/radar/ai/bots/summary.py +++ b/src/cloudflare/resources/radar/ai/bots/summary.py @@ -69,38 +69,37 @@ def user_agent( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryUserAgentResponse: """ - Percentage of Internet traffic generated by AI user agents, over a given time - period. + Retrieves the distribution of traffic by AI user agent. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -177,38 +176,37 @@ async def user_agent( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryUserAgentResponse: """ - Percentage of Internet traffic generated by AI user agents, over a given time - period. + Retrieves the distribution of traffic by AI user agent. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/ai/inference/summary.py b/src/cloudflare/resources/radar/ai/inference/summary.py index 35c328e190b..0c4077bb433 100644 --- a/src/cloudflare/resources/radar/ai/inference/summary.py +++ b/src/cloudflare/resources/radar/ai/inference/summary.py @@ -67,25 +67,25 @@ def model( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryModelResponse: """ - Percentage distribution of unique accounts by model. + Retrieves the distribution of unique accounts by model. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -135,25 +135,25 @@ def task( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryTaskResponse: """ - Percentage distribution of unique accounts by task. + Retrieves the distribution of unique accounts by task. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -224,25 +224,25 @@ async def model( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryModelResponse: """ - Percentage distribution of unique accounts by model. + Retrieves the distribution of unique accounts by model. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -292,25 +292,25 @@ async def task( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryTaskResponse: """ - Percentage distribution of unique accounts by task. + Retrieves the distribution of unique accounts by task. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/ai/inference/timeseries_groups/summary.py b/src/cloudflare/resources/radar/ai/inference/timeseries_groups/summary.py index 07207a2072a..97cb3719965 100644 --- a/src/cloudflare/resources/radar/ai/inference/timeseries_groups/summary.py +++ b/src/cloudflare/resources/radar/ai/inference/timeseries_groups/summary.py @@ -68,7 +68,7 @@ def model( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryModelResponse: """ - Percentage distribution of unique accounts by model over time. + Retrieves the distribution of unique accounts by model over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes @@ -77,20 +77,20 @@ def model( date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -142,7 +142,7 @@ def task( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryTaskResponse: """ - Percentage distribution of unique accounts by task over time. + Retrieves the distribution of unique accounts by task over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes @@ -151,20 +151,20 @@ def task( date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -237,7 +237,7 @@ async def model( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryModelResponse: """ - Percentage distribution of unique accounts by model over time. + Retrieves the distribution of unique accounts by model over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes @@ -246,20 +246,20 @@ async def model( date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -311,7 +311,7 @@ async def task( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryTaskResponse: """ - Percentage distribution of unique accounts by task over time. + Retrieves the distribution of unique accounts by task over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes @@ -320,20 +320,20 @@ async def task( date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/ai/timeseries_groups.py b/src/cloudflare/resources/radar/ai/timeseries_groups.py index ccd3113a42a..13ff03031e0 100644 --- a/src/cloudflare/resources/radar/ai/timeseries_groups.py +++ b/src/cloudflare/resources/radar/ai/timeseries_groups.py @@ -70,41 +70,41 @@ def user_agent( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupUserAgentResponse: """ - Percentage distribution of traffic per AI user agent over time. + Retrieves the distribution of traffic by AI user agent over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -183,41 +183,41 @@ async def user_agent( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupUserAgentResponse: """ - Percentage distribution of traffic per AI user agent over time. + Retrieves the distribution of traffic by AI user agent over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/annotations/annotations.py b/src/cloudflare/resources/radar/annotations/annotations.py index 256eeb936d2..344c1d84fa5 100644 --- a/src/cloudflare/resources/radar/annotations/annotations.py +++ b/src/cloudflare/resources/radar/annotations/annotations.py @@ -80,10 +80,10 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AnnotationListResponse: """ - Get the latest annotations. + Retrieves the latest annotations. Args: - asn: Single ASN as integer. + asn: Single Autonomous System Number (ASN) as integer. date_end: End of the date range (inclusive). @@ -92,13 +92,13 @@ def list( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 code. + location: Location alpha-2 code. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers @@ -177,10 +177,10 @@ async def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AnnotationListResponse: """ - Get the latest annotations. + Retrieves the latest annotations. Args: - asn: Single ASN as integer. + asn: Single Autonomous System Number (ASN) as integer. date_end: End of the date range (inclusive). @@ -189,13 +189,13 @@ async def list( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 code. + location: Location alpha-2 code. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/annotations/outages.py b/src/cloudflare/resources/radar/annotations/outages.py index 9c920789a3c..9e2e19b0e6b 100644 --- a/src/cloudflare/resources/radar/annotations/outages.py +++ b/src/cloudflare/resources/radar/annotations/outages.py @@ -69,10 +69,10 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> OutageGetResponse: """ - Get latest Internet outages and anomalies. + Retrieves the latest Internet outages and anomalies. Args: - asn: Single ASN as integer. + asn: Single Autonomous System Number (ASN) as integer. date_end: End of the date range (inclusive). @@ -81,13 +81,13 @@ def get( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 code. + location: Location alpha-2 code. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers @@ -138,7 +138,7 @@ def locations( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> OutageLocationsResponse: """ - Get the number of outages by location. + Retrieves the number of outages by location. Args: date_end: End of the date range (inclusive). @@ -148,9 +148,9 @@ def locations( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. extra_headers: Send extra headers @@ -222,10 +222,10 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> OutageGetResponse: """ - Get latest Internet outages and anomalies. + Retrieves the latest Internet outages and anomalies. Args: - asn: Single ASN as integer. + asn: Single Autonomous System Number (ASN) as integer. date_end: End of the date range (inclusive). @@ -234,13 +234,13 @@ async def get( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 code. + location: Location alpha-2 code. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers @@ -291,7 +291,7 @@ async def locations( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> OutageLocationsResponse: """ - Get the number of outages by location. + Retrieves the number of outages by location. Args: date_end: End of the date range (inclusive). @@ -301,9 +301,9 @@ async def locations( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/as112/as112.py b/src/cloudflare/resources/radar/as112/as112.py index 094b93b8aad..1880df373c6 100644 --- a/src/cloudflare/resources/radar/as112/as112.py +++ b/src/cloudflare/resources/radar/as112/as112.py @@ -105,36 +105,36 @@ def timeseries( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AS112TimeseriesResponse: """ - Get AS112 queries change over time. + Retrieves the AS112 DNS queries over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -223,36 +223,36 @@ async def timeseries( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AS112TimeseriesResponse: """ - Get AS112 queries change over time. + Retrieves the AS112 DNS queries over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/as112/summary.py b/src/cloudflare/resources/radar/as112/summary.py index a13d6d2bd54..5a6215294c7 100644 --- a/src/cloudflare/resources/radar/as112/summary.py +++ b/src/cloudflare/resources/radar/as112/summary.py @@ -80,32 +80,33 @@ def dnssec( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDNSSECResponse: """ - Percentage distribution of DNS queries to AS112 by DNSSEC support. + Retrieves the distribution of DNS queries to AS112 by DNSSEC (DNS Security + Extensions) support. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -159,32 +160,33 @@ def edns( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryEdnsResponse: """ - Percentage distribution of DNS queries to AS112 by EDNS support. + Retrieves the distribution of DNS queries to AS112 by EDNS (Extension Mechanisms + for DNS) support. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -238,32 +240,32 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of DNS queries to AS112 per IP Version. + Retrieves the distribution of DNS queries to AS112 by IP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -317,32 +319,32 @@ def protocol( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryProtocolResponse: """ - Percentage distribution of DNS queries to AS112 per protocol. + Retrieves the distribution of DNS queries to AS112 by protocol. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -397,37 +399,37 @@ def query_type( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryQueryTypeResponse: """ - Percentage distribution of DNS queries to AS112 by query type. + Retrieves the distribution of DNS queries to AS112 by type. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -483,37 +485,37 @@ def response_codes( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryResponseCodesResponse: """ - Percentage distribution of AS112 DNS requests classified by response code. + Retrieves the distribution of AS112 DNS requests classified by response code. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -589,32 +591,33 @@ async def dnssec( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDNSSECResponse: """ - Percentage distribution of DNS queries to AS112 by DNSSEC support. + Retrieves the distribution of DNS queries to AS112 by DNSSEC (DNS Security + Extensions) support. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -668,32 +671,33 @@ async def edns( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryEdnsResponse: """ - Percentage distribution of DNS queries to AS112 by EDNS support. + Retrieves the distribution of DNS queries to AS112 by EDNS (Extension Mechanisms + for DNS) support. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -747,32 +751,32 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of DNS queries to AS112 per IP Version. + Retrieves the distribution of DNS queries to AS112 by IP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -826,32 +830,32 @@ async def protocol( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryProtocolResponse: """ - Percentage distribution of DNS queries to AS112 per protocol. + Retrieves the distribution of DNS queries to AS112 by protocol. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -906,37 +910,37 @@ async def query_type( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryQueryTypeResponse: """ - Percentage distribution of DNS queries to AS112 by query type. + Retrieves the distribution of DNS queries to AS112 by type. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -992,37 +996,37 @@ async def response_codes( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryResponseCodesResponse: """ - Percentage distribution of AS112 DNS requests classified by response code. + Retrieves the distribution of AS112 DNS requests classified by response code. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/as112/timeseries_groups.py b/src/cloudflare/resources/radar/as112/timeseries_groups.py index db37c9b8831..d2500734ae2 100644 --- a/src/cloudflare/resources/radar/as112/timeseries_groups.py +++ b/src/cloudflare/resources/radar/as112/timeseries_groups.py @@ -81,36 +81,37 @@ def dnssec( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDNSSECResponse: """ - Percentage distribution of AS112 DNS queries by DNSSEC support over time. + Retrieves the distribution of AS112 DNS queries by DNSSEC (DNS Security + Extensions) support over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -166,36 +167,37 @@ def edns( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupEdnsResponse: """ - Percentage distribution of AS112 DNS queries by EDNS support over time. + Retrieves the distribution of AS112 DNS queries by EDNS (Extension Mechanisms + for DNS) support over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -251,36 +253,36 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Percentage distribution of AS112 DNS queries by IP version over time. + Retrieves the distribution of AS112 DNS queries by IP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -336,36 +338,37 @@ def protocol( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupProtocolResponse: """ - Percentage distribution of AS112 DNS requests classified by protocol over time. + Retrieves the distribution of AS112 DNS requests classified by protocol over + time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -422,41 +425,41 @@ def query_type( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupQueryTypeResponse: """ - Percentage distribution of AS112 DNS queries by query type over time. + Retrieves the distribution of AS112 DNS queries by type over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -514,42 +517,42 @@ def response_codes( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupResponseCodesResponse: """ - Percentage distribution of AS112 DNS requests classified by response code over - time. + Retrieves the distribution of AS112 DNS requests classified by response code + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -629,36 +632,37 @@ async def dnssec( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDNSSECResponse: """ - Percentage distribution of AS112 DNS queries by DNSSEC support over time. + Retrieves the distribution of AS112 DNS queries by DNSSEC (DNS Security + Extensions) support over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -714,36 +718,37 @@ async def edns( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupEdnsResponse: """ - Percentage distribution of AS112 DNS queries by EDNS support over time. + Retrieves the distribution of AS112 DNS queries by EDNS (Extension Mechanisms + for DNS) support over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -799,36 +804,36 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Percentage distribution of AS112 DNS queries by IP version over time. + Retrieves the distribution of AS112 DNS queries by IP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -884,36 +889,37 @@ async def protocol( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupProtocolResponse: """ - Percentage distribution of AS112 DNS requests classified by protocol over time. + Retrieves the distribution of AS112 DNS requests classified by protocol over + time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -970,41 +976,41 @@ async def query_type( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupQueryTypeResponse: """ - Percentage distribution of AS112 DNS queries by query type over time. + Retrieves the distribution of AS112 DNS queries by type over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -1062,42 +1068,42 @@ async def response_codes( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupResponseCodesResponse: """ - Percentage distribution of AS112 DNS requests classified by response code over - time. + Retrieves the distribution of AS112 DNS requests classified by response code + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/as112/top.py b/src/cloudflare/resources/radar/as112/top.py index 9bb43032129..449f5aaf19c 100644 --- a/src/cloudflare/resources/radar/as112/top.py +++ b/src/cloudflare/resources/radar/as112/top.py @@ -73,36 +73,37 @@ def dnssec( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopDNSSECResponse: """ - Get the top locations of DNS queries to AS112 with DNSSEC. + Retrieves the top locations of DNS queries to AS112 with DNSSEC (DNS Security + Extensions) support. Args: - dnssec: DNSSEC. + dnssec: DNSSEC (DNS Security Extensions) status. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -161,36 +162,37 @@ def edns( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopEdnsResponse: """ - Get the top locations of DNS queries to AS112 with EDNS support. + Retrieves the top locations of DNS queries to AS112 with EDNS (Extension + Mechanisms for DNS) support. Args: - edns: EDNS. + edns: EDNS (Extension Mechanisms for DNS) status. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -249,36 +251,36 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopIPVersionResponse: """ - Get the top locations of DNS queries to AS112 by IP version. + Retrieves the top locations of DNS queries to AS112 for an IP version. Args: - ip_version: IP Version. + ip_version: IP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -335,37 +337,35 @@ def locations( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopLocationsResponse: - """Get the top locations by AS112 DNS queries. - - Values are a percentage out of the - total queries. + """ + Retrieves the top locations by AS112 DNS queries. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -443,36 +443,37 @@ async def dnssec( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopDNSSECResponse: """ - Get the top locations of DNS queries to AS112 with DNSSEC. + Retrieves the top locations of DNS queries to AS112 with DNSSEC (DNS Security + Extensions) support. Args: - dnssec: DNSSEC. + dnssec: DNSSEC (DNS Security Extensions) status. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -531,36 +532,37 @@ async def edns( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopEdnsResponse: """ - Get the top locations of DNS queries to AS112 with EDNS support. + Retrieves the top locations of DNS queries to AS112 with EDNS (Extension + Mechanisms for DNS) support. Args: - edns: EDNS. + edns: EDNS (Extension Mechanisms for DNS) status. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -619,36 +621,36 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopIPVersionResponse: """ - Get the top locations of DNS queries to AS112 by IP version. + Retrieves the top locations of DNS queries to AS112 for an IP version. Args: - ip_version: IP Version. + ip_version: IP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -705,37 +707,35 @@ async def locations( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopLocationsResponse: - """Get the top locations by AS112 DNS queries. - - Values are a percentage out of the - total queries. + """ + Retrieves the top locations by AS112 DNS queries. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/attacks/layer3/layer3.py b/src/cloudflare/resources/radar/attacks/layer3/layer3.py index 6bca4393fac..dd43093b010 100644 --- a/src/cloudflare/resources/radar/attacks/layer3/layer3.py +++ b/src/cloudflare/resources/radar/attacks/layer3/layer3.py @@ -110,43 +110,43 @@ def timeseries( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> Layer3TimeseriesResponse: """ - Get attacks change over time by bytes. + Retrieves layer 3 attacks over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. metric: Measurement units, eg. bytes. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -250,43 +250,43 @@ async def timeseries( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> Layer3TimeseriesResponse: """ - Get attacks change over time by bytes. + Retrieves layer 3 attacks over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. metric: Measurement units, eg. bytes. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). diff --git a/src/cloudflare/resources/radar/attacks/layer3/summary.py b/src/cloudflare/resources/radar/attacks/layer3/summary.py index aca17e78a54..3b3b37605d1 100644 --- a/src/cloudflare/resources/radar/attacks/layer3/summary.py +++ b/src/cloudflare/resources/radar/attacks/layer3/summary.py @@ -80,33 +80,33 @@ def bitrate( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryBitrateResponse: """ - Percentage distribution of attacks by bitrate. + Retrieves the distribution of layer 3 attacks by bitrate. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -166,33 +166,33 @@ def duration( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDurationResponse: """ - Percentage distribution of attacks by duration. + Retrieves the distribution of layer 3 attacks by duration. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -251,31 +251,31 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of attacks by ip version used. + Retrieves the distribution of layer 3 attacks by IP version. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -333,33 +333,33 @@ def protocol( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryProtocolResponse: """ - Percentage distribution of attacks by protocol used. + Retrieves the distribution of layer 3 attacks by protocol. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -417,38 +417,38 @@ def vector( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryVectorResponse: """ - Percentage distribution of attacks by vector. + Retrieves the distribution of layer 3 attacks by vector. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -530,33 +530,33 @@ async def bitrate( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryBitrateResponse: """ - Percentage distribution of attacks by bitrate. + Retrieves the distribution of layer 3 attacks by bitrate. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -616,33 +616,33 @@ async def duration( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDurationResponse: """ - Percentage distribution of attacks by duration. + Retrieves the distribution of layer 3 attacks by duration. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -701,31 +701,31 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of attacks by ip version used. + Retrieves the distribution of layer 3 attacks by IP version. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -783,33 +783,33 @@ async def protocol( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryProtocolResponse: """ - Percentage distribution of attacks by protocol used. + Retrieves the distribution of layer 3 attacks by protocol. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -867,38 +867,38 @@ async def vector( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryVectorResponse: """ - Percentage distribution of attacks by vector. + Retrieves the distribution of layer 3 attacks by vector. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. diff --git a/src/cloudflare/resources/radar/attacks/layer3/timeseries_groups.py b/src/cloudflare/resources/radar/attacks/layer3/timeseries_groups.py index 87d14552a5b..856fa90f19f 100644 --- a/src/cloudflare/resources/radar/attacks/layer3/timeseries_groups.py +++ b/src/cloudflare/resources/radar/attacks/layer3/timeseries_groups.py @@ -86,37 +86,37 @@ def bitrate( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupBitrateResponse: """ - Percentage distribution of attacks by bitrate over time. + Retrieves the distribution of layer 3 attacks by bitrate over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -183,37 +183,37 @@ def duration( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDurationResponse: """ - Percentage distribution of attacks by duration over time. + Retrieves the distribution of layer 3 attacks by duration over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -281,42 +281,42 @@ def industry( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIndustryResponse: """ - Percentage distribution of attacks by industry targeted over time. + Retrieves the distribution of layer 3 attacks by targeted industry over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -383,35 +383,35 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Percentage distribution of attacks by ip version used over time. + Retrieves the distribution of layer 3 attacks by IP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -476,37 +476,37 @@ def protocol( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupProtocolResponse: """ - Percentage distribution of attacks by protocol used over time. + Retrieves the distribution of layer 3 attacks by protocol over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -571,42 +571,42 @@ def vector( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupVectorResponse: """ - Percentage distribution of attacks by vector used over time. + Retrieves the distribution of layer 3 attacks by vector over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -675,42 +675,42 @@ def vertical( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupVerticalResponse: """ - Percentage distribution of attacks by vertical targeted over time. + Retrieves the distribution of layer 3 attacks by targeted vertical over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -799,37 +799,37 @@ async def bitrate( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupBitrateResponse: """ - Percentage distribution of attacks by bitrate over time. + Retrieves the distribution of layer 3 attacks by bitrate over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -896,37 +896,37 @@ async def duration( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDurationResponse: """ - Percentage distribution of attacks by duration over time. + Retrieves the distribution of layer 3 attacks by duration over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -994,42 +994,42 @@ async def industry( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIndustryResponse: """ - Percentage distribution of attacks by industry targeted over time. + Retrieves the distribution of layer 3 attacks by targeted industry over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1096,35 +1096,35 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Percentage distribution of attacks by ip version used over time. + Retrieves the distribution of layer 3 attacks by IP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1189,37 +1189,37 @@ async def protocol( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupProtocolResponse: """ - Percentage distribution of attacks by protocol used over time. + Retrieves the distribution of layer 3 attacks by protocol over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1284,42 +1284,42 @@ async def vector( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupVectorResponse: """ - Percentage distribution of attacks by vector used over time. + Retrieves the distribution of layer 3 attacks by vector over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1388,42 +1388,42 @@ async def vertical( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupVerticalResponse: """ - Percentage distribution of attacks by vertical targeted over time. + Retrieves the distribution of layer 3 attacks by targeted vertical over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. direction: Together with the `location` parameter, will apply the filter to origin or target location. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). diff --git a/src/cloudflare/resources/radar/attacks/layer3/top/locations.py b/src/cloudflare/resources/radar/attacks/layer3/top/locations.py index b2900433339..e36577d1114 100644 --- a/src/cloudflare/resources/radar/attacks/layer3/top/locations.py +++ b/src/cloudflare/resources/radar/attacks/layer3/top/locations.py @@ -71,32 +71,32 @@ def origin( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationOriginResponse: """ - Get the origin locations of attacks. + Retrieves the origin locations of layer 3 attacks. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -156,32 +156,32 @@ def target( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationTargetResponse: """ - Get the target locations of attacks. + Retrieves the target locations of layer 3 attacks. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -262,32 +262,32 @@ async def origin( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationOriginResponse: """ - Get the origin locations of attacks. + Retrieves the origin locations of layer 3 attacks. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -347,32 +347,32 @@ async def target( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationTargetResponse: """ - Get the target locations of attacks. + Retrieves the target locations of layer 3 attacks. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. diff --git a/src/cloudflare/resources/radar/attacks/layer3/top/top.py b/src/cloudflare/resources/radar/attacks/layer3/top/top.py index 14ef69d4b41..efb040bc725 100644 --- a/src/cloudflare/resources/radar/attacks/layer3/top/top.py +++ b/src/cloudflare/resources/radar/attacks/layer3/top/top.py @@ -76,6 +76,7 @@ def attacks( limit_direction: Literal["ORIGIN", "TARGET"] | NotGiven = NOT_GIVEN, limit_per_location: int | NotGiven = NOT_GIVEN, location: List[str] | NotGiven = NOT_GIVEN, + magnitude: Literal["MITIGATED_BYTES", "MITIGATED_ATTACKS"] | NotGiven = NOT_GIVEN, name: List[str] | NotGiven = NOT_GIVEN, normalization: Literal["PERCENTAGE", "MIN_MAX"] | NotGiven = NOT_GIVEN, protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] | NotGiven = NOT_GIVEN, @@ -86,44 +87,47 @@ def attacks( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAttacksResponse: - """Get the top attacks from origin to target location. + """Retrieves the top layer 3 attacks from origin to target location. - Values are a percentage out - of the total layer 3 attacks (with billing country). You can optionally limit - the number of attacks per origin/target location (useful if all the top attacks - are from or to the same location). + Values are a + percentage out of the total layer 3 attacks (with billing country). You can + optionally limit the number of attacks by origin/target location (useful if all + the top attacks are from or to the same location). Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. limit_direction: Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location. - limit_per_location: Limit the number of attacks per origin/target (refer to `limitDirection` + limit_per_location: Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + magnitude: Attack magnitude can be defined by total mitigated bytes or by total mitigated + attacks. + + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -157,6 +161,7 @@ def attacks( "limit_direction": limit_direction, "limit_per_location": limit_per_location, "location": location, + "magnitude": magnitude, "name": name, "normalization": normalization, "protocol": protocol, @@ -189,32 +194,32 @@ def industry( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopIndustryResponse: """ - Get the industries targeted by attacks. + Retrieves the top industries targeted by layer 3 attacks. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -274,32 +279,32 @@ def vertical( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopVerticalResponse: """ - Get the verticals targeted by attacks. + Retrieves the top verticals targeted by layer 3 attacks. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -376,6 +381,7 @@ async def attacks( limit_direction: Literal["ORIGIN", "TARGET"] | NotGiven = NOT_GIVEN, limit_per_location: int | NotGiven = NOT_GIVEN, location: List[str] | NotGiven = NOT_GIVEN, + magnitude: Literal["MITIGATED_BYTES", "MITIGATED_ATTACKS"] | NotGiven = NOT_GIVEN, name: List[str] | NotGiven = NOT_GIVEN, normalization: Literal["PERCENTAGE", "MIN_MAX"] | NotGiven = NOT_GIVEN, protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] | NotGiven = NOT_GIVEN, @@ -386,44 +392,47 @@ async def attacks( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAttacksResponse: - """Get the top attacks from origin to target location. + """Retrieves the top layer 3 attacks from origin to target location. - Values are a percentage out - of the total layer 3 attacks (with billing country). You can optionally limit - the number of attacks per origin/target location (useful if all the top attacks - are from or to the same location). + Values are a + percentage out of the total layer 3 attacks (with billing country). You can + optionally limit the number of attacks by origin/target location (useful if all + the top attacks are from or to the same location). Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. limit_direction: Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location. - limit_per_location: Limit the number of attacks per origin/target (refer to `limitDirection` + limit_per_location: Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. + + magnitude: Attack magnitude can be defined by total mitigated bytes or by total mitigated + attacks. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -457,6 +466,7 @@ async def attacks( "limit_direction": limit_direction, "limit_per_location": limit_per_location, "location": location, + "magnitude": magnitude, "name": name, "normalization": normalization, "protocol": protocol, @@ -489,32 +499,32 @@ async def industry( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopIndustryResponse: """ - Get the industries targeted by attacks. + Retrieves the top industries targeted by layer 3 attacks. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. @@ -574,32 +584,32 @@ async def vertical( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopVerticalResponse: """ - Get the verticals targeted by attacks. + Retrieves the top verticals targeted by layer 3 attacks. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. protocol: Array of L3/4 attack types. diff --git a/src/cloudflare/resources/radar/attacks/layer7/layer7.py b/src/cloudflare/resources/radar/attacks/layer7/layer7.py index 61a40334d00..1c7baf6c044 100644 --- a/src/cloudflare/resources/radar/attacks/layer7/layer7.py +++ b/src/cloudflare/resources/radar/attacks/layer7/layer7.py @@ -170,49 +170,47 @@ def timeseries( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> Layer7TimeseriesResponse: - """Get a timeseries of Layer 7 attacks. - - Values represent HTTP requests and are - normalized using min-max by default. + """ + Retrieves layer 7 attacks over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. attack: This field is deprecated, please use the new `mitigationProduct`. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -375,49 +373,47 @@ async def timeseries( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> Layer7TimeseriesResponse: - """Get a timeseries of Layer 7 attacks. - - Values represent HTTP requests and are - normalized using min-max by default. + """ + Retrieves layer 7 attacks over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. attack: This field is deprecated, please use the new `mitigationProduct`. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). diff --git a/src/cloudflare/resources/radar/attacks/layer7/summary.py b/src/cloudflare/resources/radar/attacks/layer7/summary.py index a5c52c855e7..328caa824cb 100644 --- a/src/cloudflare/resources/radar/attacks/layer7/summary.py +++ b/src/cloudflare/resources/radar/attacks/layer7/summary.py @@ -87,43 +87,43 @@ def http_method( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryHTTPMethodResponse: """ - Percentage distribution of attacks by http method used. + Retrieves the distribution of layer 7 attacks by HTTP method. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -239,38 +239,38 @@ def http_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryHTTPVersionResponse: """ - Percentage distribution of attacks by http version used. + Retrieves the distribution of layer 7 attacks by HTTP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -385,38 +385,38 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of attacks by ip version used. + Retrieves the distribution of layer 7 attacks by IP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -533,45 +533,45 @@ def managed_rules( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryManagedRulesResponse: """ - Percentage distribution of attacks by managed rules used. + Retrieves the distribution of layer 7 attacks by managed rules. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -684,43 +684,43 @@ def mitigation_product( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryMitigationProductResponse: """ - Percentage distribution of attacks by mitigation product used. + Retrieves the distribution of layer 7 attacks by mitigation product. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -808,43 +808,43 @@ async def http_method( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryHTTPMethodResponse: """ - Percentage distribution of attacks by http method used. + Retrieves the distribution of layer 7 attacks by HTTP method. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -960,38 +960,38 @@ async def http_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryHTTPVersionResponse: """ - Percentage distribution of attacks by http version used. + Retrieves the distribution of layer 7 attacks by HTTP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -1106,38 +1106,38 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of attacks by ip version used. + Retrieves the distribution of layer 7 attacks by IP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -1254,45 +1254,45 @@ async def managed_rules( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryManagedRulesResponse: """ - Percentage distribution of attacks by managed rules used. + Retrieves the distribution of layer 7 attacks by managed rules. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -1405,43 +1405,43 @@ async def mitigation_product( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryMitigationProductResponse: """ - Percentage distribution of attacks by mitigation product used. + Retrieves the distribution of layer 7 attacks by mitigation product. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/attacks/layer7/timeseries_groups.py b/src/cloudflare/resources/radar/attacks/layer7/timeseries_groups.py index 56029b47f92..906e022ac1d 100644 --- a/src/cloudflare/resources/radar/attacks/layer7/timeseries_groups.py +++ b/src/cloudflare/resources/radar/attacks/layer7/timeseries_groups.py @@ -95,47 +95,47 @@ def http_method( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupHTTPMethodResponse: """ - Percentage distribution of attacks by http method used over time. + Retrieves the distribution of layer 7 attacks by HTTP method over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -258,42 +258,42 @@ def http_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupHTTPVersionResponse: """ - Percentage distribution of attacks by http version used over time. + Retrieves the distribution of layer 7 attacks by HTTP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -417,49 +417,49 @@ def industry( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIndustryResponse: """ - Percentage distribution of attacks by targeted industry over time. + Retrieves the distribution of layer 7 attacks by targeted industry over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -583,42 +583,42 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Percentage distribution of attacks by ip version used over time. + Retrieves the distribution of layer 7 attacks by IP version used over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -742,49 +742,49 @@ def managed_rules( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupManagedRulesResponse: """ - Percentage distribution of attacks by managed rules used over time. + Retrieves the distribution of layer 7 attacks by managed rules over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -904,47 +904,47 @@ def mitigation_product( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupMitigationProductResponse: """ - Percentage distribution of attacks by mitigation product used over time. + Retrieves the distribution of layer 7 attacks by mitigation product over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1071,49 +1071,49 @@ def vertical( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupVerticalResponse: """ - Percentage distribution of attacks by targeted vertical over time. + Retrieves the distribution of layer 7 attacks by targeted vertical over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1209,47 +1209,47 @@ async def http_method( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupHTTPMethodResponse: """ - Percentage distribution of attacks by http method used over time. + Retrieves the distribution of layer 7 attacks by HTTP method over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1372,42 +1372,42 @@ async def http_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupHTTPVersionResponse: """ - Percentage distribution of attacks by http version used over time. + Retrieves the distribution of layer 7 attacks by HTTP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1531,49 +1531,49 @@ async def industry( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIndustryResponse: """ - Percentage distribution of attacks by targeted industry over time. + Retrieves the distribution of layer 7 attacks by targeted industry over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1697,42 +1697,42 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Percentage distribution of attacks by ip version used over time. + Retrieves the distribution of layer 7 attacks by IP version used over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -1856,49 +1856,49 @@ async def managed_rules( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupManagedRulesResponse: """ - Percentage distribution of attacks by managed rules used over time. + Retrieves the distribution of layer 7 attacks by managed rules over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -2018,47 +2018,47 @@ async def mitigation_product( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupMitigationProductResponse: """ - Percentage distribution of attacks by mitigation product used over time. + Retrieves the distribution of layer 7 attacks by mitigation product over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -2185,49 +2185,49 @@ async def vertical( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupVerticalResponse: """ - Percentage distribution of attacks by targeted vertical over time. + Retrieves the distribution of layer 7 attacks by targeted vertical over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). diff --git a/src/cloudflare/resources/radar/attacks/layer7/top/ases.py b/src/cloudflare/resources/radar/attacks/layer7/top/ases.py index 86b39630759..8bd44c9277d 100644 --- a/src/cloudflare/resources/radar/attacks/layer7/top/ases.py +++ b/src/cloudflare/resources/radar/attacks/layer7/top/ases.py @@ -126,42 +126,42 @@ def origin( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AseOriginResponse: - """Get the top origin Autonomous Systems of and by Layer 7 attacks. + """Retrieves the top origin autonomous systems of layer 7 attacks. - Values are a - percentage out of the total Layer 7 attacks. The origin Autonomous Systems is + Values are + percentages of the total layer 7 attacks, with the origin autonomous systems determined by the client IP address. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -298,42 +298,42 @@ async def origin( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AseOriginResponse: - """Get the top origin Autonomous Systems of and by Layer 7 attacks. + """Retrieves the top origin autonomous systems of layer 7 attacks. - Values are a - percentage out of the total Layer 7 attacks. The origin Autonomous Systems is + Values are + percentages of the total layer 7 attacks, with the origin autonomous systems determined by the client IP address. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/attacks/layer7/top/locations.py b/src/cloudflare/resources/radar/attacks/layer7/top/locations.py index 18ba7f902d7..021c164d462 100644 --- a/src/cloudflare/resources/radar/attacks/layer7/top/locations.py +++ b/src/cloudflare/resources/radar/attacks/layer7/top/locations.py @@ -127,42 +127,42 @@ def origin( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationOriginResponse: - """Get the top origin locations of and by Layer 7 attacks. + """Retrieves the top origin locations of layer 7 attacks. - Values are a percentage - out of the total Layer 7 attacks. The origin location is determined by the - client IP address. + Values are percentages of + the total layer 7 attacks, with the origin location determined by the client IP + address. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -277,38 +277,38 @@ def target( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationTargetResponse: - """Get the top target locations of and by layer 7 attacks. + """Retrieves the top target locations of and by layer 7 attacks. - Values are a percentage - out of the total layer 7 attacks. The target location is determined by the - attacked zone's billing country, when available. + Values are a + percentage out of the total layer 7 attacks. The target location is determined + by the attacked zone's billing country, when available. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -444,42 +444,42 @@ async def origin( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationOriginResponse: - """Get the top origin locations of and by Layer 7 attacks. + """Retrieves the top origin locations of layer 7 attacks. - Values are a percentage - out of the total Layer 7 attacks. The origin location is determined by the - client IP address. + Values are percentages of + the total layer 7 attacks, with the origin location determined by the client IP + address. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -594,38 +594,38 @@ async def target( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationTargetResponse: - """Get the top target locations of and by layer 7 attacks. + """Retrieves the top target locations of and by layer 7 attacks. - Values are a percentage - out of the total layer 7 attacks. The target location is determined by the - attacked zone's billing country, when available. + Values are a + percentage out of the total layer 7 attacks. The target location is determined + by the attacked zone's billing country, when available. Args: - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/attacks/layer7/top/top.py b/src/cloudflare/resources/radar/attacks/layer7/top/top.py index fde5eefb380..2db47e91bcb 100644 --- a/src/cloudflare/resources/radar/attacks/layer7/top/top.py +++ b/src/cloudflare/resources/radar/attacks/layer7/top/top.py @@ -157,58 +157,58 @@ def attacks( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAttacksResponse: - """Get the top attacks from origin to target location. + """Retrieves the top attacks from origin to target location. - Values are a percentage out - of the total Layer 7 attacks (with billing country). The attack magnitude can be + Values are percentages + of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. limit_direction: Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location. - limit_per_location: Limit the number of attacks per origin/target (refer to `limitDirection` + limit_per_location: Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. magnitude: Attack magnitude can be defined by total requests mitigated or by total zones attacked. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -334,42 +334,42 @@ def industry( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopIndustryResponse: """ - Get the industries targeted by attacks. + Retrieves the industries targeted by layer 7 attacks. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -488,42 +488,42 @@ def vertical( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopVerticalResponse: """ - Get the verticals targeted by attacks. + Retrieves the verticals targeted by layer 7 attacks. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -674,58 +674,58 @@ async def attacks( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAttacksResponse: - """Get the top attacks from origin to target location. + """Retrieves the top attacks from origin to target location. - Values are a percentage out - of the total Layer 7 attacks (with billing country). The attack magnitude can be + Values are percentages + of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks by origin/target location (useful if all the top attacks are from or to the same location). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. limit_direction: Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location. - limit_per_location: Limit the number of attacks per origin/target (refer to `limitDirection` + limit_per_location: Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. magnitude: Attack magnitude can be defined by total requests mitigated or by total zones attacked. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). @@ -851,42 +851,42 @@ async def industry( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopIndustryResponse: """ - Get the industries targeted by attacks. + Retrieves the industries targeted by layer 7 attacks. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -1005,42 +1005,42 @@ async def vertical( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopVerticalResponse: """ - Get the verticals targeted by attacks. + Retrieves the verticals targeted by layer 7 attacks. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_method: Filter for http method. + http_method: Filters results by HTTP method. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. mitigation_product: Array of L7 mitigation products. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/bgp/bgp.py b/src/cloudflare/resources/radar/bgp/bgp.py index f6f22267deb..fbbb25bc31a 100644 --- a/src/cloudflare/resources/radar/bgp/bgp.py +++ b/src/cloudflare/resources/radar/bgp/bgp.py @@ -128,32 +128,31 @@ def timeseries( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BGPTimeseriesResponse: - """Get BGP updates change over time. + """Retrieves BGP updates over time. - Raw values are returned. When requesting - updates for an autonomous system (AS), only BGP updates of type announcement are - returned. + When requesting updates for an autonomous + system, only BGP updates of type announcement are returned. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. prefix: Array of BGP network prefixes. @@ -253,32 +252,31 @@ async def timeseries( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BGPTimeseriesResponse: - """Get BGP updates change over time. + """Retrieves BGP updates over time. - Raw values are returned. When requesting - updates for an autonomous system (AS), only BGP updates of type announcement are - returned. + When requesting updates for an autonomous + system, only BGP updates of type announcement are returned. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. prefix: Array of BGP network prefixes. diff --git a/src/cloudflare/resources/radar/bgp/hijacks/events.py b/src/cloudflare/resources/radar/bgp/hijacks/events.py index 4d64f84b609..083e3e10c5f 100644 --- a/src/cloudflare/resources/radar/bgp/hijacks/events.py +++ b/src/cloudflare/resources/radar/bgp/hijacks/events.py @@ -72,9 +72,8 @@ def list( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SyncV4PagePagination[EventListResponse]: - """Get the BGP hijack events. - - (Beta) + """ + Retrieves the BGP hijack events. Args: date_end: End of the date range (inclusive). @@ -84,31 +83,31 @@ def list( date_start: Start of the date range (inclusive). - event_id: The unique identifier of a event + event_id: The unique identifier of a event. - format: Format results are returned in. + format: Format in which results will be returned. - hijacker_asn: The potential hijacker AS of a BGP hijack event + hijacker_asn: The potential hijacker AS of a BGP hijack event. - involved_asn: The potential hijacker or victim AS of a BGP hijack event + involved_asn: The potential hijacker or victim AS of a BGP hijack event. - involved_country: The country code of the potential hijacker or victim AS of a BGP hijack event + involved_country: The country code of the potential hijacker or victim AS of a BGP hijack event. - max_confidence: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high) + max_confidence: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high). - min_confidence: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high) + min_confidence: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high). - page: Current page number, starting from 1 + page: Current page number, starting from 1. - per_page: Number of entries per page + per_page: Number of entries per page. prefix: Network prefix, IPv4 or IPv6. - sort_by: Sort events by field + sort_by: Sorts results by the specified field. - sort_order: Sort order + sort_order: Sort order. - victim_asn: The potential victim AS of a BGP hijack event + victim_asn: The potential victim AS of a BGP hijack event. extra_headers: Send extra headers @@ -198,9 +197,8 @@ def list( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AsyncPaginator[EventListResponse, AsyncV4PagePagination[EventListResponse]]: - """Get the BGP hijack events. - - (Beta) + """ + Retrieves the BGP hijack events. Args: date_end: End of the date range (inclusive). @@ -210,31 +208,31 @@ def list( date_start: Start of the date range (inclusive). - event_id: The unique identifier of a event + event_id: The unique identifier of a event. - format: Format results are returned in. + format: Format in which results will be returned. - hijacker_asn: The potential hijacker AS of a BGP hijack event + hijacker_asn: The potential hijacker AS of a BGP hijack event. - involved_asn: The potential hijacker or victim AS of a BGP hijack event + involved_asn: The potential hijacker or victim AS of a BGP hijack event. - involved_country: The country code of the potential hijacker or victim AS of a BGP hijack event + involved_country: The country code of the potential hijacker or victim AS of a BGP hijack event. - max_confidence: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high) + max_confidence: The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high). - min_confidence: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high) + min_confidence: The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high). - page: Current page number, starting from 1 + page: Current page number, starting from 1. - per_page: Number of entries per page + per_page: Number of entries per page. prefix: Network prefix, IPv4 or IPv6. - sort_by: Sort events by field + sort_by: Sorts results by the specified field. - sort_order: Sort order + sort_order: Sort order. - victim_asn: The potential victim AS of a BGP hijack event + victim_asn: The potential victim AS of a BGP hijack event. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/bgp/ips.py b/src/cloudflare/resources/radar/bgp/ips.py index 81834c20455..0cc8214169f 100644 --- a/src/cloudflare/resources/radar/bgp/ips.py +++ b/src/cloudflare/resources/radar/bgp/ips.py @@ -69,31 +69,31 @@ def timeseries( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IPTimeseriesResponse: """ - Get time series data for the announced IP space count, represented as the number - of IPv4 /24s and IPv6 /48s, for a given ASN. + Retrieves time series data for the announced IP space count, represented as the + number of IPv4 /24s and IPv6 /48s, for a given ASN. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - include_delay: Include data delay meta information + include_delay: Include data delay meta information. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of locations (alpha-2 country codes). + location: Comma-separated list of locations (alpha-2 codes). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -170,31 +170,31 @@ async def timeseries( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IPTimeseriesResponse: """ - Get time series data for the announced IP space count, represented as the number - of IPv4 /24s and IPv6 /48s, for a given ASN. + Retrieves time series data for the announced IP space count, represented as the + number of IPv4 /24s and IPv6 /48s, for a given ASN. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - include_delay: Include data delay meta information + include_delay: Include data delay meta information. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of locations (alpha-2 country codes). + location: Comma-separated list of locations (alpha-2 codes). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/bgp/leaks/events.py b/src/cloudflare/resources/radar/bgp/leaks/events.py index 0803b94e860..18eb2258be0 100644 --- a/src/cloudflare/resources/radar/bgp/leaks/events.py +++ b/src/cloudflare/resources/radar/bgp/leaks/events.py @@ -69,7 +69,7 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SyncV4PagePagination[EventListResponse]: """ - Get the BGP route leak events (Beta). + Retrieves the BGP route leak events. Args: date_end: End of the date range (inclusive). @@ -79,23 +79,23 @@ def list( date_start: Start of the date range (inclusive). - event_id: The unique identifier of a event + event_id: The unique identifier of a event. - format: Format results are returned in. + format: Format in which results will be returned. - involved_asn: ASN that is causing or affected by a route leak event + involved_asn: ASN that is causing or affected by a route leak event. - involved_country: Country code of a involved ASN in a route leak event + involved_country: Country code of a involved ASN in a route leak event. - leak_asn: The leaking AS of a route leak event + leak_asn: The leaking AS of a route leak event. - page: Current page number, starting from 1 + page: Current page number, starting from 1. - per_page: Number of entries per page + per_page: Number of entries per page. - sort_by: Sort events by field + sort_by: Sorts results by the specified field. - sort_order: Sort order + sort_order: Sort order. extra_headers: Send extra headers @@ -178,7 +178,7 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AsyncPaginator[EventListResponse, AsyncV4PagePagination[EventListResponse]]: """ - Get the BGP route leak events (Beta). + Retrieves the BGP route leak events. Args: date_end: End of the date range (inclusive). @@ -188,23 +188,23 @@ def list( date_start: Start of the date range (inclusive). - event_id: The unique identifier of a event + event_id: The unique identifier of a event. - format: Format results are returned in. + format: Format in which results will be returned. - involved_asn: ASN that is causing or affected by a route leak event + involved_asn: ASN that is causing or affected by a route leak event. - involved_country: Country code of a involved ASN in a route leak event + involved_country: Country code of a involved ASN in a route leak event. - leak_asn: The leaking AS of a route leak event + leak_asn: The leaking AS of a route leak event. - page: Current page number, starting from 1 + page: Current page number, starting from 1. - per_page: Number of entries per page + per_page: Number of entries per page. - sort_by: Sort events by field + sort_by: Sorts results by the specified field. - sort_order: Sort order + sort_order: Sort order. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/bgp/routes.py b/src/cloudflare/resources/radar/bgp/routes.py index 479efb55eb2..7af5788eabc 100644 --- a/src/cloudflare/resources/radar/bgp/routes.py +++ b/src/cloudflare/resources/radar/bgp/routes.py @@ -59,7 +59,7 @@ def ases( location: str | NotGiven = NOT_GIVEN, sort_by: Literal["cone", "pfxs", "ipv4", "ipv6", "rpki_valid", "rpki_invalid", "rpki_unknown"] | NotGiven = NOT_GIVEN, - sort_order: Literal["asc", "desc"] | NotGiven = NOT_GIVEN, + sort_order: Literal["ASC", "DESC"] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -68,18 +68,18 @@ def ases( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RouteAsesResponse: """ - List all ASes in current global routing tables with routing statistics + Retrieves all ASes in the current global routing tables with routing statistics. Args: - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 code. + location: Location alpha-2 code. - sort_by: Return order results by given type + sort_by: Sorts results by the specified field. - sort_order: Sort by value ascending or descending + sort_order: Sort order. extra_headers: Send extra headers @@ -126,14 +126,14 @@ def moas( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RouteMoasResponse: """ - List all Multi-Origin AS (MOAS) prefixes on the global routing tables. + Retrieves all Multi-Origin AS (MOAS) prefixes in the global routing tables. Args: - format: Format results are returned in. + format: Format in which results will be returned. - invalid_only: Lookup only RPKI invalid MOASes + invalid_only: Lookup only RPKI invalid MOASes. - origin: Lookup MOASes originated by the given ASN + origin: Lookup MOASes originated by the given ASN. prefix: Network prefix, IPv4 or IPv6. @@ -182,19 +182,19 @@ def pfx2as( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RoutePfx2asResponse: """ - Lookup prefix-to-ASN mapping on global routing tables. + Retrieves the prefix-to-ASN mapping from global routing tables. Args: - format: Format results are returned in. + format: Format in which results will be returned. longest_prefix_match: Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address. - origin: Lookup prefixes originated by the given ASN + origin: Lookup prefixes originated by the given ASN. prefix: Network prefix, IPv4 or IPv6. - rpki_status: Return only results with matching rpki status: valid, invalid or unknown + rpki_status: Return only results with matching rpki status: valid, invalid or unknown. extra_headers: Send extra headers @@ -240,14 +240,14 @@ def stats( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RouteStatsResponse: """ - Get the BGP routing table stats (Beta). + Retrieves the BGP routing table stats. Args: - asn: Single ASN as integer. + asn: Single Autonomous System Number (ASN) as integer. - format: Format results are returned in. + format: Format in which results will be returned. - location: Location Alpha2 code. + location: Location alpha-2 code. extra_headers: Send extra headers @@ -306,7 +306,7 @@ async def ases( location: str | NotGiven = NOT_GIVEN, sort_by: Literal["cone", "pfxs", "ipv4", "ipv6", "rpki_valid", "rpki_invalid", "rpki_unknown"] | NotGiven = NOT_GIVEN, - sort_order: Literal["asc", "desc"] | NotGiven = NOT_GIVEN, + sort_order: Literal["ASC", "DESC"] | NotGiven = NOT_GIVEN, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -315,18 +315,18 @@ async def ases( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RouteAsesResponse: """ - List all ASes in current global routing tables with routing statistics + Retrieves all ASes in the current global routing tables with routing statistics. Args: - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 code. + location: Location alpha-2 code. - sort_by: Return order results by given type + sort_by: Sorts results by the specified field. - sort_order: Sort by value ascending or descending + sort_order: Sort order. extra_headers: Send extra headers @@ -373,14 +373,14 @@ async def moas( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RouteMoasResponse: """ - List all Multi-Origin AS (MOAS) prefixes on the global routing tables. + Retrieves all Multi-Origin AS (MOAS) prefixes in the global routing tables. Args: - format: Format results are returned in. + format: Format in which results will be returned. - invalid_only: Lookup only RPKI invalid MOASes + invalid_only: Lookup only RPKI invalid MOASes. - origin: Lookup MOASes originated by the given ASN + origin: Lookup MOASes originated by the given ASN. prefix: Network prefix, IPv4 or IPv6. @@ -429,19 +429,19 @@ async def pfx2as( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RoutePfx2asResponse: """ - Lookup prefix-to-ASN mapping on global routing tables. + Retrieves the prefix-to-ASN mapping from global routing tables. Args: - format: Format results are returned in. + format: Format in which results will be returned. longest_prefix_match: Return only results with the longest prefix match for the given prefix. For example, specify a /32 prefix to lookup the origin ASN for an IPv4 address. - origin: Lookup prefixes originated by the given ASN + origin: Lookup prefixes originated by the given ASN. prefix: Network prefix, IPv4 or IPv6. - rpki_status: Return only results with matching rpki status: valid, invalid or unknown + rpki_status: Return only results with matching rpki status: valid, invalid or unknown. extra_headers: Send extra headers @@ -487,14 +487,14 @@ async def stats( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RouteStatsResponse: """ - Get the BGP routing table stats (Beta). + Retrieves the BGP routing table stats. Args: - asn: Single ASN as integer. + asn: Single Autonomous System Number (ASN) as integer. - format: Format results are returned in. + format: Format in which results will be returned. - location: Location Alpha2 code. + location: Location alpha-2 code. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/bgp/top/ases.py b/src/cloudflare/resources/radar/bgp/top/ases.py index d727ffafcfb..bb7bd633d22 100644 --- a/src/cloudflare/resources/radar/bgp/top/ases.py +++ b/src/cloudflare/resources/radar/bgp/top/ases.py @@ -70,27 +70,26 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AseGetResponse: """ - Get the top autonomous systems (ASes) by BGP updates (announcements only). - Values are a percentage out of the total updates. + Retrieves the top autonomous systems by BGP updates (announcements only). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. prefix: Array of BGP network prefixes. @@ -144,16 +143,16 @@ def prefixes( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AsePrefixesResponse: """ - Get the full list of autonomous systems on the global routing table ordered by - announced prefixes count. The data comes from public BGP MRT data archives and - updates every 2 hours. + Retrieves the full list of autonomous systems on the global routing table + ordered by announced prefixes count. The data comes from public BGP MRT data + archives and updates every 2 hours. Args: country: Alpha-2 country code. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Maximum number of ASes to return + limit: Maximum number of ASes to return. extra_headers: Send extra headers @@ -224,27 +223,26 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AseGetResponse: """ - Get the top autonomous systems (ASes) by BGP updates (announcements only). - Values are a percentage out of the total updates. + Retrieves the top autonomous systems by BGP updates (announcements only). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. prefix: Array of BGP network prefixes. @@ -298,16 +296,16 @@ async def prefixes( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AsePrefixesResponse: """ - Get the full list of autonomous systems on the global routing table ordered by - announced prefixes count. The data comes from public BGP MRT data archives and - updates every 2 hours. + Retrieves the full list of autonomous systems on the global routing table + ordered by announced prefixes count. The data comes from public BGP MRT data + archives and updates every 2 hours. Args: country: Alpha-2 country code. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Maximum number of ASes to return + limit: Maximum number of ASes to return. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/bgp/top/top.py b/src/cloudflare/resources/radar/bgp/top/top.py index b7b5e4b2da6..4efd8dfcb92 100644 --- a/src/cloudflare/resources/radar/bgp/top/top.py +++ b/src/cloudflare/resources/radar/bgp/top/top.py @@ -79,29 +79,27 @@ def prefixes( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopPrefixesResponse: - """Get the top network prefixes by BGP updates. - - Values are a percentage out of the - total BGP updates. + """ + Retrieves the top network prefixes by BGP updates. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. update_type: Array of BGP update types. @@ -181,29 +179,27 @@ async def prefixes( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopPrefixesResponse: - """Get the top network prefixes by BGP updates. - - Values are a percentage out of the - total BGP updates. + """ + Retrieves the top network prefixes by BGP updates. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. update_type: Array of BGP update types. diff --git a/src/cloudflare/resources/radar/datasets.py b/src/cloudflare/resources/radar/datasets.py index 21c040a20a7..29c64c23f58 100644 --- a/src/cloudflare/resources/radar/datasets.py +++ b/src/cloudflare/resources/radar/datasets.py @@ -64,16 +64,16 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DatasetListResponse: """ - Get a list of datasets. + Retrieves a list of datasets. Args: - dataset_type: Dataset type. + dataset_type: Filters results by dataset type. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers @@ -117,10 +117,10 @@ def download( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DatasetDownloadResponse: """ - Get a URL to download a single dataset. + Retrieves an URL to download a single dataset. Args: - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -155,14 +155,14 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> str: - """Get the CSV content of a given dataset by alias or ID. + """Retrieves the CSV content of a given dataset by alias or ID. - When getting the content - by alias the latest dataset is returned, optionally filtered by the latest - available at a given date. + When getting the + content by alias the latest dataset is returned, optionally filtered by the + latest available at a given date. Args: - alias: Dataset alias or id + alias: Dataset alias or ID. extra_headers: Send extra headers @@ -219,16 +219,16 @@ async def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DatasetListResponse: """ - Get a list of datasets. + Retrieves a list of datasets. Args: - dataset_type: Dataset type. + dataset_type: Filters results by dataset type. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers @@ -272,10 +272,10 @@ async def download( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DatasetDownloadResponse: """ - Get a URL to download a single dataset. + Retrieves an URL to download a single dataset. Args: - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -310,14 +310,14 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> str: - """Get the CSV content of a given dataset by alias or ID. + """Retrieves the CSV content of a given dataset by alias or ID. - When getting the content - by alias the latest dataset is returned, optionally filtered by the latest - available at a given date. + When getting the + content by alias the latest dataset is returned, optionally filtered by the + latest available at a given date. Args: - alias: Dataset alias or id + alias: Dataset alias or ID. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/dns/top.py b/src/cloudflare/resources/radar/dns/top.py index fb7a902c77e..03e74c0c2fa 100644 --- a/src/cloudflare/resources/radar/dns/top.py +++ b/src/cloudflare/resources/radar/dns/top.py @@ -71,37 +71,37 @@ def ases( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAsesResponse: """ - Get top autonomous systems by DNS queries made to Cloudflare's public DNS + Retrieves the top autonomous systems by DNS queries made to 1.1.1.1 DNS resolver. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. domain: Array of domain names. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -159,36 +159,36 @@ def locations( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopLocationsResponse: """ - Get top locations by DNS queries made to Cloudflare's public DNS resolver. + Retrieves the top locations by DNS queries made to 1.1.1.1 DNS resolver. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. domain: Array of domain names. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -267,37 +267,37 @@ async def ases( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAsesResponse: """ - Get top autonomous systems by DNS queries made to Cloudflare's public DNS + Retrieves the top autonomous systems by DNS queries made to 1.1.1.1 DNS resolver. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. domain: Array of domain names. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -355,36 +355,36 @@ async def locations( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopLocationsResponse: """ - Get top locations by DNS queries made to Cloudflare's public DNS resolver. + Retrieves the top locations by DNS queries made to 1.1.1.1 DNS resolver. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. domain: Array of domain names. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/email/routing/summary.py b/src/cloudflare/resources/radar/email/routing/summary.py index a049898dce4..194e9a849bf 100644 --- a/src/cloudflare/resources/radar/email/routing/summary.py +++ b/src/cloudflare/resources/radar/email/routing/summary.py @@ -82,30 +82,32 @@ def arc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryARCResponse: """ - Percentage distribution of emails classified by ARC validation. + Retrieves the distribution of emails by ARC (Authenticated Received Chain) + validation. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -163,30 +165,32 @@ def dkim( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDKIMResponse: """ - Percentage distribution of emails classified by DKIM validation. + Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) + validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -244,30 +248,31 @@ def dmarc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDMARCResponse: """ - Percentage distribution of emails classified by DMARC validation. + Retrieves the distribution of emails by DMARC (Domain-based Message + Authentication, Reporting and Conformance) validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -325,30 +330,32 @@ def encrypted( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryEncryptedResponse: """ - Percentage distribution of emails by encryption status. + Retrieves the distribution of emails by encryption status (encrypted vs. + not-encrypted). Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -406,30 +413,31 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of emails by IP version. + Retrieves the distribution of emails by IP version. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -487,30 +495,32 @@ def spf( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummarySPFResponse: """ - Percentage distribution of emails classified by SPF validation. + Retrieves the distribution of emails by SPF (Sender Policy Framework) + validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -589,30 +599,32 @@ async def arc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryARCResponse: """ - Percentage distribution of emails classified by ARC validation. + Retrieves the distribution of emails by ARC (Authenticated Received Chain) + validation. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -670,30 +682,32 @@ async def dkim( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDKIMResponse: """ - Percentage distribution of emails classified by DKIM validation. + Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) + validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -751,30 +765,31 @@ async def dmarc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDMARCResponse: """ - Percentage distribution of emails classified by DMARC validation. + Retrieves the distribution of emails by DMARC (Domain-based Message + Authentication, Reporting and Conformance) validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -832,30 +847,32 @@ async def encrypted( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryEncryptedResponse: """ - Percentage distribution of emails by encryption status. + Retrieves the distribution of emails by encryption status (encrypted vs. + not-encrypted). Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -913,30 +930,31 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of emails by IP version. + Retrieves the distribution of emails by IP version. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -994,30 +1012,32 @@ async def spf( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummarySPFResponse: """ - Percentage distribution of emails classified by SPF validation. + Retrieves the distribution of emails by SPF (Sender Policy Framework) + validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/email/routing/timeseries_groups.py b/src/cloudflare/resources/radar/email/routing/timeseries_groups.py index 61c4de5e245..6e278e336c6 100644 --- a/src/cloudflare/resources/radar/email/routing/timeseries_groups.py +++ b/src/cloudflare/resources/radar/email/routing/timeseries_groups.py @@ -83,7 +83,8 @@ def arc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupARCResponse: """ - Percentage distribution of emails classified by ARC validation over time. + Retrieves the distribution of emails by ARC (Authenticated Received Chain) + validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes @@ -92,25 +93,26 @@ def arc( date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -170,34 +172,36 @@ def dkim( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDKIMResponse: """ - Percentage distribution of emails classified by DKIM validation over time. + Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) + validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -257,34 +261,35 @@ def dmarc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDMARCResponse: """ - Percentage distribution of emails classified by DMARC validation over time. + Retrieves the distribution of emails by DMARC (Domain-based Message + Authentication, Reporting and Conformance) validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -344,34 +349,36 @@ def encrypted( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupEncryptedResponse: """ - Percentage distribution of emails by encryption status over time. + Retrieves the distribution of emails by encryption status (encrypted vs. + not-encrypted) over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -431,34 +438,35 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Percentage distribution of emails by IP version over time. + Retrieves the distribution of emails by IP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -518,34 +526,36 @@ def spf( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupSPFResponse: """ - Percentage distribution of emails classified by SPF validation over time. + Retrieves the distribution of emails by SPF (Sender Policy Framework) validation + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -626,7 +636,8 @@ async def arc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupARCResponse: """ - Percentage distribution of emails classified by ARC validation over time. + Retrieves the distribution of emails by ARC (Authenticated Received Chain) + validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes @@ -635,25 +646,26 @@ async def arc( date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -713,34 +725,36 @@ async def dkim( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDKIMResponse: """ - Percentage distribution of emails classified by DKIM validation over time. + Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) + validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -800,34 +814,35 @@ async def dmarc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDMARCResponse: """ - Percentage distribution of emails classified by DMARC validation over time. + Retrieves the distribution of emails by DMARC (Domain-based Message + Authentication, Reporting and Conformance) validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -887,34 +902,36 @@ async def encrypted( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupEncryptedResponse: """ - Percentage distribution of emails by encryption status over time. + Retrieves the distribution of emails by encryption status (encrypted vs. + not-encrypted) over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -974,34 +991,35 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Percentage distribution of emails by IP version over time. + Retrieves the distribution of emails by IP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -1061,34 +1079,36 @@ async def spf( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupSPFResponse: """ - Percentage distribution of emails classified by SPF validation over time. + Retrieves the distribution of emails by SPF (Sender Policy Framework) validation + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - encrypted: Filter for encrypted emails. + encrypted: Filters results by encryption status (encrypted vs. not-encrypted). - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/email/security/summary.py b/src/cloudflare/resources/radar/email/security/summary.py index c2df082e757..a042307c97f 100644 --- a/src/cloudflare/resources/radar/email/security/summary.py +++ b/src/cloudflare/resources/radar/email/security/summary.py @@ -87,28 +87,30 @@ def arc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryARCResponse: """ - Percentage distribution of emails classified by ARC validation. + Retrieves the distribution of emails by ARC (Authenticated Received Chain) + validation. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -164,28 +166,30 @@ def dkim( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDKIMResponse: """ - Percentage distribution of emails classified by DKIM validation. + Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) + validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -241,28 +245,29 @@ def dmarc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDMARCResponse: """ - Percentage distribution of emails classified by DMARC validation. + Retrieves the distribution of emails by DMARC (Domain-based Message + Authentication, Reporting and Conformance) validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -319,30 +324,31 @@ def malicious( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryMaliciousResponse: """ - Percentage distribution of emails classified as MALICIOUS. + Retrieves the distribution of emails by malicious classification. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -399,31 +405,33 @@ def spam( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummarySpamResponse: - """ - Proportion of emails categorized as either spam or legitimate (non-spam). + """Retrieves the proportion of emails by spam classification (spam vs. + + non-spam). Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -480,28 +488,30 @@ def spf( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummarySPFResponse: """ - Percentage distribution of emails classified by SPF validation. + Retrieves the distribution of emails by SPF (Sender Policy Framework) + validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -558,30 +568,32 @@ def spoof( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummarySpoofResponse: """ - Proportion of emails categorized as either spoof or legitimate (non-spoof). + Retrieves the proportion of emails by spoof classification (spoof vs. + non-spoof). Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -639,30 +651,31 @@ def threat_category( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryThreatCategoryResponse: """ - Percentage distribution of emails classified in Threat Categories. + Retrieves the distribution of emails by threat categories. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -719,28 +732,29 @@ def tls_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryTLSVersionResponse: """ - Percentage distribution of emails classified by TLS version. + Retrieves the distribution of emails by TLS version. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -817,28 +831,30 @@ async def arc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryARCResponse: """ - Percentage distribution of emails classified by ARC validation. + Retrieves the distribution of emails by ARC (Authenticated Received Chain) + validation. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -894,28 +910,30 @@ async def dkim( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDKIMResponse: """ - Percentage distribution of emails classified by DKIM validation. + Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) + validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -971,28 +989,29 @@ async def dmarc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDMARCResponse: """ - Percentage distribution of emails classified by DMARC validation. + Retrieves the distribution of emails by DMARC (Domain-based Message + Authentication, Reporting and Conformance) validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1049,30 +1068,31 @@ async def malicious( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryMaliciousResponse: """ - Percentage distribution of emails classified as MALICIOUS. + Retrieves the distribution of emails by malicious classification. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1129,31 +1149,33 @@ async def spam( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummarySpamResponse: - """ - Proportion of emails categorized as either spam or legitimate (non-spam). + """Retrieves the proportion of emails by spam classification (spam vs. + + non-spam). Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1210,28 +1232,30 @@ async def spf( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummarySPFResponse: """ - Percentage distribution of emails classified by SPF validation. + Retrieves the distribution of emails by SPF (Sender Policy Framework) + validation. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1288,30 +1312,32 @@ async def spoof( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummarySpoofResponse: """ - Proportion of emails categorized as either spoof or legitimate (non-spoof). + Retrieves the proportion of emails by spoof classification (spoof vs. + non-spoof). Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1369,30 +1395,31 @@ async def threat_category( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryThreatCategoryResponse: """ - Percentage distribution of emails classified in Threat Categories. + Retrieves the distribution of emails by threat categories. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1449,28 +1476,29 @@ async def tls_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryTLSVersionResponse: """ - Percentage distribution of emails classified by TLS version. + Retrieves the distribution of emails by TLS version. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/email/security/timeseries_groups.py b/src/cloudflare/resources/radar/email/security/timeseries_groups.py index 9d1ee856d46..547044bbeee 100644 --- a/src/cloudflare/resources/radar/email/security/timeseries_groups.py +++ b/src/cloudflare/resources/radar/email/security/timeseries_groups.py @@ -90,7 +90,8 @@ def arc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupARCResponse: """ - Percentage distribution of emails classified by ARC validation over time. + Retrieves the distribution of emails by ARC (Authenticated Received Chain) + validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes @@ -99,23 +100,24 @@ def arc( date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -173,32 +175,34 @@ def dkim( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDKIMResponse: """ - Percentage distribution of emails classified by DKIM validation over time. + Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) + validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -256,32 +260,33 @@ def dmarc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDMARCResponse: """ - Percentage distribution of emails classified by DMARC validation over time. + Retrieves the distribution of emails by DMARC (Domain-based Message + Authentication, Reporting and Conformance) validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -340,34 +345,35 @@ def malicious( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupMaliciousResponse: """ - Percentage distribution of emails classified as MALICIOUS over time. + Retrieves the distribution of emails by malicious classification over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -426,35 +432,38 @@ def spam( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupSpamResponse: - """ - Percentage distribution of emails classified as SPAM over time. + """Retrieves the distribution of emails by spam classification (spam vs. + + non-spam) + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -513,32 +522,34 @@ def spf( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupSPFResponse: """ - Percentage distribution of emails classified by SPF validation over time. + Retrieves the distribution of emails by SPF (Sender Policy Framework) validation + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -597,34 +608,36 @@ def spoof( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupSpoofResponse: """ - Percentage distribution of emails classified as SPOOF over time. + Retrieves the distribution of emails by spoof classification (spoof vs. + non-spoof) over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -684,34 +697,35 @@ def threat_category( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupThreatCategoryResponse: """ - Percentage distribution of emails classified by threat category over time. + Retrieves the distribution of emails by threat category over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -772,32 +786,33 @@ def tls_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupTLSVersionResponse: """ - Percentage distribution of emails classified by TLS version over time. + Retrieves the distribution of emails by TLS version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers @@ -876,7 +891,8 @@ async def arc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupARCResponse: """ - Percentage distribution of emails classified by ARC validation over time. + Retrieves the distribution of emails by ARC (Authenticated Received Chain) + validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes @@ -885,23 +901,24 @@ async def arc( date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -959,32 +976,34 @@ async def dkim( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDKIMResponse: """ - Percentage distribution of emails classified by DKIM validation over time. + Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) + validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1042,32 +1061,33 @@ async def dmarc( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDMARCResponse: """ - Percentage distribution of emails classified by DMARC validation over time. + Retrieves the distribution of emails by DMARC (Domain-based Message + Authentication, Reporting and Conformance) validation over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1126,34 +1146,35 @@ async def malicious( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupMaliciousResponse: """ - Percentage distribution of emails classified as MALICIOUS over time. + Retrieves the distribution of emails by malicious classification over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1212,35 +1233,38 @@ async def spam( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupSpamResponse: - """ - Percentage distribution of emails classified as SPAM over time. + """Retrieves the distribution of emails by spam classification (spam vs. + + non-spam) + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1299,32 +1323,34 @@ async def spf( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupSPFResponse: """ - Percentage distribution of emails classified by SPF validation over time. + Retrieves the distribution of emails by SPF (Sender Policy Framework) validation + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1383,34 +1409,36 @@ async def spoof( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupSpoofResponse: """ - Percentage distribution of emails classified as SPOOF over time. + Retrieves the distribution of emails by spoof classification (spoof vs. + non-spoof) over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1470,34 +1498,35 @@ async def threat_category( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupThreatCategoryResponse: """ - Percentage distribution of emails classified by threat category over time. + Retrieves the distribution of emails by threat category over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1558,32 +1587,33 @@ async def tls_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupTLSVersionResponse: """ - Percentage distribution of emails classified by TLS version over time. + Retrieves the distribution of emails by TLS version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/email/security/top/tlds/malicious.py b/src/cloudflare/resources/radar/email/security/top/tlds/malicious.py index cd9ed653bd0..21b1e2c86e5 100644 --- a/src/cloudflare/resources/radar/email/security/top/tlds/malicious.py +++ b/src/cloudflare/resources/radar/email/security/top/tlds/malicious.py @@ -73,36 +73,37 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> MaliciousGetResponse: """ - Get the TLDs by emails classified as malicious or not. + Retrieves the top TLDs by emails classified as malicious or not. Args: - malicious: Malicious. + malicious: Malicious classification. - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tld_category: Filter for TLDs by category. + tld_category: Filters results by TLD category. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -188,36 +189,37 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> MaliciousGetResponse: """ - Get the TLDs by emails classified as malicious or not. + Retrieves the top TLDs by emails classified as malicious or not. Args: - malicious: Malicious. + malicious: Malicious classification. - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tld_category: Filter for TLDs by category. + tld_category: Filters results by TLD category. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/email/security/top/tlds/spam.py b/src/cloudflare/resources/radar/email/security/top/tlds/spam.py index 4a1c04f15a0..ca14d4a3af7 100644 --- a/src/cloudflare/resources/radar/email/security/top/tlds/spam.py +++ b/src/cloudflare/resources/radar/email/security/top/tlds/spam.py @@ -73,36 +73,37 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SpamGetResponse: """ - Get the top TLDs by emails classified as spam or not. + Retrieves the top TLDs by emails classified as spam or not. Args: - spam: Spam. + spam: Spam classification. - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tld_category: Filter for TLDs by category. + tld_category: Filters results by TLD category. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -188,36 +189,37 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SpamGetResponse: """ - Get the top TLDs by emails classified as spam or not. + Retrieves the top TLDs by emails classified as spam or not. Args: - spam: Spam. + spam: Spam classification. - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tld_category: Filter for TLDs by category. + tld_category: Filters results by TLD category. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/email/security/top/tlds/spoof.py b/src/cloudflare/resources/radar/email/security/top/tlds/spoof.py index 60c42d0c1a9..2e007ce64ca 100644 --- a/src/cloudflare/resources/radar/email/security/top/tlds/spoof.py +++ b/src/cloudflare/resources/radar/email/security/top/tlds/spoof.py @@ -73,36 +73,37 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SpoofGetResponse: """ - Get the TLDs by emails classified as spoof or not. + Retrieves the top TLDs by emails classified as spoof or not. Args: - spoof: Spoof. + spoof: Spoof classification. - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tld_category: Filter for TLDs by category. + tld_category: Filters results by TLD category. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -188,36 +189,37 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SpoofGetResponse: """ - Get the TLDs by emails classified as spoof or not. + Retrieves the top TLDs by emails classified as spoof or not. Args: - spoof: Spoof. + spoof: Spoof classification. - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tld_category: Filter for TLDs by category. + tld_category: Filters results by TLD category. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/email/security/top/tlds/tlds.py b/src/cloudflare/resources/radar/email/security/top/tlds/tlds.py index d45089f3adc..0b69f5dd811 100644 --- a/src/cloudflare/resources/radar/email/security/top/tlds/tlds.py +++ b/src/cloudflare/resources/radar/email/security/top/tlds/tlds.py @@ -107,37 +107,36 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TldGetResponse: - """Get the top TLDs by email messages. - - Values are a percentage out of total email - volume. + """ + Retrieves the top TLDs by number of email messages. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tld_category: Filter for TLDs by category. + tld_category: Filters results by TLD category. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -231,37 +230,36 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TldGetResponse: - """Get the top TLDs by email messages. - - Values are a percentage out of total email - volume. + """ + Retrieves the top TLDs by number of email messages. Args: - arc: Filter for arc (Authenticated Received Chain). + arc: Filters results by ARC (Authenticated Received Chain) validation. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - dkim: Filter for dkim. + dkim: Filters results by DKIM (DomainKeys Identified Mail) validation status. - dmarc: Filter for dmarc. + dmarc: Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - spf: Filter for spf. + spf: Filters results by SPF (Sender Policy Framework) validation status. - tld_category: Filter for TLDs by category. + tld_category: Filters results by TLD category. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/entities/asns.py b/src/cloudflare/resources/radar/entities/asns.py index c8ff8ed8e22..3ff7de2fbf2 100644 --- a/src/cloudflare/resources/radar/entities/asns.py +++ b/src/cloudflare/resources/radar/entities/asns.py @@ -68,20 +68,20 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ASNListResponse: """ - Get a list of autonomous systems (ASes). + Retrieves a list of autonomous systems. Args: - asn: Comma separated list of ASNs. + asn: Comma-separated list of Autonomous System Numbers (ASNs). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 to filter results. + location: Location alpha-2 code. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. - order_by: Order asn list. + order_by: Metric to order the ASNs by. extra_headers: Send extra headers @@ -126,17 +126,17 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ASNGetResponse: - """Get the requested autonomous system information. + """Retrieves the requested autonomous system information. - (A confidence level below `5` - indicates a low level of confidence in the traffic data - normally this happens - because Cloudflare has a small amount of traffic from/to this AS). Population - estimates come from APNIC (refer to https://labs.apnic.net/?p=526). + (A confidence level below + `5` indicates a low level of confidence in the traffic data - normally this + happens because Cloudflare has a small amount of traffic from/to this AS). + Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526). Args: - asn: Autonomous System Number (ASN). + asn: Single Autonomous System Number (ASN) as integer. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -171,15 +171,14 @@ def ip( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ASNIPResponse: - """Get the requested autonomous system information based on IP address. - - Population - estimates come from APNIC (refer to https://labs.apnic.net/?p=526). + """ + Retrieves the requested autonomous system information based on IP address. + Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526). Args: ip: IP address. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -222,14 +221,15 @@ def rel( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ASNRelResponse: """ - Get AS-level relationship for given networks. + Retrieves AS-level relationship for given networks. Args: - asn: Get all ASNs with provider-customer or peering relationships with the given ASN + asn: Retrieves all ASNs with provider-customer or peering relationships with the + given ASN. - asn2: Get the AS relationship of ASN2 with respect to the given ASN + asn2: Retrieves the AS relationship of ASN2 with respect to the given ASN. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -296,20 +296,20 @@ async def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ASNListResponse: """ - Get a list of autonomous systems (ASes). + Retrieves a list of autonomous systems. Args: - asn: Comma separated list of ASNs. + asn: Comma-separated list of Autonomous System Numbers (ASNs). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 to filter results. + location: Location alpha-2 code. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. - order_by: Order asn list. + order_by: Metric to order the ASNs by. extra_headers: Send extra headers @@ -354,17 +354,17 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ASNGetResponse: - """Get the requested autonomous system information. + """Retrieves the requested autonomous system information. - (A confidence level below `5` - indicates a low level of confidence in the traffic data - normally this happens - because Cloudflare has a small amount of traffic from/to this AS). Population - estimates come from APNIC (refer to https://labs.apnic.net/?p=526). + (A confidence level below + `5` indicates a low level of confidence in the traffic data - normally this + happens because Cloudflare has a small amount of traffic from/to this AS). + Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526). Args: - asn: Autonomous System Number (ASN). + asn: Single Autonomous System Number (ASN) as integer. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -399,15 +399,14 @@ async def ip( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ASNIPResponse: - """Get the requested autonomous system information based on IP address. - - Population - estimates come from APNIC (refer to https://labs.apnic.net/?p=526). + """ + Retrieves the requested autonomous system information based on IP address. + Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526). Args: ip: IP address. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -450,14 +449,15 @@ async def rel( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> ASNRelResponse: """ - Get AS-level relationship for given networks. + Retrieves AS-level relationship for given networks. Args: - asn: Get all ASNs with provider-customer or peering relationships with the given ASN + asn: Retrieves all ASNs with provider-customer or peering relationships with the + given ASN. - asn2: Get the AS relationship of ASN2 with respect to the given ASN + asn2: Retrieves the AS relationship of ASN2 with respect to the given ASN. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/entities/entities.py b/src/cloudflare/resources/radar/entities/entities.py index 695496eb3af..901d2881104 100644 --- a/src/cloudflare/resources/radar/entities/entities.py +++ b/src/cloudflare/resources/radar/entities/entities.py @@ -85,12 +85,12 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> EntityGetResponse: """ - Get IP address information. + Retrieves IP address information. Args: ip: IP address. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -161,12 +161,12 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> EntityGetResponse: """ - Get IP address information. + Retrieves IP address information. Args: ip: IP address. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/entities/locations.py b/src/cloudflare/resources/radar/entities/locations.py index a64b242ac69..ef11561af8e 100644 --- a/src/cloudflare/resources/radar/entities/locations.py +++ b/src/cloudflare/resources/radar/entities/locations.py @@ -64,16 +64,16 @@ def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationListResponse: """ - Get a list of locations. + Retrieves a list of locations. Args: - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Comma separated list of locations. + location: Comma-separated list of locations (alpha-2 location codes). - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers @@ -116,16 +116,16 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationGetResponse: - """Get the requested location information. + """Retrieves the requested location information. - (A confidence level below `5` indicates - a low level of confidence in the traffic data - normally this happens because - Cloudflare has a small amount of traffic from/to this location). + (A confidence level below `5` + indicates a low level of confidence in the traffic data - normally this happens + because Cloudflare has a small amount of traffic from/to this location). Args: - location: Alpha-2 country code. + location: Location alpha-2 code. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers @@ -186,16 +186,16 @@ async def list( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationListResponse: """ - Get a list of locations. + Retrieves a list of locations. Args: - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Comma separated list of locations. + location: Comma-separated list of locations (alpha-2 location codes). - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers @@ -238,16 +238,16 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationGetResponse: - """Get the requested location information. + """Retrieves the requested location information. - (A confidence level below `5` indicates - a low level of confidence in the traffic data - normally this happens because - Cloudflare has a small amount of traffic from/to this location). + (A confidence level below `5` + indicates a low level of confidence in the traffic data - normally this happens + because Cloudflare has a small amount of traffic from/to this location). Args: - location: Alpha-2 country code. + location: Location alpha-2 code. - format: Format results are returned in. + format: Format in which results will be returned. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/ases/ases.py b/src/cloudflare/resources/radar/http/ases/ases.py index 73e828d07a7..74f2dbcc9ef 100644 --- a/src/cloudflare/resources/radar/http/ases/ases.py +++ b/src/cloudflare/resources/radar/http/ases/ases.py @@ -173,54 +173,52 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AseGetResponse: - """Get the top autonomous systems by HTTP traffic. - - Values are a percentage out of - the total traffic. + """ + Retrieves the top autonomous systems by HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -345,54 +343,52 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> AseGetResponse: - """Get the top autonomous systems by HTTP traffic. - - Values are a percentage out of - the total traffic. + """ + Retrieves the top autonomous systems by HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/ases/bot_class.py b/src/cloudflare/resources/radar/http/ases/bot_class.py index 6850fdf96cf..056f9162760 100644 --- a/src/cloudflare/resources/radar/http/ases/bot_class.py +++ b/src/cloudflare/resources/radar/http/ases/bot_class.py @@ -77,55 +77,53 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BotClassGetResponse: - """Get the top autonomous systems (AS), by HTTP traffic, of the requested bot + """ + Retrieves the top autonomous systems, by HTTP requests, of the requested bot class. - These two categories use Cloudflare's bot score - refer to - [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more - information. Values are a percentage out of the total traffic. - Args: - bot_class: Bot class. + bot_class: Bot class. Refer to + [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -219,55 +217,53 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BotClassGetResponse: - """Get the top autonomous systems (AS), by HTTP traffic, of the requested bot + """ + Retrieves the top autonomous systems, by HTTP requests, of the requested bot class. - These two categories use Cloudflare's bot score - refer to - [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more - information. Values are a percentage out of the total traffic. - Args: - bot_class: Bot class. + bot_class: Bot class. Refer to + [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/ases/browser_family.py b/src/cloudflare/resources/radar/http/ases/browser_family.py index 8c0d842f074..23918e76f2d 100644 --- a/src/cloudflare/resources/radar/http/ases/browser_family.py +++ b/src/cloudflare/resources/radar/http/ases/browser_family.py @@ -78,52 +78,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BrowserFamilyGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested browser - family. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested browser + family. Args: browser_family: Browser family. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -218,52 +218,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BrowserFamilyGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested browser - family. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested browser + family. Args: browser_family: Browser family. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/ases/device_type.py b/src/cloudflare/resources/radar/http/ases/device_type.py index 36f269961c0..a2cd8b763cf 100644 --- a/src/cloudflare/resources/radar/http/ases/device_type.py +++ b/src/cloudflare/resources/radar/http/ases/device_type.py @@ -78,52 +78,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DeviceTypeGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested device - type. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested device + type. Args: device_type: Device type. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -218,52 +218,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DeviceTypeGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested device - type. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested device + type. Args: device_type: Device type. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/ases/http_method.py b/src/cloudflare/resources/radar/http/ases/http_method.py index afae27fb638..524aa0112fd 100644 --- a/src/cloudflare/resources/radar/http/ases/http_method.py +++ b/src/cloudflare/resources/radar/http/ases/http_method.py @@ -78,52 +78,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPMethodGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP - version. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP + version. Args: http_version: HTTP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -218,52 +218,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPMethodGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP - version. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP + version. Args: http_version: HTTP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/ases/http_protocol.py b/src/cloudflare/resources/radar/http/ases/http_protocol.py index 613777f074f..36250f4f2d5 100644 --- a/src/cloudflare/resources/radar/http/ases/http_protocol.py +++ b/src/cloudflare/resources/radar/http/ases/http_protocol.py @@ -62,6 +62,7 @@ def get( date_start: List[Union[str, datetime]] | NotGiven = NOT_GIVEN, device_type: List[Literal["DESKTOP", "MOBILE", "OTHER"]] | NotGiven = NOT_GIVEN, format: Literal["JSON", "CSV"] | NotGiven = NOT_GIVEN, + http_version: List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]] | NotGiven = NOT_GIVEN, ip_version: List[Literal["IPv4", "IPv6"]] | NotGiven = NOT_GIVEN, limit: int | NotGiven = NOT_GIVEN, location: List[str] | NotGiven = NOT_GIVEN, @@ -77,50 +78,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPProtocolGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP - protocol. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP + protocol. Args: - http_protocol: HTTP Protocol. + http_protocol: HTTP protocol (HTTP vs. HTTPS). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - ip_version: Filter for ip version. + http_version: Filters results by HTTP version. - limit: Limit the number of objects in the response. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - os: Filter for os name. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + os: Filters results by operating system. + + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -150,6 +153,7 @@ def get( "date_start": date_start, "device_type": device_type, "format": format, + "http_version": http_version, "ip_version": ip_version, "limit": limit, "location": location, @@ -198,6 +202,7 @@ async def get( date_start: List[Union[str, datetime]] | NotGiven = NOT_GIVEN, device_type: List[Literal["DESKTOP", "MOBILE", "OTHER"]] | NotGiven = NOT_GIVEN, format: Literal["JSON", "CSV"] | NotGiven = NOT_GIVEN, + http_version: List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]] | NotGiven = NOT_GIVEN, ip_version: List[Literal["IPv4", "IPv6"]] | NotGiven = NOT_GIVEN, limit: int | NotGiven = NOT_GIVEN, location: List[str] | NotGiven = NOT_GIVEN, @@ -213,50 +218,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPProtocolGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP - protocol. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested HTTP + protocol. Args: - http_protocol: HTTP Protocol. + http_protocol: HTTP protocol (HTTP vs. HTTPS). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). + + date_start: Start of the date range. - date_start: Array of datetimes to filter the start of a series. + device_type: Filters results by device type. - device_type: Filter for device type. + format: Format in which results will be returned. - format: Format results are returned in. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -286,6 +293,7 @@ async def get( "date_start": date_start, "device_type": device_type, "format": format, + "http_version": http_version, "ip_version": ip_version, "limit": limit, "location": location, diff --git a/src/cloudflare/resources/radar/http/ases/ip_version.py b/src/cloudflare/resources/radar/http/ases/ip_version.py index aee722d0eaa..380e6204527 100644 --- a/src/cloudflare/resources/radar/http/ases/ip_version.py +++ b/src/cloudflare/resources/radar/http/ases/ip_version.py @@ -78,52 +78,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IPVersionGetResponse: """ - Get the top autonomous systems, by HTTP traffic, of the requested IP version. - Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested IP + version. Args: ip_version: IP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -218,52 +218,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IPVersionGetResponse: """ - Get the top autonomous systems, by HTTP traffic, of the requested IP version. - Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested IP + version. Args: ip_version: IP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/ases/os.py b/src/cloudflare/resources/radar/http/ases/os.py index ef59110ac0b..bf846c04615 100644 --- a/src/cloudflare/resources/radar/http/ases/os.py +++ b/src/cloudflare/resources/radar/http/ases/os.py @@ -77,52 +77,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> OSGetResponse: """ - Get the top autonomous systems, by HTTP traffic, of the requested operating - systems. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested + operating system. Args: os: Operating system. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -216,52 +216,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> OSGetResponse: """ - Get the top autonomous systems, by HTTP traffic, of the requested operating - systems. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested + operating system. Args: os: Operating system. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/ases/tls_version.py b/src/cloudflare/resources/radar/http/ases/tls_version.py index 3603964e669..7699af8b1c3 100644 --- a/src/cloudflare/resources/radar/http/ases/tls_version.py +++ b/src/cloudflare/resources/radar/http/ases/tls_version.py @@ -78,52 +78,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TLSVersionGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS - protocol version. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested TLS + protocol version. Args: tls_version: TLS version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. extra_headers: Send extra headers @@ -218,52 +218,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TLSVersionGetResponse: """ - Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS - protocol version. Values are a percentage out of the total traffic. + Retrieves the top autonomous systems, by HTTP requests, of the requested TLS + protocol version. Args: tls_version: TLS version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/http.py b/src/cloudflare/resources/radar/http/http.py index 256d212419b..598cf160a51 100644 --- a/src/cloudflare/resources/radar/http/http.py +++ b/src/cloudflare/resources/radar/http/http.py @@ -138,54 +138,54 @@ def timeseries( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPTimeseriesResponse: """ - Get HTTP requests over time. + Retrieves the HTTP requests over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -299,54 +299,54 @@ async def timeseries( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPTimeseriesResponse: """ - Get HTTP requests over time. + Retrieves the HTTP requests over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/locations/bot_class.py b/src/cloudflare/resources/radar/http/locations/bot_class.py index 8d33f970f8e..414746db158 100644 --- a/src/cloudflare/resources/radar/http/locations/bot_class.py +++ b/src/cloudflare/resources/radar/http/locations/bot_class.py @@ -77,55 +77,52 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BotClassGetResponse: - """Get the top locations, by HTTP traffic, of the requested bot class. - - These two - categories use Cloudflare's bot score - refer to [Bot - scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a - percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested bot class. Args: - bot_class: Bot class. + bot_class: Bot class. Refer to + [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -219,55 +216,52 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BotClassGetResponse: - """Get the top locations, by HTTP traffic, of the requested bot class. - - These two - categories use Cloudflare's bot score - refer to [Bot - scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a - percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested bot class. Args: - bot_class: Bot class. + bot_class: Bot class. Refer to + [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/locations/browser_family.py b/src/cloudflare/resources/radar/http/locations/browser_family.py index bee94d89c75..cfa4d8b954d 100644 --- a/src/cloudflare/resources/radar/http/locations/browser_family.py +++ b/src/cloudflare/resources/radar/http/locations/browser_family.py @@ -77,54 +77,52 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BrowserFamilyGetResponse: - """Get the top locations, by HTTP traffic, of the requested browser family. - - Values - are a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested browser family. Args: browser_family: Browser family. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -218,54 +216,52 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> BrowserFamilyGetResponse: - """Get the top locations, by HTTP traffic, of the requested browser family. - - Values - are a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested browser family. Args: browser_family: Browser family. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/locations/device_type.py b/src/cloudflare/resources/radar/http/locations/device_type.py index 44234522dae..39d476edd2c 100644 --- a/src/cloudflare/resources/radar/http/locations/device_type.py +++ b/src/cloudflare/resources/radar/http/locations/device_type.py @@ -77,54 +77,52 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DeviceTypeGetResponse: - """Get the top locations, by HTTP traffic, of the requested device type. - - Values are - a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested device type. Args: device_type: Device type. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -218,54 +216,52 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DeviceTypeGetResponse: - """Get the top locations, by HTTP traffic, of the requested device type. - - Values are - a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested device type. Args: device_type: Device type. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/locations/http_method.py b/src/cloudflare/resources/radar/http/locations/http_method.py index d2f9b464437..ee9489bc27c 100644 --- a/src/cloudflare/resources/radar/http/locations/http_method.py +++ b/src/cloudflare/resources/radar/http/locations/http_method.py @@ -77,54 +77,52 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPMethodGetResponse: - """Get the top locations, by HTTP traffic, of the requested HTTP version. - - Values - are a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested HTTP version. Args: http_version: HTTP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -218,54 +216,52 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPMethodGetResponse: - """Get the top locations, by HTTP traffic, of the requested HTTP version. - - Values - are a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested HTTP version. Args: http_version: HTTP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/locations/http_protocol.py b/src/cloudflare/resources/radar/http/locations/http_protocol.py index 7c5c8f4f644..779831fff30 100644 --- a/src/cloudflare/resources/radar/http/locations/http_protocol.py +++ b/src/cloudflare/resources/radar/http/locations/http_protocol.py @@ -62,6 +62,7 @@ def get( date_start: List[Union[str, datetime]] | NotGiven = NOT_GIVEN, device_type: List[Literal["DESKTOP", "MOBILE", "OTHER"]] | NotGiven = NOT_GIVEN, format: Literal["JSON", "CSV"] | NotGiven = NOT_GIVEN, + http_version: List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]] | NotGiven = NOT_GIVEN, ip_version: List[Literal["IPv4", "IPv6"]] | NotGiven = NOT_GIVEN, limit: int | NotGiven = NOT_GIVEN, location: List[str] | NotGiven = NOT_GIVEN, @@ -76,52 +77,52 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPProtocolGetResponse: - """Get the top locations, by HTTP traffic, of the requested HTTP protocol. - - Values - are a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested HTTP protocol. Args: - http_protocol: HTTP Protocol. + http_protocol: HTTP protocol (HTTP vs. HTTPS). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). + + date_start: Start of the date range. - date_start: Array of datetimes to filter the start of a series. + device_type: Filters results by device type. - device_type: Filter for device type. + format: Format in which results will be returned. - format: Format results are returned in. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -151,6 +152,7 @@ def get( "date_start": date_start, "device_type": device_type, "format": format, + "http_version": http_version, "ip_version": ip_version, "limit": limit, "location": location, @@ -199,6 +201,7 @@ async def get( date_start: List[Union[str, datetime]] | NotGiven = NOT_GIVEN, device_type: List[Literal["DESKTOP", "MOBILE", "OTHER"]] | NotGiven = NOT_GIVEN, format: Literal["JSON", "CSV"] | NotGiven = NOT_GIVEN, + http_version: List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]] | NotGiven = NOT_GIVEN, ip_version: List[Literal["IPv4", "IPv6"]] | NotGiven = NOT_GIVEN, limit: int | NotGiven = NOT_GIVEN, location: List[str] | NotGiven = NOT_GIVEN, @@ -213,52 +216,52 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> HTTPProtocolGetResponse: - """Get the top locations, by HTTP traffic, of the requested HTTP protocol. - - Values - are a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested HTTP protocol. Args: - http_protocol: HTTP Protocol. + http_protocol: HTTP protocol (HTTP vs. HTTPS). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). + + date_start: Start of the date range. - date_start: Array of datetimes to filter the start of a series. + device_type: Filters results by device type. - device_type: Filter for device type. + format: Format in which results will be returned. - format: Format results are returned in. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -288,6 +291,7 @@ async def get( "date_start": date_start, "device_type": device_type, "format": format, + "http_version": http_version, "ip_version": ip_version, "limit": limit, "location": location, diff --git a/src/cloudflare/resources/radar/http/locations/ip_version.py b/src/cloudflare/resources/radar/http/locations/ip_version.py index 84d25e8135d..54c76e1620c 100644 --- a/src/cloudflare/resources/radar/http/locations/ip_version.py +++ b/src/cloudflare/resources/radar/http/locations/ip_version.py @@ -77,54 +77,52 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IPVersionGetResponse: - """Get the top locations, by HTTP traffic, of the requested IP version. - - Values are - a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested IP version. Args: ip_version: IP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -218,54 +216,52 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IPVersionGetResponse: - """Get the top locations, by HTTP traffic, of the requested IP version. - - Values are - a percentage out of the total traffic. + """ + Retrieves the top locations, by HTTP requests, of the requested IP version. Args: ip_version: IP version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/locations/locations.py b/src/cloudflare/resources/radar/http/locations/locations.py index 2e47beade9e..75c4c62f00a 100644 --- a/src/cloudflare/resources/radar/http/locations/locations.py +++ b/src/cloudflare/resources/radar/http/locations/locations.py @@ -173,54 +173,52 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationGetResponse: - """Get the top locations by HTTP traffic. - - Values are a percentage out of the total - traffic. + """ + Retrieves the top locations by HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -345,54 +343,52 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationGetResponse: - """Get the top locations by HTTP traffic. - - Values are a percentage out of the total - traffic. + """ + Retrieves the top locations by HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/locations/os.py b/src/cloudflare/resources/radar/http/locations/os.py index f1e8ad2da45..dd5f0d0dffe 100644 --- a/src/cloudflare/resources/radar/http/locations/os.py +++ b/src/cloudflare/resources/radar/http/locations/os.py @@ -77,52 +77,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> OSGetResponse: """ - Get the top locations, by HTTP traffic, of the requested operating systems. - Values are a percentage out of the total traffic. + Retrieves the top locations, by HTTP requests, of the requested operating + system. Args: os: Operating system. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -216,52 +216,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> OSGetResponse: """ - Get the top locations, by HTTP traffic, of the requested operating systems. - Values are a percentage out of the total traffic. + Retrieves the top locations, by HTTP requests, of the requested operating + system. Args: os: Operating system. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/locations/tls_version.py b/src/cloudflare/resources/radar/http/locations/tls_version.py index b916c68c4e8..adc15d784c9 100644 --- a/src/cloudflare/resources/radar/http/locations/tls_version.py +++ b/src/cloudflare/resources/radar/http/locations/tls_version.py @@ -78,52 +78,52 @@ def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TLSVersionGetResponse: """ - Get the top locations, by HTTP traffic, of the requested TLS protocol version. - Values are a percentage out of the total traffic. + Retrieves the top locations, by HTTP requests, of the requested TLS protocol + version. Args: tls_version: TLS version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. extra_headers: Send extra headers @@ -218,52 +218,52 @@ async def get( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TLSVersionGetResponse: """ - Get the top locations, by HTTP traffic, of the requested TLS protocol version. - Values are a percentage out of the total traffic. + Retrieves the top locations, by HTTP requests, of the requested TLS protocol + version. Args: tls_version: TLS version. - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/summary.py b/src/cloudflare/resources/radar/http/summary.py index 6af78371015..395d0808e5f 100644 --- a/src/cloudflare/resources/radar/http/summary.py +++ b/src/cloudflare/resources/radar/http/summary.py @@ -91,47 +91,47 @@ def bot_class( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryBotClassResponse: """ - Percentage distribution of bot-generated traffic to genuine human traffic, as - classified by Cloudflare. Visit + Retrieves the distribution of bot-generated HTTP requests to genuine human + traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -198,46 +198,46 @@ def device_type( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDeviceTypeResponse: """ - Percentage of Internet traffic generated by mobile, desktop, and other types of - devices over a given time period. + Retrieves the distribution of HTTP requests generated by mobile, desktop, and + other types of devices. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -303,46 +303,47 @@ def http_protocol( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryHTTPProtocolResponse: - """ - Percentage distribution of traffic by HTTP protocol over a given time period. + """Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. + + HTTPS). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -409,45 +410,45 @@ def http_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryHTTPVersionResponse: """ - Percentage distribution of traffic by HTTP version over a given time period. + Retrieves the distribution of HTTP requests by HTTP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -514,46 +515,45 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of Internet traffic based on IP versions (IPv4 and IPv6) - over a given time period. + Retrieves the distribution of HTTP requests by IP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -619,46 +619,46 @@ def os( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryOSResponse: """ - Percentage distribution of Internet traffic generated by different operating - systems like Windows, macOS, Android, iOS, and others, over a given time period. + Retrieves the distribution of HTTP requests by operating system (Windows, macOS, + Android, iOS, and others). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -726,48 +726,47 @@ def post_quantum( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryPostQuantumResponse: """ - Percentage distribution of traffic by post-quantum support over a given time - period. + Retrieves the distribution of HTTP requests by post-quantum support. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -835,46 +834,45 @@ def tls_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryTLSVersionResponse: """ - Percentage distribution of traffic by TLS protocol version, over a given time - period. + Retrieves the distribution of HTTP requests by TLS version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. extra_headers: Send extra headers @@ -962,47 +960,47 @@ async def bot_class( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryBotClassResponse: """ - Percentage distribution of bot-generated traffic to genuine human traffic, as - classified by Cloudflare. Visit + Retrieves the distribution of bot-generated HTTP requests to genuine human + traffic, as classified by Cloudflare. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ for more information. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1069,46 +1067,46 @@ async def device_type( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryDeviceTypeResponse: """ - Percentage of Internet traffic generated by mobile, desktop, and other types of - devices over a given time period. + Retrieves the distribution of HTTP requests generated by mobile, desktop, and + other types of devices. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1174,46 +1172,47 @@ async def http_protocol( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryHTTPProtocolResponse: - """ - Percentage distribution of traffic by HTTP protocol over a given time period. + """Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. + + HTTPS). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1280,45 +1279,45 @@ async def http_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryHTTPVersionResponse: """ - Percentage distribution of traffic by HTTP version over a given time period. + Retrieves the distribution of HTTP requests by HTTP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1385,46 +1384,45 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryIPVersionResponse: """ - Percentage distribution of Internet traffic based on IP versions (IPv4 and IPv6) - over a given time period. + Retrieves the distribution of HTTP requests by IP version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1490,46 +1488,46 @@ async def os( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryOSResponse: """ - Percentage distribution of Internet traffic generated by different operating - systems like Windows, macOS, Android, iOS, and others, over a given time period. + Retrieves the distribution of HTTP requests by operating system (Windows, macOS, + Android, iOS, and others). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1597,48 +1595,47 @@ async def post_quantum( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryPostQuantumResponse: """ - Percentage distribution of traffic by post-quantum support over a given time - period. + Retrieves the distribution of HTTP requests by post-quantum support. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1706,46 +1703,45 @@ async def tls_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SummaryTLSVersionResponse: """ - Percentage distribution of traffic by TLS protocol version, over a given time - period. + Retrieves the distribution of HTTP requests by TLS version. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/timeseries_groups.py b/src/cloudflare/resources/radar/http/timeseries_groups.py index f81fb20fd7f..72a67be4c13 100644 --- a/src/cloudflare/resources/radar/http/timeseries_groups.py +++ b/src/cloudflare/resources/radar/http/timeseries_groups.py @@ -96,51 +96,50 @@ def bot_class( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupBotClassResponse: """ - Get a time series of the percentage distribution of traffic classified as - automated or human. Visit - https://developers.cloudflare.com/radar/concepts/bot-classes/ for more - information. + Retrieves the distribution of HTTP requests classified as automated or human + over time. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ + for more information. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -211,57 +210,56 @@ def browser( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupBrowserResponse: """ - Get a time series of the percentage distribution of traffic of the top user - agents. + Retrieves the distribution of HTTP requests by user agent over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -334,57 +332,56 @@ def browser_family( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupBrowserFamilyResponse: """ - Get a time series of the percentage distribution of traffic of the top user - agents aggregated in families. + Retrieves the distribution of HTTP requests by user agent family over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -457,49 +454,49 @@ def device_type( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDeviceTypeResponse: """ - Get a time series of the percentage distribution of traffic by device type. + Retrieves the distribution of HTTP requests by device type over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -567,50 +564,52 @@ def http_protocol( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupHTTPProtocolResponse: - """ - Get a time series of the percentage distribution of traffic by HTTP protocol. + """Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. + + HTTPS) + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -679,49 +678,49 @@ def http_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupHTTPVersionResponse: """ - Get a time series of the percentage distribution of traffic by HTTP version. + Retrieves the distribution of HTTP requests by HTTP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -790,49 +789,49 @@ def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Get a time series of the percentage distribution of traffic by IP version. + Retrieves the distribution of HTTP requests by IP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -900,50 +899,49 @@ def os( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupOSResponse: """ - Get a time series of the percentage distribution of traffic of the top operating - systems. + Retrieves the distribution of HTTP requests by operating system over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1013,52 +1011,51 @@ def post_quantum( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupPostQuantumResponse: """ - Get a time series of the percentage distribution of traffic by post-quantum - suport. + Retrieves the distribution of HTTP requests by post-quantum support over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1128,50 +1125,49 @@ def tls_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupTLSVersionResponse: """ - Get a time series of the percentage distribution of traffic by TLS protocol - version. + Retrieves the distribution of HTTP requests by TLS version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. extra_headers: Send extra headers @@ -1261,51 +1257,50 @@ async def bot_class( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupBotClassResponse: """ - Get a time series of the percentage distribution of traffic classified as - automated or human. Visit - https://developers.cloudflare.com/radar/concepts/bot-classes/ for more - information. + Retrieves the distribution of HTTP requests classified as automated or human + over time. Visit https://developers.cloudflare.com/radar/concepts/bot-classes/ + for more information. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1376,57 +1371,56 @@ async def browser( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupBrowserResponse: """ - Get a time series of the percentage distribution of traffic of the top user - agents. + Retrieves the distribution of HTTP requests by user agent over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1499,57 +1493,56 @@ async def browser_family( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupBrowserFamilyResponse: """ - Get a time series of the percentage distribution of traffic of the top user - agents aggregated in families. + Retrieves the distribution of HTTP requests by user agent family over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit_per_group: Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + limit_per_group: Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1622,49 +1615,49 @@ async def device_type( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupDeviceTypeResponse: """ - Get a time series of the percentage distribution of traffic by device type. + Retrieves the distribution of HTTP requests by device type over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1732,50 +1725,52 @@ async def http_protocol( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupHTTPProtocolResponse: - """ - Get a time series of the percentage distribution of traffic by HTTP protocol. + """Retrieves the distribution of HTTP requests by HTTP protocol (HTTP vs. + + HTTPS) + over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1844,49 +1839,49 @@ async def http_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupHTTPVersionResponse: """ - Get a time series of the percentage distribution of traffic by HTTP version. + Retrieves the distribution of HTTP requests by HTTP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -1955,49 +1950,49 @@ async def ip_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupIPVersionResponse: """ - Get a time series of the percentage distribution of traffic by IP version. + Retrieves the distribution of HTTP requests by IP version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -2065,50 +2060,49 @@ async def os( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupOSResponse: """ - Get a time series of the percentage distribution of traffic of the top operating - systems. + Retrieves the distribution of HTTP requests by operating system over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -2178,52 +2172,51 @@ async def post_quantum( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupPostQuantumResponse: """ - Get a time series of the percentage distribution of traffic by post-quantum - suport. + Retrieves the distribution of HTTP requests by post-quantum support over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -2293,50 +2286,49 @@ async def tls_version( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TimeseriesGroupTLSVersionResponse: """ - Get a time series of the percentage distribution of traffic by TLS protocol - version. + Retrieves the distribution of HTTP requests by TLS version over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/http/top.py b/src/cloudflare/resources/radar/http/top.py index bee2512dedb..4a0cb61af0e 100644 --- a/src/cloudflare/resources/radar/http/top.py +++ b/src/cloudflare/resources/radar/http/top.py @@ -78,54 +78,52 @@ def browser( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopBrowserResponse: - """Get the top user agents by HTTP traffic. - - Values are a percentage out of the - total traffic. + """ + Retrieves the top user agents by HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -196,52 +194,50 @@ def browser_family( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopBrowserFamilyResponse: - """Get the top user agents aggregated in families by HTTP traffic. - - Values are a - percentage out of the total traffic. + """ + Retrieves the top user agents, aggregated in families, by HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -333,54 +329,52 @@ async def browser( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopBrowserResponse: - """Get the top user agents by HTTP traffic. - - Values are a percentage out of the - total traffic. + """ + Retrieves the top user agents by HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - browser_family: Filter for browser family. + browser_family: Filters results by browser family. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers @@ -451,52 +445,50 @@ async def browser_family( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopBrowserFamilyResponse: - """Get the top user agents aggregated in families by HTTP traffic. - - Values are a - percentage out of the total traffic. + """ + Retrieves the top user agents, aggregated in families, by HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bot_class: Filter for bot class. Refer to + bot_class: Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - device_type: Filter for device type. + device_type: Filters results by device type. - format: Format results are returned in. + format: Format in which results will be returned. - http_protocol: Filter for http protocol. + http_protocol: Filters results by HTTP protocol (HTTP vs. HTTPS). - http_version: Filter for http version. + http_version: Filters results by HTTP version. - ip_version: Filter for ip version. + ip_version: Filters results by IP version (Ipv4 vs. IPv6). - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - os: Filter for os name. + os: Filters results by operating system. - tls_version: Filter for tls version. + tls_version: Filters results by TLS version. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/netflows/netflows.py b/src/cloudflare/resources/radar/netflows/netflows.py index 0384af11246..976c671ccb0 100644 --- a/src/cloudflare/resources/radar/netflows/netflows.py +++ b/src/cloudflare/resources/radar/netflows/netflows.py @@ -81,33 +81,33 @@ def summary( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> NetflowSummaryResponse: """ - Percentage distribution of HTTP vs other protocols traffic over a given time - period. + Retrieves the distribution of network traffic (NetFlows) by HTTP vs other + protocols. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -163,44 +163,42 @@ def timeseries( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> NetflowTimeseriesResponse: - """Get network traffic change over time. - - Visit - https://en.wikipedia.org/wiki/NetFlow for more information on NetFlows. + """ + Retrieves network traffic (NetFlows) over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - product: Array of network traffic product types. + product: Array of network traffic product types to filters results by. extra_headers: Send extra headers @@ -282,33 +280,33 @@ async def summary( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> NetflowSummaryResponse: """ - Percentage distribution of HTTP vs other protocols traffic over a given time - period. + Retrieves the distribution of network traffic (NetFlows) by HTTP vs other + protocols. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -364,44 +362,42 @@ async def timeseries( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> NetflowTimeseriesResponse: - """Get network traffic change over time. - - Visit - https://en.wikipedia.org/wiki/NetFlow for more information on NetFlows. + """ + Retrieves network traffic (NetFlows) over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. normalization: Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/). - product: Array of network traffic product types. + product: Array of network traffic product types to filters results by. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/netflows/top.py b/src/cloudflare/resources/radar/netflows/top.py index 368f350ac13..0dde34111ae 100644 --- a/src/cloudflare/resources/radar/netflows/top.py +++ b/src/cloudflare/resources/radar/netflows/top.py @@ -70,35 +70,34 @@ def ases( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAsesResponse: """ - Get the top autonomous systems (AS) by network traffic (NetFlows) over a given - time period. Visit https://en.wikipedia.org/wiki/NetFlow for more information. + Retrieves the top autonomous systems by network traffic (NetFlows). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -154,35 +153,34 @@ def locations( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopLocationsResponse: """ - Get the top locations by network traffic (NetFlows) over a given time period. - Visit https://en.wikipedia.org/wiki/NetFlow for more information. + Retrieves the top locations by network traffic (NetFlows). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -259,35 +257,34 @@ async def ases( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAsesResponse: """ - Get the top autonomous systems (AS) by network traffic (NetFlows) over a given - time period. Visit https://en.wikipedia.org/wiki/NetFlow for more information. + Retrieves the top autonomous systems by network traffic (NetFlows). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -343,35 +340,34 @@ async def locations( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopLocationsResponse: """ - Get the top locations by network traffic (NetFlows) over a given time period. - Visit https://en.wikipedia.org/wiki/NetFlow for more information. + Retrieves the top locations by network traffic (NetFlows). Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/quality/iqi.py b/src/cloudflare/resources/radar/quality/iqi.py index bcdeb909f41..fa87c8c30ba 100644 --- a/src/cloudflare/resources/radar/quality/iqi.py +++ b/src/cloudflare/resources/radar/quality/iqi.py @@ -70,35 +70,35 @@ def summary( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IQISummaryResponse: """ - Get a summary (percentiles) of bandwidth, latency or DNS response time from the - Radar Internet Quality Index (IQI). + Retrieves a summary (percentiles) of bandwidth, latency, or DNS response time + from the Radar Internet Quality Index (IQI). Args: - metric: Which metric to return: bandwidth, latency or DNS response time. + metric: Defines which metric to return (bandwidth, latency, or DNS response time). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -156,41 +156,41 @@ def timeseries_groups( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IQITimeseriesGroupsResponse: """ - Get a time series (percentiles) of bandwidth, latency or DNS response time from - the Radar Internet Quality Index (IQI). + Retrieves a time series (percentiles) of bandwidth, latency, or DNS response + time from the Radar Internet Quality Index (IQI). Args: - metric: Which metric to return: bandwidth, latency or DNS response time. + metric: Defines which metric to return (bandwidth, latency, or DNS response time). agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - interpolation: Enable interpolation for all series (using the average). + interpolation: Enables interpolation for all series (using the average). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -269,35 +269,35 @@ async def summary( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IQISummaryResponse: """ - Get a summary (percentiles) of bandwidth, latency or DNS response time from the - Radar Internet Quality Index (IQI). + Retrieves a summary (percentiles) of bandwidth, latency, or DNS response time + from the Radar Internet Quality Index (IQI). Args: - metric: Which metric to return: bandwidth, latency or DNS response time. + metric: Defines which metric to return (bandwidth, latency, or DNS response time). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -355,41 +355,41 @@ async def timeseries_groups( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> IQITimeseriesGroupsResponse: """ - Get a time series (percentiles) of bandwidth, latency or DNS response time from - the Radar Internet Quality Index (IQI). + Retrieves a time series (percentiles) of bandwidth, latency, or DNS response + time from the Radar Internet Quality Index (IQI). Args: - metric: Which metric to return: bandwidth, latency or DNS response time. + metric: Defines which metric to return (bandwidth, latency, or DNS response time). agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - interpolation: Enable interpolation for all series (using the average). + interpolation: Enables interpolation for all series (using the average). - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/quality/speed/speed.py b/src/cloudflare/resources/radar/quality/speed/speed.py index 496dfa907c7..1ac55917b42 100644 --- a/src/cloudflare/resources/radar/quality/speed/speed.py +++ b/src/cloudflare/resources/radar/quality/speed/speed.py @@ -81,31 +81,31 @@ def histogram( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SpeedHistogramResponse: """ - Get an histogram from the previous 90 days of Cloudflare Speed Test data, split - into fixed bandwidth (Mbps), latency (ms) or jitter (ms) buckets. + Retrieves a histogram from the previous 90 days of Cloudflare Speed Test data, + split into fixed bandwidth (Mbps), latency (ms), or jitter (ms) buckets. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bucket_size: The width for every bucket in the histogram. + bucket_size: Width for every bucket in the histogram. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. metric_group: Metrics to be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -157,27 +157,27 @@ def summary( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SpeedSummaryResponse: """ - Get a summary of bandwidth, latency, jitter and packet loss, from the previous - 90 days of Cloudflare Speed Test data. + Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the + previous 90 days of Cloudflare Speed Test data. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -254,31 +254,31 @@ async def histogram( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SpeedHistogramResponse: """ - Get an histogram from the previous 90 days of Cloudflare Speed Test data, split - into fixed bandwidth (Mbps), latency (ms) or jitter (ms) buckets. + Retrieves a histogram from the previous 90 days of Cloudflare Speed Test data, + split into fixed bandwidth (Mbps), latency (ms), or jitter (ms) buckets. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - bucket_size: The width for every bucket in the histogram. + bucket_size: Width for every bucket in the histogram. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. metric_group: Metrics to be returned. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -330,27 +330,27 @@ async def summary( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SpeedSummaryResponse: """ - Get a summary of bandwidth, latency, jitter and packet loss, from the previous - 90 days of Cloudflare Speed Test data. + Retrieves a summary of bandwidth, latency, jitter, and packet loss, from the + previous 90 days of Cloudflare Speed Test data. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/quality/speed/top.py b/src/cloudflare/resources/radar/quality/speed/top.py index 827ad096ef9..471927135f1 100644 --- a/src/cloudflare/resources/radar/quality/speed/top.py +++ b/src/cloudflare/resources/radar/quality/speed/top.py @@ -73,33 +73,33 @@ def ases( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAsesResponse: """ - Get the top autonomous systems by bandwidth, latency, jitter or packet loss, - from the previous 90 days of Cloudflare Speed Test data. + Retrieves the top autonomous systems by bandwidth, latency, jitter, or packet + loss, from the previous 90 days of Cloudflare Speed Test data. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. order_by: Metric to order the results by. - reverse: Reverse the order of results. + reverse: Reverses the order of results. extra_headers: Send extra headers @@ -158,33 +158,33 @@ def locations( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopLocationsResponse: """ - Get the top locations by bandwidth, latency, jitter or packet loss, from the - previous 90 days of Cloudflare Speed Test data. + Retrieves the top locations by bandwidth, latency, jitter, or packet loss, from + the previous 90 days of Cloudflare Speed Test data. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. order_by: Metric to order the results by. - reverse: Reverse the order of results. + reverse: Reverses the order of results. extra_headers: Send extra headers @@ -264,33 +264,33 @@ async def ases( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopAsesResponse: """ - Get the top autonomous systems by bandwidth, latency, jitter or packet loss, - from the previous 90 days of Cloudflare Speed Test data. + Retrieves the top autonomous systems by bandwidth, latency, jitter, or packet + loss, from the previous 90 days of Cloudflare Speed Test data. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. order_by: Metric to order the results by. - reverse: Reverse the order of results. + reverse: Reverses the order of results. extra_headers: Send extra headers @@ -349,33 +349,33 @@ async def locations( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopLocationsResponse: """ - Get the top locations by bandwidth, latency, jitter or packet loss, from the - previous 90 days of Cloudflare Speed Test data. + Retrieves the top locations by bandwidth, latency, jitter, or packet loss, from + the previous 90 days of Cloudflare Speed Test data. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. order_by: Metric to order the results by. - reverse: Reverse the order of results. + reverse: Reverses the order of results. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/ranking/domain.py b/src/cloudflare/resources/radar/ranking/domain.py index 2f6b40cd8ef..ad1627be374 100644 --- a/src/cloudflare/resources/radar/ranking/domain.py +++ b/src/cloudflare/resources/radar/ranking/domain.py @@ -66,25 +66,27 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DomainGetResponse: - """Gets Domains Rank details. + """Retrieves domain rank details. - Cloudflare provides an ordered rank for the top 100 - domains, but for the remainder it only provides ranking buckets like top 200 + Cloudflare provides an ordered rank for the top + 100 domains, but for the remainder it only provides ranking buckets like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints. Args: + domain: Domain name. + date: Array of dates to filter the ranking. - format: Format results are returned in. + format: Format in which results will be returned. - include_top_locations: Include top locations in the response. + include_top_locations: Includes top locations in the response. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - ranking_type: The ranking type. + ranking_type: Ranking type. extra_headers: Send extra headers @@ -157,25 +159,27 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> DomainGetResponse: - """Gets Domains Rank details. + """Retrieves domain rank details. - Cloudflare provides an ordered rank for the top 100 - domains, but for the remainder it only provides ranking buckets like top 200 + Cloudflare provides an ordered rank for the top + 100 domains, but for the remainder it only provides ranking buckets like top 200 thousand, top one million, etc.. These are available through Radar datasets endpoints. Args: + domain: Domain name. + date: Array of dates to filter the ranking. - format: Format results are returned in. + format: Format in which results will be returned. - include_top_locations: Include top locations in the response. + include_top_locations: Includes top locations in the response. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - ranking_type: The ranking type. + ranking_type: Ranking type. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/ranking/internet_services.py b/src/cloudflare/resources/radar/ranking/internet_services.py index abfa97aa3f2..f604a2daf48 100644 --- a/src/cloudflare/resources/radar/ranking/internet_services.py +++ b/src/cloudflare/resources/radar/ranking/internet_services.py @@ -67,26 +67,25 @@ def timeseries_groups( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InternetServiceTimeseriesGroupsResponse: - """Gets Internet Services rank update changes over time. - - Raw values are returned. + """ + Retrieves Internet Services rank update changes over time. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - service_category: Filter for services category. + service_category: Filters results by Internet service category. extra_headers: Send extra headers @@ -138,18 +137,18 @@ def top( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InternetServiceTopResponse: """ - Get top Internet services based on their rank. + Retrieves top Internet services based on their rank. Args: date: Array of dates to filter the ranking. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - service_category: Filter for services category. + service_category: Filters results by Internet service category. extra_headers: Send extra headers @@ -219,26 +218,25 @@ async def timeseries_groups( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InternetServiceTimeseriesGroupsResponse: - """Gets Internet Services rank update changes over time. - - Raw values are returned. + """ + Retrieves Internet Services rank update changes over time. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - service_category: Filter for services category. + service_category: Filters results by Internet service category. extra_headers: Send extra headers @@ -290,18 +288,18 @@ async def top( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> InternetServiceTopResponse: """ - Get top Internet services based on their rank. + Retrieves top Internet services based on their rank. Args: date: Array of dates to filter the ranking. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - service_category: Filter for services category. + service_category: Filters results by Internet service category. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/ranking/ranking.py b/src/cloudflare/resources/radar/ranking/ranking.py index 5880b49037c..5e46497e023 100644 --- a/src/cloudflare/resources/radar/ranking/ranking.py +++ b/src/cloudflare/resources/radar/ranking/ranking.py @@ -94,32 +94,31 @@ def timeseries_groups( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RankingTimeseriesGroupsResponse: - """Gets Domains Rank updates change over time. - - Raw values are returned. + """ + Retrieves domains rank over time. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - domain_category: Filter by domain category. + domain_category: Filters results by domain category. - domains: Array of comma separated list of domains names. + domains: Comma-separated list of domain names. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of locations (alpha-2 country codes). + location: Comma-separated list of locations (alpha-2 codes). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - ranking_type: The ranking type. + ranking_type: Ranking type. extra_headers: Send extra headers @@ -173,27 +172,27 @@ def top( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RankingTopResponse: - """Get top or trending domains based on their rank. + """Retrieves the top or trending domains based on their rank. - Popular domains are domains of - broad appeal based on how people use the Internet. Trending domains are domains - that are generating a surge in interest. For more information on top domains, - see https://blog.cloudflare.com/radar-domain-rankings/. + Popular domains are + domains of broad appeal based on how people use the Internet. Trending domains + are domains that are generating a surge in interest. For more information on top + domains, see https://blog.cloudflare.com/radar-domain-rankings/. Args: date: Array of dates to filter the ranking. - domain_category: Filter by domain category. + domain_category: Filters results by domain category. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of locations (alpha-2 country codes). + location: Comma-separated list of locations (alpha-2 codes). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - ranking_type: The ranking type. + ranking_type: Ranking type. extra_headers: Send extra headers @@ -276,32 +275,31 @@ async def timeseries_groups( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RankingTimeseriesGroupsResponse: - """Gets Domains Rank updates change over time. - - Raw values are returned. + """ + Retrieves domains rank over time. Args: date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - domain_category: Filter by domain category. + domain_category: Filters results by domain category. - domains: Array of comma separated list of domains names. + domains: Comma-separated list of domain names. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of locations (alpha-2 country codes). + location: Comma-separated list of locations (alpha-2 codes). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - ranking_type: The ranking type. + ranking_type: Ranking type. extra_headers: Send extra headers @@ -355,27 +353,27 @@ async def top( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> RankingTopResponse: - """Get top or trending domains based on their rank. + """Retrieves the top or trending domains based on their rank. - Popular domains are domains of - broad appeal based on how people use the Internet. Trending domains are domains - that are generating a surge in interest. For more information on top domains, - see https://blog.cloudflare.com/radar-domain-rankings/. + Popular domains are + domains of broad appeal based on how people use the Internet. Trending domains + are domains that are generating a surge in interest. For more information on top + domains, see https://blog.cloudflare.com/radar-domain-rankings/. Args: date: Array of dates to filter the ranking. - domain_category: Filter by domain category. + domain_category: Filters results by domain category. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of locations (alpha-2 country codes). + location: Comma-separated list of locations (alpha-2 codes). - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - ranking_type: The ranking type. + ranking_type: Ranking type. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/robots_txt/top/top.py b/src/cloudflare/resources/radar/robots_txt/top/top.py index a49a078fc72..e30d7cea4ea 100644 --- a/src/cloudflare/resources/radar/robots_txt/top/top.py +++ b/src/cloudflare/resources/radar/robots_txt/top/top.py @@ -77,18 +77,18 @@ def domain_categories( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopDomainCategoriesResponse: """ - Get the top domain categories by the number of robots.txt files parsed. + Retrieves the top domain categories by the number of robots.txt files parsed. Args: date: Array of dates to filter the ranking. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - user_agent_category: Filter by user agent category. + user_agent_category: Filters results by user agent category. extra_headers: Send extra headers @@ -161,18 +161,18 @@ async def domain_categories( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopDomainCategoriesResponse: """ - Get the top domain categories by the number of robots.txt files parsed. + Retrieves the top domain categories by the number of robots.txt files parsed. Args: date: Array of dates to filter the ranking. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - user_agent_category: Filter by user agent category. + user_agent_category: Filters results by user agent category. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/robots_txt/top/user_agents.py b/src/cloudflare/resources/radar/robots_txt/top/user_agents.py index 774f29ecaf5..603d7bbb868 100644 --- a/src/cloudflare/resources/radar/robots_txt/top/user_agents.py +++ b/src/cloudflare/resources/radar/robots_txt/top/user_agents.py @@ -67,22 +67,22 @@ def directive( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> UserAgentDirectiveResponse: """ - Get the top user agents on robots.txt files by directive. + Retrieves the top user agents on robots.txt files. Args: date: Array of dates to filter the ranking. - directive: Filter by directive. + directive: Filters results by robots.txt directive. - domain_category: Filter by domain category. + domain_category: Filters results by domain category. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - user_agent_category: Filter by user agent category. + user_agent_category: Filters results by user agent category. extra_headers: Send extra headers @@ -155,22 +155,22 @@ async def directive( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> UserAgentDirectiveResponse: """ - Get the top user agents on robots.txt files by directive. + Retrieves the top user agents on robots.txt files. Args: date: Array of dates to filter the ranking. - directive: Filter by directive. + directive: Filters results by robots.txt directive. - domain_category: Filter by domain category. + domain_category: Filters results by domain category. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. - user_agent_category: Filter by user agent category. + user_agent_category: Filters results by user agent category. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/search.py b/src/cloudflare/resources/radar/search.py index 52751f99375..c070a76f316 100644 --- a/src/cloudflare/resources/radar/search.py +++ b/src/cloudflare/resources/radar/search.py @@ -65,18 +65,18 @@ def global_( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SearchGlobalResponse: """ - Lets you search for locations, autonomous systems (ASes), and reports. + Searches for locations, autonomous systems, and reports. Args: - query: Search for locations, AS and reports. + query: Search for locations, autonomous systems and reports. exclude: Search types to be excluded from results. - format: Format results are returned in. + format: Format in which results will be returned. include: Search types to be included in results. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. limit_per_group: Limit the number of objects per search category. @@ -149,18 +149,18 @@ async def global_( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> SearchGlobalResponse: """ - Lets you search for locations, autonomous systems (ASes), and reports. + Searches for locations, autonomous systems, and reports. Args: - query: Search for locations, AS and reports. + query: Search for locations, autonomous systems and reports. exclude: Search types to be excluded from results. - format: Format results are returned in. + format: Format in which results will be returned. include: Search types to be included in results. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. limit_per_group: Limit the number of objects per search category. diff --git a/src/cloudflare/resources/radar/tcp_resets_timeouts.py b/src/cloudflare/resources/radar/tcp_resets_timeouts.py index 74c034cc349..3922164ea80 100644 --- a/src/cloudflare/resources/radar/tcp_resets_timeouts.py +++ b/src/cloudflare/resources/radar/tcp_resets_timeouts.py @@ -69,33 +69,33 @@ def summary( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TCPResetsTimeoutSummaryResponse: """ - Percentage distribution by connection stage of TCP connections terminated within - the first 10 packets by a reset or timeout, for a given time period. + Retrieves the distribution of connection stage by TCP connections terminated + within the first 10 packets by a reset or timeout. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -150,37 +150,37 @@ def timeseries_groups( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TCPResetsTimeoutTimeseriesGroupsResponse: """ - Percentage distribution by connection stage of TCP connections terminated within - the first 10 packets by a reset or timeout, over time. + Retrieves the distribution of connection stage by TCP connections terminated + within the first 10 packets by a reset or timeout over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -258,33 +258,33 @@ async def summary( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TCPResetsTimeoutSummaryResponse: """ - Percentage distribution by connection stage of TCP connections terminated within - the first 10 packets by a reset or timeout, for a given time period. + Retrieves the distribution of connection stage by TCP connections terminated + within the first 10 packets by a reset or timeout. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -339,37 +339,37 @@ async def timeseries_groups( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TCPResetsTimeoutTimeseriesGroupsResponse: """ - Percentage distribution by connection stage of TCP connections terminated within - the first 10 packets by a reset or timeout, over time. + Retrieves the distribution of connection stage by TCP connections terminated + within the first 10 packets by a reset or timeout over time. Args: agg_interval: Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/). - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/traffic_anomalies/locations.py b/src/cloudflare/resources/radar/traffic_anomalies/locations.py index fb20b5df6f7..cccbceff4c5 100644 --- a/src/cloudflare/resources/radar/traffic_anomalies/locations.py +++ b/src/cloudflare/resources/radar/traffic_anomalies/locations.py @@ -65,11 +65,11 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationGetResponse: - """Internet traffic anomalies are signals that might point to an outage. + """Retrieves the sum of Internet traffic anomalies, grouped by location. These - alerts are automatically detected by Radar and then manually verified by our - team. This endpoint returns the sum of alerts grouped by location. + anomalies are signals that might indicate an outage, automatically detected by + Radar and manually verified by our team. Args: date_end: End of the date range (inclusive). @@ -79,9 +79,9 @@ def get( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. extra_headers: Send extra headers @@ -151,11 +151,11 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> LocationGetResponse: - """Internet traffic anomalies are signals that might point to an outage. + """Retrieves the sum of Internet traffic anomalies, grouped by location. These - alerts are automatically detected by Radar and then manually verified by our - team. This endpoint returns the sum of alerts grouped by location. + anomalies are signals that might indicate an outage, automatically detected by + Radar and manually verified by our team. Args: date_end: End of the date range (inclusive). @@ -165,9 +165,9 @@ async def get( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/traffic_anomalies/traffic_anomalies.py b/src/cloudflare/resources/radar/traffic_anomalies/traffic_anomalies.py index eba1dee52cd..2bb5146b08c 100644 --- a/src/cloudflare/resources/radar/traffic_anomalies/traffic_anomalies.py +++ b/src/cloudflare/resources/radar/traffic_anomalies/traffic_anomalies.py @@ -80,14 +80,13 @@ def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TrafficAnomalyGetResponse: - """Internet traffic anomalies are signals that might point to an outage. - - These - alerts are automatically detected by Radar and then manually verified by our - team. This endpoint returns the latest alerts. + """ + Retrieves the latest Internet traffic anomalies, which are signals that might + indicate an outage. These alerts are automatically detected by Radar and + manually verified by our team. Args: - asn: Single ASN as integer. + asn: Single Autonomous System Number (ASN) as integer. date_end: End of the date range (inclusive). @@ -96,13 +95,13 @@ def get( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 code. + location: Location alpha-2 code. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers @@ -182,14 +181,13 @@ async def get( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TrafficAnomalyGetResponse: - """Internet traffic anomalies are signals that might point to an outage. - - These - alerts are automatically detected by Radar and then manually verified by our - team. This endpoint returns the latest alerts. + """ + Retrieves the latest Internet traffic anomalies, which are signals that might + indicate an outage. These alerts are automatically detected by Radar and + manually verified by our team. Args: - asn: Single ASN as integer. + asn: Single Autonomous System Number (ASN) as integer. date_end: End of the date range (inclusive). @@ -198,13 +196,13 @@ async def get( date_start: Start of the date range (inclusive). - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Location Alpha2 code. + location: Location alpha-2 code. - offset: Number of objects to skip before grabbing results. + offset: Skips the specified number of objects before fetching the results. extra_headers: Send extra headers diff --git a/src/cloudflare/resources/radar/verified_bots/top.py b/src/cloudflare/resources/radar/verified_bots/top.py index 4400b19e6fe..bb40d31672b 100644 --- a/src/cloudflare/resources/radar/verified_bots/top.py +++ b/src/cloudflare/resources/radar/verified_bots/top.py @@ -70,34 +70,34 @@ def bots( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopBotsResponse: """ - Get top verified bots by HTTP requests, with owner and category. + Retrieves the top verified bots by HTTP requests, with owner and category. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -153,35 +153,35 @@ def categories( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopCategoriesResponse: """ - Get top verified bot categories by HTTP requests, along with their corresponding - percentage, over the total verified bot HTTP requests. + Retrieves the top verified bot categories by HTTP requests, along with their + corresponding percentage, over the total verified bot HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -258,34 +258,34 @@ async def bots( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopBotsResponse: """ - Get top verified bots by HTTP requests, with owner and category. + Retrieves the top verified bots by HTTP requests, with owner and category. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers @@ -341,35 +341,35 @@ async def categories( timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN, ) -> TopCategoriesResponse: """ - Get top verified bot categories by HTTP requests, along with their corresponding - percentage, over the total verified bot HTTP requests. + Retrieves the top verified bot categories by HTTP requests, along with their + corresponding percentage, over the total verified bot HTTP requests. Args: - asn: Array of comma separated list of ASNs, start with `-` to exclude from results. - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + asn: Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to + exclude ASNs from results. For example, `-174, 3356` excludes results from + AS174, but includes results from AS3356. - continent: Array of comma separated list of continents (alpha-2 continent codes). Start - with `-` to exclude from results. For example, `-EU,NA` excludes results from - Europe, but includes results from North America. + continent: Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to + exclude continents from results. For example, `-EU,NA` excludes results from EU, + but includes results from NA. date_end: End of the date range (inclusive). - date_range: For example, use `7d` and `7dControl` to compare this week with the previous - week. Use this parameter or set specific start and end dates (`dateStart` and - `dateEnd` parameters). + date_range: Filters results by the specified date range. For example, use `7d` and + `7dcontrol` to compare this week with the previous week. Use this parameter or + set specific start and end dates (`dateStart` and `dateEnd` parameters). - date_start: Array of datetimes to filter the start of a series. + date_start: Start of the date range. - format: Format results are returned in. + format: Format in which results will be returned. - limit: Limit the number of objects in the response. + limit: Limits the number of objects returned in the response. - location: Array of comma separated list of locations (alpha-2 country codes). Start with - `-` to exclude from results. For example, `-US,PT` excludes results from the US, - but includes results from PT. + location: Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude + locations from results. For example, `-US,PT` excludes results from the US, but + includes results from PT. - name: Array of names that will be used to name the series in responses. + name: Array of names used to label the series in the response. extra_headers: Send extra headers diff --git a/src/cloudflare/types/radar/ai/bots/summary_user_agent_params.py b/src/cloudflare/types/radar/ai/bots/summary_user_agent_params.py index c9c5d2a8a7d..c3b19ac96e6 100644 --- a/src/cloudflare/types/radar/ai/bots/summary_user_agent_params.py +++ b/src/cloudflare/types/radar/ai/bots/summary_user_agent_params.py @@ -13,49 +13,50 @@ class SummaryUserAgentParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/ai/inference/summary_model_params.py b/src/cloudflare/types/radar/ai/inference/summary_model_params.py index 4c64260d54e..5ba87e45e11 100644 --- a/src/cloudflare/types/radar/ai/inference/summary_model_params.py +++ b/src/cloudflare/types/radar/ai/inference/summary_model_params.py @@ -16,25 +16,26 @@ class SummaryModelParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/ai/inference/summary_task_params.py b/src/cloudflare/types/radar/ai/inference/summary_task_params.py index 95c3d7c5001..bb1b07e5cb2 100644 --- a/src/cloudflare/types/radar/ai/inference/summary_task_params.py +++ b/src/cloudflare/types/radar/ai/inference/summary_task_params.py @@ -16,25 +16,26 @@ class SummaryTaskParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/ai/inference/timeseries_groups/summary_model_params.py b/src/cloudflare/types/radar/ai/inference/timeseries_groups/summary_model_params.py index 15e67216fa4..0e1abaf0eb4 100644 --- a/src/cloudflare/types/radar/ai/inference/timeseries_groups/summary_model_params.py +++ b/src/cloudflare/types/radar/ai/inference/timeseries_groups/summary_model_params.py @@ -23,25 +23,26 @@ class SummaryModelParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/ai/inference/timeseries_groups/summary_task_params.py b/src/cloudflare/types/radar/ai/inference/timeseries_groups/summary_task_params.py index 454700028ef..64d01e558d1 100644 --- a/src/cloudflare/types/radar/ai/inference/timeseries_groups/summary_task_params.py +++ b/src/cloudflare/types/radar/ai/inference/timeseries_groups/summary_task_params.py @@ -23,25 +23,26 @@ class SummaryTaskParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/ai/timeseries_group_user_agent_params.py b/src/cloudflare/types/radar/ai/timeseries_group_user_agent_params.py index 2872b380571..d3ff896bb48 100644 --- a/src/cloudflare/types/radar/ai/timeseries_group_user_agent_params.py +++ b/src/cloudflare/types/radar/ai/timeseries_group_user_agent_params.py @@ -20,49 +20,50 @@ class TimeseriesGroupUserAgentParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/annotation_list_params.py b/src/cloudflare/types/radar/annotation_list_params.py index 884c4c007d0..cce0763a000 100644 --- a/src/cloudflare/types/radar/annotation_list_params.py +++ b/src/cloudflare/types/radar/annotation_list_params.py @@ -13,7 +13,7 @@ class AnnotationListParams(TypedDict, total=False): asn: int - """Single ASN as integer.""" + """Single Autonomous System Number (ASN) as integer.""" date_end: Annotated[Union[str, datetime], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" @@ -28,13 +28,13 @@ class AnnotationListParams(TypedDict, total=False): """Start of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: str - """Location Alpha2 code.""" + """Location alpha-2 code.""" offset: int - """Number of objects to skip before grabbing results.""" + """Skips the specified number of objects before fetching the results.""" diff --git a/src/cloudflare/types/radar/annotations/outage_get_params.py b/src/cloudflare/types/radar/annotations/outage_get_params.py index 23df4113305..4b233de61dc 100644 --- a/src/cloudflare/types/radar/annotations/outage_get_params.py +++ b/src/cloudflare/types/radar/annotations/outage_get_params.py @@ -13,7 +13,7 @@ class OutageGetParams(TypedDict, total=False): asn: int - """Single ASN as integer.""" + """Single Autonomous System Number (ASN) as integer.""" date_end: Annotated[Union[str, datetime], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" @@ -28,13 +28,13 @@ class OutageGetParams(TypedDict, total=False): """Start of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: str - """Location Alpha2 code.""" + """Location alpha-2 code.""" offset: int - """Number of objects to skip before grabbing results.""" + """Skips the specified number of objects before fetching the results.""" diff --git a/src/cloudflare/types/radar/annotations/outage_locations_params.py b/src/cloudflare/types/radar/annotations/outage_locations_params.py index 51ae0778681..ae2cb30dab3 100644 --- a/src/cloudflare/types/radar/annotations/outage_locations_params.py +++ b/src/cloudflare/types/radar/annotations/outage_locations_params.py @@ -25,7 +25,7 @@ class OutageLocationsParams(TypedDict, total=False): """Start of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" diff --git a/src/cloudflare/types/radar/as112/summary_dnssec_params.py b/src/cloudflare/types/radar/as112/summary_dnssec_params.py index df69e836284..e85c9620edc 100644 --- a/src/cloudflare/types/radar/as112/summary_dnssec_params.py +++ b/src/cloudflare/types/radar/as112/summary_dnssec_params.py @@ -13,41 +13,42 @@ class SummaryDNSSECParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/summary_edns_params.py b/src/cloudflare/types/radar/as112/summary_edns_params.py index aa8cb759564..beea6363f97 100644 --- a/src/cloudflare/types/radar/as112/summary_edns_params.py +++ b/src/cloudflare/types/radar/as112/summary_edns_params.py @@ -13,41 +13,42 @@ class SummaryEdnsParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/summary_ip_version_params.py b/src/cloudflare/types/radar/as112/summary_ip_version_params.py index edf5caac4ef..7181e6a9542 100644 --- a/src/cloudflare/types/radar/as112/summary_ip_version_params.py +++ b/src/cloudflare/types/radar/as112/summary_ip_version_params.py @@ -13,41 +13,42 @@ class SummaryIPVersionParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/summary_protocol_params.py b/src/cloudflare/types/radar/as112/summary_protocol_params.py index bfe7e77315b..1ca3107bcad 100644 --- a/src/cloudflare/types/radar/as112/summary_protocol_params.py +++ b/src/cloudflare/types/radar/as112/summary_protocol_params.py @@ -13,41 +13,42 @@ class SummaryProtocolParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/summary_query_type_params.py b/src/cloudflare/types/radar/as112/summary_query_type_params.py index cf165b13dc5..61b5dbbf095 100644 --- a/src/cloudflare/types/radar/as112/summary_query_type_params.py +++ b/src/cloudflare/types/radar/as112/summary_query_type_params.py @@ -13,49 +13,50 @@ class SummaryQueryTypeParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/summary_response_codes_params.py b/src/cloudflare/types/radar/as112/summary_response_codes_params.py index 8408087e475..4e0ebd3d0b4 100644 --- a/src/cloudflare/types/radar/as112/summary_response_codes_params.py +++ b/src/cloudflare/types/radar/as112/summary_response_codes_params.py @@ -13,49 +13,50 @@ class SummaryResponseCodesParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/timeseries_group_dnssec_params.py b/src/cloudflare/types/radar/as112/timeseries_group_dnssec_params.py index d818ce2ddf2..e15ffb2bf11 100644 --- a/src/cloudflare/types/radar/as112/timeseries_group_dnssec_params.py +++ b/src/cloudflare/types/radar/as112/timeseries_group_dnssec_params.py @@ -20,41 +20,42 @@ class TimeseriesGroupDNSSECParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/timeseries_group_edns_params.py b/src/cloudflare/types/radar/as112/timeseries_group_edns_params.py index cde360d1e43..5aa1ec39e40 100644 --- a/src/cloudflare/types/radar/as112/timeseries_group_edns_params.py +++ b/src/cloudflare/types/radar/as112/timeseries_group_edns_params.py @@ -20,41 +20,42 @@ class TimeseriesGroupEdnsParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/timeseries_group_ip_version_params.py b/src/cloudflare/types/radar/as112/timeseries_group_ip_version_params.py index 54f655692fb..355582109a6 100644 --- a/src/cloudflare/types/radar/as112/timeseries_group_ip_version_params.py +++ b/src/cloudflare/types/radar/as112/timeseries_group_ip_version_params.py @@ -20,41 +20,42 @@ class TimeseriesGroupIPVersionParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/timeseries_group_protocol_params.py b/src/cloudflare/types/radar/as112/timeseries_group_protocol_params.py index deb737e61b1..fb7b9eb574c 100644 --- a/src/cloudflare/types/radar/as112/timeseries_group_protocol_params.py +++ b/src/cloudflare/types/radar/as112/timeseries_group_protocol_params.py @@ -20,41 +20,42 @@ class TimeseriesGroupProtocolParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/timeseries_group_query_type_params.py b/src/cloudflare/types/radar/as112/timeseries_group_query_type_params.py index e8223ad7587..0562fa3785e 100644 --- a/src/cloudflare/types/radar/as112/timeseries_group_query_type_params.py +++ b/src/cloudflare/types/radar/as112/timeseries_group_query_type_params.py @@ -20,49 +20,50 @@ class TimeseriesGroupQueryTypeParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/timeseries_group_response_codes_params.py b/src/cloudflare/types/radar/as112/timeseries_group_response_codes_params.py index f1377b2ca94..7d78e79b65a 100644 --- a/src/cloudflare/types/radar/as112/timeseries_group_response_codes_params.py +++ b/src/cloudflare/types/radar/as112/timeseries_group_response_codes_params.py @@ -20,49 +20,50 @@ class TimeseriesGroupResponseCodesParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/top_dnssec_params.py b/src/cloudflare/types/radar/as112/top_dnssec_params.py index 9f46b8ec011..e3c10d7a312 100644 --- a/src/cloudflare/types/radar/as112/top_dnssec_params.py +++ b/src/cloudflare/types/radar/as112/top_dnssec_params.py @@ -13,44 +13,45 @@ class TopDNSSECParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/top_edns_params.py b/src/cloudflare/types/radar/as112/top_edns_params.py index 046c0d251b6..4505e90325e 100644 --- a/src/cloudflare/types/radar/as112/top_edns_params.py +++ b/src/cloudflare/types/radar/as112/top_edns_params.py @@ -13,44 +13,45 @@ class TopEdnsParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/top_ip_version_params.py b/src/cloudflare/types/radar/as112/top_ip_version_params.py index 18ff8eb6a9b..eae79b17012 100644 --- a/src/cloudflare/types/radar/as112/top_ip_version_params.py +++ b/src/cloudflare/types/radar/as112/top_ip_version_params.py @@ -13,44 +13,45 @@ class TopIPVersionParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112/top_locations_params.py b/src/cloudflare/types/radar/as112/top_locations_params.py index 74b6631d0b9..8bcca93a00b 100644 --- a/src/cloudflare/types/radar/as112/top_locations_params.py +++ b/src/cloudflare/types/radar/as112/top_locations_params.py @@ -13,44 +13,45 @@ class TopLocationsParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/as112_timeseries_params.py b/src/cloudflare/types/radar/as112_timeseries_params.py index c2e37c6ce35..74cd6477b4e 100644 --- a/src/cloudflare/types/radar/as112_timeseries_params.py +++ b/src/cloudflare/types/radar/as112_timeseries_params.py @@ -20,41 +20,42 @@ class AS112TimeseriesParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/summary_bitrate_params.py b/src/cloudflare/types/radar/attacks/layer3/summary_bitrate_params.py index b4d0b88d8fb..5870dc85ffa 100644 --- a/src/cloudflare/types/radar/attacks/layer3/summary_bitrate_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/summary_bitrate_params.py @@ -13,24 +13,25 @@ class SummaryBitrateParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -39,20 +40,20 @@ class SummaryBitrateParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] """Array of L3/4 attack types.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/summary_duration_params.py b/src/cloudflare/types/radar/attacks/layer3/summary_duration_params.py index 615fe97285f..a7b9924330d 100644 --- a/src/cloudflare/types/radar/attacks/layer3/summary_duration_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/summary_duration_params.py @@ -13,24 +13,25 @@ class SummaryDurationParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -39,20 +40,20 @@ class SummaryDurationParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] """Array of L3/4 attack types.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/summary_ip_version_params.py b/src/cloudflare/types/radar/attacks/layer3/summary_ip_version_params.py index b1ab3c41730..672a96d01a6 100644 --- a/src/cloudflare/types/radar/attacks/layer3/summary_ip_version_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/summary_ip_version_params.py @@ -13,24 +13,25 @@ class SummaryIPVersionParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -39,17 +40,17 @@ class SummaryIPVersionParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] """Array of L3/4 attack types.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/summary_protocol_params.py b/src/cloudflare/types/radar/attacks/layer3/summary_protocol_params.py index f3c6e1f2d4e..55df6c13b3c 100644 --- a/src/cloudflare/types/radar/attacks/layer3/summary_protocol_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/summary_protocol_params.py @@ -13,24 +13,25 @@ class SummaryProtocolParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -39,17 +40,17 @@ class SummaryProtocolParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/summary_vector_params.py b/src/cloudflare/types/radar/attacks/layer3/summary_vector_params.py index 6b5744619ee..0b26e85f3e4 100644 --- a/src/cloudflare/types/radar/attacks/layer3/summary_vector_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/summary_vector_params.py @@ -13,24 +13,25 @@ class SummaryVectorParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -39,28 +40,28 @@ class SummaryVectorParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] """Array of L3/4 attack types.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_bitrate_params.py b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_bitrate_params.py index 9ef70e178ad..606fd938b33 100644 --- a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_bitrate_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_bitrate_params.py @@ -20,24 +20,25 @@ class TimeseriesGroupBitrateParams(TypedDict, total=False): """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -46,20 +47,20 @@ class TimeseriesGroupBitrateParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_duration_params.py b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_duration_params.py index 0ac1f04ea12..92584ab488a 100644 --- a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_duration_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_duration_params.py @@ -20,24 +20,25 @@ class TimeseriesGroupDurationParams(TypedDict, total=False): """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -46,20 +47,20 @@ class TimeseriesGroupDurationParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_industry_params.py b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_industry_params.py index 515faeaacb9..a6784a97974 100644 --- a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_industry_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_industry_params.py @@ -20,24 +20,25 @@ class TimeseriesGroupIndustryParams(TypedDict, total=False): """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -46,28 +47,28 @@ class TimeseriesGroupIndustryParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_ip_version_params.py b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_ip_version_params.py index 5f8b50a1f23..ec100f21090 100644 --- a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_ip_version_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_ip_version_params.py @@ -20,24 +20,25 @@ class TimeseriesGroupIPVersionParams(TypedDict, total=False): """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -46,17 +47,17 @@ class TimeseriesGroupIPVersionParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_protocol_params.py b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_protocol_params.py index c96f496eb67..95b2acf43de 100644 --- a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_protocol_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_protocol_params.py @@ -20,24 +20,25 @@ class TimeseriesGroupProtocolParams(TypedDict, total=False): """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -46,20 +47,20 @@ class TimeseriesGroupProtocolParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_vector_params.py b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_vector_params.py index fbaa2b94630..80e79d2bf05 100644 --- a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_vector_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_vector_params.py @@ -20,24 +20,25 @@ class TimeseriesGroupVectorParams(TypedDict, total=False): """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -46,28 +47,28 @@ class TimeseriesGroupVectorParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_vertical_params.py b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_vertical_params.py index d743ba599a2..4e03a094b5f 100644 --- a/src/cloudflare/types/radar/attacks/layer3/timeseries_group_vertical_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/timeseries_group_vertical_params.py @@ -20,24 +20,25 @@ class TimeseriesGroupVerticalParams(TypedDict, total=False): """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -46,28 +47,28 @@ class TimeseriesGroupVerticalParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer3/top/location_origin_params.py b/src/cloudflare/types/radar/attacks/layer3/top/location_origin_params.py index 06ae05b878d..0617eb0b497 100644 --- a/src/cloudflare/types/radar/attacks/layer3/top/location_origin_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/top/location_origin_params.py @@ -13,43 +13,44 @@ class LocationOriginParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] """Array of L3/4 attack types.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/top/location_target_params.py b/src/cloudflare/types/radar/attacks/layer3/top/location_target_params.py index 4b1f0a0e41d..08bceffaacd 100644 --- a/src/cloudflare/types/radar/attacks/layer3/top/location_target_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/top/location_target_params.py @@ -13,43 +13,44 @@ class LocationTargetParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] """Array of L3/4 attack types.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/top_attacks_params.py b/src/cloudflare/types/radar/attacks/layer3/top_attacks_params.py index a93d37a6324..e9a3ac145dc 100644 --- a/src/cloudflare/types/radar/attacks/layer3/top_attacks_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/top_attacks_params.py @@ -13,33 +13,34 @@ class TopAttacksParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" limit_direction: Annotated[Literal["ORIGIN", "TARGET"], PropertyInfo(alias="limitDirection")] """Array of attack origin/target location attack limits. @@ -50,19 +51,25 @@ class TopAttacksParams(TypedDict, total=False): limit_per_location: Annotated[int, PropertyInfo(alias="limitPerLocation")] """ - Limit the number of attacks per origin/target (refer to `limitDirection` + Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. + """ + + magnitude: Literal["MITIGATED_BYTES", "MITIGATED_ATTACKS"] + """ + Attack magnitude can be defined by total mitigated bytes or by total mitigated + attacks. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer3/top_industry_params.py b/src/cloudflare/types/radar/attacks/layer3/top_industry_params.py index 41360260afa..986cc889b8b 100644 --- a/src/cloudflare/types/radar/attacks/layer3/top_industry_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/top_industry_params.py @@ -13,43 +13,44 @@ class TopIndustryParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] """Array of L3/4 attack types.""" diff --git a/src/cloudflare/types/radar/attacks/layer3/top_vertical_params.py b/src/cloudflare/types/radar/attacks/layer3/top_vertical_params.py index d04759c7af9..19576209aa8 100644 --- a/src/cloudflare/types/radar/attacks/layer3/top_vertical_params.py +++ b/src/cloudflare/types/radar/attacks/layer3/top_vertical_params.py @@ -13,43 +13,44 @@ class TopVerticalParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" protocol: List[Literal["UDP", "TCP", "ICMP", "GRE"]] """Array of L3/4 attack types.""" diff --git a/src/cloudflare/types/radar/attacks/layer3_timeseries_params.py b/src/cloudflare/types/radar/attacks/layer3_timeseries_params.py index 61c6eb22613..f934c657d3d 100644 --- a/src/cloudflare/types/radar/attacks/layer3_timeseries_params.py +++ b/src/cloudflare/types/radar/attacks/layer3_timeseries_params.py @@ -20,31 +20,32 @@ class Layer3TimeseriesParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" direction: Literal["ORIGIN", "TARGET"] """ @@ -53,23 +54,23 @@ class Layer3TimeseriesParams(TypedDict, total=False): """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ metric: Literal["BYTES", "BYTES_OLD"] """Measurement units, eg. bytes.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE_CHANGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/summary_http_method_params.py b/src/cloudflare/types/radar/attacks/layer7/summary_http_method_params.py index bbdab4eeeb2..1b4d91ca4ac 100644 --- a/src/cloudflare/types/radar/attacks/layer7/summary_http_method_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/summary_http_method_params.py @@ -13,54 +13,55 @@ class SummaryHTTPMethodParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -74,4 +75,4 @@ class SummaryHTTPMethodParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/summary_http_version_params.py b/src/cloudflare/types/radar/attacks/layer7/summary_http_version_params.py index 7a900629d0f..b350058d8d1 100644 --- a/src/cloudflare/types/radar/attacks/layer7/summary_http_version_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/summary_http_version_params.py @@ -13,34 +13,35 @@ class SummaryHTTPVersionParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -95,16 +96,16 @@ class SummaryHTTPVersionParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -118,4 +119,4 @@ class SummaryHTTPVersionParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/summary_ip_version_params.py b/src/cloudflare/types/radar/attacks/layer7/summary_ip_version_params.py index 9a7e6f3ccff..ccf528d9a2e 100644 --- a/src/cloudflare/types/radar/attacks/layer7/summary_ip_version_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/summary_ip_version_params.py @@ -13,34 +13,35 @@ class SummaryIPVersionParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -95,16 +96,16 @@ class SummaryIPVersionParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -118,4 +119,4 @@ class SummaryIPVersionParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/summary_managed_rules_params.py b/src/cloudflare/types/radar/attacks/layer7/summary_managed_rules_params.py index 7806a0a359f..43f7614a2a8 100644 --- a/src/cloudflare/types/radar/attacks/layer7/summary_managed_rules_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/summary_managed_rules_params.py @@ -13,34 +13,35 @@ class SummaryManagedRulesParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -95,27 +96,27 @@ class SummaryManagedRulesParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -129,4 +130,4 @@ class SummaryManagedRulesParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/summary_mitigation_product_params.py b/src/cloudflare/types/radar/attacks/layer7/summary_mitigation_product_params.py index 4b27aa2249a..7c82f1cd77a 100644 --- a/src/cloudflare/types/radar/attacks/layer7/summary_mitigation_product_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/summary_mitigation_product_params.py @@ -13,34 +13,35 @@ class SummaryMitigationProductParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -95,28 +96,28 @@ class SummaryMitigationProductParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_http_method_params.py b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_http_method_params.py index debc2ef8f21..6a096fe5052 100644 --- a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_http_method_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_http_method_params.py @@ -20,54 +20,55 @@ class TimeseriesGroupHTTPMethodParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -81,7 +82,7 @@ class TimeseriesGroupHTTPMethodParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_http_version_params.py b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_http_version_params.py index f2c435b5132..26cba2ba13a 100644 --- a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_http_version_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_http_version_params.py @@ -20,34 +20,35 @@ class TimeseriesGroupHTTPVersionParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -102,16 +103,16 @@ class TimeseriesGroupHTTPVersionParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -125,7 +126,7 @@ class TimeseriesGroupHTTPVersionParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_industry_params.py b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_industry_params.py index aa5b1132116..5918096479c 100644 --- a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_industry_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_industry_params.py @@ -20,34 +20,35 @@ class TimeseriesGroupIndustryParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -102,27 +103,27 @@ class TimeseriesGroupIndustryParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -136,7 +137,7 @@ class TimeseriesGroupIndustryParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_ip_version_params.py b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_ip_version_params.py index dfeee4f83b4..5ff212f3550 100644 --- a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_ip_version_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_ip_version_params.py @@ -20,34 +20,35 @@ class TimeseriesGroupIPVersionParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -102,16 +103,16 @@ class TimeseriesGroupIPVersionParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -125,7 +126,7 @@ class TimeseriesGroupIPVersionParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_managed_rules_params.py b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_managed_rules_params.py index 1a5f1348cf7..477120ee018 100644 --- a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_managed_rules_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_managed_rules_params.py @@ -20,34 +20,35 @@ class TimeseriesGroupManagedRulesParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -102,27 +103,27 @@ class TimeseriesGroupManagedRulesParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -136,7 +137,7 @@ class TimeseriesGroupManagedRulesParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_mitigation_product_params.py b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_mitigation_product_params.py index f3b8c35235e..68b64a0b58b 100644 --- a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_mitigation_product_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_mitigation_product_params.py @@ -20,34 +20,35 @@ class TimeseriesGroupMitigationProductParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -102,31 +103,31 @@ class TimeseriesGroupMitigationProductParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_vertical_params.py b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_vertical_params.py index 6d44b7cfad4..624241930e9 100644 --- a/src/cloudflare/types/radar/attacks/layer7/timeseries_group_vertical_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/timeseries_group_vertical_params.py @@ -20,34 +20,35 @@ class TimeseriesGroupVerticalParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -102,27 +103,27 @@ class TimeseriesGroupVerticalParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -136,7 +137,7 @@ class TimeseriesGroupVerticalParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/top/ase_origin_params.py b/src/cloudflare/types/radar/attacks/layer7/top/ase_origin_params.py index 17099f3e08c..80a2ec7ed6d 100644 --- a/src/cloudflare/types/radar/attacks/layer7/top/ase_origin_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/top/ase_origin_params.py @@ -13,27 +13,28 @@ class AseOriginParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -88,22 +89,22 @@ class AseOriginParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -117,4 +118,4 @@ class AseOriginParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/top/location_origin_params.py b/src/cloudflare/types/radar/attacks/layer7/top/location_origin_params.py index 58aa33984ac..259fe3fe817 100644 --- a/src/cloudflare/types/radar/attacks/layer7/top/location_origin_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/top/location_origin_params.py @@ -13,34 +13,35 @@ class LocationOriginParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -95,16 +96,16 @@ class LocationOriginParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" mitigation_product: Annotated[ List[ @@ -117,4 +118,4 @@ class LocationOriginParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/top/location_target_params.py b/src/cloudflare/types/radar/attacks/layer7/top/location_target_params.py index 50a57bfe056..ba9cf22e5d2 100644 --- a/src/cloudflare/types/radar/attacks/layer7/top/location_target_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/top/location_target_params.py @@ -13,27 +13,28 @@ class LocationTargetParams(TypedDict, total=False): continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -88,16 +89,16 @@ class LocationTargetParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" mitigation_product: Annotated[ List[ @@ -110,4 +111,4 @@ class LocationTargetParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/top_attacks_params.py b/src/cloudflare/types/radar/attacks/layer7/top_attacks_params.py index d735b60cb91..0b37953159b 100644 --- a/src/cloudflare/types/radar/attacks/layer7/top_attacks_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/top_attacks_params.py @@ -13,34 +13,35 @@ class TopAttacksParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -95,16 +96,16 @@ class TopAttacksParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" limit_direction: Annotated[Literal["ORIGIN", "TARGET"], PropertyInfo(alias="limitDirection")] """Array of attack origin/target location attack limits. @@ -115,15 +116,15 @@ class TopAttacksParams(TypedDict, total=False): limit_per_location: Annotated[int, PropertyInfo(alias="limitPerLocation")] """ - Limit the number of attacks per origin/target (refer to `limitDirection` + Limits the number of attacks per origin/target (refer to `limitDirection` parameter) location. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ magnitude: Literal["AFFECTED_ZONES", "MITIGATED_REQUESTS"] @@ -143,7 +144,7 @@ class TopAttacksParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE", "MIN_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/attacks/layer7/top_industry_params.py b/src/cloudflare/types/radar/attacks/layer7/top_industry_params.py index 54c26d71680..8b00bdca991 100644 --- a/src/cloudflare/types/radar/attacks/layer7/top_industry_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/top_industry_params.py @@ -13,34 +13,35 @@ class TopIndustryParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -95,22 +96,22 @@ class TopIndustryParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -124,4 +125,4 @@ class TopIndustryParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7/top_vertical_params.py b/src/cloudflare/types/radar/attacks/layer7/top_vertical_params.py index cb941de5c43..920afad3298 100644 --- a/src/cloudflare/types/radar/attacks/layer7/top_vertical_params.py +++ b/src/cloudflare/types/radar/attacks/layer7/top_vertical_params.py @@ -13,34 +13,35 @@ class TopVerticalParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -95,22 +96,22 @@ class TopVerticalParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -124,4 +125,4 @@ class TopVerticalParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/attacks/layer7_timeseries_params.py b/src/cloudflare/types/radar/attacks/layer7_timeseries_params.py index 1808607d48b..4d3af21b5cd 100644 --- a/src/cloudflare/types/radar/attacks/layer7_timeseries_params.py +++ b/src/cloudflare/types/radar/attacks/layer7_timeseries_params.py @@ -20,10 +20,10 @@ class Layer7TimeseriesParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ attack: List[ @@ -32,27 +32,28 @@ class Layer7TimeseriesParams(TypedDict, total=False): """This field is deprecated, please use the new `mitigationProduct`.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_method: Annotated[ List[ @@ -107,19 +108,19 @@ class Layer7TimeseriesParams(TypedDict, total=False): ], PropertyInfo(alias="httpMethod"), ] - """Filter for http method.""" + """Filters results by HTTP method.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ mitigation_product: Annotated[ @@ -133,7 +134,7 @@ class Layer7TimeseriesParams(TypedDict, total=False): """Array of L7 mitigation products.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE_CHANGE", "MIN0_MAX"] """Normalization method applied. diff --git a/src/cloudflare/types/radar/bgp/hijacks/event_list_params.py b/src/cloudflare/types/radar/bgp/hijacks/event_list_params.py index 7433cf1aae5..aad07d56b79 100644 --- a/src/cloudflare/types/radar/bgp/hijacks/event_list_params.py +++ b/src/cloudflare/types/radar/bgp/hijacks/event_list_params.py @@ -25,40 +25,40 @@ class EventListParams(TypedDict, total=False): """Start of the date range (inclusive).""" event_id: Annotated[int, PropertyInfo(alias="eventId")] - """The unique identifier of a event""" + """The unique identifier of a event.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" hijacker_asn: Annotated[int, PropertyInfo(alias="hijackerAsn")] - """The potential hijacker AS of a BGP hijack event""" + """The potential hijacker AS of a BGP hijack event.""" involved_asn: Annotated[int, PropertyInfo(alias="involvedAsn")] - """The potential hijacker or victim AS of a BGP hijack event""" + """The potential hijacker or victim AS of a BGP hijack event.""" involved_country: Annotated[str, PropertyInfo(alias="involvedCountry")] - """The country code of the potential hijacker or victim AS of a BGP hijack event""" + """The country code of the potential hijacker or victim AS of a BGP hijack event.""" max_confidence: Annotated[int, PropertyInfo(alias="maxConfidence")] - """The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)""" + """The maximum confidence score to filter events (1-4 low, 5-7 mid, 8+ high).""" min_confidence: Annotated[int, PropertyInfo(alias="minConfidence")] - """The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high)""" + """The minimum confidence score to filter events (1-4 low, 5-7 mid, 8+ high).""" page: int - """Current page number, starting from 1""" + """Current page number, starting from 1.""" per_page: int - """Number of entries per page""" + """Number of entries per page.""" prefix: str """Network prefix, IPv4 or IPv6.""" sort_by: Annotated[Literal["ID", "TIME", "CONFIDENCE"], PropertyInfo(alias="sortBy")] - """Sort events by field""" + """Sorts results by the specified field.""" sort_order: Annotated[Literal["ASC", "DESC"], PropertyInfo(alias="sortOrder")] - """Sort order""" + """Sort order.""" victim_asn: Annotated[int, PropertyInfo(alias="victimAsn")] - """The potential victim AS of a BGP hijack event""" + """The potential victim AS of a BGP hijack event.""" diff --git a/src/cloudflare/types/radar/bgp/ip_timeseries_params.py b/src/cloudflare/types/radar/bgp/ip_timeseries_params.py index 4eead42aca9..c383845aabb 100644 --- a/src/cloudflare/types/radar/bgp/ip_timeseries_params.py +++ b/src/cloudflare/types/radar/bgp/ip_timeseries_params.py @@ -13,36 +13,37 @@ class IPTimeseriesParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" include_delay: Annotated[bool, PropertyInfo(alias="includeDelay")] - """Include data delay meta information""" + """Include data delay meta information.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of locations (alpha-2 country codes).""" + """Comma-separated list of locations (alpha-2 codes).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/bgp/leaks/event_list_params.py b/src/cloudflare/types/radar/bgp/leaks/event_list_params.py index a9773f39dfa..66f7abde0b9 100644 --- a/src/cloudflare/types/radar/bgp/leaks/event_list_params.py +++ b/src/cloudflare/types/radar/bgp/leaks/event_list_params.py @@ -25,28 +25,28 @@ class EventListParams(TypedDict, total=False): """Start of the date range (inclusive).""" event_id: Annotated[int, PropertyInfo(alias="eventId")] - """The unique identifier of a event""" + """The unique identifier of a event.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" involved_asn: Annotated[int, PropertyInfo(alias="involvedAsn")] - """ASN that is causing or affected by a route leak event""" + """ASN that is causing or affected by a route leak event.""" involved_country: Annotated[str, PropertyInfo(alias="involvedCountry")] - """Country code of a involved ASN in a route leak event""" + """Country code of a involved ASN in a route leak event.""" leak_asn: Annotated[int, PropertyInfo(alias="leakAsn")] - """The leaking AS of a route leak event""" + """The leaking AS of a route leak event.""" page: int - """Current page number, starting from 1""" + """Current page number, starting from 1.""" per_page: int - """Number of entries per page""" + """Number of entries per page.""" sort_by: Annotated[Literal["ID", "LEAKS", "PEERS", "PREFIXES", "ORIGINS", "TIME"], PropertyInfo(alias="sortBy")] - """Sort events by field""" + """Sorts results by the specified field.""" sort_order: Annotated[Literal["ASC", "DESC"], PropertyInfo(alias="sortOrder")] - """Sort order""" + """Sort order.""" diff --git a/src/cloudflare/types/radar/bgp/route_ases_params.py b/src/cloudflare/types/radar/bgp/route_ases_params.py index 734a74168f0..5b7f3a62624 100644 --- a/src/cloudflare/types/radar/bgp/route_ases_params.py +++ b/src/cloudflare/types/radar/bgp/route_ases_params.py @@ -11,19 +11,19 @@ class RouteAsesParams(TypedDict, total=False): format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: str - """Location Alpha2 code.""" + """Location alpha-2 code.""" sort_by: Annotated[ Literal["cone", "pfxs", "ipv4", "ipv6", "rpki_valid", "rpki_invalid", "rpki_unknown"], PropertyInfo(alias="sortBy"), ] - """Return order results by given type""" + """Sorts results by the specified field.""" - sort_order: Annotated[Literal["asc", "desc"], PropertyInfo(alias="sortOrder")] - """Sort by value ascending or descending""" + sort_order: Annotated[Literal["ASC", "DESC"], PropertyInfo(alias="sortOrder")] + """Sort order.""" diff --git a/src/cloudflare/types/radar/bgp/route_moas_params.py b/src/cloudflare/types/radar/bgp/route_moas_params.py index 8bf9d86d6c6..eb1675105b4 100644 --- a/src/cloudflare/types/radar/bgp/route_moas_params.py +++ b/src/cloudflare/types/radar/bgp/route_moas_params.py @@ -9,13 +9,13 @@ class RouteMoasParams(TypedDict, total=False): format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" invalid_only: bool - """Lookup only RPKI invalid MOASes""" + """Lookup only RPKI invalid MOASes.""" origin: int - """Lookup MOASes originated by the given ASN""" + """Lookup MOASes originated by the given ASN.""" prefix: str """Network prefix, IPv4 or IPv6.""" diff --git a/src/cloudflare/types/radar/bgp/route_pfx2as_params.py b/src/cloudflare/types/radar/bgp/route_pfx2as_params.py index caa3a87e8b0..1e996832360 100644 --- a/src/cloudflare/types/radar/bgp/route_pfx2as_params.py +++ b/src/cloudflare/types/radar/bgp/route_pfx2as_params.py @@ -11,7 +11,7 @@ class RoutePfx2asParams(TypedDict, total=False): format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" longest_prefix_match: Annotated[bool, PropertyInfo(alias="longestPrefixMatch")] """Return only results with the longest prefix match for the given prefix. @@ -20,10 +20,10 @@ class RoutePfx2asParams(TypedDict, total=False): """ origin: int - """Lookup prefixes originated by the given ASN""" + """Lookup prefixes originated by the given ASN.""" prefix: str """Network prefix, IPv4 or IPv6.""" rpki_status: Annotated[Literal["VALID", "INVALID", "UNKNOWN"], PropertyInfo(alias="rpkiStatus")] - """Return only results with matching rpki status: valid, invalid or unknown""" + """Return only results with matching rpki status: valid, invalid or unknown.""" diff --git a/src/cloudflare/types/radar/bgp/route_stats_params.py b/src/cloudflare/types/radar/bgp/route_stats_params.py index 0cd7211c5b4..dc42ead7c26 100644 --- a/src/cloudflare/types/radar/bgp/route_stats_params.py +++ b/src/cloudflare/types/radar/bgp/route_stats_params.py @@ -9,10 +9,10 @@ class RouteStatsParams(TypedDict, total=False): asn: int - """Single ASN as integer.""" + """Single Autonomous System Number (ASN) as integer.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: str - """Location Alpha2 code.""" + """Location alpha-2 code.""" diff --git a/src/cloudflare/types/radar/bgp/top/ase_get_params.py b/src/cloudflare/types/radar/bgp/top/ase_get_params.py index 4073484c048..a388e94b804 100644 --- a/src/cloudflare/types/radar/bgp/top/ase_get_params.py +++ b/src/cloudflare/types/radar/bgp/top/ase_get_params.py @@ -13,33 +13,34 @@ class AseGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" prefix: List[str] """Array of BGP network prefixes.""" diff --git a/src/cloudflare/types/radar/bgp/top/ase_prefixes_params.py b/src/cloudflare/types/radar/bgp/top/ase_prefixes_params.py index c9c9492ee5c..b54a76cf9bb 100644 --- a/src/cloudflare/types/radar/bgp/top/ase_prefixes_params.py +++ b/src/cloudflare/types/radar/bgp/top/ase_prefixes_params.py @@ -12,7 +12,7 @@ class AsePrefixesParams(TypedDict, total=False): """Alpha-2 country code.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Maximum number of ASes to return""" + """Maximum number of ASes to return.""" diff --git a/src/cloudflare/types/radar/bgp/top_prefixes_params.py b/src/cloudflare/types/radar/bgp/top_prefixes_params.py index a73c20fb3c6..dd2e36b8629 100644 --- a/src/cloudflare/types/radar/bgp/top_prefixes_params.py +++ b/src/cloudflare/types/radar/bgp/top_prefixes_params.py @@ -13,33 +13,34 @@ class TopPrefixesParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" update_type: Annotated[List[Literal["ANNOUNCEMENT", "WITHDRAWAL"]], PropertyInfo(alias="updateType")] """Array of BGP update types.""" diff --git a/src/cloudflare/types/radar/bgp_timeseries_params.py b/src/cloudflare/types/radar/bgp_timeseries_params.py index df2ef13b543..b53c7a6acea 100644 --- a/src/cloudflare/types/radar/bgp_timeseries_params.py +++ b/src/cloudflare/types/radar/bgp_timeseries_params.py @@ -20,30 +20,31 @@ class BGPTimeseriesParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" prefix: List[str] """Array of BGP network prefixes.""" diff --git a/src/cloudflare/types/radar/dataset_download_params.py b/src/cloudflare/types/radar/dataset_download_params.py index 6921739ca44..40aaab98d01 100644 --- a/src/cloudflare/types/radar/dataset_download_params.py +++ b/src/cloudflare/types/radar/dataset_download_params.py @@ -13,4 +13,4 @@ class DatasetDownloadParams(TypedDict, total=False): dataset_id: Required[Annotated[int, PropertyInfo(alias="datasetId")]] format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" diff --git a/src/cloudflare/types/radar/dataset_list_params.py b/src/cloudflare/types/radar/dataset_list_params.py index 9e2a161f36f..d1c779cec44 100644 --- a/src/cloudflare/types/radar/dataset_list_params.py +++ b/src/cloudflare/types/radar/dataset_list_params.py @@ -11,13 +11,13 @@ class DatasetListParams(TypedDict, total=False): dataset_type: Annotated[Literal["RANKING_BUCKET", "REPORT"], PropertyInfo(alias="datasetType")] - """Dataset type.""" + """Filters results by dataset type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" offset: int - """Number of objects to skip before grabbing results.""" + """Skips the specified number of objects before fetching the results.""" diff --git a/src/cloudflare/types/radar/dns/top_ases_params.py b/src/cloudflare/types/radar/dns/top_ases_params.py index 7cf911c139b..e35a22098d0 100644 --- a/src/cloudflare/types/radar/dns/top_ases_params.py +++ b/src/cloudflare/types/radar/dns/top_ases_params.py @@ -13,47 +13,48 @@ class TopAsesParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" domain: List[str] """Array of domain names.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/dns/top_locations_params.py b/src/cloudflare/types/radar/dns/top_locations_params.py index f6e3c2327d1..07260d9803a 100644 --- a/src/cloudflare/types/radar/dns/top_locations_params.py +++ b/src/cloudflare/types/radar/dns/top_locations_params.py @@ -13,47 +13,48 @@ class TopLocationsParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" domain: List[str] """Array of domain names.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/email/routing/summary_arc_params.py b/src/cloudflare/types/radar/email/routing/summary_arc_params.py index 58c3c121836..01121bb4d22 100644 --- a/src/cloudflare/types/radar/email/routing/summary_arc_params.py +++ b/src/cloudflare/types/radar/email/routing/summary_arc_params.py @@ -16,32 +16,36 @@ class SummaryARCParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/summary_dkim_params.py b/src/cloudflare/types/radar/email/routing/summary_dkim_params.py index 19be324942f..fba82080156 100644 --- a/src/cloudflare/types/radar/email/routing/summary_dkim_params.py +++ b/src/cloudflare/types/radar/email/routing/summary_dkim_params.py @@ -13,35 +13,39 @@ class SummaryDKIMParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/summary_dmarc_params.py b/src/cloudflare/types/radar/email/routing/summary_dmarc_params.py index f356077e043..547ab98019d 100644 --- a/src/cloudflare/types/radar/email/routing/summary_dmarc_params.py +++ b/src/cloudflare/types/radar/email/routing/summary_dmarc_params.py @@ -13,35 +13,36 @@ class SummaryDMARCParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/summary_encrypted_params.py b/src/cloudflare/types/radar/email/routing/summary_encrypted_params.py index b6553448171..b2c24903336 100644 --- a/src/cloudflare/types/radar/email/routing/summary_encrypted_params.py +++ b/src/cloudflare/types/radar/email/routing/summary_encrypted_params.py @@ -13,35 +13,39 @@ class SummaryEncryptedParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/summary_ip_version_params.py b/src/cloudflare/types/radar/email/routing/summary_ip_version_params.py index a1e7d6396f4..cc76020acee 100644 --- a/src/cloudflare/types/radar/email/routing/summary_ip_version_params.py +++ b/src/cloudflare/types/radar/email/routing/summary_ip_version_params.py @@ -13,35 +13,39 @@ class SummaryIPVersionParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/summary_spf_params.py b/src/cloudflare/types/radar/email/routing/summary_spf_params.py index f594b1931b7..9cbfddceeb8 100644 --- a/src/cloudflare/types/radar/email/routing/summary_spf_params.py +++ b/src/cloudflare/types/radar/email/routing/summary_spf_params.py @@ -13,35 +13,39 @@ class SummarySPFParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/email/routing/timeseries_group_arc_params.py b/src/cloudflare/types/radar/email/routing/timeseries_group_arc_params.py index 2c950448fe6..6acda04e889 100644 --- a/src/cloudflare/types/radar/email/routing/timeseries_group_arc_params.py +++ b/src/cloudflare/types/radar/email/routing/timeseries_group_arc_params.py @@ -23,32 +23,36 @@ class TimeseriesGroupARCParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/timeseries_group_dkim_params.py b/src/cloudflare/types/radar/email/routing/timeseries_group_dkim_params.py index 28c98ab3c92..8a4f0c9c3ed 100644 --- a/src/cloudflare/types/radar/email/routing/timeseries_group_dkim_params.py +++ b/src/cloudflare/types/radar/email/routing/timeseries_group_dkim_params.py @@ -20,35 +20,39 @@ class TimeseriesGroupDKIMParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/timeseries_group_dmarc_params.py b/src/cloudflare/types/radar/email/routing/timeseries_group_dmarc_params.py index 71271e551db..7ca61476360 100644 --- a/src/cloudflare/types/radar/email/routing/timeseries_group_dmarc_params.py +++ b/src/cloudflare/types/radar/email/routing/timeseries_group_dmarc_params.py @@ -20,35 +20,36 @@ class TimeseriesGroupDMARCParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/timeseries_group_encrypted_params.py b/src/cloudflare/types/radar/email/routing/timeseries_group_encrypted_params.py index 093524f3bbd..9070f8612b2 100644 --- a/src/cloudflare/types/radar/email/routing/timeseries_group_encrypted_params.py +++ b/src/cloudflare/types/radar/email/routing/timeseries_group_encrypted_params.py @@ -20,35 +20,39 @@ class TimeseriesGroupEncryptedParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/timeseries_group_ip_version_params.py b/src/cloudflare/types/radar/email/routing/timeseries_group_ip_version_params.py index f264feafdc3..60ac1e092d2 100644 --- a/src/cloudflare/types/radar/email/routing/timeseries_group_ip_version_params.py +++ b/src/cloudflare/types/radar/email/routing/timeseries_group_ip_version_params.py @@ -20,35 +20,39 @@ class TimeseriesGroupIPVersionParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/routing/timeseries_group_spf_params.py b/src/cloudflare/types/radar/email/routing/timeseries_group_spf_params.py index 22168b70e9f..d810dc31351 100644 --- a/src/cloudflare/types/radar/email/routing/timeseries_group_spf_params.py +++ b/src/cloudflare/types/radar/email/routing/timeseries_group_spf_params.py @@ -20,35 +20,39 @@ class TimeseriesGroupSPFParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ encrypted: List[Literal["ENCRYPTED", "NOT_ENCRYPTED"]] - """Filter for encrypted emails.""" + """Filters results by encryption status (encrypted vs. not-encrypted).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/email/security/summary_arc_params.py b/src/cloudflare/types/radar/email/security/summary_arc_params.py index b141a65af14..fc72001c27f 100644 --- a/src/cloudflare/types/radar/email/security/summary_arc_params.py +++ b/src/cloudflare/types/radar/email/security/summary_arc_params.py @@ -16,29 +16,33 @@ class SummaryARCParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/summary_dkim_params.py b/src/cloudflare/types/radar/email/security/summary_dkim_params.py index f92d7545793..b701f8461ec 100644 --- a/src/cloudflare/types/radar/email/security/summary_dkim_params.py +++ b/src/cloudflare/types/radar/email/security/summary_dkim_params.py @@ -13,32 +13,36 @@ class SummaryDKIMParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/summary_dmarc_params.py b/src/cloudflare/types/radar/email/security/summary_dmarc_params.py index f31a3218ce0..ef0122462cd 100644 --- a/src/cloudflare/types/radar/email/security/summary_dmarc_params.py +++ b/src/cloudflare/types/radar/email/security/summary_dmarc_params.py @@ -13,32 +13,33 @@ class SummaryDMARCParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/summary_malicious_params.py b/src/cloudflare/types/radar/email/security/summary_malicious_params.py index 432685036f3..06f1be09208 100644 --- a/src/cloudflare/types/radar/email/security/summary_malicious_params.py +++ b/src/cloudflare/types/radar/email/security/summary_malicious_params.py @@ -13,35 +13,39 @@ class SummaryMaliciousParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/summary_spam_params.py b/src/cloudflare/types/radar/email/security/summary_spam_params.py index bc535bf3aae..1a376419ccf 100644 --- a/src/cloudflare/types/radar/email/security/summary_spam_params.py +++ b/src/cloudflare/types/radar/email/security/summary_spam_params.py @@ -13,35 +13,39 @@ class SummarySpamParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/summary_spf_params.py b/src/cloudflare/types/radar/email/security/summary_spf_params.py index 43e4ba10cc7..7cb2e31bda2 100644 --- a/src/cloudflare/types/radar/email/security/summary_spf_params.py +++ b/src/cloudflare/types/radar/email/security/summary_spf_params.py @@ -13,32 +13,36 @@ class SummarySPFParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/summary_spoof_params.py b/src/cloudflare/types/radar/email/security/summary_spoof_params.py index f82a3b58522..55ee62ba56b 100644 --- a/src/cloudflare/types/radar/email/security/summary_spoof_params.py +++ b/src/cloudflare/types/radar/email/security/summary_spoof_params.py @@ -13,35 +13,39 @@ class SummarySpoofParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/summary_threat_category_params.py b/src/cloudflare/types/radar/email/security/summary_threat_category_params.py index c38e50ac6b3..2a4f7cbc3b6 100644 --- a/src/cloudflare/types/radar/email/security/summary_threat_category_params.py +++ b/src/cloudflare/types/radar/email/security/summary_threat_category_params.py @@ -13,35 +13,39 @@ class SummaryThreatCategoryParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/summary_tls_version_params.py b/src/cloudflare/types/radar/email/security/summary_tls_version_params.py index 4d7362e138e..73303819e98 100644 --- a/src/cloudflare/types/radar/email/security/summary_tls_version_params.py +++ b/src/cloudflare/types/radar/email/security/summary_tls_version_params.py @@ -13,32 +13,36 @@ class SummaryTLSVersionParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_arc_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_arc_params.py index abc50a0d1c2..eba81a331e7 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_arc_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_arc_params.py @@ -23,29 +23,33 @@ class TimeseriesGroupARCParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_dkim_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_dkim_params.py index 25f67103fbc..0738ba57903 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_dkim_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_dkim_params.py @@ -20,32 +20,36 @@ class TimeseriesGroupDKIMParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_dmarc_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_dmarc_params.py index b6c44355beb..47445066fe1 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_dmarc_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_dmarc_params.py @@ -20,32 +20,33 @@ class TimeseriesGroupDMARCParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_malicious_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_malicious_params.py index 4fadea1473b..80425c7b7ff 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_malicious_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_malicious_params.py @@ -20,35 +20,39 @@ class TimeseriesGroupMaliciousParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_spam_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_spam_params.py index cf290efb92d..3d28942799e 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_spam_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_spam_params.py @@ -20,35 +20,39 @@ class TimeseriesGroupSpamParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_spf_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_spf_params.py index 02c8899e043..0961c1591f2 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_spf_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_spf_params.py @@ -20,32 +20,36 @@ class TimeseriesGroupSPFParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_spoof_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_spoof_params.py index 7192baec686..c7fbb651a90 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_spoof_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_spoof_params.py @@ -20,35 +20,39 @@ class TimeseriesGroupSpoofParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_threat_category_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_threat_category_params.py index 2db3534a333..4cd60f87af6 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_threat_category_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_threat_category_params.py @@ -20,35 +20,39 @@ class TimeseriesGroupThreatCategoryParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/timeseries_group_tls_version_params.py b/src/cloudflare/types/radar/email/security/timeseries_group_tls_version_params.py index 84a9ada0097..88f1f60e094 100644 --- a/src/cloudflare/types/radar/email/security/timeseries_group_tls_version_params.py +++ b/src/cloudflare/types/radar/email/security/timeseries_group_tls_version_params.py @@ -20,32 +20,36 @@ class TimeseriesGroupTLSVersionParams(TypedDict, total=False): """ arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" diff --git a/src/cloudflare/types/radar/email/security/top/tld_get_params.py b/src/cloudflare/types/radar/email/security/top/tld_get_params.py index 3921a4e597d..1b687eea07a 100644 --- a/src/cloudflare/types/radar/email/security/top/tld_get_params.py +++ b/src/cloudflare/types/radar/email/security/top/tld_get_params.py @@ -13,41 +13,45 @@ class TldGetParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tld_category: Annotated[Literal["CLASSIC", "COUNTRY"], PropertyInfo(alias="tldCategory")] - """Filter for TLDs by category.""" + """Filters results by TLD category.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/top/tlds/malicious_get_params.py b/src/cloudflare/types/radar/email/security/top/tlds/malicious_get_params.py index e1cc9a0218f..e8943e4faf9 100644 --- a/src/cloudflare/types/radar/email/security/top/tlds/malicious_get_params.py +++ b/src/cloudflare/types/radar/email/security/top/tlds/malicious_get_params.py @@ -13,41 +13,45 @@ class MaliciousGetParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tld_category: Annotated[Literal["CLASSIC", "COUNTRY"], PropertyInfo(alias="tldCategory")] - """Filter for TLDs by category.""" + """Filters results by TLD category.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/top/tlds/spam_get_params.py b/src/cloudflare/types/radar/email/security/top/tlds/spam_get_params.py index 69fbfba03d0..255241962d4 100644 --- a/src/cloudflare/types/radar/email/security/top/tlds/spam_get_params.py +++ b/src/cloudflare/types/radar/email/security/top/tlds/spam_get_params.py @@ -13,41 +13,45 @@ class SpamGetParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tld_category: Annotated[Literal["CLASSIC", "COUNTRY"], PropertyInfo(alias="tldCategory")] - """Filter for TLDs by category.""" + """Filters results by TLD category.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/email/security/top/tlds/spoof_get_params.py b/src/cloudflare/types/radar/email/security/top/tlds/spoof_get_params.py index 5750c343985..b09086f72a0 100644 --- a/src/cloudflare/types/radar/email/security/top/tlds/spoof_get_params.py +++ b/src/cloudflare/types/radar/email/security/top/tlds/spoof_get_params.py @@ -13,41 +13,45 @@ class SpoofGetParams(TypedDict, total=False): arc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for arc (Authenticated Received Chain).""" + """Filters results by ARC (Authenticated Received Chain) validation.""" date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" dkim: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dkim.""" + """Filters results by DKIM (DomainKeys Identified Mail) validation status.""" dmarc: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for dmarc.""" + """ + Filters results by DMARC (Domain-based Message Authentication, Reporting and + Conformance) validation status. + """ format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" spf: List[Literal["PASS", "NONE", "FAIL"]] - """Filter for spf.""" + """Filters results by SPF (Sender Policy Framework) validation status.""" tld_category: Annotated[Literal["CLASSIC", "COUNTRY"], PropertyInfo(alias="tldCategory")] - """Filter for TLDs by category.""" + """Filters results by TLD category.""" tls_version: Annotated[List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3"]], PropertyInfo(alias="tlsVersion")] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/entities/asn_get_params.py b/src/cloudflare/types/radar/entities/asn_get_params.py index c74a42d2517..9d039842992 100644 --- a/src/cloudflare/types/radar/entities/asn_get_params.py +++ b/src/cloudflare/types/radar/entities/asn_get_params.py @@ -9,4 +9,4 @@ class ASNGetParams(TypedDict, total=False): format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" diff --git a/src/cloudflare/types/radar/entities/asn_ip_params.py b/src/cloudflare/types/radar/entities/asn_ip_params.py index 11d8bfa9dd0..ff2e2207073 100644 --- a/src/cloudflare/types/radar/entities/asn_ip_params.py +++ b/src/cloudflare/types/radar/entities/asn_ip_params.py @@ -12,4 +12,4 @@ class ASNIPParams(TypedDict, total=False): """IP address.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" diff --git a/src/cloudflare/types/radar/entities/asn_list_params.py b/src/cloudflare/types/radar/entities/asn_list_params.py index 7c327f0ff78..fe3c05257c0 100644 --- a/src/cloudflare/types/radar/entities/asn_list_params.py +++ b/src/cloudflare/types/radar/entities/asn_list_params.py @@ -11,19 +11,19 @@ class ASNListParams(TypedDict, total=False): asn: str - """Comma separated list of ASNs.""" + """Comma-separated list of Autonomous System Numbers (ASNs).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: str - """Location Alpha2 to filter results.""" + """Location alpha-2 code.""" offset: int - """Number of objects to skip before grabbing results.""" + """Skips the specified number of objects before fetching the results.""" order_by: Annotated[Literal["ASN", "POPULATION"], PropertyInfo(alias="orderBy")] - """Order asn list.""" + """Metric to order the ASNs by.""" diff --git a/src/cloudflare/types/radar/entities/asn_rel_params.py b/src/cloudflare/types/radar/entities/asn_rel_params.py index 500ad9c46a1..d4c89b89f13 100644 --- a/src/cloudflare/types/radar/entities/asn_rel_params.py +++ b/src/cloudflare/types/radar/entities/asn_rel_params.py @@ -9,7 +9,7 @@ class ASNRelParams(TypedDict, total=False): asn2: int - """Get the AS relationship of ASN2 with respect to the given ASN""" + """Retrieves the AS relationship of ASN2 with respect to the given ASN.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" diff --git a/src/cloudflare/types/radar/entities/location_get_params.py b/src/cloudflare/types/radar/entities/location_get_params.py index 7b90d15cbe3..f8b945c2fda 100644 --- a/src/cloudflare/types/radar/entities/location_get_params.py +++ b/src/cloudflare/types/radar/entities/location_get_params.py @@ -9,4 +9,4 @@ class LocationGetParams(TypedDict, total=False): format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" diff --git a/src/cloudflare/types/radar/entities/location_list_params.py b/src/cloudflare/types/radar/entities/location_list_params.py index 89e77d5625a..32d72642bdf 100644 --- a/src/cloudflare/types/radar/entities/location_list_params.py +++ b/src/cloudflare/types/radar/entities/location_list_params.py @@ -9,13 +9,13 @@ class LocationListParams(TypedDict, total=False): format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: str - """Comma separated list of locations.""" + """Comma-separated list of locations (alpha-2 location codes).""" offset: int - """Number of objects to skip before grabbing results.""" + """Skips the specified number of objects before fetching the results.""" diff --git a/src/cloudflare/types/radar/entity_get_params.py b/src/cloudflare/types/radar/entity_get_params.py index 1bd5c38fabe..cea577975c4 100644 --- a/src/cloudflare/types/radar/entity_get_params.py +++ b/src/cloudflare/types/radar/entity_get_params.py @@ -12,4 +12,4 @@ class EntityGetParams(TypedDict, total=False): """IP address.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" diff --git a/src/cloudflare/types/radar/http/ase_get_params.py b/src/cloudflare/types/radar/http/ase_get_params.py index 811464b10b0..42cd5f2a3a6 100644 --- a/src/cloudflare/types/radar/http/ase_get_params.py +++ b/src/cloudflare/types/radar/http/ase_get_params.py @@ -13,74 +13,75 @@ class AseGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/ases/bot_class_get_params.py b/src/cloudflare/types/radar/http/ases/bot_class_get_params.py index 59a823a180a..ee7fd0c6d5c 100644 --- a/src/cloudflare/types/radar/http/ases/bot_class_get_params.py +++ b/src/cloudflare/types/radar/http/ases/bot_class_get_params.py @@ -13,67 +13,68 @@ class BotClassGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/ases/browser_family_get_params.py b/src/cloudflare/types/radar/http/ases/browser_family_get_params.py index ed19fdee421..82d29344f6c 100644 --- a/src/cloudflare/types/radar/http/ases/browser_family_get_params.py +++ b/src/cloudflare/types/radar/http/ases/browser_family_get_params.py @@ -13,71 +13,72 @@ class BrowserFamilyGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/ases/device_type_get_params.py b/src/cloudflare/types/radar/http/ases/device_type_get_params.py index 43e1b06c821..0fa49773473 100644 --- a/src/cloudflare/types/radar/http/ases/device_type_get_params.py +++ b/src/cloudflare/types/radar/http/ases/device_type_get_params.py @@ -13,71 +13,72 @@ class DeviceTypeGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/ases/http_method_get_params.py b/src/cloudflare/types/radar/http/ases/http_method_get_params.py index fb227592965..5a35c809ac1 100644 --- a/src/cloudflare/types/radar/http/ases/http_method_get_params.py +++ b/src/cloudflare/types/radar/http/ases/http_method_get_params.py @@ -13,71 +13,72 @@ class HTTPMethodGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/ases/http_protocol_get_params.py b/src/cloudflare/types/radar/http/ases/http_protocol_get_params.py index 629a3b8d8c0..23095abe1db 100644 --- a/src/cloudflare/types/radar/http/ases/http_protocol_get_params.py +++ b/src/cloudflare/types/radar/http/ases/http_protocol_get_params.py @@ -13,68 +13,72 @@ class HTTPProtocolGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" + + http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/ases/ip_version_get_params.py b/src/cloudflare/types/radar/http/ases/ip_version_get_params.py index 86ababaa79a..7ebd38c5f84 100644 --- a/src/cloudflare/types/radar/http/ases/ip_version_get_params.py +++ b/src/cloudflare/types/radar/http/ases/ip_version_get_params.py @@ -13,71 +13,72 @@ class IPVersionGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/ases/os_get_params.py b/src/cloudflare/types/radar/http/ases/os_get_params.py index 12ac2d093b7..51802fbcb2c 100644 --- a/src/cloudflare/types/radar/http/ases/os_get_params.py +++ b/src/cloudflare/types/radar/http/ases/os_get_params.py @@ -13,71 +13,72 @@ class OSGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/ases/tls_version_get_params.py b/src/cloudflare/types/radar/http/ases/tls_version_get_params.py index 050045d800f..e69eadf0c26 100644 --- a/src/cloudflare/types/radar/http/ases/tls_version_get_params.py +++ b/src/cloudflare/types/radar/http/ases/tls_version_get_params.py @@ -13,69 +13,70 @@ class TLSVersionGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" diff --git a/src/cloudflare/types/radar/http/location_get_params.py b/src/cloudflare/types/radar/http/location_get_params.py index 1459dbe0e58..c7c6b500e22 100644 --- a/src/cloudflare/types/radar/http/location_get_params.py +++ b/src/cloudflare/types/radar/http/location_get_params.py @@ -13,74 +13,75 @@ class LocationGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/locations/bot_class_get_params.py b/src/cloudflare/types/radar/http/locations/bot_class_get_params.py index 59a823a180a..ee7fd0c6d5c 100644 --- a/src/cloudflare/types/radar/http/locations/bot_class_get_params.py +++ b/src/cloudflare/types/radar/http/locations/bot_class_get_params.py @@ -13,67 +13,68 @@ class BotClassGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/locations/browser_family_get_params.py b/src/cloudflare/types/radar/http/locations/browser_family_get_params.py index ed19fdee421..82d29344f6c 100644 --- a/src/cloudflare/types/radar/http/locations/browser_family_get_params.py +++ b/src/cloudflare/types/radar/http/locations/browser_family_get_params.py @@ -13,71 +13,72 @@ class BrowserFamilyGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/locations/device_type_get_params.py b/src/cloudflare/types/radar/http/locations/device_type_get_params.py index 43e1b06c821..0fa49773473 100644 --- a/src/cloudflare/types/radar/http/locations/device_type_get_params.py +++ b/src/cloudflare/types/radar/http/locations/device_type_get_params.py @@ -13,71 +13,72 @@ class DeviceTypeGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/locations/http_method_get_params.py b/src/cloudflare/types/radar/http/locations/http_method_get_params.py index fb227592965..5a35c809ac1 100644 --- a/src/cloudflare/types/radar/http/locations/http_method_get_params.py +++ b/src/cloudflare/types/radar/http/locations/http_method_get_params.py @@ -13,71 +13,72 @@ class HTTPMethodGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/locations/http_protocol_get_params.py b/src/cloudflare/types/radar/http/locations/http_protocol_get_params.py index 629a3b8d8c0..23095abe1db 100644 --- a/src/cloudflare/types/radar/http/locations/http_protocol_get_params.py +++ b/src/cloudflare/types/radar/http/locations/http_protocol_get_params.py @@ -13,68 +13,72 @@ class HTTPProtocolGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" + + http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/locations/ip_version_get_params.py b/src/cloudflare/types/radar/http/locations/ip_version_get_params.py index 86ababaa79a..7ebd38c5f84 100644 --- a/src/cloudflare/types/radar/http/locations/ip_version_get_params.py +++ b/src/cloudflare/types/radar/http/locations/ip_version_get_params.py @@ -13,71 +13,72 @@ class IPVersionGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/locations/os_get_params.py b/src/cloudflare/types/radar/http/locations/os_get_params.py index 12ac2d093b7..51802fbcb2c 100644 --- a/src/cloudflare/types/radar/http/locations/os_get_params.py +++ b/src/cloudflare/types/radar/http/locations/os_get_params.py @@ -13,71 +13,72 @@ class OSGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/locations/tls_version_get_params.py b/src/cloudflare/types/radar/http/locations/tls_version_get_params.py index 050045d800f..e69eadf0c26 100644 --- a/src/cloudflare/types/radar/http/locations/tls_version_get_params.py +++ b/src/cloudflare/types/radar/http/locations/tls_version_get_params.py @@ -13,69 +13,70 @@ class TLSVersionGetParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" diff --git a/src/cloudflare/types/radar/http/summary_bot_class_params.py b/src/cloudflare/types/radar/http/summary_bot_class_params.py index fcd244197a8..bcdb53eebf5 100644 --- a/src/cloudflare/types/radar/http/summary_bot_class_params.py +++ b/src/cloudflare/types/radar/http/summary_bot_class_params.py @@ -13,61 +13,62 @@ class SummaryBotClassParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/summary_device_type_params.py b/src/cloudflare/types/radar/http/summary_device_type_params.py index c0a7a7664f2..1073a6d89bc 100644 --- a/src/cloudflare/types/radar/http/summary_device_type_params.py +++ b/src/cloudflare/types/radar/http/summary_device_type_params.py @@ -13,65 +13,66 @@ class SummaryDeviceTypeParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/summary_http_protocol_params.py b/src/cloudflare/types/radar/http/summary_http_protocol_params.py index ca05adc80b4..dd9c1197955 100644 --- a/src/cloudflare/types/radar/http/summary_http_protocol_params.py +++ b/src/cloudflare/types/radar/http/summary_http_protocol_params.py @@ -13,65 +13,66 @@ class SummaryHTTPProtocolParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/summary_http_version_params.py b/src/cloudflare/types/radar/http/summary_http_version_params.py index f103dfb0592..39140304f22 100644 --- a/src/cloudflare/types/radar/http/summary_http_version_params.py +++ b/src/cloudflare/types/radar/http/summary_http_version_params.py @@ -13,65 +13,66 @@ class SummaryHTTPVersionParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/summary_ip_version_params.py b/src/cloudflare/types/radar/http/summary_ip_version_params.py index 5d135a39310..e1db184475e 100644 --- a/src/cloudflare/types/radar/http/summary_ip_version_params.py +++ b/src/cloudflare/types/radar/http/summary_ip_version_params.py @@ -13,65 +13,66 @@ class SummaryIPVersionParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/summary_os_params.py b/src/cloudflare/types/radar/http/summary_os_params.py index f475ca9335f..8f42f54b134 100644 --- a/src/cloudflare/types/radar/http/summary_os_params.py +++ b/src/cloudflare/types/radar/http/summary_os_params.py @@ -13,65 +13,66 @@ class SummaryOSParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/summary_post_quantum_params.py b/src/cloudflare/types/radar/http/summary_post_quantum_params.py index e9c7b6195d3..1139394d649 100644 --- a/src/cloudflare/types/radar/http/summary_post_quantum_params.py +++ b/src/cloudflare/types/radar/http/summary_post_quantum_params.py @@ -13,68 +13,69 @@ class SummaryPostQuantumParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/summary_tls_version_params.py b/src/cloudflare/types/radar/http/summary_tls_version_params.py index d158f1f43a6..443d5f2fe13 100644 --- a/src/cloudflare/types/radar/http/summary_tls_version_params.py +++ b/src/cloudflare/types/radar/http/summary_tls_version_params.py @@ -13,63 +13,64 @@ class SummaryTLSVersionParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_bot_class_params.py b/src/cloudflare/types/radar/http/timeseries_group_bot_class_params.py index c356954fbc4..6b79f440d4d 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_bot_class_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_bot_class_params.py @@ -20,61 +20,62 @@ class TimeseriesGroupBotClassParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_browser_family_params.py b/src/cloudflare/types/radar/http/timeseries_group_browser_family_params.py index a54c769250c..1701bb66cc0 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_browser_family_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_browser_family_params.py @@ -20,76 +20,77 @@ class TimeseriesGroupBrowserFamilyParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_browser_params.py b/src/cloudflare/types/radar/http/timeseries_group_browser_params.py index 2b0aab2a5eb..abe2cc51b5b 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_browser_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_browser_params.py @@ -20,76 +20,77 @@ class TimeseriesGroupBrowserParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit_per_group: Annotated[int, PropertyInfo(alias="limitPerGroup")] """ - Limit the number of objects (e.g., browsers, verticals, etc.) to the top items - within the specified time range. If the limitPerGroup is set, the response will - include that number of items, with the remaining items grouped together under an - "other" category. + Limits the number of objects per group to the top items within the specified + time range. If there are more items than the limit, the response will include + the count of items, with any remaining items grouped together under an "other" + category. """ location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_device_type_params.py b/src/cloudflare/types/radar/http/timeseries_group_device_type_params.py index 4e44b25d6cb..e9f270e9841 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_device_type_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_device_type_params.py @@ -20,65 +20,66 @@ class TimeseriesGroupDeviceTypeParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_http_protocol_params.py b/src/cloudflare/types/radar/http/timeseries_group_http_protocol_params.py index ba7ee2c31aa..d5a71b26448 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_http_protocol_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_http_protocol_params.py @@ -20,65 +20,66 @@ class TimeseriesGroupHTTPProtocolParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_http_version_params.py b/src/cloudflare/types/radar/http/timeseries_group_http_version_params.py index 97e2dbca21e..c9a73048627 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_http_version_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_http_version_params.py @@ -20,65 +20,66 @@ class TimeseriesGroupHTTPVersionParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_ip_version_params.py b/src/cloudflare/types/radar/http/timeseries_group_ip_version_params.py index 6c5aa48d095..7ea9592c435 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_ip_version_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_ip_version_params.py @@ -20,65 +20,66 @@ class TimeseriesGroupIPVersionParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_os_params.py b/src/cloudflare/types/radar/http/timeseries_group_os_params.py index 229e0d9ff31..ccb3a19caa9 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_os_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_os_params.py @@ -20,65 +20,66 @@ class TimeseriesGroupOSParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_post_quantum_params.py b/src/cloudflare/types/radar/http/timeseries_group_post_quantum_params.py index 486a7428ed3..f9adb227aa0 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_post_quantum_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_post_quantum_params.py @@ -20,68 +20,69 @@ class TimeseriesGroupPostQuantumParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/timeseries_group_tls_version_params.py b/src/cloudflare/types/radar/http/timeseries_group_tls_version_params.py index 8fef3fd1627..21326f7cbee 100644 --- a/src/cloudflare/types/radar/http/timeseries_group_tls_version_params.py +++ b/src/cloudflare/types/radar/http/timeseries_group_tls_version_params.py @@ -20,63 +20,64 @@ class TimeseriesGroupTLSVersionParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" diff --git a/src/cloudflare/types/radar/http/top_browser_family_params.py b/src/cloudflare/types/radar/http/top_browser_family_params.py index 2373d275b84..bd6d1a0ca9a 100644 --- a/src/cloudflare/types/radar/http/top_browser_family_params.py +++ b/src/cloudflare/types/radar/http/top_browser_family_params.py @@ -13,71 +13,72 @@ class TopBrowserFamilyParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http/top_browser_params.py b/src/cloudflare/types/radar/http/top_browser_params.py index a5ff89514de..02d070cc524 100644 --- a/src/cloudflare/types/radar/http/top_browser_params.py +++ b/src/cloudflare/types/radar/http/top_browser_params.py @@ -13,74 +13,75 @@ class TopBrowserParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ browser_family: Annotated[List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]], PropertyInfo(alias="browserFamily")] - """Filter for browser family.""" + """Filters results by browser family.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/http_timeseries_params.py b/src/cloudflare/types/radar/http_timeseries_params.py index 2723de57522..e4b3f8e6b4b 100644 --- a/src/cloudflare/types/radar/http_timeseries_params.py +++ b/src/cloudflare/types/radar/http_timeseries_params.py @@ -20,63 +20,64 @@ class HTTPTimeseriesParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bot_class: Annotated[List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]], PropertyInfo(alias="botClass")] - """Filter for bot class. + """Filters results by bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/). """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" device_type: Annotated[List[Literal["DESKTOP", "MOBILE", "OTHER"]], PropertyInfo(alias="deviceType")] - """Filter for device type.""" + """Filters results by device type.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" http_protocol: Annotated[List[Literal["HTTP", "HTTPS"]], PropertyInfo(alias="httpProtocol")] - """Filter for http protocol.""" + """Filters results by HTTP protocol (HTTP vs. HTTPS).""" http_version: Annotated[List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]], PropertyInfo(alias="httpVersion")] - """Filter for http version.""" + """Filters results by HTTP version.""" ip_version: Annotated[List[Literal["IPv4", "IPv6"]], PropertyInfo(alias="ipVersion")] - """Filter for ip version.""" + """Filters results by IP version (Ipv4 vs. IPv6).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE_CHANGE", "MIN0_MAX"] """Normalization method applied. @@ -86,9 +87,9 @@ class HTTPTimeseriesParams(TypedDict, total=False): """ os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] - """Filter for os name.""" + """Filters results by operating system.""" tls_version: Annotated[ List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]], PropertyInfo(alias="tlsVersion") ] - """Filter for tls version.""" + """Filters results by TLS version.""" diff --git a/src/cloudflare/types/radar/netflow_summary_params.py b/src/cloudflare/types/radar/netflow_summary_params.py index eaae72b84e7..5c4c3798546 100644 --- a/src/cloudflare/types/radar/netflow_summary_params.py +++ b/src/cloudflare/types/radar/netflow_summary_params.py @@ -13,41 +13,42 @@ class NetflowSummaryParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/netflow_timeseries_params.py b/src/cloudflare/types/radar/netflow_timeseries_params.py index 4b0bc3ba324..2db987b7ece 100644 --- a/src/cloudflare/types/radar/netflow_timeseries_params.py +++ b/src/cloudflare/types/radar/netflow_timeseries_params.py @@ -20,44 +20,45 @@ class NetflowTimeseriesParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" normalization: Literal["PERCENTAGE_CHANGE", "MIN0_MAX"] """Normalization method applied. @@ -67,4 +68,4 @@ class NetflowTimeseriesParams(TypedDict, total=False): """ product: List[Literal["HTTP", "ALL"]] - """Array of network traffic product types.""" + """Array of network traffic product types to filters results by.""" diff --git a/src/cloudflare/types/radar/netflows/top_ases_params.py b/src/cloudflare/types/radar/netflows/top_ases_params.py index 951cd0fb34e..525b077f274 100644 --- a/src/cloudflare/types/radar/netflows/top_ases_params.py +++ b/src/cloudflare/types/radar/netflows/top_ases_params.py @@ -13,44 +13,45 @@ class TopAsesParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/netflows/top_locations_params.py b/src/cloudflare/types/radar/netflows/top_locations_params.py index 74b6631d0b9..8bcca93a00b 100644 --- a/src/cloudflare/types/radar/netflows/top_locations_params.py +++ b/src/cloudflare/types/radar/netflows/top_locations_params.py @@ -13,44 +13,45 @@ class TopLocationsParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/quality/iqi_summary_params.py b/src/cloudflare/types/radar/quality/iqi_summary_params.py index 1de09c36ab0..7ac3e5acad9 100644 --- a/src/cloudflare/types/radar/quality/iqi_summary_params.py +++ b/src/cloudflare/types/radar/quality/iqi_summary_params.py @@ -13,44 +13,45 @@ class IQISummaryParams(TypedDict, total=False): metric: Required[Literal["BANDWIDTH", "DNS", "LATENCY"]] - """Which metric to return: bandwidth, latency or DNS response time.""" + """Defines which metric to return (bandwidth, latency, or DNS response time).""" asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/quality/iqi_timeseries_groups_params.py b/src/cloudflare/types/radar/quality/iqi_timeseries_groups_params.py index 6923ba58c7c..1ed21f67ec4 100644 --- a/src/cloudflare/types/radar/quality/iqi_timeseries_groups_params.py +++ b/src/cloudflare/types/radar/quality/iqi_timeseries_groups_params.py @@ -13,7 +13,7 @@ class IQITimeseriesGroupsParams(TypedDict, total=False): metric: Required[Literal["BANDWIDTH", "DNS", "LATENCY"]] - """Which metric to return: bandwidth, latency or DNS response time.""" + """Defines which metric to return (bandwidth, latency, or DNS response time).""" agg_interval: Annotated[Literal["15m", "1h", "1d", "1w"], PropertyInfo(alias="aggInterval")] """ @@ -23,44 +23,45 @@ class IQITimeseriesGroupsParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" interpolation: bool - """Enable interpolation for all series (using the average).""" + """Enables interpolation for all series (using the average).""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/quality/speed/top_ases_params.py b/src/cloudflare/types/radar/quality/speed/top_ases_params.py index d6d3e12b718..600fe41bf20 100644 --- a/src/cloudflare/types/radar/quality/speed/top_ases_params.py +++ b/src/cloudflare/types/radar/quality/speed/top_ases_params.py @@ -13,37 +13,37 @@ class TopAsesParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" order_by: Annotated[ Literal[ @@ -54,4 +54,4 @@ class TopAsesParams(TypedDict, total=False): """Metric to order the results by.""" reverse: bool - """Reverse the order of results.""" + """Reverses the order of results.""" diff --git a/src/cloudflare/types/radar/quality/speed/top_locations_params.py b/src/cloudflare/types/radar/quality/speed/top_locations_params.py index 89adc5a9988..cab56f22f9d 100644 --- a/src/cloudflare/types/radar/quality/speed/top_locations_params.py +++ b/src/cloudflare/types/radar/quality/speed/top_locations_params.py @@ -13,37 +13,37 @@ class TopLocationsParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" order_by: Annotated[ Literal[ @@ -54,4 +54,4 @@ class TopLocationsParams(TypedDict, total=False): """Metric to order the results by.""" reverse: bool - """Reverse the order of results.""" + """Reverses the order of results.""" diff --git a/src/cloudflare/types/radar/quality/speed_histogram_params.py b/src/cloudflare/types/radar/quality/speed_histogram_params.py index 489717a60e2..050ac38017a 100644 --- a/src/cloudflare/types/radar/quality/speed_histogram_params.py +++ b/src/cloudflare/types/radar/quality/speed_histogram_params.py @@ -13,37 +13,37 @@ class SpeedHistogramParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ bucket_size: Annotated[int, PropertyInfo(alias="bucketSize")] - """The width for every bucket in the histogram.""" + """Width for every bucket in the histogram.""" continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ metric_group: Annotated[Literal["BANDWIDTH", "LATENCY", "JITTER"], PropertyInfo(alias="metricGroup")] """Metrics to be returned.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/quality/speed_summary_params.py b/src/cloudflare/types/radar/quality/speed_summary_params.py index 8cf97078bf9..9610be34f9a 100644 --- a/src/cloudflare/types/radar/quality/speed_summary_params.py +++ b/src/cloudflare/types/radar/quality/speed_summary_params.py @@ -13,31 +13,31 @@ class SpeedSummaryParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/ranking/domain_get_params.py b/src/cloudflare/types/radar/ranking/domain_get_params.py index 95eb1587c83..4f8b6c4b71f 100644 --- a/src/cloudflare/types/radar/ranking/domain_get_params.py +++ b/src/cloudflare/types/radar/ranking/domain_get_params.py @@ -16,16 +16,16 @@ class DomainGetParams(TypedDict, total=False): """Array of dates to filter the ranking.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" include_top_locations: Annotated[bool, PropertyInfo(alias="includeTopLocations")] - """Include top locations in the response.""" + """Includes top locations in the response.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" ranking_type: Annotated[Literal["POPULAR", "TRENDING_RISE", "TRENDING_STEADY"], PropertyInfo(alias="rankingType")] - """The ranking type.""" + """Ranking type.""" diff --git a/src/cloudflare/types/radar/ranking/domain_get_response.py b/src/cloudflare/types/radar/ranking/domain_get_response.py index 64792b86087..c577ec3c1d3 100644 --- a/src/cloudflare/types/radar/ranking/domain_get_response.py +++ b/src/cloudflare/types/radar/ranking/domain_get_response.py @@ -1,12 +1,13 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. from typing import List, Optional +from datetime import datetime from pydantic import Field as FieldInfo from ...._models import BaseModel -__all__ = ["DomainGetResponse", "Details0", "Details0Category", "Details0TopLocation"] +__all__ = ["DomainGetResponse", "Details0", "Details0Category", "Details0TopLocation", "Meta", "MetaDateRange"] class Details0Category(BaseModel): @@ -36,5 +37,19 @@ class Details0(BaseModel): top_locations: Optional[List[Details0TopLocation]] = None +class MetaDateRange(BaseModel): + end_time: datetime = FieldInfo(alias="endTime") + """Adjusted end of date range.""" + + start_time: datetime = FieldInfo(alias="startTime") + """Adjusted start of date range.""" + + +class Meta(BaseModel): + date_range: List[MetaDateRange] = FieldInfo(alias="dateRange") + + class DomainGetResponse(BaseModel): details_0: Details0 + + meta: Meta diff --git a/src/cloudflare/types/radar/ranking/internet_service_timeseries_groups_params.py b/src/cloudflare/types/radar/ranking/internet_service_timeseries_groups_params.py index fe6a82d3f79..70db4ea3858 100644 --- a/src/cloudflare/types/radar/ranking/internet_service_timeseries_groups_params.py +++ b/src/cloudflare/types/radar/ranking/internet_service_timeseries_groups_params.py @@ -16,23 +16,24 @@ class InternetServiceTimeseriesGroupsParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" service_category: Annotated[List[str], PropertyInfo(alias="serviceCategory")] - """Filter for services category.""" + """Filters results by Internet service category.""" diff --git a/src/cloudflare/types/radar/ranking/internet_service_top_params.py b/src/cloudflare/types/radar/ranking/internet_service_top_params.py index d2809e2b3b0..11e594959d0 100644 --- a/src/cloudflare/types/radar/ranking/internet_service_top_params.py +++ b/src/cloudflare/types/radar/ranking/internet_service_top_params.py @@ -16,13 +16,13 @@ class InternetServiceTopParams(TypedDict, total=False): """Array of dates to filter the ranking.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" service_category: Annotated[List[str], PropertyInfo(alias="serviceCategory")] - """Filter for services category.""" + """Filters results by Internet service category.""" diff --git a/src/cloudflare/types/radar/ranking_timeseries_groups_params.py b/src/cloudflare/types/radar/ranking_timeseries_groups_params.py index e942258f0f9..a872fd43b66 100644 --- a/src/cloudflare/types/radar/ranking_timeseries_groups_params.py +++ b/src/cloudflare/types/radar/ranking_timeseries_groups_params.py @@ -16,32 +16,33 @@ class RankingTimeseriesGroupsParams(TypedDict, total=False): """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" domain_category: Annotated[List[str], PropertyInfo(alias="domainCategory")] - """Filter by domain category.""" + """Filters results by domain category.""" domains: List[str] - """Array of comma separated list of domains names.""" + """Comma-separated list of domain names.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of locations (alpha-2 country codes).""" + """Comma-separated list of locations (alpha-2 codes).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" ranking_type: Annotated[Literal["POPULAR", "TRENDING_RISE", "TRENDING_STEADY"], PropertyInfo(alias="rankingType")] - """The ranking type.""" + """Ranking type.""" diff --git a/src/cloudflare/types/radar/ranking_top_params.py b/src/cloudflare/types/radar/ranking_top_params.py index 8508b5159b5..06ab761773a 100644 --- a/src/cloudflare/types/radar/ranking_top_params.py +++ b/src/cloudflare/types/radar/ranking_top_params.py @@ -16,19 +16,19 @@ class RankingTopParams(TypedDict, total=False): """Array of dates to filter the ranking.""" domain_category: Annotated[List[str], PropertyInfo(alias="domainCategory")] - """Filter by domain category.""" + """Filters results by domain category.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of locations (alpha-2 country codes).""" + """Comma-separated list of locations (alpha-2 codes).""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" ranking_type: Annotated[Literal["POPULAR", "TRENDING_RISE", "TRENDING_STEADY"], PropertyInfo(alias="rankingType")] - """The ranking type.""" + """Ranking type.""" diff --git a/src/cloudflare/types/radar/robots_txt/top/user_agent_directive_params.py b/src/cloudflare/types/radar/robots_txt/top/user_agent_directive_params.py index 5b45e1e7913..3b345e6eba4 100644 --- a/src/cloudflare/types/radar/robots_txt/top/user_agent_directive_params.py +++ b/src/cloudflare/types/radar/robots_txt/top/user_agent_directive_params.py @@ -16,19 +16,19 @@ class UserAgentDirectiveParams(TypedDict, total=False): """Array of dates to filter the ranking.""" directive: Literal["ALLOW", "DISALLOW"] - """Filter by directive.""" + """Filters results by robots.txt directive.""" domain_category: Annotated[List[str], PropertyInfo(alias="domainCategory")] - """Filter by domain category.""" + """Filters results by domain category.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" user_agent_category: Annotated[Literal["AI"], PropertyInfo(alias="userAgentCategory")] - """Filter by user agent category.""" + """Filters results by user agent category.""" diff --git a/src/cloudflare/types/radar/robots_txt/top_domain_categories_params.py b/src/cloudflare/types/radar/robots_txt/top_domain_categories_params.py index b36b8ee64f9..cb62f868b87 100644 --- a/src/cloudflare/types/radar/robots_txt/top_domain_categories_params.py +++ b/src/cloudflare/types/radar/robots_txt/top_domain_categories_params.py @@ -16,13 +16,13 @@ class TopDomainCategoriesParams(TypedDict, total=False): """Array of dates to filter the ranking.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" user_agent_category: Annotated[Literal["AI"], PropertyInfo(alias="userAgentCategory")] - """Filter by user agent category.""" + """Filters results by user agent category.""" diff --git a/src/cloudflare/types/radar/search_global_params.py b/src/cloudflare/types/radar/search_global_params.py index a819d17e12f..425ee6851a1 100644 --- a/src/cloudflare/types/radar/search_global_params.py +++ b/src/cloudflare/types/radar/search_global_params.py @@ -12,19 +12,19 @@ class SearchGlobalParams(TypedDict, total=False): query: Required[str] - """Search for locations, AS and reports.""" + """Search for locations, autonomous systems and reports.""" exclude: List[Literal["SPECIAL_EVENTS", "NOTEBOOKS", "LOCATIONS", "ASNS"]] """Search types to be excluded from results.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" include: List[Literal["SPECIAL_EVENTS", "NOTEBOOKS", "LOCATIONS", "ASNS"]] """Search types to be included in results.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" limit_per_group: Annotated[float, PropertyInfo(alias="limitPerGroup")] """Limit the number of objects per search category.""" diff --git a/src/cloudflare/types/radar/tcp_resets_timeout_summary_params.py b/src/cloudflare/types/radar/tcp_resets_timeout_summary_params.py index a278b500c38..d3ce0dc3f62 100644 --- a/src/cloudflare/types/radar/tcp_resets_timeout_summary_params.py +++ b/src/cloudflare/types/radar/tcp_resets_timeout_summary_params.py @@ -13,41 +13,42 @@ class TCPResetsTimeoutSummaryParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/tcp_resets_timeout_timeseries_groups_params.py b/src/cloudflare/types/radar/tcp_resets_timeout_timeseries_groups_params.py index 81d83b0cdc2..798d771997b 100644 --- a/src/cloudflare/types/radar/tcp_resets_timeout_timeseries_groups_params.py +++ b/src/cloudflare/types/radar/tcp_resets_timeout_timeseries_groups_params.py @@ -20,41 +20,42 @@ class TCPResetsTimeoutTimeseriesGroupsParams(TypedDict, total=False): """ asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/traffic_anomalies/location_get_params.py b/src/cloudflare/types/radar/traffic_anomalies/location_get_params.py index bd0ebc748dd..fc67fa7e32e 100644 --- a/src/cloudflare/types/radar/traffic_anomalies/location_get_params.py +++ b/src/cloudflare/types/radar/traffic_anomalies/location_get_params.py @@ -25,9 +25,9 @@ class LocationGetParams(TypedDict, total=False): """Start of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" status: Literal["VERIFIED", "UNVERIFIED"] diff --git a/src/cloudflare/types/radar/traffic_anomaly_get_params.py b/src/cloudflare/types/radar/traffic_anomaly_get_params.py index 0fae350c54c..93ffefde206 100644 --- a/src/cloudflare/types/radar/traffic_anomaly_get_params.py +++ b/src/cloudflare/types/radar/traffic_anomaly_get_params.py @@ -13,7 +13,7 @@ class TrafficAnomalyGetParams(TypedDict, total=False): asn: int - """Single ASN as integer.""" + """Single Autonomous System Number (ASN) as integer.""" date_end: Annotated[Union[str, datetime], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" @@ -28,15 +28,15 @@ class TrafficAnomalyGetParams(TypedDict, total=False): """Start of the date range (inclusive).""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: str - """Location Alpha2 code.""" + """Location alpha-2 code.""" offset: int - """Number of objects to skip before grabbing results.""" + """Skips the specified number of objects before fetching the results.""" status: Literal["VERIFIED", "UNVERIFIED"] diff --git a/src/cloudflare/types/radar/verified_bots/top_bots_params.py b/src/cloudflare/types/radar/verified_bots/top_bots_params.py index 5eb7fcda9cc..0186950a322 100644 --- a/src/cloudflare/types/radar/verified_bots/top_bots_params.py +++ b/src/cloudflare/types/radar/verified_bots/top_bots_params.py @@ -13,44 +13,45 @@ class TopBotsParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/src/cloudflare/types/radar/verified_bots/top_categories_params.py b/src/cloudflare/types/radar/verified_bots/top_categories_params.py index 70f3ced1ddc..3382942381b 100644 --- a/src/cloudflare/types/radar/verified_bots/top_categories_params.py +++ b/src/cloudflare/types/radar/verified_bots/top_categories_params.py @@ -13,44 +13,45 @@ class TopCategoriesParams(TypedDict, total=False): asn: List[str] - """Array of comma separated list of ASNs, start with `-` to exclude from results. + """Comma-separated list of Autonomous System Numbers (ASNs). - For example, `-174, 3356` excludes results from AS174, but includes results from - AS3356. + Prefix with `-` to exclude ASNs from results. For example, `-174, 3356` excludes + results from AS174, but includes results from AS3356. """ continent: List[str] - """Array of comma separated list of continents (alpha-2 continent codes). + """Comma-separated list of continents (alpha-2 continent codes). - Start with `-` to exclude from results. For example, `-EU,NA` excludes results - from Europe, but includes results from North America. + Prefix with `-` to exclude continents from results. For example, `-EU,NA` + excludes results from EU, but includes results from NA. """ date_end: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateEnd", format="iso8601")] """End of the date range (inclusive).""" date_range: Annotated[List[str], PropertyInfo(alias="dateRange")] - """ - For example, use `7d` and `7dControl` to compare this week with the previous + """Filters results by the specified date range. + + For example, use `7d` and `7dcontrol` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters). """ date_start: Annotated[List[Union[str, datetime]], PropertyInfo(alias="dateStart", format="iso8601")] - """Array of datetimes to filter the start of a series.""" + """Start of the date range.""" format: Literal["JSON", "CSV"] - """Format results are returned in.""" + """Format in which results will be returned.""" limit: int - """Limit the number of objects in the response.""" + """Limits the number of objects returned in the response.""" location: List[str] - """Array of comma separated list of locations (alpha-2 country codes). + """Comma-separated list of locations (alpha-2 codes). - Start with `-` to exclude from results. For example, `-US,PT` excludes results - from the US, but includes results from PT. + Prefix with `-` to exclude locations from results. For example, `-US,PT` + excludes results from the US, but includes results from PT. """ name: List[str] - """Array of names that will be used to name the series in responses.""" + """Array of names used to label the series in the response.""" diff --git a/tests/api_resources/radar/ai/bots/test_summary.py b/tests/api_resources/radar/ai/bots/test_summary.py index ca5d4e987c0..90e08cd591d 100644 --- a/tests/api_resources/radar/ai/bots/test_summary.py +++ b/tests/api_resources/radar/ai/bots/test_summary.py @@ -34,7 +34,7 @@ def test_method_user_agent_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryUserAgentResponse, summary, path=["response"]) @@ -78,7 +78,7 @@ async def test_method_user_agent_with_all_params(self, async_client: AsyncCloudf format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryUserAgentResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/ai/inference/test_summary.py b/tests/api_resources/radar/ai/inference/test_summary.py index 26083d232ef..353a568f366 100644 --- a/tests/api_resources/radar/ai/inference/test_summary.py +++ b/tests/api_resources/radar/ai/inference/test_summary.py @@ -34,7 +34,7 @@ def test_method_model_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit_per_group=10, - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryModelResponse, summary, path=["response"]) @@ -71,7 +71,7 @@ def test_method_task_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit_per_group=10, - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryTaskResponse, summary, path=["response"]) @@ -112,7 +112,7 @@ async def test_method_model_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit_per_group=10, - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryModelResponse, summary, path=["response"]) @@ -149,7 +149,7 @@ async def test_method_task_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit_per_group=10, - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryTaskResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/ai/inference/timeseries_groups/test_summary.py b/tests/api_resources/radar/ai/inference/timeseries_groups/test_summary.py index 243d0f83b6c..59cef513ed6 100644 --- a/tests/api_resources/radar/ai/inference/timeseries_groups/test_summary.py +++ b/tests/api_resources/radar/ai/inference/timeseries_groups/test_summary.py @@ -35,7 +35,7 @@ def test_method_model_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit_per_group=10, - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryModelResponse, summary, path=["response"]) @@ -73,7 +73,7 @@ def test_method_task_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit_per_group=10, - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryTaskResponse, summary, path=["response"]) @@ -115,7 +115,7 @@ async def test_method_model_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit_per_group=10, - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryModelResponse, summary, path=["response"]) @@ -155,7 +155,7 @@ async def test_method_task_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit_per_group=10, - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryTaskResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/ai/test_timeseries_groups.py b/tests/api_resources/radar/ai/test_timeseries_groups.py index 94ccc123297..3d145476cd8 100644 --- a/tests/api_resources/radar/ai/test_timeseries_groups.py +++ b/tests/api_resources/radar/ai/test_timeseries_groups.py @@ -35,7 +35,7 @@ def test_method_user_agent_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupUserAgentResponse, timeseries_group, path=["response"]) @@ -80,7 +80,7 @@ async def test_method_user_agent_with_all_params(self, async_client: AsyncCloudf format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupUserAgentResponse, timeseries_group, path=["response"]) diff --git a/tests/api_resources/radar/as112/test_summary.py b/tests/api_resources/radar/as112/test_summary.py index d5956baed72..92f332097d4 100644 --- a/tests/api_resources/radar/as112/test_summary.py +++ b/tests/api_resources/radar/as112/test_summary.py @@ -40,7 +40,7 @@ def test_method_dnssec_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryDNSSECResponse, summary, path=["response"]) @@ -79,7 +79,7 @@ def test_method_edns_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryEdnsResponse, summary, path=["response"]) @@ -118,7 +118,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryIPVersionResponse, summary, path=["response"]) @@ -157,7 +157,7 @@ def test_method_protocol_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryProtocolResponse, summary, path=["response"]) @@ -197,7 +197,7 @@ def test_method_query_type_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryQueryTypeResponse, summary, path=["response"]) @@ -237,7 +237,7 @@ def test_method_response_codes_with_all_params(self, client: Cloudflare) -> None format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryResponseCodesResponse, summary, path=["response"]) @@ -280,7 +280,7 @@ async def test_method_dnssec_with_all_params(self, async_client: AsyncCloudflare date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryDNSSECResponse, summary, path=["response"]) @@ -319,7 +319,7 @@ async def test_method_edns_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryEdnsResponse, summary, path=["response"]) @@ -358,7 +358,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryIPVersionResponse, summary, path=["response"]) @@ -397,7 +397,7 @@ async def test_method_protocol_with_all_params(self, async_client: AsyncCloudfla date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryProtocolResponse, summary, path=["response"]) @@ -437,7 +437,7 @@ async def test_method_query_type_with_all_params(self, async_client: AsyncCloudf format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryQueryTypeResponse, summary, path=["response"]) @@ -477,7 +477,7 @@ async def test_method_response_codes_with_all_params(self, async_client: AsyncCl format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryResponseCodesResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/as112/test_timeseries_groups.py b/tests/api_resources/radar/as112/test_timeseries_groups.py index 26adfcf7eab..0ba776d7d90 100644 --- a/tests/api_resources/radar/as112/test_timeseries_groups.py +++ b/tests/api_resources/radar/as112/test_timeseries_groups.py @@ -41,7 +41,7 @@ def test_method_dnssec_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupDNSSECResponse, timeseries_group, path=["response"]) @@ -81,7 +81,7 @@ def test_method_edns_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupEdnsResponse, timeseries_group, path=["response"]) @@ -121,7 +121,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupIPVersionResponse, timeseries_group, path=["response"]) @@ -161,7 +161,7 @@ def test_method_protocol_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupProtocolResponse, timeseries_group, path=["response"]) @@ -202,7 +202,7 @@ def test_method_query_type_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupQueryTypeResponse, timeseries_group, path=["response"]) @@ -243,7 +243,7 @@ def test_method_response_codes_with_all_params(self, client: Cloudflare) -> None format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupResponseCodesResponse, timeseries_group, path=["response"]) @@ -287,7 +287,7 @@ async def test_method_dnssec_with_all_params(self, async_client: AsyncCloudflare date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupDNSSECResponse, timeseries_group, path=["response"]) @@ -327,7 +327,7 @@ async def test_method_edns_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupEdnsResponse, timeseries_group, path=["response"]) @@ -367,7 +367,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupIPVersionResponse, timeseries_group, path=["response"]) @@ -407,7 +407,7 @@ async def test_method_protocol_with_all_params(self, async_client: AsyncCloudfla date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupProtocolResponse, timeseries_group, path=["response"]) @@ -448,7 +448,7 @@ async def test_method_query_type_with_all_params(self, async_client: AsyncCloudf format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupQueryTypeResponse, timeseries_group, path=["response"]) @@ -489,7 +489,7 @@ async def test_method_response_codes_with_all_params(self, async_client: AsyncCl format="JSON", limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupResponseCodesResponse, timeseries_group, path=["response"]) diff --git a/tests/api_resources/radar/as112/test_top.py b/tests/api_resources/radar/as112/test_top.py index 27ffc7e5b59..5ee313e582e 100644 --- a/tests/api_resources/radar/as112/test_top.py +++ b/tests/api_resources/radar/as112/test_top.py @@ -42,7 +42,7 @@ def test_method_dnssec_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopDNSSECResponse, top, path=["response"]) @@ -89,7 +89,7 @@ def test_method_edns_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopEdnsResponse, top, path=["response"]) @@ -136,7 +136,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopIPVersionResponse, top, path=["response"]) @@ -180,7 +180,7 @@ def test_method_locations_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopLocationsResponse, top, path=["response"]) @@ -227,7 +227,7 @@ async def test_method_dnssec_with_all_params(self, async_client: AsyncCloudflare format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopDNSSECResponse, top, path=["response"]) @@ -274,7 +274,7 @@ async def test_method_edns_with_all_params(self, async_client: AsyncCloudflare) format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopEdnsResponse, top, path=["response"]) @@ -321,7 +321,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopIPVersionResponse, top, path=["response"]) @@ -365,7 +365,7 @@ async def test_method_locations_with_all_params(self, async_client: AsyncCloudfl format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopLocationsResponse, top, path=["response"]) diff --git a/tests/api_resources/radar/attacks/layer3/test_summary.py b/tests/api_resources/radar/attacks/layer3/test_summary.py index 8bee0ce91a1..fdcc5ae9d60 100644 --- a/tests/api_resources/radar/attacks/layer3/test_summary.py +++ b/tests/api_resources/radar/attacks/layer3/test_summary.py @@ -40,7 +40,7 @@ def test_method_bitrate_with_all_params(self, client: Cloudflare) -> None: format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(SummaryBitrateResponse, summary, path=["response"]) @@ -81,7 +81,7 @@ def test_method_duration_with_all_params(self, client: Cloudflare) -> None: format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(SummaryDurationResponse, summary, path=["response"]) @@ -121,7 +121,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: direction="ORIGIN", format="JSON", location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(SummaryIPVersionResponse, summary, path=["response"]) @@ -162,7 +162,7 @@ def test_method_protocol_with_all_params(self, client: Cloudflare) -> None: format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryProtocolResponse, summary, path=["response"]) @@ -203,7 +203,7 @@ def test_method_vector_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(SummaryVectorResponse, summary, path=["response"]) @@ -248,7 +248,7 @@ async def test_method_bitrate_with_all_params(self, async_client: AsyncCloudflar format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(SummaryBitrateResponse, summary, path=["response"]) @@ -289,7 +289,7 @@ async def test_method_duration_with_all_params(self, async_client: AsyncCloudfla format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(SummaryDurationResponse, summary, path=["response"]) @@ -329,7 +329,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf direction="ORIGIN", format="JSON", location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(SummaryIPVersionResponse, summary, path=["response"]) @@ -370,7 +370,7 @@ async def test_method_protocol_with_all_params(self, async_client: AsyncCloudfla format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryProtocolResponse, summary, path=["response"]) @@ -411,7 +411,7 @@ async def test_method_vector_with_all_params(self, async_client: AsyncCloudflare ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(SummaryVectorResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/attacks/layer3/test_timeseries_groups.py b/tests/api_resources/radar/attacks/layer3/test_timeseries_groups.py index b248a2bc01e..6234245b8f2 100644 --- a/tests/api_resources/radar/attacks/layer3/test_timeseries_groups.py +++ b/tests/api_resources/radar/attacks/layer3/test_timeseries_groups.py @@ -43,7 +43,7 @@ def test_method_bitrate_with_all_params(self, client: Cloudflare) -> None: format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -86,7 +86,7 @@ def test_method_duration_with_all_params(self, client: Cloudflare) -> None: format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -130,7 +130,7 @@ def test_method_industry_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -172,7 +172,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: direction="ORIGIN", format="JSON", location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -215,7 +215,7 @@ def test_method_protocol_with_all_params(self, client: Cloudflare) -> None: format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupProtocolResponse, timeseries_group, path=["response"]) @@ -258,7 +258,7 @@ def test_method_vector_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -302,7 +302,7 @@ def test_method_vertical_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -349,7 +349,7 @@ async def test_method_bitrate_with_all_params(self, async_client: AsyncCloudflar format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -392,7 +392,7 @@ async def test_method_duration_with_all_params(self, async_client: AsyncCloudfla format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -436,7 +436,7 @@ async def test_method_industry_with_all_params(self, async_client: AsyncCloudfla ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -478,7 +478,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf direction="ORIGIN", format="JSON", location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -521,7 +521,7 @@ async def test_method_protocol_with_all_params(self, async_client: AsyncCloudfla format="JSON", ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupProtocolResponse, timeseries_group, path=["response"]) @@ -564,7 +564,7 @@ async def test_method_vector_with_all_params(self, async_client: AsyncCloudflare ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -608,7 +608,7 @@ async def test_method_vertical_with_all_params(self, async_client: AsyncCloudfla ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) diff --git a/tests/api_resources/radar/attacks/layer3/test_top.py b/tests/api_resources/radar/attacks/layer3/test_top.py index 22989fa3d9d..2a2362c4450 100644 --- a/tests/api_resources/radar/attacks/layer3/test_top.py +++ b/tests/api_resources/radar/attacks/layer3/test_top.py @@ -40,7 +40,8 @@ def test_method_attacks_with_all_params(self, client: Cloudflare) -> None: limit_direction="ORIGIN", limit_per_location=10, location=["string"], - name=["string"], + magnitude="MITIGATED_BYTES", + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -82,7 +83,7 @@ def test_method_industry_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(TopIndustryResponse, top, path=["response"]) @@ -123,7 +124,7 @@ def test_method_vertical_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(TopVerticalResponse, top, path=["response"]) @@ -170,7 +171,8 @@ async def test_method_attacks_with_all_params(self, async_client: AsyncCloudflar limit_direction="ORIGIN", limit_per_location=10, location=["string"], - name=["string"], + magnitude="MITIGATED_BYTES", + name=["main_series"], normalization="PERCENTAGE", protocol=["UDP"], ) @@ -212,7 +214,7 @@ async def test_method_industry_with_all_params(self, async_client: AsyncCloudfla ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(TopIndustryResponse, top, path=["response"]) @@ -253,7 +255,7 @@ async def test_method_vertical_with_all_params(self, async_client: AsyncCloudfla ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(TopVerticalResponse, top, path=["response"]) diff --git a/tests/api_resources/radar/attacks/layer3/top/test_locations.py b/tests/api_resources/radar/attacks/layer3/top/test_locations.py index eceaabee20d..fc0424a2a6b 100644 --- a/tests/api_resources/radar/attacks/layer3/top/test_locations.py +++ b/tests/api_resources/radar/attacks/layer3/top/test_locations.py @@ -37,7 +37,7 @@ def test_method_origin_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(LocationOriginResponse, location, path=["response"]) @@ -78,7 +78,7 @@ def test_method_target_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(LocationTargetResponse, location, path=["response"]) @@ -123,7 +123,7 @@ async def test_method_origin_with_all_params(self, async_client: AsyncCloudflare ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(LocationOriginResponse, location, path=["response"]) @@ -164,7 +164,7 @@ async def test_method_target_with_all_params(self, async_client: AsyncCloudflare ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], protocol=["UDP"], ) assert_matches_type(LocationTargetResponse, location, path=["response"]) diff --git a/tests/api_resources/radar/attacks/layer7/test_summary.py b/tests/api_resources/radar/attacks/layer7/test_summary.py index a457ff963bc..e7264d066ec 100644 --- a/tests/api_resources/radar/attacks/layer7/test_summary.py +++ b/tests/api_resources/radar/attacks/layer7/test_summary.py @@ -43,7 +43,7 @@ def test_method_http_method_with_all_params(self, client: Cloudflare) -> None: limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryHTTPMethodResponse, summary, path=["response"]) @@ -85,7 +85,7 @@ def test_method_http_version_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryHTTPVersionResponse, summary, path=["response"]) @@ -127,7 +127,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryIPVersionResponse, summary, path=["response"]) @@ -171,7 +171,7 @@ def test_method_managed_rules_with_all_params(self, client: Cloudflare) -> None: limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryManagedRulesResponse, summary, path=["response"]) @@ -214,7 +214,7 @@ def test_method_mitigation_product_with_all_params(self, client: Cloudflare) -> ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryMitigationProductResponse, summary, path=["response"]) @@ -261,7 +261,7 @@ async def test_method_http_method_with_all_params(self, async_client: AsyncCloud limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryHTTPMethodResponse, summary, path=["response"]) @@ -303,7 +303,7 @@ async def test_method_http_version_with_all_params(self, async_client: AsyncClou ip_version=["IPv4"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryHTTPVersionResponse, summary, path=["response"]) @@ -345,7 +345,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf http_version=["HTTPv1"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryIPVersionResponse, summary, path=["response"]) @@ -389,7 +389,7 @@ async def test_method_managed_rules_with_all_params(self, async_client: AsyncClo limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryManagedRulesResponse, summary, path=["response"]) @@ -432,7 +432,7 @@ async def test_method_mitigation_product_with_all_params(self, async_client: Asy ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummaryMitigationProductResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/attacks/layer7/test_timeseries_groups.py b/tests/api_resources/radar/attacks/layer7/test_timeseries_groups.py index d45d9e3dee9..7e25c5ca585 100644 --- a/tests/api_resources/radar/attacks/layer7/test_timeseries_groups.py +++ b/tests/api_resources/radar/attacks/layer7/test_timeseries_groups.py @@ -46,7 +46,7 @@ def test_method_http_method_with_all_params(self, client: Cloudflare) -> None: limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupHTTPMethodResponse, timeseries_group, path=["response"]) @@ -90,7 +90,7 @@ def test_method_http_version_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupHTTPVersionResponse, timeseries_group, path=["response"]) @@ -136,7 +136,7 @@ def test_method_industry_with_all_params(self, client: Cloudflare) -> None: limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupIndustryResponse, timeseries_group, path=["response"]) @@ -180,7 +180,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupIPVersionResponse, timeseries_group, path=["response"]) @@ -226,7 +226,7 @@ def test_method_managed_rules_with_all_params(self, client: Cloudflare) -> None: limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupManagedRulesResponse, timeseries_group, path=["response"]) @@ -271,7 +271,7 @@ def test_method_mitigation_product_with_all_params(self, client: Cloudflare) -> ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupMitigationProductResponse, timeseries_group, path=["response"]) @@ -317,7 +317,7 @@ def test_method_vertical_with_all_params(self, client: Cloudflare) -> None: limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupVerticalResponse, timeseries_group, path=["response"]) @@ -366,7 +366,7 @@ async def test_method_http_method_with_all_params(self, async_client: AsyncCloud limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupHTTPMethodResponse, timeseries_group, path=["response"]) @@ -412,7 +412,7 @@ async def test_method_http_version_with_all_params(self, async_client: AsyncClou ip_version=["IPv4"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupHTTPVersionResponse, timeseries_group, path=["response"]) @@ -460,7 +460,7 @@ async def test_method_industry_with_all_params(self, async_client: AsyncCloudfla limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupIndustryResponse, timeseries_group, path=["response"]) @@ -504,7 +504,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf http_version=["HTTPv1"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupIPVersionResponse, timeseries_group, path=["response"]) @@ -550,7 +550,7 @@ async def test_method_managed_rules_with_all_params(self, async_client: AsyncClo limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupManagedRulesResponse, timeseries_group, path=["response"]) @@ -597,7 +597,7 @@ async def test_method_mitigation_product_with_all_params(self, async_client: Asy ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupMitigationProductResponse, timeseries_group, path=["response"]) @@ -645,7 +645,7 @@ async def test_method_vertical_with_all_params(self, async_client: AsyncCloudfla limit_per_group=10, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TimeseriesGroupVerticalResponse, timeseries_group, path=["response"]) diff --git a/tests/api_resources/radar/attacks/layer7/test_top.py b/tests/api_resources/radar/attacks/layer7/test_top.py index eebffc3e959..585e30ae8ea 100644 --- a/tests/api_resources/radar/attacks/layer7/test_top.py +++ b/tests/api_resources/radar/attacks/layer7/test_top.py @@ -45,7 +45,7 @@ def test_method_attacks_with_all_params(self, client: Cloudflare) -> None: location=["string"], magnitude="AFFECTED_ZONES", mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TopAttacksResponse, top, path=["response"]) @@ -90,7 +90,7 @@ def test_method_industry_with_all_params(self, client: Cloudflare) -> None: limit=5, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopIndustryResponse, top, path=["response"]) @@ -134,7 +134,7 @@ def test_method_vertical_with_all_params(self, client: Cloudflare) -> None: limit=5, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopVerticalResponse, top, path=["response"]) @@ -185,7 +185,7 @@ async def test_method_attacks_with_all_params(self, async_client: AsyncCloudflar location=["string"], magnitude="AFFECTED_ZONES", mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE", ) assert_matches_type(TopAttacksResponse, top, path=["response"]) @@ -230,7 +230,7 @@ async def test_method_industry_with_all_params(self, async_client: AsyncCloudfla limit=5, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopIndustryResponse, top, path=["response"]) @@ -274,7 +274,7 @@ async def test_method_vertical_with_all_params(self, async_client: AsyncCloudfla limit=5, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopVerticalResponse, top, path=["response"]) diff --git a/tests/api_resources/radar/attacks/layer7/top/test_ases.py b/tests/api_resources/radar/attacks/layer7/top/test_ases.py index a5418a14455..355e8d958f3 100644 --- a/tests/api_resources/radar/attacks/layer7/top/test_ases.py +++ b/tests/api_resources/radar/attacks/layer7/top/test_ases.py @@ -37,7 +37,7 @@ def test_method_origin_with_all_params(self, client: Cloudflare) -> None: limit=5, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(AseOriginResponse, ase, path=["response"]) @@ -84,7 +84,7 @@ async def test_method_origin_with_all_params(self, async_client: AsyncCloudflare limit=5, location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(AseOriginResponse, ase, path=["response"]) diff --git a/tests/api_resources/radar/attacks/layer7/top/test_locations.py b/tests/api_resources/radar/attacks/layer7/top/test_locations.py index 5c0efdabfe6..912d7f31098 100644 --- a/tests/api_resources/radar/attacks/layer7/top/test_locations.py +++ b/tests/api_resources/radar/attacks/layer7/top/test_locations.py @@ -40,7 +40,7 @@ def test_method_origin_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(LocationOriginResponse, location, path=["response"]) @@ -82,7 +82,7 @@ def test_method_target_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(LocationTargetResponse, location, path=["response"]) @@ -129,7 +129,7 @@ async def test_method_origin_with_all_params(self, async_client: AsyncCloudflare ip_version=["IPv4"], limit=5, mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(LocationOriginResponse, location, path=["response"]) @@ -171,7 +171,7 @@ async def test_method_target_with_all_params(self, async_client: AsyncCloudflare ip_version=["IPv4"], limit=5, mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], ) assert_matches_type(LocationTargetResponse, location, path=["response"]) diff --git a/tests/api_resources/radar/attacks/test_layer3.py b/tests/api_resources/radar/attacks/test_layer3.py index 65d6d7bcb35..0157bde3dcc 100644 --- a/tests/api_resources/radar/attacks/test_layer3.py +++ b/tests/api_resources/radar/attacks/test_layer3.py @@ -37,7 +37,7 @@ def test_method_timeseries_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], location=["string"], metric="BYTES", - name=["string"], + name=["main_series"], normalization="PERCENTAGE_CHANGE", protocol=["UDP"], ) @@ -86,7 +86,7 @@ async def test_method_timeseries_with_all_params(self, async_client: AsyncCloudf ip_version=["IPv4"], location=["string"], metric="BYTES", - name=["string"], + name=["main_series"], normalization="PERCENTAGE_CHANGE", protocol=["UDP"], ) diff --git a/tests/api_resources/radar/attacks/test_layer7.py b/tests/api_resources/radar/attacks/test_layer7.py index ac1bc86575c..67df94d5aa0 100644 --- a/tests/api_resources/radar/attacks/test_layer7.py +++ b/tests/api_resources/radar/attacks/test_layer7.py @@ -39,7 +39,7 @@ def test_method_timeseries_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE_CHANGE", ) assert_matches_type(Layer7TimeseriesResponse, layer7, path=["response"]) @@ -89,7 +89,7 @@ async def test_method_timeseries_with_all_params(self, async_client: AsyncCloudf ip_version=["IPv4"], location=["string"], mitigation_product=["DDOS"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE_CHANGE", ) assert_matches_type(Layer7TimeseriesResponse, layer7, path=["response"]) diff --git a/tests/api_resources/radar/bgp/test_ips.py b/tests/api_resources/radar/bgp/test_ips.py index cff76af41ff..27272ae08e2 100644 --- a/tests/api_resources/radar/bgp/test_ips.py +++ b/tests/api_resources/radar/bgp/test_ips.py @@ -34,7 +34,7 @@ def test_method_timeseries_with_all_params(self, client: Cloudflare) -> None: include_delay=True, ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(IPTimeseriesResponse, ip, path=["response"]) @@ -78,7 +78,7 @@ async def test_method_timeseries_with_all_params(self, async_client: AsyncCloudf include_delay=True, ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(IPTimeseriesResponse, ip, path=["response"]) diff --git a/tests/api_resources/radar/bgp/test_routes.py b/tests/api_resources/radar/bgp/test_routes.py index 2352e1e1852..6e1de8fdc16 100644 --- a/tests/api_resources/radar/bgp/test_routes.py +++ b/tests/api_resources/radar/bgp/test_routes.py @@ -34,7 +34,7 @@ def test_method_ases_with_all_params(self, client: Cloudflare) -> None: limit=5, location="US", sort_by="cone", - sort_order="asc", + sort_order="ASC", ) assert_matches_type(RouteAsesResponse, route, path=["response"]) @@ -179,7 +179,7 @@ async def test_method_ases_with_all_params(self, async_client: AsyncCloudflare) limit=5, location="US", sort_by="cone", - sort_order="asc", + sort_order="ASC", ) assert_matches_type(RouteAsesResponse, route, path=["response"]) diff --git a/tests/api_resources/radar/bgp/test_top.py b/tests/api_resources/radar/bgp/test_top.py index 7a0fa5044e4..afd90a9fc0d 100644 --- a/tests/api_resources/radar/bgp/test_top.py +++ b/tests/api_resources/radar/bgp/test_top.py @@ -32,7 +32,7 @@ def test_method_prefixes_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit=5, - name=["string"], + name=["main_series"], update_type=["ANNOUNCEMENT"], ) assert_matches_type(TopPrefixesResponse, top, path=["response"]) @@ -75,7 +75,7 @@ async def test_method_prefixes_with_all_params(self, async_client: AsyncCloudfla date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit=5, - name=["string"], + name=["main_series"], update_type=["ANNOUNCEMENT"], ) assert_matches_type(TopPrefixesResponse, top, path=["response"]) diff --git a/tests/api_resources/radar/bgp/top/test_ases.py b/tests/api_resources/radar/bgp/top/test_ases.py index dfa6dca32e3..261cfd82941 100644 --- a/tests/api_resources/radar/bgp/top/test_ases.py +++ b/tests/api_resources/radar/bgp/top/test_ases.py @@ -32,7 +32,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit=5, - name=["string"], + name=["main_series"], prefix=["1.1.1.0/24"], update_type=["ANNOUNCEMENT"], ) @@ -110,7 +110,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit=5, - name=["string"], + name=["main_series"], prefix=["1.1.1.0/24"], update_type=["ANNOUNCEMENT"], ) diff --git a/tests/api_resources/radar/dns/test_top.py b/tests/api_resources/radar/dns/test_top.py index 4d9bb94fefc..6d6eb3b42b4 100644 --- a/tests/api_resources/radar/dns/test_top.py +++ b/tests/api_resources/radar/dns/test_top.py @@ -35,7 +35,7 @@ def test_method_ases_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopAsesResponse, top, path=["response"]) @@ -76,7 +76,7 @@ def test_method_locations_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopLocationsResponse, top, path=["response"]) @@ -121,7 +121,7 @@ async def test_method_ases_with_all_params(self, async_client: AsyncCloudflare) format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopAsesResponse, top, path=["response"]) @@ -162,7 +162,7 @@ async def test_method_locations_with_all_params(self, async_client: AsyncCloudfl format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopLocationsResponse, top, path=["response"]) diff --git a/tests/api_resources/radar/email/routing/test_summary.py b/tests/api_resources/radar/email/routing/test_summary.py index 71050cd8eb3..64bbf2de1d2 100644 --- a/tests/api_resources/radar/email/routing/test_summary.py +++ b/tests/api_resources/radar/email/routing/test_summary.py @@ -41,7 +41,7 @@ def test_method_arc_with_all_params(self, client: Cloudflare) -> None: encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryARCResponse, summary, path=["response"]) @@ -82,7 +82,7 @@ def test_method_dkim_with_all_params(self, client: Cloudflare) -> None: encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryDKIMResponse, summary, path=["response"]) @@ -123,7 +123,7 @@ def test_method_dmarc_with_all_params(self, client: Cloudflare) -> None: encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryDMARCResponse, summary, path=["response"]) @@ -164,7 +164,7 @@ def test_method_encrypted_with_all_params(self, client: Cloudflare) -> None: dmarc=["PASS"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryEncryptedResponse, summary, path=["response"]) @@ -205,7 +205,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: dmarc=["PASS"], encrypted=["ENCRYPTED"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryIPVersionResponse, summary, path=["response"]) @@ -247,7 +247,7 @@ def test_method_spf_with_all_params(self, client: Cloudflare) -> None: encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummarySPFResponse, summary, path=["response"]) @@ -291,7 +291,7 @@ async def test_method_arc_with_all_params(self, async_client: AsyncCloudflare) - encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryARCResponse, summary, path=["response"]) @@ -332,7 +332,7 @@ async def test_method_dkim_with_all_params(self, async_client: AsyncCloudflare) encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryDKIMResponse, summary, path=["response"]) @@ -373,7 +373,7 @@ async def test_method_dmarc_with_all_params(self, async_client: AsyncCloudflare) encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryDMARCResponse, summary, path=["response"]) @@ -414,7 +414,7 @@ async def test_method_encrypted_with_all_params(self, async_client: AsyncCloudfl dmarc=["PASS"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryEncryptedResponse, summary, path=["response"]) @@ -455,7 +455,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf dmarc=["PASS"], encrypted=["ENCRYPTED"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryIPVersionResponse, summary, path=["response"]) @@ -497,7 +497,7 @@ async def test_method_spf_with_all_params(self, async_client: AsyncCloudflare) - encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], ) assert_matches_type(SummarySPFResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/email/routing/test_timeseries_groups.py b/tests/api_resources/radar/email/routing/test_timeseries_groups.py index ebffbbcdc12..ebf7b0bfcde 100644 --- a/tests/api_resources/radar/email/routing/test_timeseries_groups.py +++ b/tests/api_resources/radar/email/routing/test_timeseries_groups.py @@ -42,7 +42,7 @@ def test_method_arc_with_all_params(self, client: Cloudflare) -> None: encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupARCResponse, timeseries_group, path=["response"]) @@ -84,7 +84,7 @@ def test_method_dkim_with_all_params(self, client: Cloudflare) -> None: encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupDKIMResponse, timeseries_group, path=["response"]) @@ -126,7 +126,7 @@ def test_method_dmarc_with_all_params(self, client: Cloudflare) -> None: encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupDMARCResponse, timeseries_group, path=["response"]) @@ -168,7 +168,7 @@ def test_method_encrypted_with_all_params(self, client: Cloudflare) -> None: dmarc=["PASS"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupEncryptedResponse, timeseries_group, path=["response"]) @@ -210,7 +210,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: dmarc=["PASS"], encrypted=["ENCRYPTED"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupIPVersionResponse, timeseries_group, path=["response"]) @@ -253,7 +253,7 @@ def test_method_spf_with_all_params(self, client: Cloudflare) -> None: encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupSPFResponse, timeseries_group, path=["response"]) @@ -298,7 +298,7 @@ async def test_method_arc_with_all_params(self, async_client: AsyncCloudflare) - encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupARCResponse, timeseries_group, path=["response"]) @@ -340,7 +340,7 @@ async def test_method_dkim_with_all_params(self, async_client: AsyncCloudflare) encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupDKIMResponse, timeseries_group, path=["response"]) @@ -382,7 +382,7 @@ async def test_method_dmarc_with_all_params(self, async_client: AsyncCloudflare) encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupDMARCResponse, timeseries_group, path=["response"]) @@ -424,7 +424,7 @@ async def test_method_encrypted_with_all_params(self, async_client: AsyncCloudfl dmarc=["PASS"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupEncryptedResponse, timeseries_group, path=["response"]) @@ -466,7 +466,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf dmarc=["PASS"], encrypted=["ENCRYPTED"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupIPVersionResponse, timeseries_group, path=["response"]) @@ -509,7 +509,7 @@ async def test_method_spf_with_all_params(self, async_client: AsyncCloudflare) - encrypted=["ENCRYPTED"], format="JSON", ip_version=["IPv4"], - name=["string"], + name=["main_series"], ) assert_matches_type(TimeseriesGroupSPFResponse, timeseries_group, path=["response"]) diff --git a/tests/api_resources/radar/email/security/test_summary.py b/tests/api_resources/radar/email/security/test_summary.py index 21d2dbf2aae..51820e1bd4e 100644 --- a/tests/api_resources/radar/email/security/test_summary.py +++ b/tests/api_resources/radar/email/security/test_summary.py @@ -42,7 +42,7 @@ def test_method_arc_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -82,7 +82,7 @@ def test_method_dkim_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -122,7 +122,7 @@ def test_method_dmarc_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], dkim=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -163,7 +163,7 @@ def test_method_malicious_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -204,7 +204,7 @@ def test_method_spam_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -245,7 +245,7 @@ def test_method_spf_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(SummarySPFResponse, summary, path=["response"]) @@ -285,7 +285,7 @@ def test_method_spoof_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -326,7 +326,7 @@ def test_method_threat_category_with_all_params(self, client: Cloudflare) -> Non dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -367,7 +367,7 @@ def test_method_tls_version_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryTLSVersionResponse, summary, path=["response"]) @@ -410,7 +410,7 @@ async def test_method_arc_with_all_params(self, async_client: AsyncCloudflare) - dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -450,7 +450,7 @@ async def test_method_dkim_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -490,7 +490,7 @@ async def test_method_dmarc_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], dkim=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -531,7 +531,7 @@ async def test_method_malicious_with_all_params(self, async_client: AsyncCloudfl dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -572,7 +572,7 @@ async def test_method_spam_with_all_params(self, async_client: AsyncCloudflare) dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -613,7 +613,7 @@ async def test_method_spf_with_all_params(self, async_client: AsyncCloudflare) - dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(SummarySPFResponse, summary, path=["response"]) @@ -653,7 +653,7 @@ async def test_method_spoof_with_all_params(self, async_client: AsyncCloudflare) dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -694,7 +694,7 @@ async def test_method_threat_category_with_all_params(self, async_client: AsyncC dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -735,7 +735,7 @@ async def test_method_tls_version_with_all_params(self, async_client: AsyncCloud dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(SummaryTLSVersionResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/email/security/test_timeseries_groups.py b/tests/api_resources/radar/email/security/test_timeseries_groups.py index 3b306bd7c33..eba63818ff7 100644 --- a/tests/api_resources/radar/email/security/test_timeseries_groups.py +++ b/tests/api_resources/radar/email/security/test_timeseries_groups.py @@ -43,7 +43,7 @@ def test_method_arc_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -84,7 +84,7 @@ def test_method_dkim_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -125,7 +125,7 @@ def test_method_dmarc_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], dkim=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -167,7 +167,7 @@ def test_method_malicious_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -209,7 +209,7 @@ def test_method_spam_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -251,7 +251,7 @@ def test_method_spf_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(TimeseriesGroupSPFResponse, timeseries_group, path=["response"]) @@ -292,7 +292,7 @@ def test_method_spoof_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -334,7 +334,7 @@ def test_method_threat_category_with_all_params(self, client: Cloudflare) -> Non dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -376,7 +376,7 @@ def test_method_tls_version_with_all_params(self, client: Cloudflare) -> None: dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupTLSVersionResponse, timeseries_group, path=["response"]) @@ -420,7 +420,7 @@ async def test_method_arc_with_all_params(self, async_client: AsyncCloudflare) - dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -461,7 +461,7 @@ async def test_method_dkim_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -502,7 +502,7 @@ async def test_method_dmarc_with_all_params(self, async_client: AsyncCloudflare) date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], dkim=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -544,7 +544,7 @@ async def test_method_malicious_with_all_params(self, async_client: AsyncCloudfl dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -586,7 +586,7 @@ async def test_method_spam_with_all_params(self, async_client: AsyncCloudflare) dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -628,7 +628,7 @@ async def test_method_spf_with_all_params(self, async_client: AsyncCloudflare) - dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(TimeseriesGroupSPFResponse, timeseries_group, path=["response"]) @@ -669,7 +669,7 @@ async def test_method_spoof_with_all_params(self, async_client: AsyncCloudflare) dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -711,7 +711,7 @@ async def test_method_threat_category_with_all_params(self, async_client: AsyncC dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], tls_version=["TLSv1_0"], ) @@ -755,7 +755,7 @@ async def test_method_tls_version_with_all_params(self, async_client: AsyncCloud dkim=["PASS"], dmarc=["PASS"], format="JSON", - name=["string"], + name=["main_series"], spf=["PASS"], ) assert_matches_type(TimeseriesGroupTLSVersionResponse, timeseries_group, path=["response"]) diff --git a/tests/api_resources/radar/email/security/top/test_tlds.py b/tests/api_resources/radar/email/security/top/test_tlds.py index 6bca8ef255e..0633c38550e 100644 --- a/tests/api_resources/radar/email/security/top/test_tlds.py +++ b/tests/api_resources/radar/email/security/top/test_tlds.py @@ -34,7 +34,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: dmarc=["PASS"], format="JSON", limit=5, - name=["string"], + name=["main_series"], spf=["PASS"], tld_category="CLASSIC", tls_version=["TLSv1_0"], @@ -81,7 +81,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - dmarc=["PASS"], format="JSON", limit=5, - name=["string"], + name=["main_series"], spf=["PASS"], tld_category="CLASSIC", tls_version=["TLSv1_0"], diff --git a/tests/api_resources/radar/email/security/top/tlds/test_malicious.py b/tests/api_resources/radar/email/security/top/tlds/test_malicious.py index 45fb924aa1e..79ca8b49bbe 100644 --- a/tests/api_resources/radar/email/security/top/tlds/test_malicious.py +++ b/tests/api_resources/radar/email/security/top/tlds/test_malicious.py @@ -37,7 +37,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: dmarc=["PASS"], format="JSON", limit=5, - name=["string"], + name=["main_series"], spf=["PASS"], tld_category="CLASSIC", tls_version=["TLSv1_0"], @@ -91,7 +91,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - dmarc=["PASS"], format="JSON", limit=5, - name=["string"], + name=["main_series"], spf=["PASS"], tld_category="CLASSIC", tls_version=["TLSv1_0"], diff --git a/tests/api_resources/radar/email/security/top/tlds/test_spam.py b/tests/api_resources/radar/email/security/top/tlds/test_spam.py index cba4fce1a25..2e561af84f9 100644 --- a/tests/api_resources/radar/email/security/top/tlds/test_spam.py +++ b/tests/api_resources/radar/email/security/top/tlds/test_spam.py @@ -37,7 +37,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: dmarc=["PASS"], format="JSON", limit=5, - name=["string"], + name=["main_series"], spf=["PASS"], tld_category="CLASSIC", tls_version=["TLSv1_0"], @@ -91,7 +91,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - dmarc=["PASS"], format="JSON", limit=5, - name=["string"], + name=["main_series"], spf=["PASS"], tld_category="CLASSIC", tls_version=["TLSv1_0"], diff --git a/tests/api_resources/radar/email/security/top/tlds/test_spoof.py b/tests/api_resources/radar/email/security/top/tlds/test_spoof.py index 26bbd0bd9f1..c06d638af23 100644 --- a/tests/api_resources/radar/email/security/top/tlds/test_spoof.py +++ b/tests/api_resources/radar/email/security/top/tlds/test_spoof.py @@ -37,7 +37,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: dmarc=["PASS"], format="JSON", limit=5, - name=["string"], + name=["main_series"], spf=["PASS"], tld_category="CLASSIC", tls_version=["TLSv1_0"], @@ -91,7 +91,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - dmarc=["PASS"], format="JSON", limit=5, - name=["string"], + name=["main_series"], spf=["PASS"], tld_category="CLASSIC", tls_version=["TLSv1_0"], diff --git a/tests/api_resources/radar/entities/test_asns.py b/tests/api_resources/radar/entities/test_asns.py index 78555b0de2d..25c5d7f322b 100644 --- a/tests/api_resources/radar/entities/test_asns.py +++ b/tests/api_resources/radar/entities/test_asns.py @@ -62,14 +62,14 @@ def test_streaming_response_list(self, client: Cloudflare) -> None: @parametrize def test_method_get(self, client: Cloudflare) -> None: asn = client.radar.entities.asns.get( - asn=3, + asn=174, ) assert_matches_type(ASNGetResponse, asn, path=["response"]) @parametrize def test_method_get_with_all_params(self, client: Cloudflare) -> None: asn = client.radar.entities.asns.get( - asn=3, + asn=174, format="JSON", ) assert_matches_type(ASNGetResponse, asn, path=["response"]) @@ -77,7 +77,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: @parametrize def test_raw_response_get(self, client: Cloudflare) -> None: response = client.radar.entities.asns.with_raw_response.get( - asn=3, + asn=174, ) assert response.is_closed is True @@ -88,7 +88,7 @@ def test_raw_response_get(self, client: Cloudflare) -> None: @parametrize def test_streaming_response_get(self, client: Cloudflare) -> None: with client.radar.entities.asns.with_streaming_response.get( - asn=3, + asn=174, ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" @@ -221,14 +221,14 @@ async def test_streaming_response_list(self, async_client: AsyncCloudflare) -> N @parametrize async def test_method_get(self, async_client: AsyncCloudflare) -> None: asn = await async_client.radar.entities.asns.get( - asn=3, + asn=174, ) assert_matches_type(ASNGetResponse, asn, path=["response"]) @parametrize async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) -> None: asn = await async_client.radar.entities.asns.get( - asn=3, + asn=174, format="JSON", ) assert_matches_type(ASNGetResponse, asn, path=["response"]) @@ -236,7 +236,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - @parametrize async def test_raw_response_get(self, async_client: AsyncCloudflare) -> None: response = await async_client.radar.entities.asns.with_raw_response.get( - asn=3, + asn=174, ) assert response.is_closed is True @@ -247,7 +247,7 @@ async def test_raw_response_get(self, async_client: AsyncCloudflare) -> None: @parametrize async def test_streaming_response_get(self, async_client: AsyncCloudflare) -> None: async with async_client.radar.entities.asns.with_streaming_response.get( - asn=3, + asn=174, ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" diff --git a/tests/api_resources/radar/http/ases/test_bot_class.py b/tests/api_resources/radar/http/ases/test_bot_class.py index 8d566b8b679..98df2ef1124 100644 --- a/tests/api_resources/radar/http/ases/test_bot_class.py +++ b/tests/api_resources/radar/http/ases/test_bot_class.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/ases/test_browser_family.py b/tests/api_resources/radar/http/ases/test_browser_family.py index d06f05ca1d8..ec95ad11eb3 100644 --- a/tests/api_resources/radar/http/ases/test_browser_family.py +++ b/tests/api_resources/radar/http/ases/test_browser_family.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/ases/test_device_type.py b/tests/api_resources/radar/http/ases/test_device_type.py index e9189b19b69..16f5159f28e 100644 --- a/tests/api_resources/radar/http/ases/test_device_type.py +++ b/tests/api_resources/radar/http/ases/test_device_type.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/ases/test_http_method.py b/tests/api_resources/radar/http/ases/test_http_method.py index 11c2ca3f1bd..e78240f48d0 100644 --- a/tests/api_resources/radar/http/ases/test_http_method.py +++ b/tests/api_resources/radar/http/ases/test_http_method.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/ases/test_http_protocol.py b/tests/api_resources/radar/http/ases/test_http_protocol.py index 9f16038522a..ed93997533f 100644 --- a/tests/api_resources/radar/http/ases/test_http_protocol.py +++ b/tests/api_resources/radar/http/ases/test_http_protocol.py @@ -38,10 +38,11 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], device_type=["DESKTOP"], format="JSON", + http_version=["HTTPv1"], ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -95,10 +96,11 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], device_type=["DESKTOP"], format="JSON", + http_version=["HTTPv1"], ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/ases/test_ip_version.py b/tests/api_resources/radar/http/ases/test_ip_version.py index 598493b047d..6852e542ea2 100644 --- a/tests/api_resources/radar/http/ases/test_ip_version.py +++ b/tests/api_resources/radar/http/ases/test_ip_version.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - http_version=["HTTPv1"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/ases/test_os.py b/tests/api_resources/radar/http/ases/test_os.py index 96a70f74afe..6504480d77e 100644 --- a/tests/api_resources/radar/http/ases/test_os.py +++ b/tests/api_resources/radar/http/ases/test_os.py @@ -43,7 +43,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(OSGetResponse, os, path=["response"]) @@ -101,7 +101,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(OSGetResponse, os, path=["response"]) diff --git a/tests/api_resources/radar/http/ases/test_tls_version.py b/tests/api_resources/radar/http/ases/test_tls_version.py index d11dec49fd6..bbd6d24f88d 100644 --- a/tests/api_resources/radar/http/ases/test_tls_version.py +++ b/tests/api_resources/radar/http/ases/test_tls_version.py @@ -43,7 +43,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], ) assert_matches_type(TLSVersionGetResponse, tls_version, path=["response"]) @@ -101,7 +101,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], ) assert_matches_type(TLSVersionGetResponse, tls_version, path=["response"]) diff --git a/tests/api_resources/radar/http/locations/test_bot_class.py b/tests/api_resources/radar/http/locations/test_bot_class.py index 6690ffd465a..6dc83153fd2 100644 --- a/tests/api_resources/radar/http/locations/test_bot_class.py +++ b/tests/api_resources/radar/http/locations/test_bot_class.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/locations/test_browser_family.py b/tests/api_resources/radar/http/locations/test_browser_family.py index 5f283bceedd..4f1d0335857 100644 --- a/tests/api_resources/radar/http/locations/test_browser_family.py +++ b/tests/api_resources/radar/http/locations/test_browser_family.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/locations/test_device_type.py b/tests/api_resources/radar/http/locations/test_device_type.py index cb5782f3914..7d5e60d4bb5 100644 --- a/tests/api_resources/radar/http/locations/test_device_type.py +++ b/tests/api_resources/radar/http/locations/test_device_type.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/locations/test_http_method.py b/tests/api_resources/radar/http/locations/test_http_method.py index e3b1ce1379e..f38a1e462c2 100644 --- a/tests/api_resources/radar/http/locations/test_http_method.py +++ b/tests/api_resources/radar/http/locations/test_http_method.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/locations/test_http_protocol.py b/tests/api_resources/radar/http/locations/test_http_protocol.py index e23e9254cca..b72c48d133f 100644 --- a/tests/api_resources/radar/http/locations/test_http_protocol.py +++ b/tests/api_resources/radar/http/locations/test_http_protocol.py @@ -38,10 +38,11 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], device_type=["DESKTOP"], format="JSON", + http_version=["HTTPv1"], ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -95,10 +96,11 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], device_type=["DESKTOP"], format="JSON", + http_version=["HTTPv1"], ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/locations/test_ip_version.py b/tests/api_resources/radar/http/locations/test_ip_version.py index a6885e7512c..cccb9672906 100644 --- a/tests/api_resources/radar/http/locations/test_ip_version.py +++ b/tests/api_resources/radar/http/locations/test_ip_version.py @@ -42,7 +42,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -100,7 +100,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - http_version=["HTTPv1"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/locations/test_os.py b/tests/api_resources/radar/http/locations/test_os.py index 532c1040d94..adda371838c 100644 --- a/tests/api_resources/radar/http/locations/test_os.py +++ b/tests/api_resources/radar/http/locations/test_os.py @@ -43,7 +43,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(OSGetResponse, os, path=["response"]) @@ -101,7 +101,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(OSGetResponse, os, path=["response"]) diff --git a/tests/api_resources/radar/http/locations/test_tls_version.py b/tests/api_resources/radar/http/locations/test_tls_version.py index f73cadd1ec6..d44cf7872ee 100644 --- a/tests/api_resources/radar/http/locations/test_tls_version.py +++ b/tests/api_resources/radar/http/locations/test_tls_version.py @@ -43,7 +43,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], ) assert_matches_type(TLSVersionGetResponse, tls_version, path=["response"]) @@ -101,7 +101,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], ) assert_matches_type(TLSVersionGetResponse, tls_version, path=["response"]) diff --git a/tests/api_resources/radar/http/test_ases.py b/tests/api_resources/radar/http/test_ases.py index 6a0b4b29ae8..9413713558b 100644 --- a/tests/api_resources/radar/http/test_ases.py +++ b/tests/api_resources/radar/http/test_ases.py @@ -40,7 +40,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -92,7 +92,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/test_locations.py b/tests/api_resources/radar/http/test_locations.py index 0b276ddf3cf..a4bd04bb8cd 100644 --- a/tests/api_resources/radar/http/test_locations.py +++ b/tests/api_resources/radar/http/test_locations.py @@ -40,7 +40,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -92,7 +92,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/http/test_summary.py b/tests/api_resources/radar/http/test_summary.py index f6c0cbfe3e9..94d5f33f7ac 100644 --- a/tests/api_resources/radar/http/test_summary.py +++ b/tests/api_resources/radar/http/test_summary.py @@ -46,7 +46,7 @@ def test_method_bot_class_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -91,7 +91,7 @@ def test_method_device_type_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -136,7 +136,7 @@ def test_method_http_protocol_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -181,7 +181,7 @@ def test_method_http_version_with_all_params(self, client: Cloudflare) -> None: http_protocol=["HTTP"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -226,7 +226,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: http_protocol=["HTTP"], http_version=["HTTPv1"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -272,7 +272,7 @@ def test_method_os_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(SummaryOSResponse, summary, path=["response"]) @@ -317,7 +317,7 @@ def test_method_post_quantum_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -363,7 +363,7 @@ def test_method_tls_version_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], ) assert_matches_type(SummaryTLSVersionResponse, summary, path=["response"]) @@ -411,7 +411,7 @@ async def test_method_bot_class_with_all_params(self, async_client: AsyncCloudfl http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -456,7 +456,7 @@ async def test_method_device_type_with_all_params(self, async_client: AsyncCloud http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -501,7 +501,7 @@ async def test_method_http_protocol_with_all_params(self, async_client: AsyncClo http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -546,7 +546,7 @@ async def test_method_http_version_with_all_params(self, async_client: AsyncClou http_protocol=["HTTP"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -591,7 +591,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf http_protocol=["HTTP"], http_version=["HTTPv1"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -637,7 +637,7 @@ async def test_method_os_with_all_params(self, async_client: AsyncCloudflare) -> http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(SummaryOSResponse, summary, path=["response"]) @@ -682,7 +682,7 @@ async def test_method_post_quantum_with_all_params(self, async_client: AsyncClou http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -728,7 +728,7 @@ async def test_method_tls_version_with_all_params(self, async_client: AsyncCloud http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], ) assert_matches_type(SummaryTLSVersionResponse, summary, path=["response"]) diff --git a/tests/api_resources/radar/http/test_timeseries_groups.py b/tests/api_resources/radar/http/test_timeseries_groups.py index 8789e6c61ed..753bf24162b 100644 --- a/tests/api_resources/radar/http/test_timeseries_groups.py +++ b/tests/api_resources/radar/http/test_timeseries_groups.py @@ -49,7 +49,7 @@ def test_method_bot_class_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -97,7 +97,7 @@ def test_method_browser_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -145,7 +145,7 @@ def test_method_browser_family_with_all_params(self, client: Cloudflare) -> None ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -191,7 +191,7 @@ def test_method_device_type_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -237,7 +237,7 @@ def test_method_http_protocol_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -283,7 +283,7 @@ def test_method_http_version_with_all_params(self, client: Cloudflare) -> None: http_protocol=["HTTP"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -329,7 +329,7 @@ def test_method_ip_version_with_all_params(self, client: Cloudflare) -> None: http_protocol=["HTTP"], http_version=["HTTPv1"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -376,7 +376,7 @@ def test_method_os_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(TimeseriesGroupOSResponse, timeseries_group, path=["response"]) @@ -422,7 +422,7 @@ def test_method_post_quantum_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -469,7 +469,7 @@ def test_method_tls_version_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], ) assert_matches_type(TimeseriesGroupTLSVersionResponse, timeseries_group, path=["response"]) @@ -518,7 +518,7 @@ async def test_method_bot_class_with_all_params(self, async_client: AsyncCloudfl http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -566,7 +566,7 @@ async def test_method_browser_with_all_params(self, async_client: AsyncCloudflar ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -614,7 +614,7 @@ async def test_method_browser_family_with_all_params(self, async_client: AsyncCl ip_version=["IPv4"], limit_per_group=10, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -660,7 +660,7 @@ async def test_method_device_type_with_all_params(self, async_client: AsyncCloud http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -706,7 +706,7 @@ async def test_method_http_protocol_with_all_params(self, async_client: AsyncClo http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -752,7 +752,7 @@ async def test_method_http_version_with_all_params(self, async_client: AsyncClou http_protocol=["HTTP"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -798,7 +798,7 @@ async def test_method_ip_version_with_all_params(self, async_client: AsyncCloudf http_protocol=["HTTP"], http_version=["HTTPv1"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -845,7 +845,7 @@ async def test_method_os_with_all_params(self, async_client: AsyncCloudflare) -> http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], tls_version=["TLSv1_0"], ) assert_matches_type(TimeseriesGroupOSResponse, timeseries_group, path=["response"]) @@ -891,7 +891,7 @@ async def test_method_post_quantum_with_all_params(self, async_client: AsyncClou http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -938,7 +938,7 @@ async def test_method_tls_version_with_all_params(self, async_client: AsyncCloud http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], ) assert_matches_type(TimeseriesGroupTLSVersionResponse, timeseries_group, path=["response"]) diff --git a/tests/api_resources/radar/http/test_top.py b/tests/api_resources/radar/http/test_top.py index a940b158847..ebfce964cf3 100644 --- a/tests/api_resources/radar/http/test_top.py +++ b/tests/api_resources/radar/http/test_top.py @@ -43,7 +43,7 @@ def test_method_browser_with_all_params(self, client: Cloudflare) -> None: ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -90,7 +90,7 @@ def test_method_browser_family_with_all_params(self, client: Cloudflare) -> None ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -142,7 +142,7 @@ async def test_method_browser_with_all_params(self, async_client: AsyncCloudflar ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) @@ -189,7 +189,7 @@ async def test_method_browser_family_with_all_params(self, async_client: AsyncCl ip_version=["IPv4"], limit=5, location=["string"], - name=["string"], + name=["main_series"], os=["WINDOWS"], tls_version=["TLSv1_0"], ) diff --git a/tests/api_resources/radar/netflows/test_top.py b/tests/api_resources/radar/netflows/test_top.py index ce6cb7cf7ab..9dc8315bdcb 100644 --- a/tests/api_resources/radar/netflows/test_top.py +++ b/tests/api_resources/radar/netflows/test_top.py @@ -34,7 +34,7 @@ def test_method_ases_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopAsesResponse, top, path=["response"]) @@ -74,7 +74,7 @@ def test_method_locations_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopLocationsResponse, top, path=["response"]) @@ -118,7 +118,7 @@ async def test_method_ases_with_all_params(self, async_client: AsyncCloudflare) format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopAsesResponse, top, path=["response"]) @@ -158,7 +158,7 @@ async def test_method_locations_with_all_params(self, async_client: AsyncCloudfl format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopLocationsResponse, top, path=["response"]) diff --git a/tests/api_resources/radar/quality/speed/test_top.py b/tests/api_resources/radar/quality/speed/test_top.py index 595c3f3814e..5e8c6d353f7 100644 --- a/tests/api_resources/radar/quality/speed/test_top.py +++ b/tests/api_resources/radar/quality/speed/test_top.py @@ -35,7 +35,7 @@ def test_method_ases_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], order_by="BANDWIDTH_DOWNLOAD", reverse=True, ) @@ -75,7 +75,7 @@ def test_method_locations_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], order_by="BANDWIDTH_DOWNLOAD", reverse=True, ) @@ -119,7 +119,7 @@ async def test_method_ases_with_all_params(self, async_client: AsyncCloudflare) format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], order_by="BANDWIDTH_DOWNLOAD", reverse=True, ) @@ -159,7 +159,7 @@ async def test_method_locations_with_all_params(self, async_client: AsyncCloudfl format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], order_by="BANDWIDTH_DOWNLOAD", reverse=True, ) diff --git a/tests/api_resources/radar/quality/test_iqi.py b/tests/api_resources/radar/quality/test_iqi.py index ff562866312..0e0187f9479 100644 --- a/tests/api_resources/radar/quality/test_iqi.py +++ b/tests/api_resources/radar/quality/test_iqi.py @@ -39,7 +39,7 @@ def test_method_summary_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(IQISummaryResponse, iqi, path=["response"]) @@ -87,7 +87,7 @@ def test_method_timeseries_groups_with_all_params(self, client: Cloudflare) -> N format="JSON", interpolation=True, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(IQITimeseriesGroupsResponse, iqi, path=["response"]) @@ -137,7 +137,7 @@ async def test_method_summary_with_all_params(self, async_client: AsyncCloudflar date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(IQISummaryResponse, iqi, path=["response"]) @@ -185,7 +185,7 @@ async def test_method_timeseries_groups_with_all_params(self, async_client: Asyn format="JSON", interpolation=True, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(IQITimeseriesGroupsResponse, iqi, path=["response"]) diff --git a/tests/api_resources/radar/quality/test_speed.py b/tests/api_resources/radar/quality/test_speed.py index 7eaee21c74e..235910fd4e7 100644 --- a/tests/api_resources/radar/quality/test_speed.py +++ b/tests/api_resources/radar/quality/test_speed.py @@ -36,7 +36,7 @@ def test_method_histogram_with_all_params(self, client: Cloudflare) -> None: format="JSON", location=["string"], metric_group="BANDWIDTH", - name=["string"], + name=["main_series"], ) assert_matches_type(SpeedHistogramResponse, speed, path=["response"]) @@ -73,7 +73,7 @@ def test_method_summary_with_all_params(self, client: Cloudflare) -> None: date_end=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SpeedSummaryResponse, speed, path=["response"]) @@ -116,7 +116,7 @@ async def test_method_histogram_with_all_params(self, async_client: AsyncCloudfl format="JSON", location=["string"], metric_group="BANDWIDTH", - name=["string"], + name=["main_series"], ) assert_matches_type(SpeedHistogramResponse, speed, path=["response"]) @@ -153,7 +153,7 @@ async def test_method_summary_with_all_params(self, async_client: AsyncCloudflar date_end=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(SpeedSummaryResponse, speed, path=["response"]) diff --git a/tests/api_resources/radar/ranking/test_domain.py b/tests/api_resources/radar/ranking/test_domain.py index 26021593dd9..553229c8e89 100644 --- a/tests/api_resources/radar/ranking/test_domain.py +++ b/tests/api_resources/radar/ranking/test_domain.py @@ -33,7 +33,7 @@ def test_method_get_with_all_params(self, client: Cloudflare) -> None: format="JSON", include_top_locations=True, limit=5, - name=["string"], + name=["main_series"], ranking_type="POPULAR", ) assert_matches_type(DomainGetResponse, domain, path=["response"]) @@ -88,7 +88,7 @@ async def test_method_get_with_all_params(self, async_client: AsyncCloudflare) - format="JSON", include_top_locations=True, limit=5, - name=["string"], + name=["main_series"], ranking_type="POPULAR", ) assert_matches_type(DomainGetResponse, domain, path=["response"]) diff --git a/tests/api_resources/radar/ranking/test_internet_services.py b/tests/api_resources/radar/ranking/test_internet_services.py index f6b97175f9a..c39961e86e9 100644 --- a/tests/api_resources/radar/ranking/test_internet_services.py +++ b/tests/api_resources/radar/ranking/test_internet_services.py @@ -34,7 +34,7 @@ def test_method_timeseries_groups_with_all_params(self, client: Cloudflare) -> N date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit=5, - name=["string"], + name=["main_series"], service_category=["string"], ) assert_matches_type(InternetServiceTimeseriesGroupsResponse, internet_service, path=["response"]) @@ -70,7 +70,7 @@ def test_method_top_with_all_params(self, client: Cloudflare) -> None: date=[parse_date("2019-12-27")], format="JSON", limit=5, - name=["string"], + name=["main_series"], service_category=["string"], ) assert_matches_type(InternetServiceTopResponse, internet_service, path=["response"]) @@ -112,7 +112,7 @@ async def test_method_timeseries_groups_with_all_params(self, async_client: Asyn date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", limit=5, - name=["string"], + name=["main_series"], service_category=["string"], ) assert_matches_type(InternetServiceTimeseriesGroupsResponse, internet_service, path=["response"]) @@ -148,7 +148,7 @@ async def test_method_top_with_all_params(self, async_client: AsyncCloudflare) - date=[parse_date("2019-12-27")], format="JSON", limit=5, - name=["string"], + name=["main_series"], service_category=["string"], ) assert_matches_type(InternetServiceTopResponse, internet_service, path=["response"]) diff --git a/tests/api_resources/radar/robots_txt/test_top.py b/tests/api_resources/radar/robots_txt/test_top.py index 8206f5be9d5..e0cc7628659 100644 --- a/tests/api_resources/radar/robots_txt/test_top.py +++ b/tests/api_resources/radar/robots_txt/test_top.py @@ -29,7 +29,7 @@ def test_method_domain_categories_with_all_params(self, client: Cloudflare) -> N date=[parse_date("2019-12-27")], format="JSON", limit=5, - name=["string"], + name=["main_series"], user_agent_category="AI", ) assert_matches_type(TopDomainCategoriesResponse, top, path=["response"]) @@ -69,7 +69,7 @@ async def test_method_domain_categories_with_all_params(self, async_client: Asyn date=[parse_date("2019-12-27")], format="JSON", limit=5, - name=["string"], + name=["main_series"], user_agent_category="AI", ) assert_matches_type(TopDomainCategoriesResponse, top, path=["response"]) diff --git a/tests/api_resources/radar/robots_txt/top/test_user_agents.py b/tests/api_resources/radar/robots_txt/top/test_user_agents.py index 471e63bbeeb..ac2435dba6d 100644 --- a/tests/api_resources/radar/robots_txt/top/test_user_agents.py +++ b/tests/api_resources/radar/robots_txt/top/test_user_agents.py @@ -31,7 +31,7 @@ def test_method_directive_with_all_params(self, client: Cloudflare) -> None: domain_category=["string"], format="JSON", limit=5, - name=["string"], + name=["main_series"], user_agent_category="AI", ) assert_matches_type(UserAgentDirectiveResponse, user_agent, path=["response"]) @@ -73,7 +73,7 @@ async def test_method_directive_with_all_params(self, async_client: AsyncCloudfl domain_category=["string"], format="JSON", limit=5, - name=["string"], + name=["main_series"], user_agent_category="AI", ) assert_matches_type(UserAgentDirectiveResponse, user_agent, path=["response"]) diff --git a/tests/api_resources/radar/test_as112.py b/tests/api_resources/radar/test_as112.py index dc91117f06a..e0dd677a213 100644 --- a/tests/api_resources/radar/test_as112.py +++ b/tests/api_resources/radar/test_as112.py @@ -34,7 +34,7 @@ def test_method_timeseries_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(AS112TimeseriesResponse, as112, path=["response"]) @@ -78,7 +78,7 @@ async def test_method_timeseries_with_all_params(self, async_client: AsyncCloudf date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(AS112TimeseriesResponse, as112, path=["response"]) diff --git a/tests/api_resources/radar/test_bgp.py b/tests/api_resources/radar/test_bgp.py index 375ef3eaeab..e4676a91818 100644 --- a/tests/api_resources/radar/test_bgp.py +++ b/tests/api_resources/radar/test_bgp.py @@ -32,7 +32,7 @@ def test_method_timeseries_with_all_params(self, client: Cloudflare) -> None: date_range=["7d"], date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", - name=["string"], + name=["main_series"], prefix=["1.1.1.0/24"], update_type=["ANNOUNCEMENT"], ) @@ -76,7 +76,7 @@ async def test_method_timeseries_with_all_params(self, async_client: AsyncCloudf date_range=["7d"], date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", - name=["string"], + name=["main_series"], prefix=["1.1.1.0/24"], update_type=["ANNOUNCEMENT"], ) diff --git a/tests/api_resources/radar/test_http.py b/tests/api_resources/radar/test_http.py index c1ec1aef328..aab9b6f596d 100644 --- a/tests/api_resources/radar/test_http.py +++ b/tests/api_resources/radar/test_http.py @@ -39,7 +39,7 @@ def test_method_timeseries_with_all_params(self, client: Cloudflare) -> None: http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE_CHANGE", os=["WINDOWS"], tls_version=["TLSv1_0"], @@ -91,7 +91,7 @@ async def test_method_timeseries_with_all_params(self, async_client: AsyncCloudf http_version=["HTTPv1"], ip_version=["IPv4"], location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE_CHANGE", os=["WINDOWS"], tls_version=["TLSv1_0"], diff --git a/tests/api_resources/radar/test_netflows.py b/tests/api_resources/radar/test_netflows.py index 170b3ca5696..1e7080d313a 100644 --- a/tests/api_resources/radar/test_netflows.py +++ b/tests/api_resources/radar/test_netflows.py @@ -36,7 +36,7 @@ def test_method_summary_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(NetflowSummaryResponse, netflow, path=["response"]) @@ -76,7 +76,7 @@ def test_method_timeseries_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE_CHANGE", product=["HTTP"], ) @@ -121,7 +121,7 @@ async def test_method_summary_with_all_params(self, async_client: AsyncCloudflar date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(NetflowSummaryResponse, netflow, path=["response"]) @@ -161,7 +161,7 @@ async def test_method_timeseries_with_all_params(self, async_client: AsyncCloudf date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], normalization="PERCENTAGE_CHANGE", product=["HTTP"], ) diff --git a/tests/api_resources/radar/test_ranking.py b/tests/api_resources/radar/test_ranking.py index 56dc29a330d..9ea16b2ce33 100644 --- a/tests/api_resources/radar/test_ranking.py +++ b/tests/api_resources/radar/test_ranking.py @@ -37,7 +37,7 @@ def test_method_timeseries_groups_with_all_params(self, client: Cloudflare) -> N format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ranking_type="POPULAR", ) assert_matches_type(RankingTimeseriesGroupsResponse, ranking, path=["response"]) @@ -75,7 +75,7 @@ def test_method_top_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ranking_type="POPULAR", ) assert_matches_type(RankingTopResponse, ranking, path=["response"]) @@ -120,7 +120,7 @@ async def test_method_timeseries_groups_with_all_params(self, async_client: Asyn format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ranking_type="POPULAR", ) assert_matches_type(RankingTimeseriesGroupsResponse, ranking, path=["response"]) @@ -158,7 +158,7 @@ async def test_method_top_with_all_params(self, async_client: AsyncCloudflare) - format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ranking_type="POPULAR", ) assert_matches_type(RankingTopResponse, ranking, path=["response"]) diff --git a/tests/api_resources/radar/test_tcp_resets_timeouts.py b/tests/api_resources/radar/test_tcp_resets_timeouts.py index 57669977513..b7ed69156cd 100644 --- a/tests/api_resources/radar/test_tcp_resets_timeouts.py +++ b/tests/api_resources/radar/test_tcp_resets_timeouts.py @@ -36,7 +36,7 @@ def test_method_summary_with_all_params(self, client: Cloudflare) -> None: date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TCPResetsTimeoutSummaryResponse, tcp_resets_timeout, path=["response"]) @@ -76,7 +76,7 @@ def test_method_timeseries_groups_with_all_params(self, client: Cloudflare) -> N date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TCPResetsTimeoutTimeseriesGroupsResponse, tcp_resets_timeout, path=["response"]) @@ -119,7 +119,7 @@ async def test_method_summary_with_all_params(self, async_client: AsyncCloudflar date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TCPResetsTimeoutSummaryResponse, tcp_resets_timeout, path=["response"]) @@ -159,7 +159,7 @@ async def test_method_timeseries_groups_with_all_params(self, async_client: Asyn date_start=[parse_datetime("2019-12-27T18:11:19.117Z")], format="JSON", location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TCPResetsTimeoutTimeseriesGroupsResponse, tcp_resets_timeout, path=["response"]) diff --git a/tests/api_resources/radar/verified_bots/test_top.py b/tests/api_resources/radar/verified_bots/test_top.py index 55547b5d908..888fe79936c 100644 --- a/tests/api_resources/radar/verified_bots/test_top.py +++ b/tests/api_resources/radar/verified_bots/test_top.py @@ -37,7 +37,7 @@ def test_method_bots_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopBotsResponse, top, path=["response"]) @@ -77,7 +77,7 @@ def test_method_categories_with_all_params(self, client: Cloudflare) -> None: format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopCategoriesResponse, top, path=["response"]) @@ -121,7 +121,7 @@ async def test_method_bots_with_all_params(self, async_client: AsyncCloudflare) format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopBotsResponse, top, path=["response"]) @@ -161,7 +161,7 @@ async def test_method_categories_with_all_params(self, async_client: AsyncCloudf format="JSON", limit=5, location=["string"], - name=["string"], + name=["main_series"], ) assert_matches_type(TopCategoriesResponse, top, path=["response"])