ipgeolocationio 1.0.0__py3-none-any.whl

ipgeolocation/__init__.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    IPGeolocation.io - IP intelligence products
+
+    Ipgeolocation provides a set of APIs to make ip based decisions.
+
+    Creat a free account by signing up here:
+    https://app.ipgeolocation.io/signup
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# import apis into sdk package
+from ipgeolocation.api.asn_lookup_api import ASNLookupApi
+from ipgeolocation.api.abuse_contact_api import AbuseContactApi
+from ipgeolocation.api.astronomy_api import AstronomyApi
+from ipgeolocation.api.ipgeolocation_api import IPGeolocationApi
+from ipgeolocation.api.ip_security_api import IPSecurityApi
+from ipgeolocation.api.time_conversion_api import TimeConversionApi
+from ipgeolocation.api.timezone_api import TimezoneApi
+from ipgeolocation.api.user_agent_api import UserAgentApi
+
+# import ApiClient
+from ipgeolocation.api_response import ApiResponse
+from ipgeolocation.api_client import ApiClient
+from ipgeolocation.configuration import Configuration
+from ipgeolocation.exceptions import OpenApiException
+from ipgeolocation.exceptions import ApiTypeError
+from ipgeolocation.exceptions import ApiValueError
+from ipgeolocation.exceptions import ApiKeyError
+from ipgeolocation.exceptions import ApiAttributeError
+from ipgeolocation.exceptions import ApiException
+
+# import models into sdk package
+from ipgeolocation.models.asn_connection import ASNConnection
+from ipgeolocation.models.asn_response import ASNResponse
+from ipgeolocation.models.asn_details import ASNDetails
+from ipgeolocation.models.asn_response_xml import ASNResponseXML
+from ipgeolocation.models.abuse import Abuse
+from ipgeolocation.models.abuse_response import AbuseResponse
+from ipgeolocation.models.abuse_response_xml import AbuseResponseXML
+from ipgeolocation.models.astronomy import Astronomy
+from ipgeolocation.models.astronomy_evening import AstronomyEvening
+from ipgeolocation.models.astronomy_location import AstronomyLocation
+from ipgeolocation.models.astronomy_morning import AstronomyMorning
+from ipgeolocation.models.astronomy_response import AstronomyResponse
+from ipgeolocation.models.astronomy_xml_response import AstronomyXMLResponse
+from ipgeolocation.models.country_metadata import CountryMetadata
+from ipgeolocation.models.currency import Currency
+from ipgeolocation.models.error_response import ErrorResponse
+from ipgeolocation.models.error_xml_response import ErrorXMLResponse
+from ipgeolocation.models.error_xml_response_array import ErrorXMLResponseArray
+from ipgeolocation.models.geolocation_response import GeolocationResponse
+from ipgeolocation.models.geolocation_xml_response import GeolocationXMLResponse
+from ipgeolocation.models.geolocation_xml_response_array import GeolocationXMLResponseArray
+from ipgeolocation.models.get_bulk_ip_geolocation_response import GetBulkIpGeolocationResponse
+from ipgeolocation.models.get_bulk_ip_geolocation_xml_response import GetBulkIpGeolocationXmlResponse
+from ipgeolocation.models.get_bulk_ip_geolocation_request import GetBulkIpGeolocationRequest
+from ipgeolocation.models.get_bulk_ip_security_info_response import GetBulkIpSecurityInfoResponse
+from ipgeolocation.models.get_bulk_ip_security_info_xml_response import GetBulkIpSecurityInfoXmlResponse
+from ipgeolocation.models.location import Location
+from ipgeolocation.models.location_minimal import LocationMinimal
+from ipgeolocation.models.network import Network
+from ipgeolocation.models.network_asn import NetworkAsn
+from ipgeolocation.models.network_company import NetworkCompany
+from ipgeolocation.models.network_minimal import NetworkMinimal
+from ipgeolocation.models.network_minimal_asn import NetworkMinimalAsn
+from ipgeolocation.models.network_minimal_company import NetworkMinimalCompany
+from ipgeolocation.models.parse_bulk_user_agent_strings_request import ParseBulkUserAgentStringsRequest
+from ipgeolocation.models.parse_user_agent_string_request import ParseUserAgentStringRequest
+from ipgeolocation.models.security import Security
+from ipgeolocation.models.ip_security_api_response import IPSecurityAPIResponse
+from ipgeolocation.models.ip_security_api_xml_response import IPSecurityAPIXMLResponse
+from ipgeolocation.models.ip_security_api_xml_response_array import IPSecurityAPIXMLResponseArray
+from ipgeolocation.models.time_conversion_response import TimeConversionResponse
+from ipgeolocation.models.time_conversion_xml_response import TimeConversionXMLResponse
+from ipgeolocation.models.time_series import TimeSeries
+from ipgeolocation.models.time_series_response import TimeSeriesResponse
+from ipgeolocation.models.time_series_xml_response import TimeSeriesXmlResponse
+from ipgeolocation.models.time_zone import TimeZone
+from ipgeolocation.models.time_zone_detailed_response import TimeZoneDetailedResponse
+from ipgeolocation.models.time_zone_detailed_xml_response import TimeZoneDetailedXMLResponse
+from ipgeolocation.models.time_zone_dst_end import TimeZoneDstEnd
+from ipgeolocation.models.time_zone_dst_start import TimeZoneDstStart
+from ipgeolocation.models.timezone_airport import TimezoneAirport
+from ipgeolocation.models.timezone_detail import TimezoneDetail
+from ipgeolocation.models.timezone_detail_dst_end import TimezoneDetailDstEnd
+from ipgeolocation.models.timezone_detail_dst_start import TimezoneDetailDstStart
+from ipgeolocation.models.timezone_location import TimezoneLocation
+from ipgeolocation.models.timezone_locode import TimezoneLocode
+from ipgeolocation.models.user_agent_data import UserAgentData
+from ipgeolocation.models.user_agent_data_device import UserAgentDataDevice
+from ipgeolocation.models.user_agent_data_engine import UserAgentDataEngine
+from ipgeolocation.models.user_agent_data_operating_system import UserAgentDataOperatingSystem
+from ipgeolocation.models.user_agent_xml_data import UserAgentXMLData
+from ipgeolocation.models.user_agent_xml_data_array import UserAgentXMLDataArray

