opportify-sdk 0.1.1__py3-none-any.whl → 0.3.1__py3-none-any.whl

openapi_client/__init__.py

@@ -0,0 +1,186 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Opportify Insights API
+
+    ## Overview  The **Opportify Insights API** provides access to a powerful and up-to-date platform. With advanced data warehousing and AI-driven capabilities, this API is designed to empower your business to make informed, data-driven decisions and effectively assess potential risks.  ### Base URL Use the following base URL for all API requests:  ```plaintext https://api.opportify.ai/insights/v1/<service>/<endpoint> ```  ### Features - [**Email Insights:**](/docs/api/api-reference/email-insights)   - Validate email syntax.   - Identify email types (free, disposable, private or unknown).   - Real time verifications:     - Reachable: Confirms if the email domain has valid MX DNS records using DNS lookup.     - Deliverable: Simulates an SMTP handshake to check if the email address exists and is deliverable.     - Catch-All: Detects if the domain accepts all emails (catch-all configuration).   - Intelligent Error Correction: Automatically corrects well-known misspelled email addresses.   - Risk Report: Provides an AI-driven normalized score (200-1000) to evaluate email risk, using predefined thresholds.      [Access Documentation >>](/docs/api/api-reference/email-insights)  - [**IP Insights:**](/docs/api/api-reference/ip-insights)   - Connection types: Detects connection types such as `wired`, `mobile`, `enterprise`, `satellite`, `VPN`, `cloud-provider`, `open-proxy`, or `Tor`.   - Geo location: Delivers detailed insights such as country, city, timezone, language preferences, and additional location-based information to enhance regional understanding.   - WHOIS: Provides main details including RIR, ASN, organization, and abuse/admin/technical contacts.   - Trusted Provider Recognition: Identifies if the IP is part of a known trusted provider (e.g., ZTNA - Zero Trust Network Access).   - Blocklist Reports: Retrieves up-to-date blocklist statuses, active reports, and the latest detections.   - Risk Report: Delivers an AI-driven normalized score (200-1000) to evaluate IP risk, supported by predefined thresholds.    [Access Documentation >>](/docs/api/api-reference/ip-insights)  ### Authentication & Security - **API Key:** Access to the API requires an API key, which must be included in the request headers. Businesses can generate unlimited API keys directly from their account, offering flexibility and ease of use.  - **ACL Rules:** Enhance security with Access Control Lists (ACL), allowing you to restrict API access from specific IP addresses or ranges. This feature provides an additional layer of protection by ensuring only authorized IPs can interact with the API. - **No Query Parameters:** As a precautionary measure, our API avoids the use of query parameters for all operations, including authentication and handling Personally Identifiable Information (PII). This approach minimizes security risks by preventing sensitive data from being exposed in access logs, browser history, cached URLs, debugging tools, or inadvertently shared URLs. All sensitive information is securely transmitted through headers or the request body. 
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "EmailInsightsApi",
+    "IPInsightsApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AbuseContact",
+    "AddressSignals",
+    "AdminContact",
+    "AnalyzeEmail200Response",
+    "AnalyzeEmail400Response",
+    "AnalyzeEmail403Response",
+    "AnalyzeEmail500Response",
+    "AnalyzeEmailRequest",
+    "AnalyzeIp200Response",
+    "AnalyzeIp400Response",
+    "AnalyzeIpRequest",
+    "Asn",
+    "BatchAnalyzeEmails202Response",
+    "BatchAnalyzeEmails400Response",
+    "BatchAnalyzeEmails401Response",
+    "BatchAnalyzeEmails402Response",
+    "BatchAnalyzeEmails403Response",
+    "BatchAnalyzeEmails413Response",
+    "BatchAnalyzeEmails429Response",
+    "BatchAnalyzeEmailsRequest",
+    "BatchAnalyzeIps202Response",
+    "BatchAnalyzeIps400Response",
+    "BatchAnalyzeIpsRequest",
+    "BlockListed",
+    "CreateEmailBatchExport400Response",
+    "CreateEmailBatchExport403Response",
+    "CreateEmailBatchExport404Response",
+    "CreateEmailBatchExport409Response",
+    "EXPORTNOTFOUND",
+    "EmailDNS",
+    "EmailDomain",
+    "ExportCreatedResponse",
+    "ExportFilter",
+    "ExportRequest",
+    "ExportStatusResponse",
+    "FORBIDDEN",
+    "Geo",
+    "GetEmailBatchExportStatus400Response",
+    "GetEmailBatchExportStatus404Response",
+    "GetEmailBatchStatus200Response",
+    "GetEmailBatchStatus200ResponseDownloadUrls",
+    "GetEmailBatchStatus404Response",
+    "GetIpBatchStatus200Response",
+    "INTERNALERROR",
+    "INTERNALERROR1",
+    "INVALIDDATA",
+    "INVALIDDATA1",
+    "INVALIDEMAIL",
+    "INVALIDPLAN",
+    "INVALIDPLAN1",
+    "INVALIDTOKEN",
+    "IPVALIDATIONFAILED",
+    "JOBNOTFOUND",
+    "JOBNOTREADY",
+    "MALFORMEDREQUEST",
+    "MALFORMEDREQUEST1",
+    "MALFORMEDREQUEST2",
+    "MALFORMEDREQUEST3",
+    "MANIFESTNOTAVAILABLE",
+    "NOTFOUND",
+    "Organization",
+    "QUOTAEXCEEDED",
+    "RiskReportEmail",
+    "RiskReportIp",
+    "TOOMANYREQUESTS",
+    "TechContact",
+    "TrustedProvider",
+    "Whois",
+]
+
+# import apis into sdk package
+from openapi_client.api.email_insights_api import EmailInsightsApi as EmailInsightsApi
+from openapi_client.api.ip_insights_api import IPInsightsApi as IPInsightsApi
+
+# import ApiClient
+from openapi_client.api_response import ApiResponse as ApiResponse
+from openapi_client.api_client import ApiClient as ApiClient
+from openapi_client.configuration import Configuration as Configuration
+from openapi_client.exceptions import OpenApiException as OpenApiException
+from openapi_client.exceptions import ApiTypeError as ApiTypeError
+from openapi_client.exceptions import ApiValueError as ApiValueError
+from openapi_client.exceptions import ApiKeyError as ApiKeyError
+from openapi_client.exceptions import ApiAttributeError as ApiAttributeError
+from openapi_client.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from openapi_client.models.abuse_contact import AbuseContact as AbuseContact
+from openapi_client.models.address_signals import AddressSignals as AddressSignals
+from openapi_client.models.admin_contact import AdminContact as AdminContact
+from openapi_client.models.analyze_email200_response import AnalyzeEmail200Response as AnalyzeEmail200Response
+from openapi_client.models.analyze_email400_response import AnalyzeEmail400Response as AnalyzeEmail400Response
+from openapi_client.models.analyze_email403_response import AnalyzeEmail403Response as AnalyzeEmail403Response
+from openapi_client.models.analyze_email500_response import AnalyzeEmail500Response as AnalyzeEmail500Response
+from openapi_client.models.analyze_email_request import AnalyzeEmailRequest as AnalyzeEmailRequest
+from openapi_client.models.analyze_ip200_response import AnalyzeIp200Response as AnalyzeIp200Response
+from openapi_client.models.analyze_ip400_response import AnalyzeIp400Response as AnalyzeIp400Response
+from openapi_client.models.analyze_ip_request import AnalyzeIpRequest as AnalyzeIpRequest
+from openapi_client.models.asn import Asn as Asn
+from openapi_client.models.batch_analyze_emails202_response import BatchAnalyzeEmails202Response as BatchAnalyzeEmails202Response
+from openapi_client.models.batch_analyze_emails400_response import BatchAnalyzeEmails400Response as BatchAnalyzeEmails400Response
+from openapi_client.models.batch_analyze_emails401_response import BatchAnalyzeEmails401Response as BatchAnalyzeEmails401Response
+from openapi_client.models.batch_analyze_emails402_response import BatchAnalyzeEmails402Response as BatchAnalyzeEmails402Response
+from openapi_client.models.batch_analyze_emails403_response import BatchAnalyzeEmails403Response as BatchAnalyzeEmails403Response
+from openapi_client.models.batch_analyze_emails413_response import BatchAnalyzeEmails413Response as BatchAnalyzeEmails413Response
+from openapi_client.models.batch_analyze_emails429_response import BatchAnalyzeEmails429Response as BatchAnalyzeEmails429Response
+from openapi_client.models.batch_analyze_emails_request import BatchAnalyzeEmailsRequest as BatchAnalyzeEmailsRequest
+from openapi_client.models.batch_analyze_ips202_response import BatchAnalyzeIps202Response as BatchAnalyzeIps202Response
+from openapi_client.models.batch_analyze_ips400_response import BatchAnalyzeIps400Response as BatchAnalyzeIps400Response
+from openapi_client.models.batch_analyze_ips_request import BatchAnalyzeIpsRequest as BatchAnalyzeIpsRequest
+from openapi_client.models.block_listed import BlockListed as BlockListed
+from openapi_client.models.create_email_batch_export400_response import CreateEmailBatchExport400Response as CreateEmailBatchExport400Response
+from openapi_client.models.create_email_batch_export403_response import CreateEmailBatchExport403Response as CreateEmailBatchExport403Response
+from openapi_client.models.create_email_batch_export404_response import CreateEmailBatchExport404Response as CreateEmailBatchExport404Response
+from openapi_client.models.create_email_batch_export409_response import CreateEmailBatchExport409Response as CreateEmailBatchExport409Response
+from openapi_client.models.exportnotfound import EXPORTNOTFOUND as EXPORTNOTFOUND
+from openapi_client.models.email_dns import EmailDNS as EmailDNS
+from openapi_client.models.email_domain import EmailDomain as EmailDomain
+from openapi_client.models.export_created_response import ExportCreatedResponse as ExportCreatedResponse
+from openapi_client.models.export_filter import ExportFilter as ExportFilter
+from openapi_client.models.export_request import ExportRequest as ExportRequest
+from openapi_client.models.export_status_response import ExportStatusResponse as ExportStatusResponse
+from openapi_client.models.forbidden import FORBIDDEN as FORBIDDEN
+from openapi_client.models.geo import Geo as Geo
+from openapi_client.models.get_email_batch_export_status400_response import GetEmailBatchExportStatus400Response as GetEmailBatchExportStatus400Response
+from openapi_client.models.get_email_batch_export_status404_response import GetEmailBatchExportStatus404Response as GetEmailBatchExportStatus404Response
+from openapi_client.models.get_email_batch_status200_response import GetEmailBatchStatus200Response as GetEmailBatchStatus200Response
+from openapi_client.models.get_email_batch_status200_response_download_urls import GetEmailBatchStatus200ResponseDownloadUrls as GetEmailBatchStatus200ResponseDownloadUrls
+from openapi_client.models.get_email_batch_status404_response import GetEmailBatchStatus404Response as GetEmailBatchStatus404Response
+from openapi_client.models.get_ip_batch_status200_response import GetIpBatchStatus200Response as GetIpBatchStatus200Response
+from openapi_client.models.internalerror import INTERNALERROR as INTERNALERROR
+from openapi_client.models.internalerror1 import INTERNALERROR1 as INTERNALERROR1
+from openapi_client.models.invaliddata import INVALIDDATA as INVALIDDATA
+from openapi_client.models.invaliddata1 import INVALIDDATA1 as INVALIDDATA1
+from openapi_client.models.invalidemail import INVALIDEMAIL as INVALIDEMAIL
+from openapi_client.models.invalidplan import INVALIDPLAN as INVALIDPLAN
+from openapi_client.models.invalidplan1 import INVALIDPLAN1 as INVALIDPLAN1
+from openapi_client.models.invalidtoken import INVALIDTOKEN as INVALIDTOKEN
+from openapi_client.models.ipvalidationfailed import IPVALIDATIONFAILED as IPVALIDATIONFAILED
+from openapi_client.models.jobnotfound import JOBNOTFOUND as JOBNOTFOUND
+from openapi_client.models.jobnotready import JOBNOTREADY as JOBNOTREADY
+from openapi_client.models.malformedrequest import MALFORMEDREQUEST as MALFORMEDREQUEST
+from openapi_client.models.malformedrequest1 import MALFORMEDREQUEST1 as MALFORMEDREQUEST1
+from openapi_client.models.malformedrequest2 import MALFORMEDREQUEST2 as MALFORMEDREQUEST2
+from openapi_client.models.malformedrequest3 import MALFORMEDREQUEST3 as MALFORMEDREQUEST3
+from openapi_client.models.manifestnotavailable import MANIFESTNOTAVAILABLE as MANIFESTNOTAVAILABLE
+from openapi_client.models.notfound import NOTFOUND as NOTFOUND
+from openapi_client.models.organization import Organization as Organization
+from openapi_client.models.quotaexceeded import QUOTAEXCEEDED as QUOTAEXCEEDED
+from openapi_client.models.risk_report_email import RiskReportEmail as RiskReportEmail
+from openapi_client.models.risk_report_ip import RiskReportIp as RiskReportIp
+from openapi_client.models.toomanyrequests import TOOMANYREQUESTS as TOOMANYREQUESTS
+from openapi_client.models.tech_contact import TechContact as TechContact
+from openapi_client.models.trusted_provider import TrustedProvider as TrustedProvider
+from openapi_client.models.whois import Whois as Whois
+