opportify-sdk 0.1.1__tar.gz → 0.2.0__tar.gz

opportify_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: opportify_sdk
+Version: 0.2.0
+Summary: Opportify Insights API
+Home-page: https://github.com/opportify/opportify-sdk-python
+Author: Opportify & OpenAPI-Generator
+Author-email: 
+Keywords: OpenAPI,OpenAPI-Generator,Opportify Insights API,Opportify
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+# Opportify-SDK-Python
+
+## 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.
+
+[Sign Up Free](https://www.opportify.ai)
+
+### Base URL
+Use the following base URL for all API requests:
+
+```plaintext
+https://api.opportify.ai/insights/v1/<service>/<endpoint>
+```
+
+## Requirements
+
+Requires Python v3.8 or later
+
+## Getting Started
+
+First, install Opportify SDK via PyPI manager:
+
+```
+pip install opportify-sdk
+```
+
+## Single Analysis
+
+### Calling Email Insights
+
+```python
+from opportify_sdk import EmailInsights
+
+# Initialize the wrapper with your API key
+api_key = "<YOUR-API-KEY-HERE>"
+email_insights = EmailInsights(api_key)
+
+# Optional: Configure host, version, and debug mode
+email_insights.set_version("v1")
+
+# Define request parameters
+params = {
+    "email": "<SOME-EMAIL-HERE>",
+    "enableAutoCorrection": True,
+    "enableAi": True 
+}
+
+# Call the API
+try:
+    result = email_insights.analyze(params)
+    print("Response:", result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+### Calling IP Insights
+
+```python
+
+from opportify_sdk import IpInsights
+
+# Initialize the wrapper with your API key
+api_key = "<YOUR-API-KEY-HERE>"
+ip_insights = IpInsights(api_key)
+
+# Optional: Configure host, version, and debug mode
+ip_insights.set_version("v1")
+
+# Define request parameters
+params = {
+    "ip": "<SOME-IP-HERE>",
+    "enableAi": True 
+}
+
+# Call the API
+try:
+    result = ip_insights.analyze(params)
+    print("Response:", result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## Batch Analysis
+
+For processing large volumes of emails or IP addresses, use the batch analysis methods:
+
+### Batch Email Analysis
+
+```python
+from opportify_sdk import EmailInsights
+
+# Initialize the wrapper with your API key
+api_key = "<YOUR-API-KEY-HERE>"
+email_insights = EmailInsights(api_key)
+
+# Define batch request parameters
+batch_params = {
+    "emails": [
+        "user1@company.com",
+        "user2@domain.org",
+        "test@example.com"
+    ],
+    "enableAutoCorrection": True,
+    "enableAi": True 
+}
+
+# Start batch analysis
+try:
+    batch_response = email_insights.batch_analyze(batch_params)
+    job_id = batch_response['job_id']
+    print(f"Batch job started: {job_id}")
+    
+    # Check batch status
+    status = email_insights.get_batch_status(job_id)
+    print(f"Status: {status['status']}, Progress: {status['progress']}%")
+    
+    # When completed, download URLs will be available
+    if status['status'] == 'COMPLETED':
+        download_urls = status['download_urls']
+        print(f"Results ready: {download_urls['csv']}")
+        
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+### Batch IP Analysis
+
+```python
+from opportify_sdk import IpInsights
+
+# Initialize the wrapper with your API key
+api_key = "<YOUR-API-KEY-HERE>"
+ip_insights = IpInsights(api_key)
+
+# Define batch request parameters
+batch_params = {
+    "ips": [
+        "8.8.8.8",
+        "1.1.1.1",
+        "192.168.1.1"
+    ],
+    "enableAi": True 
+}
+
+# Start batch analysis
+try:
+    batch_response = ip_insights.batch_analyze(batch_params)
+    job_id = batch_response['job_id']
+    print(f"Batch job started: {job_id}")
+    
+    # Check batch status
+    status = ip_insights.get_batch_status(job_id)
+    print(f"Status: {status['status']}, Progress: {status['progress']}%")
+    
+    # When completed, download URLs will be available
+    if status['status'] == 'COMPLETED':
+        download_urls = status['download_urls']
+        print(f"Results ready: {download_urls['csv']}")
+        
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## Configuration
+
+### Enable Debug Mode
+
+```python
+ip_insights.set_version("v1").set_debug_mode(True)
+email_insights.set_version("v1").set_debug_mode(True)
+```
+
+### Batch Status Polling
+
+For long-running batch jobs, poll the status periodically:
+
+```python
+import time
+
+def wait_for_batch_completion(client, job_id, max_wait=300):
+    """Wait for batch job to complete with polling."""
+    start_time = time.time()
+    
+    while time.time() - start_time < max_wait:
+        status = client.get_batch_status(job_id)
+        
+        if status['status'] == 'COMPLETED':
+            return status
+        elif status['status'] == 'ERROR':
+            raise Exception(f"Batch job failed: {status.get('status_description')}")
+        
+        print(f"Progress: {status.get('progress', 0)}%")
+        time.sleep(10)  # Wait 10 seconds before next check
+    
+    raise TimeoutError("Batch job did not complete within the timeout period")
+
+# Usage
+try:
+    batch_response = email_insights.batch_analyze(batch_params)
+    final_status = wait_for_batch_completion(email_insights, batch_response['job_id'])
+    print("Batch completed successfully!")
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## About this package
+
+This Python package supports both single and batch analysis operations and is a customization of the base generated by:
+
+- [OpenAPI Generator](https://openapi-generator.tech) project.
+
+## Additional Resources
+
+- **[Batch Processing Guide](BATCH_PROCESSING_GUIDE.md)** - Comprehensive guide for batch operations
+- **[API Documentation](https://api.opportify.ai/docs)** - Full API reference
+- **[Support](https://www.opportify.ai/support)** - Get help and support
+

opportify_sdk-0.2.0/README.md

@@ -0,0 +1,218 @@
+# Opportify-SDK-Python
+
+## 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.
+
+[Sign Up Free](https://www.opportify.ai)
+
+### Base URL
+Use the following base URL for all API requests:
+
+```plaintext
+https://api.opportify.ai/insights/v1/<service>/<endpoint>
+```
+
+## Requirements
+
+Requires Python v3.8 or later
+
+## Getting Started
+
+First, install Opportify SDK via PyPI manager:
+
+```
+pip install opportify-sdk
+```
+
+## Single Analysis
+
+### Calling Email Insights
+
+```python
+from opportify_sdk import EmailInsights
+
+# Initialize the wrapper with your API key
+api_key = "<YOUR-API-KEY-HERE>"
+email_insights = EmailInsights(api_key)
+
+# Optional: Configure host, version, and debug mode
+email_insights.set_version("v1")
+
+# Define request parameters
+params = {
+    "email": "<SOME-EMAIL-HERE>",
+    "enableAutoCorrection": True,
+    "enableAi": True 
+}
+
+# Call the API
+try:
+    result = email_insights.analyze(params)
+    print("Response:", result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+### Calling IP Insights
+
+```python
+
+from opportify_sdk import IpInsights
+
+# Initialize the wrapper with your API key
+api_key = "<YOUR-API-KEY-HERE>"
+ip_insights = IpInsights(api_key)
+
+# Optional: Configure host, version, and debug mode
+ip_insights.set_version("v1")
+
+# Define request parameters
+params = {
+    "ip": "<SOME-IP-HERE>",
+    "enableAi": True 
+}
+
+# Call the API
+try:
+    result = ip_insights.analyze(params)
+    print("Response:", result)
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## Batch Analysis
+
+For processing large volumes of emails or IP addresses, use the batch analysis methods:
+
+### Batch Email Analysis
+
+```python
+from opportify_sdk import EmailInsights
+
+# Initialize the wrapper with your API key
+api_key = "<YOUR-API-KEY-HERE>"
+email_insights = EmailInsights(api_key)
+
+# Define batch request parameters
+batch_params = {
+    "emails": [
+        "user1@company.com",
+        "user2@domain.org",
+        "test@example.com"
+    ],
+    "enableAutoCorrection": True,
+    "enableAi": True 
+}
+
+# Start batch analysis
+try:
+    batch_response = email_insights.batch_analyze(batch_params)
+    job_id = batch_response['job_id']
+    print(f"Batch job started: {job_id}")
+    
+    # Check batch status
+    status = email_insights.get_batch_status(job_id)
+    print(f"Status: {status['status']}, Progress: {status['progress']}%")
+    
+    # When completed, download URLs will be available
+    if status['status'] == 'COMPLETED':
+        download_urls = status['download_urls']
+        print(f"Results ready: {download_urls['csv']}")
+        
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+### Batch IP Analysis
+
+```python
+from opportify_sdk import IpInsights
+
+# Initialize the wrapper with your API key
+api_key = "<YOUR-API-KEY-HERE>"
+ip_insights = IpInsights(api_key)
+
+# Define batch request parameters
+batch_params = {
+    "ips": [
+        "8.8.8.8",
+        "1.1.1.1",
+        "192.168.1.1"
+    ],
+    "enableAi": True 
+}
+
+# Start batch analysis
+try:
+    batch_response = ip_insights.batch_analyze(batch_params)
+    job_id = batch_response['job_id']
+    print(f"Batch job started: {job_id}")
+    
+    # Check batch status
+    status = ip_insights.get_batch_status(job_id)
+    print(f"Status: {status['status']}, Progress: {status['progress']}%")
+    
+    # When completed, download URLs will be available
+    if status['status'] == 'COMPLETED':
+        download_urls = status['download_urls']
+        print(f"Results ready: {download_urls['csv']}")
+        
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## Configuration
+
+### Enable Debug Mode
+
+```python
+ip_insights.set_version("v1").set_debug_mode(True)
+email_insights.set_version("v1").set_debug_mode(True)
+```
+
+### Batch Status Polling
+
+For long-running batch jobs, poll the status periodically:
+
+```python
+import time
+
+def wait_for_batch_completion(client, job_id, max_wait=300):
+    """Wait for batch job to complete with polling."""
+    start_time = time.time()
+    
+    while time.time() - start_time < max_wait:
+        status = client.get_batch_status(job_id)
+        
+        if status['status'] == 'COMPLETED':
+            return status
+        elif status['status'] == 'ERROR':
+            raise Exception(f"Batch job failed: {status.get('status_description')}")
+        
+        print(f"Progress: {status.get('progress', 0)}%")
+        time.sleep(10)  # Wait 10 seconds before next check
+    
+    raise TimeoutError("Batch job did not complete within the timeout period")
+
+# Usage
+try:
+    batch_response = email_insights.batch_analyze(batch_params)
+    final_status = wait_for_batch_completion(email_insights, batch_response['job_id'])
+    print("Batch completed successfully!")
+except Exception as e:
+    print(f"Error: {e}")
+```
+
+## About this package
+
+This Python package supports both single and batch analysis operations and is a customization of the base generated by:
+
+- [OpenAPI Generator](https://openapi-generator.tech) project.
+
+## Additional Resources
+
+- **[Batch Processing Guide](BATCH_PROCESSING_GUIDE.md)** - Comprehensive guide for batch operations
+- **[API Documentation](https://api.opportify.ai/docs)** - Full API reference
+- **[Support](https://www.opportify.ai/support)** - Get help and support
+

{opportify_sdk-0.1.1 → opportify_sdk-0.2.0}/pyproject.toml

@@ -1,13 +1,15 @@
 [tool.poetry]
 name = "opportify_sdk"
-version = "0.1.1"
+version = "0.2.0"
 description = "Opportify Insights API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "NoLicense"
 readme = "README.md"
 repository = "https://github.com/opportify/opportify-sdk-python"
-keywords = ["OpenAPI", "OpenAPI-Generator", "Opportify Insights API","Opportify"]
-include = ["/lib/v1/openapi_client/py.typed"]
+keywords = ["OpenAPI", "OpenAPI-Generator", "Opportify Insights API", "Opportify"]
+packages = [
+    { include = "opportify_sdk", from = "src" } 
+]
 
 [tool.poetry.dependencies]
 python = "^3.8"
@@ -25,7 +27,6 @@ flake8 = ">= 4.0.0"
 types-python-dateutil = ">= 2.8.19.14"
 mypy = ">= 1.5"
 
-
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"

{opportify_sdk-0.1.1 → opportify_sdk-0.2.0}/setup.py

@@ -13,7 +13,7 @@ with open('README.md') as readme_file:
     readme = readme_file.read()
 
 NAME = "opportify_sdk"
-VERSION = "0.1.1"
+VERSION = "0.2.0"
 PYTHON_REQUIRES = ">= 3.8"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 3.0.0",
@@ -29,11 +29,12 @@ setup(
     author="Opportify & OpenAPI-Generator",
     author_email="",
     url="https://github.com/opportify/opportify-sdk-python",
-    keywords=["OpenAPI", "OpenAPI-Generator", "Opportify Insights API","Opportify"],
+    keywords=["OpenAPI", "OpenAPI-Generator", "Opportify Insights API", "Opportify"],
     install_requires=REQUIRES,
-    packages=find_packages(exclude=["test", "tests"]),
+    packages=find_packages(where="src"),  
+    package_dir={"": "src"},  
     include_package_data=True,
     long_description_content_type='text/markdown',
     long_description=readme,
-    package_data={"openapi_client": ["py.typed"]},
+    package_data={"opportify_sdk": ["py.typed"]},  
 )

opportify_sdk-0.2.0/src/openapi_client/__init__.py

@@ -0,0 +1,86 @@
+# 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"
+
+# import apis into sdk package
+from openapi_client.api.email_insights_api import EmailInsightsApi
+from openapi_client.api.ip_insights_api import IPInsightsApi
+
+# import ApiClient
+from openapi_client.api_response import ApiResponse
+from openapi_client.api_client import ApiClient
+from openapi_client.configuration import Configuration
+from openapi_client.exceptions import OpenApiException
+from openapi_client.exceptions import ApiTypeError
+from openapi_client.exceptions import ApiValueError
+from openapi_client.exceptions import ApiKeyError
+from openapi_client.exceptions import ApiAttributeError
+from openapi_client.exceptions import ApiException
+
+# import models into sdk package
+from openapi_client.models.abuse_contact import AbuseContact
+from openapi_client.models.admin_contact import AdminContact
+from openapi_client.models.analyze_email200_response import AnalyzeEmail200Response
+from openapi_client.models.analyze_email400_response import AnalyzeEmail400Response
+from openapi_client.models.analyze_email400_response_error import AnalyzeEmail400ResponseError
+from openapi_client.models.analyze_email403_response import AnalyzeEmail403Response
+from openapi_client.models.analyze_email403_response_error import AnalyzeEmail403ResponseError
+from openapi_client.models.analyze_email500_response import AnalyzeEmail500Response
+from openapi_client.models.analyze_email500_response_error import AnalyzeEmail500ResponseError
+from openapi_client.models.analyze_email_request import AnalyzeEmailRequest
+from openapi_client.models.analyze_ip200_response import AnalyzeIp200Response
+from openapi_client.models.analyze_ip400_response import AnalyzeIp400Response
+from openapi_client.models.analyze_ip400_response_error import AnalyzeIp400ResponseError
+from openapi_client.models.analyze_ip404_response import AnalyzeIp404Response
+from openapi_client.models.analyze_ip500_response import AnalyzeIp500Response
+from openapi_client.models.analyze_ip_request import AnalyzeIpRequest
+from openapi_client.models.asn import Asn
+from openapi_client.models.batch_analyze_emails202_response import BatchAnalyzeEmails202Response
+from openapi_client.models.batch_analyze_emails400_response import BatchAnalyzeEmails400Response
+from openapi_client.models.batch_analyze_emails400_response_error import BatchAnalyzeEmails400ResponseError
+from openapi_client.models.batch_analyze_emails403_response import BatchAnalyzeEmails403Response
+from openapi_client.models.batch_analyze_emails403_response_error import BatchAnalyzeEmails403ResponseError
+from openapi_client.models.batch_analyze_emails413_response import BatchAnalyzeEmails413Response
+from openapi_client.models.batch_analyze_emails413_response_error import BatchAnalyzeEmails413ResponseError
+from openapi_client.models.batch_analyze_emails_request import BatchAnalyzeEmailsRequest
+from openapi_client.models.batch_analyze_ips400_response import BatchAnalyzeIps400Response
+from openapi_client.models.batch_analyze_ips400_response_error import BatchAnalyzeIps400ResponseError
+from openapi_client.models.batch_analyze_ips_request import BatchAnalyzeIpsRequest
+from openapi_client.models.block_listed import BlockListed
+from openapi_client.models.email_dns import EmailDNS
+from openapi_client.models.geo import Geo
+from openapi_client.models.get_email_batch_status200_response import GetEmailBatchStatus200Response
+from openapi_client.models.get_email_batch_status200_response_download_urls import GetEmailBatchStatus200ResponseDownloadUrls
+from openapi_client.models.get_email_batch_status404_response import GetEmailBatchStatus404Response
+from openapi_client.models.get_email_batch_status404_response_error import GetEmailBatchStatus404ResponseError
+from openapi_client.models.internalerror import INTERNALERROR
+from openapi_client.models.invaliddata import INVALIDDATA
+from openapi_client.models.invaliddata1 import INVALIDDATA1
+from openapi_client.models.invalidemail import INVALIDEMAIL
+from openapi_client.models.invalidplan import INVALIDPLAN
+from openapi_client.models.invalidtoken import INVALIDTOKEN
+from openapi_client.models.ipvalidationfailed import IPVALIDATIONFAILED
+from openapi_client.models.malformedrequest import MALFORMEDREQUEST
+from openapi_client.models.malformedrequest1 import MALFORMEDREQUEST1
+from openapi_client.models.malformedrequest2 import MALFORMEDREQUEST2
+from openapi_client.models.notfound import NOTFOUND
+from openapi_client.models.organization import Organization
+from openapi_client.models.risk_report_email import RiskReportEmail
+from openapi_client.models.risk_report_ip import RiskReportIp
+from openapi_client.models.tech_contact import TechContact
+from openapi_client.models.trusted_provider import TrustedProvider
+from openapi_client.models.whois import Whois