mirror of
https://github.com/cloudflare/cloudflare-python.git
synced 2026-01-16 23:01:03 +00:00
354 lines
16 KiB
Python
354 lines
16 KiB
Python
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import List, Type, Union, cast
|
|
from datetime import datetime
|
|
from typing_extensions import Literal
|
|
|
|
import httpx
|
|
|
|
from ....._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
|
|
from ....._utils import maybe_transform, async_maybe_transform
|
|
from ....._compat import cached_property
|
|
from ....._resource import SyncAPIResource, AsyncAPIResource
|
|
from ....._response import (
|
|
to_raw_response_wrapper,
|
|
to_streamed_response_wrapper,
|
|
async_to_raw_response_wrapper,
|
|
async_to_streamed_response_wrapper,
|
|
)
|
|
from ....._wrappers import ResultWrapper
|
|
from ....._base_client import make_request_options
|
|
from .....types.radar.http.locations import http_protocol_get_params
|
|
from .....types.radar.http.locations.http_protocol_get_response import HTTPProtocolGetResponse
|
|
|
|
__all__ = ["HTTPProtocolResource", "AsyncHTTPProtocolResource"]
|
|
|
|
|
|
class HTTPProtocolResource(SyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> HTTPProtocolResourceWithRawResponse:
|
|
"""
|
|
This property can be used as a prefix for any HTTP method call to return
|
|
the raw response object instead of the parsed content.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return HTTPProtocolResourceWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> HTTPProtocolResourceWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
|
|
"""
|
|
return HTTPProtocolResourceWithStreamingResponse(self)
|
|
|
|
def get(
|
|
self,
|
|
http_protocol: Literal["HTTP", "HTTPS"],
|
|
*,
|
|
asn: SequenceNotStr[str] | Omit = omit,
|
|
bot_class: List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]] | Omit = omit,
|
|
browser_family: List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]] | Omit = omit,
|
|
continent: SequenceNotStr[str] | Omit = omit,
|
|
date_end: SequenceNotStr[Union[str, datetime]] | Omit = omit,
|
|
date_range: SequenceNotStr[str] | Omit = omit,
|
|
date_start: SequenceNotStr[Union[str, datetime]] | Omit = omit,
|
|
device_type: List[Literal["DESKTOP", "MOBILE", "OTHER"]] | Omit = omit,
|
|
format: Literal["JSON", "CSV"] | Omit = omit,
|
|
geo_id: SequenceNotStr[str] | Omit = omit,
|
|
http_version: List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]] | Omit = omit,
|
|
ip_version: List[Literal["IPv4", "IPv6"]] | Omit = omit,
|
|
limit: int | Omit = omit,
|
|
location: SequenceNotStr[str] | Omit = omit,
|
|
name: SequenceNotStr[str] | Omit = omit,
|
|
os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] | Omit = omit,
|
|
tls_version: List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]] | Omit = omit,
|
|
# 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,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> HTTPProtocolGetResponse:
|
|
"""
|
|
Retrieves the top locations, by HTTP requests, of the requested HTTP protocol.
|
|
|
|
Args:
|
|
http_protocol: HTTP protocol (HTTP vs. HTTPS).
|
|
|
|
asn: Filters results by Autonomous System. Specify one or more Autonomous System
|
|
Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
|
|
results. For example, `-174, 3356` excludes results from AS174, but includes
|
|
results from AS3356.
|
|
|
|
bot_class: Filters results by bot class. Refer to
|
|
[Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
|
|
|
|
browser_family: Filters results by browser family.
|
|
|
|
continent: Filters results by continent. Specify a comma-separated list of alpha-2 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: Filters results by date range. For example, use `7d` and `7dcontrol` 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.
|
|
|
|
device_type: Filters results by device type.
|
|
|
|
format: Format in which results will be returned.
|
|
|
|
geo_id: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs.
|
|
Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689`
|
|
excludes results from the 2267056 (Lisbon), but includes results from 5128638
|
|
(New York).
|
|
|
|
http_version: Filters results by HTTP version.
|
|
|
|
ip_version: Filters results by IP version (Ipv4 vs. IPv6).
|
|
|
|
limit: Limits the number of objects returned in the response.
|
|
|
|
location: Filters results by location. Specify a comma-separated list of 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 used to label the series in the response.
|
|
|
|
os: Filters results by operating system.
|
|
|
|
tls_version: Filters results by TLS version.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not http_protocol:
|
|
raise ValueError(f"Expected a non-empty value for `http_protocol` but received {http_protocol!r}")
|
|
return self._get(
|
|
f"/radar/http/top/locations/http_protocol/{http_protocol}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
query=maybe_transform(
|
|
{
|
|
"asn": asn,
|
|
"bot_class": bot_class,
|
|
"browser_family": browser_family,
|
|
"continent": continent,
|
|
"date_end": date_end,
|
|
"date_range": date_range,
|
|
"date_start": date_start,
|
|
"device_type": device_type,
|
|
"format": format,
|
|
"geo_id": geo_id,
|
|
"http_version": http_version,
|
|
"ip_version": ip_version,
|
|
"limit": limit,
|
|
"location": location,
|
|
"name": name,
|
|
"os": os,
|
|
"tls_version": tls_version,
|
|
},
|
|
http_protocol_get_params.HTTPProtocolGetParams,
|
|
),
|
|
post_parser=ResultWrapper[HTTPProtocolGetResponse]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[HTTPProtocolGetResponse], ResultWrapper[HTTPProtocolGetResponse]),
|
|
)
|
|
|
|
|
|
class AsyncHTTPProtocolResource(AsyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> AsyncHTTPProtocolResourceWithRawResponse:
|
|
"""
|
|
This property can be used as a prefix for any HTTP method call to return
|
|
the raw response object instead of the parsed content.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return AsyncHTTPProtocolResourceWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> AsyncHTTPProtocolResourceWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
|
|
"""
|
|
return AsyncHTTPProtocolResourceWithStreamingResponse(self)
|
|
|
|
async def get(
|
|
self,
|
|
http_protocol: Literal["HTTP", "HTTPS"],
|
|
*,
|
|
asn: SequenceNotStr[str] | Omit = omit,
|
|
bot_class: List[Literal["LIKELY_AUTOMATED", "LIKELY_HUMAN"]] | Omit = omit,
|
|
browser_family: List[Literal["CHROME", "EDGE", "FIREFOX", "SAFARI"]] | Omit = omit,
|
|
continent: SequenceNotStr[str] | Omit = omit,
|
|
date_end: SequenceNotStr[Union[str, datetime]] | Omit = omit,
|
|
date_range: SequenceNotStr[str] | Omit = omit,
|
|
date_start: SequenceNotStr[Union[str, datetime]] | Omit = omit,
|
|
device_type: List[Literal["DESKTOP", "MOBILE", "OTHER"]] | Omit = omit,
|
|
format: Literal["JSON", "CSV"] | Omit = omit,
|
|
geo_id: SequenceNotStr[str] | Omit = omit,
|
|
http_version: List[Literal["HTTPv1", "HTTPv2", "HTTPv3"]] | Omit = omit,
|
|
ip_version: List[Literal["IPv4", "IPv6"]] | Omit = omit,
|
|
limit: int | Omit = omit,
|
|
location: SequenceNotStr[str] | Omit = omit,
|
|
name: SequenceNotStr[str] | Omit = omit,
|
|
os: List[Literal["WINDOWS", "MACOSX", "IOS", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"]] | Omit = omit,
|
|
tls_version: List[Literal["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"]] | Omit = omit,
|
|
# 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,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
) -> HTTPProtocolGetResponse:
|
|
"""
|
|
Retrieves the top locations, by HTTP requests, of the requested HTTP protocol.
|
|
|
|
Args:
|
|
http_protocol: HTTP protocol (HTTP vs. HTTPS).
|
|
|
|
asn: Filters results by Autonomous System. Specify one or more Autonomous System
|
|
Numbers (ASNs) as a comma-separated list. Prefix with `-` to exclude ASNs from
|
|
results. For example, `-174, 3356` excludes results from AS174, but includes
|
|
results from AS3356.
|
|
|
|
bot_class: Filters results by bot class. Refer to
|
|
[Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
|
|
|
|
browser_family: Filters results by browser family.
|
|
|
|
continent: Filters results by continent. Specify a comma-separated list of alpha-2 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: Filters results by date range. For example, use `7d` and `7dcontrol` 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.
|
|
|
|
device_type: Filters results by device type.
|
|
|
|
format: Format in which results will be returned.
|
|
|
|
geo_id: Filters results by Geolocation. Specify a comma-separated list of GeoNames IDs.
|
|
Prefix with `-` to exclude geoIds from results. For example, `-2267056,360689`
|
|
excludes results from the 2267056 (Lisbon), but includes results from 5128638
|
|
(New York).
|
|
|
|
http_version: Filters results by HTTP version.
|
|
|
|
ip_version: Filters results by IP version (Ipv4 vs. IPv6).
|
|
|
|
limit: Limits the number of objects returned in the response.
|
|
|
|
location: Filters results by location. Specify a comma-separated list of 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 used to label the series in the response.
|
|
|
|
os: Filters results by operating system.
|
|
|
|
tls_version: Filters results by TLS version.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not http_protocol:
|
|
raise ValueError(f"Expected a non-empty value for `http_protocol` but received {http_protocol!r}")
|
|
return await self._get(
|
|
f"/radar/http/top/locations/http_protocol/{http_protocol}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
query=await async_maybe_transform(
|
|
{
|
|
"asn": asn,
|
|
"bot_class": bot_class,
|
|
"browser_family": browser_family,
|
|
"continent": continent,
|
|
"date_end": date_end,
|
|
"date_range": date_range,
|
|
"date_start": date_start,
|
|
"device_type": device_type,
|
|
"format": format,
|
|
"geo_id": geo_id,
|
|
"http_version": http_version,
|
|
"ip_version": ip_version,
|
|
"limit": limit,
|
|
"location": location,
|
|
"name": name,
|
|
"os": os,
|
|
"tls_version": tls_version,
|
|
},
|
|
http_protocol_get_params.HTTPProtocolGetParams,
|
|
),
|
|
post_parser=ResultWrapper[HTTPProtocolGetResponse]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[HTTPProtocolGetResponse], ResultWrapper[HTTPProtocolGetResponse]),
|
|
)
|
|
|
|
|
|
class HTTPProtocolResourceWithRawResponse:
|
|
def __init__(self, http_protocol: HTTPProtocolResource) -> None:
|
|
self._http_protocol = http_protocol
|
|
|
|
self.get = to_raw_response_wrapper(
|
|
http_protocol.get,
|
|
)
|
|
|
|
|
|
class AsyncHTTPProtocolResourceWithRawResponse:
|
|
def __init__(self, http_protocol: AsyncHTTPProtocolResource) -> None:
|
|
self._http_protocol = http_protocol
|
|
|
|
self.get = async_to_raw_response_wrapper(
|
|
http_protocol.get,
|
|
)
|
|
|
|
|
|
class HTTPProtocolResourceWithStreamingResponse:
|
|
def __init__(self, http_protocol: HTTPProtocolResource) -> None:
|
|
self._http_protocol = http_protocol
|
|
|
|
self.get = to_streamed_response_wrapper(
|
|
http_protocol.get,
|
|
)
|
|
|
|
|
|
class AsyncHTTPProtocolResourceWithStreamingResponse:
|
|
def __init__(self, http_protocol: AsyncHTTPProtocolResource) -> None:
|
|
self._http_protocol = http_protocol
|
|
|
|
self.get = async_to_streamed_response_wrapper(
|
|
http_protocol.get,
|
|
)
|