ipgeolocation/api/__init__.py

@@ -0,0 +1,12 @@
+# flake8: noqa
+
+# import apis into api package
+from ipgeolocation.api.asn_lookup_api import ASNLookupApi
+from ipgeolocation.api.abuse_contact_api import AbuseContactApi
+from ipgeolocation.api.astronomy_api import AstronomyApi
+from ipgeolocation.api.ipgeolocation_api import IPGeolocationApi
+from ipgeolocation.api.ip_security_api import IPSecurityApi
+from ipgeolocation.api.time_conversion_api import TimeConversionApi
+from ipgeolocation.api.timezone_api import TimezoneApi
+from ipgeolocation.api.user_agent_api import UserAgentApi
+

ipgeolocation/api/abuse_contact_api.py

@@ -0,0 +1,358 @@
+# coding: utf-8
+
+"""
+    IPGeolocation.io - IP intelligence products
+
+    Ipgeolocation provides a set of APIs to make ip based decisions.
+
+    Creat a free account by signing up here:
+    https://app.ipgeolocation.io/signup
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from ipgeolocation.models.abuse_response import AbuseResponse
+
+from ipgeolocation.api_client import ApiClient, RequestSerialized
+from ipgeolocation.api_response import ApiResponse
+from ipgeolocation.rest import RESTResponseType
+
+
+class AbuseContactApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_abuse_contact_info(
+        self,
+        ip: Annotated[Optional[StrictStr], Field(description="query parameter 'ip'.")] = None,
+        excludes: Annotated[Optional[StrictStr], Field(description="You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.")] = None,
+        fields: Annotated[Optional[StrictStr], Field(description="You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> AbuseResponse:
+        """get_abuse_contact_info
+
+        The Abuse Contact API provides essential contact information to report abusive activity associated with IP addresses. By querying an IP address (IPv4 or IPv6), users receive detailed abuse contact data, including the responsible organization, abuse handling role, contact emails, phone numbers, and registered address. This enables users to swiftly take action to report and mitigate threats such as spam, DDoS attacks, and phishing.     In addition to abuse-specific contacts, the API also includes registration metadata like the registered country and abuse handle. This empowers cybersecurity teams, hosting providers, and compliance entities to take appropriate legal or administrative action. 
+
+        :param ip: query parameter 'ip'.
+        :type ip: str
+        :param excludes: You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.
+        :type excludes: str
+        :param fields: You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.
+        :type fields: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_abuse_contact_info_serialize(
+            ip=ip,
+            excludes=excludes,
+            fields=fields,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AbuseResponse",
+            '400': "ErrorResponse",
+            '401': "ErrorResponse",
+            '404': "ErrorResponse",
+            '405': "ErrorResponse",
+            '429': "ErrorResponse",
+            '499': "ErrorResponse",
+            '500': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_abuse_contact_info_with_http_info(
+        self,
+        ip: Annotated[Optional[StrictStr], Field(description="query parameter 'ip'.")] = None,
+        excludes: Annotated[Optional[StrictStr], Field(description="You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.")] = None,
+        fields: Annotated[Optional[StrictStr], Field(description="You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[AbuseResponse]:
+        """get_abuse_contact_info
+
+        The Abuse Contact API provides essential contact information to report abusive activity associated with IP addresses. By querying an IP address (IPv4 or IPv6), users receive detailed abuse contact data, including the responsible organization, abuse handling role, contact emails, phone numbers, and registered address. This enables users to swiftly take action to report and mitigate threats such as spam, DDoS attacks, and phishing.     In addition to abuse-specific contacts, the API also includes registration metadata like the registered country and abuse handle. This empowers cybersecurity teams, hosting providers, and compliance entities to take appropriate legal or administrative action. 
+
+        :param ip: query parameter 'ip'.
+        :type ip: str
+        :param excludes: You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.
+        :type excludes: str
+        :param fields: You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.
+        :type fields: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_abuse_contact_info_serialize(
+            ip=ip,
+            excludes=excludes,
+            fields=fields,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AbuseResponse",
+            '400': "ErrorResponse",
+            '401': "ErrorResponse",
+            '404': "ErrorResponse",
+            '405': "ErrorResponse",
+            '429': "ErrorResponse",
+            '499': "ErrorResponse",
+            '500': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_abuse_contact_info_without_preload_content(
+        self,
+        ip: Annotated[Optional[StrictStr], Field(description="query parameter 'ip'.")] = None,
+        excludes: Annotated[Optional[StrictStr], Field(description="You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.")] = None,
+        fields: Annotated[Optional[StrictStr], Field(description="You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """get_abuse_contact_info
+
+        The Abuse Contact API provides essential contact information to report abusive activity associated with IP addresses. By querying an IP address (IPv4 or IPv6), users receive detailed abuse contact data, including the responsible organization, abuse handling role, contact emails, phone numbers, and registered address. This enables users to swiftly take action to report and mitigate threats such as spam, DDoS attacks, and phishing.     In addition to abuse-specific contacts, the API also includes registration metadata like the registered country and abuse handle. This empowers cybersecurity teams, hosting providers, and compliance entities to take appropriate legal or administrative action. 
+
+        :param ip: query parameter 'ip'.
+        :type ip: str
+        :param excludes: You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.
+        :type excludes: str
+        :param fields: You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.
+        :type fields: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_abuse_contact_info_serialize(
+            ip=ip,
+            excludes=excludes,
+            fields=fields,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AbuseResponse",
+            '400': "ErrorResponse",
+            '401': "ErrorResponse",
+            '404': "ErrorResponse",
+            '405': "ErrorResponse",
+            '429': "ErrorResponse",
+            '499': "ErrorResponse",
+            '500': "ErrorResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_abuse_contact_info_serialize(
+        self,
+        ip,
+        excludes,
+        fields,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if ip is not None:
+            
+            _query_params.append(('ip', ip))
+            
+        if excludes is not None:
+            
+            _query_params.append(('excludes', excludes))
+            
+        if fields is not None:
+            
+            _query_params.append(('fields', fields))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json', 
+                    'application/xml'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'ApiKeyAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/abuse',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+