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

opportify_sdk-0.1.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: opportify_sdk
+Version: 0.1.1
+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
+
+# 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
+```
+
+### 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}")
+```
+
+### Enable Debug Mode
+
+```python
+ip_insights.set_version("v1").set_debug_mode(True)
+email_insights.set_version("v1").set_debug_mode(False)
+```
+
+## About this package
+
+This Python package is a customization of the base generated by:
+
+- [OpenAPI Generator](https://openapi-generator.tech) project.
+

opportify_sdk-0.1.1/opportify_sdk.egg-info/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: opportify_sdk
+Version: 0.1.1
+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
+
+# 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
+```
+
+### 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}")
+```
+
+### Enable Debug Mode
+
+```python
+ip_insights.set_version("v1").set_debug_mode(True)
+email_insights.set_version("v1").set_debug_mode(False)
+```
+
+## About this package
+
+This Python package is a customization of the base generated by:
+
+- [OpenAPI Generator](https://openapi-generator.tech) project.
+

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "opportify_sdk"
-version = "0.1.0"
+version = "0.1.1"
 description = "Opportify Insights API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "NoLicense"

opportify_sdk-0.1.1/setup.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    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-reference/email-insights)   - Validate email syntax.   - Identify email types (free, disposable, corporate 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-reference/email-insights)  - [**IP Insights:**](/docs/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-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. 
+
+"""  # noqa: E501
+
+from setuptools import setup, find_packages  # noqa: H301
+
+with open('README.md') as readme_file:
+    readme = readme_file.read()
+
+NAME = "opportify_sdk"
+VERSION = "0.1.1"
+PYTHON_REQUIRES = ">= 3.8"
+REQUIRES = [
+    "urllib3 >= 1.25.3, < 3.0.0",
+    "python-dateutil >= 2.8.2",
+    "pydantic >= 2",
+    "typing-extensions >= 4.7.1",
+]
+
+setup(
+    name=NAME,
+    version=VERSION,
+    description="Opportify Insights API",
+    author="Opportify & OpenAPI-Generator",
+    author_email="",
+    url="https://github.com/opportify/opportify-sdk-python",
+    keywords=["OpenAPI", "OpenAPI-Generator", "Opportify Insights API","Opportify"],
+    install_requires=REQUIRES,
+    packages=find_packages(exclude=["test", "tests"]),
+    include_package_data=True,
+    long_description_content_type='text/markdown',
+    long_description=readme,
+    package_data={"openapi_client": ["py.typed"]},
+)

opportify_sdk-0.1.0/PKG-INFO

@@ -1,16 +0,0 @@
-Metadata-Version: 2.1
-Name: opportify_sdk
-Version: 0.1.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
-
-    ## 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:  &#x60;&#x60;&#x60;plaintext https://api.opportify.ai/insights/v1/&lt;service&gt;/&lt;endpoint&gt; &#x60;&#x60;&#x60;  ### Features - [**Email Insights:**](/docs/api-reference/email-insights)   - Validate email syntax.   - Identify email types (free, disposable, corporate 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 &gt;&gt;](/docs/api-reference/email-insights)  - [**IP Insights:**](/docs/api-reference/ip-insights)   - Connection types: Detects connection types such as &#x60;wired&#x60;, &#x60;mobile&#x60;, &#x60;enterprise&#x60;, &#x60;satellite&#x60;, &#x60;VPN&#x60;, &#x60;cloud-provider&#x60;, &#x60;open-proxy&#x60;, or &#x60;Tor&#x60;.   - 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 &gt;&gt;](/docs/api-reference/ip-insights)  ### Authentication &amp; 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. 
-    

opportify_sdk-0.1.0/opportify_sdk.egg-info/PKG-INFO

@@ -1,16 +0,0 @@
-Metadata-Version: 2.1
-Name: opportify_sdk
-Version: 0.1.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
-
-    ## 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:  &#x60;&#x60;&#x60;plaintext https://api.opportify.ai/insights/v1/&lt;service&gt;/&lt;endpoint&gt; &#x60;&#x60;&#x60;  ### Features - [**Email Insights:**](/docs/api-reference/email-insights)   - Validate email syntax.   - Identify email types (free, disposable, corporate 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 &gt;&gt;](/docs/api-reference/email-insights)  - [**IP Insights:**](/docs/api-reference/ip-insights)   - Connection types: Detects connection types such as &#x60;wired&#x60;, &#x60;mobile&#x60;, &#x60;enterprise&#x60;, &#x60;satellite&#x60;, &#x60;VPN&#x60;, &#x60;cloud-provider&#x60;, &#x60;open-proxy&#x60;, or &#x60;Tor&#x60;.   - 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 &gt;&gt;](/docs/api-reference/ip-insights)  ### Authentication &amp; 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. 
-    

opportify_sdk-0.1.0/setup.py

@@ -1,38 +0,0 @@
-# coding: utf-8
-
-"""
-    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-reference/email-insights)   - Validate email syntax.   - Identify email types (free, disposable, corporate 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-reference/email-insights)  - [**IP Insights:**](/docs/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-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. 
-
-"""  # noqa: E501
-
-from setuptools import setup, find_packages  # noqa: H301
-
-NAME = "opportify_sdk"
-VERSION = "0.1.0"
-PYTHON_REQUIRES = ">= 3.8"
-REQUIRES = [
-    "urllib3 >= 1.25.3, < 3.0.0",
-    "python-dateutil >= 2.8.2",
-    "pydantic >= 2",
-    "typing-extensions >= 4.7.1",
-]
-
-setup(
-    name=NAME,
-    version=VERSION,
-    description="Opportify Insights API",
-    author="Opportify & OpenAPI-Generator",
-    author_email="",
-    url="https://github.com/opportify/opportify-sdk-python",
-    keywords=["OpenAPI", "OpenAPI-Generator", "Opportify Insights API","Opportify"],
-    install_requires=REQUIRES,
-    packages=find_packages(exclude=["test", "tests"]),
-    include_package_data=True,
-    long_description_content_type='text/markdown',
-    long_description="""\
-    ## 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:  &#x60;&#x60;&#x60;plaintext https://api.opportify.ai/insights/v1/&lt;service&gt;/&lt;endpoint&gt; &#x60;&#x60;&#x60;  ### Features - [**Email Insights:**](/docs/api-reference/email-insights)   - Validate email syntax.   - Identify email types (free, disposable, corporate 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 &gt;&gt;](/docs/api-reference/email-insights)  - [**IP Insights:**](/docs/api-reference/ip-insights)   - Connection types: Detects connection types such as &#x60;wired&#x60;, &#x60;mobile&#x60;, &#x60;enterprise&#x60;, &#x60;satellite&#x60;, &#x60;VPN&#x60;, &#x60;cloud-provider&#x60;, &#x60;open-proxy&#x60;, or &#x60;Tor&#x60;.   - 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 &gt;&gt;](/docs/api-reference/ip-insights)  ### Authentication &amp; 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. 
-    """,  # noqa: E501
-    package_data={"openapi_client": ["py.typed"]},
-)