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

opportify_sdk-0.3.1.dist-info/METADATA

@@ -0,0 +1,300 @@
+Metadata-Version: 2.4
+Name: opportify_sdk
+Version: 0.3.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
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+# Opportify-SDK-Python
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Requirements](#requirements)
+- [Getting Started](#getting-started)
+    - [Calling Email Insights](#calling-email-insights)
+    - [Calling IP Insights](#calling-ip-insights)
+- [Batch Analysis (Email & IP)](#batch-analysis-email--ip)
+    - [Batch Email Analysis (JSON)](#1-batch-email-analysis-json)
+    - [Batch Email Analysis (Plain Text)](#2-batch-email-analysis-plain-text)
+    - [Batch Email Analysis (File Upload)](#3-batch-email-analysis-file-upload)
+    - [Batch IP Analysis (JSON)](#4-batch-ip-analysis-json)
+    - [Batch IP Analysis (Plain Text)](#5-batch-ip-analysis-plain-text)
+    - [Batch IP Analysis (File Upload)](#6-batch-ip-analysis-file-upload)
+- [Batch Export Jobs](#batch-export-jobs)
+    - [Email Batch Exports](#email-batch-exports)
+    - [IP Batch Exports](#ip-batch-exports)
+- [Enabling Debug Mode](#enabling-debug-mode)
+- [Handling Errors](#handling-errors)
+- [About this package](#about-this-package)
+
+## 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](https://www.python.org/downloads/)
+
+## Getting Started
+
+First, install Opportify via the pip package manager:
+
+```shell
+pip install opportify-sdk
+```
+
+### Calling Email Insights
+
+```python
+from opportify_sdk import EmailInsights
+
+email_insights = EmailInsights("YOUR-API-KEY-HERE")
+
+params = {
+    "email": "test@gmial.com",  # *gmial* - just an example to be auto-corrected
+    "enableAi": True,
+    "enableAutoCorrection": True,
+    "enableDomainEnrichment": True  # Optional: include domain enrichment block
+}
+
+result = email_insights.analyze(params)
+```
+
+### Calling IP Insights
+
+```python
+from opportify_sdk import IpInsights
+
+ip_insights = IpInsights("<YOUR-KEY-HERE>")
+
+params = {
+    "ip": "3.1.122.82",
+    "enableAi": True
+}
+
+result = ip_insights.analyze(params)
+```
+
+
+## Batch Analysis (Email & IP)
+
+You can submit multiple emails or IPs in a single request. Batch jobs are processed asynchronously; the response returns a job identifier (`job_id`) you can poll for status.
+
+#### 1. Batch Email Analysis (JSON)
+
+```python
+from opportify_sdk import EmailInsights
+
+email_insights = EmailInsights("<YOUR-KEY-HERE>")
+
+params = {
+    'emails': [
+        'one@example.com',
+        'two@example.org'
+    ],
+    'name': 'Customer Email Validation',  # Optional: descriptive name for the job
+    'enableAi': True,
+    'enableAutoCorrection': True
+}
+
+# Default content type is application/json
+batch = email_insights.batch_analyze(params)
+
+# Optional: poll status later
+status = email_insights.get_batch_status(batch['job_id'])
+```
+
+#### 2. Batch Email Analysis (Plain Text)
+Provide one email per line and set the content type to `text/plain`.
+
+```python
+content = "one@example.com\nTwo.User@example.org"  # newline-delimited emails
+batch = email_insights.batch_analyze({'text': content}, 'text/plain')
+status = email_insights.get_batch_status(batch['job_id'])
+```
+
+#### 3. Batch Email Analysis (File Upload)
+Supply a `.csv` (one email per row; header optional) via `batch_analyze_file()`. A `.csv` triggers `multipart/form-data`; other extensions fall back to `text/plain` (newline-delimited body).
+
+```python
+batch = email_insights.batch_analyze_file('emails.csv', {
+    'name': 'Monthly Email Cleanup',  # Optional: descriptive name for the job
+    'enableAi': True,
+    'enableAutoCorrection': True
+})
+status = email_insights.get_batch_status(batch['job_id'])
+```
+
+#### 4. Batch IP Analysis (JSON)
+
+```python
+from opportify_sdk import IpInsights
+
+ip_insights = IpInsights("<YOUR-KEY-HERE>")
+
+params = {
+    'ips': [
+        '1.1.1.1',
+        '8.8.8.8'
+    ],
+    'name': 'Network Security Scan',  # Optional: descriptive name for the job
+    'enableAi': True
+}
+
+batch = ip_insights.batch_analyze(params)  # application/json
+status = ip_insights.get_batch_status(batch['job_id'])
+```
+
+#### 5. Batch IP Analysis (Plain Text)
+
+```python
+content = "1.1.1.1\n8.8.8.8"  # newline-delimited IPs
+batch = ip_insights.batch_analyze({'text': content}, 'text/plain')
+status = ip_insights.get_batch_status(batch['job_id'])
+```
+
+#### 6. Batch IP Analysis (File Upload)
+
+```python
+batch = ip_insights.batch_analyze_file('ips.csv', {
+    'name': 'Firewall IP Assessment',  # Optional: descriptive name for the job
+    'enableAi': True
+})
+status = ip_insights.get_batch_status(batch['job_id'])
+```
+
+#### Convenience & Notes
+- `batch_analyze_file()` auto-selects content type: `.csv` -> `multipart/form-data`; otherwise `text/plain`.
+- For `text/plain`, pass newline-delimited values via the `text` key.
+- For `multipart/form-data`, pass a readable file path via the `file` key (handled internally by `batch_analyze_file()`).
+- The `name` parameter is optional for all batch operations and helps with job identification and tracking.
+- `enableAutoCorrection` applies only to Email Insights.
+- Always wrap calls in a try-except (see Error Handling) to capture API errors.
+- Polling cadence depends on payload size; a short delay (1–3s) between status checks is recommended.
+
+## Batch Export Jobs
+
+Use batch exports to materialize filtered results from completed jobs. Exports run asynchronously and expose polling helpers similar to batch status checks.
+
+### Email Batch Exports
+
+```python
+email_insights = EmailInsights('<YOUR-KEY-HERE>')
+
+# Trigger a new export for a completed batch job
+export = email_insights.create_batch_export('job-uuid-here', {
+    'exportType': 'csv',
+    'columns': [
+        'emailAddress',
+        'emailProvider',
+        'riskReport.score',
+        'isDeliverable'
+    ],
+    'filters': {
+        'isDeliverable': 'true',
+        'riskReport.score': {'min': 400}
+    }
+})
+
+# Poll until the export is ready
+status = email_insights.get_batch_export_status('job-uuid-here', export['export_id'])
+
+if status['status'] == 'COMPLETED':
+    # Use status['download_url'] for the pre-signed file link
+    print(f"Download: {status['download_url']}")
+```
+
+### IP Batch Exports
+
+```python
+ip_insights = IpInsights('<YOUR-KEY-HERE>')
+
+export = ip_insights.create_batch_export('job-uuid-here', {
+    'exportType': 'json',
+    'columns': [
+        'result.ipAddress',
+        'result.connectionType',
+        'result.riskReport.score'
+    ],
+    'filters': {
+        'result.riskReport.level': ['low', 'medium']
+    }
+})
+
+status = ip_insights.get_batch_export_status('job-uuid-here', export['export_id'])
+
+if status['status'] == 'COMPLETED':
+    # Use status['download_url'] to retrieve the generated export
+    print(f"Download: {status['download_url']}")
+elif status['status'] == 'FAILED':
+    # Review status['error_code'] and status['error_message'] for remediation guidance
+    print(f"Error: {status['error_code']} - {status['error_message']}")
+```
+
+
+## Enabling Debug Mode
+
+```python
+client_insights.set_debug_mode(True)
+```
+
+## Handling Errors
+
+We strongly recommend that any usage of this SDK happens within a try-except to properly handle any exceptions or errors.
+
+```python
+from openapi_client.exceptions import ApiException
+
+try:
+    # Email or IP Insights usage...
+    result = email_insights.analyze(params)
+except ApiException as e:
+    print(f"API Error: {e.status} - {e.reason}")
+    print(f"Response: {e.body}")
+except Exception as e:
+    print(f"Error: {str(e)}")
+```
+
+Below are common error responses you might encounter:
+
+| Status Code | Error Type | Description |
+|------------|------------|-------------|
+| `400` | Bad Request | Invalid parameters or malformed request |
+| `401` | Unauthorized | Invalid or missing API key |
+| `402` | Payment Required | Account has insufficient credits |
+| `403` | Forbidden | Plan limitation or feature not available |
+| `404` | Not Found | Resource not found (e.g., invalid job ID) |
+| `413` | Payload Too Large | Request exceeds maximum size (3MB) |
+| `429` | Too Many Requests | Rate limit exceeded |
+| `500` | Internal Server Error | Server-side error occurred |
+
+## About this package
+
+This Python package is a customization of the base generated by:
+
+- [OpenAPI Generator](https://openapi-generator.tech) project.
+

opportify_sdk-0.3.1.dist-info/RECORD

@@ -0,0 +1,86 @@
+openapi_client/__init__.py,sha256=wsRmo1p8_83udLGPgXnFoDTjSo8xmvu9qC6jgoycJ8w,13034
+openapi_client/api_client.py,sha256=Y2bAooKiF6d2NopIpEh-04x3DEmjCf_H08l1BnjeQ0w,30770
+openapi_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
+openapi_client/configuration.py,sha256=FQSsdWBVCXSRkM5W6su6ADll77c8oKwQKcIkr4MFrPY,22116
+openapi_client/exceptions.py,sha256=bulb1NA5LG77JM9puU1kLzNpPY8xe5T1B7zN99xqSk0,9451
+openapi_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+openapi_client/rest.py,sha256=E0G2pCDWyeXLAb0zOw_dzM3GK84WDsKvCzvQQJC0iG8,12448
+openapi_client/api/__init__.py,sha256=_2MpmNT7so7K9CyzP-_2Sd_1EU8-Gq10jtUKccY86-Q,176
+openapi_client/api/email_insights_api.py,sha256=BmPLxuh-15B4i6tIngaFHLeAAlU8WYUBa3wNUAOEWuA,78736
+openapi_client/api/ip_insights_api.py,sha256=uTEq8iq20cJNuBPDuSM7topnZx6ZoJwJjngQzjG9jRg,78724
+openapi_client/models/__init__.py,sha256=J_UJAN6qP4Ijf7nTHkX1eD0qmrNoOZymVAgsfDlId-c,8497
+openapi_client/models/abuse_contact.py,sha256=eFANN7T_IHf9e7PQoRA89kBOOFDPgHPF3KjZg7C6Fjc,6574
+openapi_client/models/address_signals.py,sha256=3tOdEqSYWOgNyUtMuqLxClYeHdPzvY4WPoBj6XjqNfY,7625
+openapi_client/models/admin_contact.py,sha256=5TYVZYoRA42x0AtLQufe9KnGsEqQJ-Z2E-74s1gco3I,6574
+openapi_client/models/analyze_email200_response.py,sha256=3TmtkSmEyM0e_dfdLGmTkob57ugk5ZMAZlK2PmRqfBA,10184
+openapi_client/models/analyze_email400_response.py,sha256=rMLeJMAx2aYIwXjQ8FvAc2m3nfpyCwdoodSEzgZ9jrg,8365
+openapi_client/models/analyze_email403_response.py,sha256=0wVqwdRJEqov1eqEtobqoASoWWWrqnq72lVJf2CFb7o,12029
+openapi_client/models/analyze_email500_response.py,sha256=3qCTuKOMxYnWZb-VOcrei2BZjKgfoL45y1pEw6c6odg,5729
+openapi_client/models/analyze_email_request.py,sha256=G2XuxfFnWjRTDej_LObTwR961iFj_MCqwniSD3a4C9s,6509
+openapi_client/models/analyze_ip200_response.py,sha256=K3N2BgQpE3x4oI7LHq4EmAIWTJsuk3BHdKCk51WiqAQ,9166
+openapi_client/models/analyze_ip400_response.py,sha256=KPR3oSVcbbyfAmmJYR77a0pLm_rk-w8QxwNbbnzuIc4,8460
+openapi_client/models/analyze_ip_request.py,sha256=So-JYoOPAodi-7BXcE6PrCs06ZMl4kfy-HKmJQ7WBU4,5755
+openapi_client/models/asn.py,sha256=69gzMBcgDVjC5hnlqHtD3ExNrlydXuNQyK1SX6UBS34,6251
+openapi_client/models/batch_analyze_emails202_response.py,sha256=Y-8rGn6_tN24uAwMqBY89A2ToFythmLxfY1LVrJ8TgI,6277
+openapi_client/models/batch_analyze_emails400_response.py,sha256=O970eDu4WS9nprk74H_p0N3rVmgeP8B5jZzMxu2WgD4,8413
+openapi_client/models/batch_analyze_emails401_response.py,sha256=8AQJrJ0VXrN8S7gzVMcZI_PyOw2M3_okTVpECFioqXg,5753
+openapi_client/models/batch_analyze_emails402_response.py,sha256=w6D8TqwwNASQvmXu0j4_OIaCdDJm_Q0M77LEp9I2RxQ,8362
+openapi_client/models/batch_analyze_emails403_response.py,sha256=2r_vc5qskdBdmmGpcFDNVxk_Lq9JE-KP3JPXMdhcv3M,11334
+openapi_client/models/batch_analyze_emails413_response.py,sha256=n79z_U49ECEm_kUE80KOFrhWFtLFegOSKMb5zWQwV6U,5753
+openapi_client/models/batch_analyze_emails429_response.py,sha256=4KVg7WZ7ZwmdTJDt9WHGZT3C2PmCCGnkVcWt2Y4NESU,5753
+openapi_client/models/batch_analyze_emails_request.py,sha256=HG0NrP-j_1dlLkG-gFmaTvBMtTsdKPpbSBqo49Qq6kk,6192
+openapi_client/models/batch_analyze_ips202_response.py,sha256=zsyl1OIX5oSfVP8RGE-JiBkQno2SmlqEDUdyUW-vP_k,6265
+openapi_client/models/batch_analyze_ips400_response.py,sha256=NeEKN45tu4GUZEhexqtmIAiyEULwC_EkS0HkgVb3RKQ,8406
+openapi_client/models/batch_analyze_ips_request.py,sha256=-3nSIQ8XNacoQRf_W2QMXKSApQe2-v7icS1nVwT3VeM,5904
+openapi_client/models/block_listed.py,sha256=YdOYTjZNHzQxOpLbbCYKhez7tbshqbt-oqMLgCWCSss,6866
+openapi_client/models/create_email_batch_export400_response.py,sha256=hOHC77nVzgcbYYA67V7AJxHvyEvA_WY_6C9aXRl_5_w,5769
+openapi_client/models/create_email_batch_export403_response.py,sha256=ocEspTGOOj2pfekSGNyNrmHJVVJ-zsfzAQDA1pPlbBI,5769
+openapi_client/models/create_email_batch_export404_response.py,sha256=VF5bdO4QnVeOkifzTqMSr1qS1pJ-13hHdP0rBn33Kog,5769
+openapi_client/models/create_email_batch_export409_response.py,sha256=MarqTsQ4dl9n28tlRzHB9Yj9FjV7zqNh0-ajDrhQMNE,8496
+openapi_client/models/email_dns.py,sha256=z3IGhD4fNuPm2GjJ-asOgtpweTBSysjZfnEv8izR4Fk,6935
+openapi_client/models/email_domain.py,sha256=IVOlQa1iN78myj5H5vIjfEyOeA8jWheD_xKyGwMPqdg,9678
+openapi_client/models/export_created_response.py,sha256=oapKY5eWiT765IBPnD-uUMSQbaNqqPiX5jrJx4aDOYY,6051
+openapi_client/models/export_filter.py,sha256=bbtNGcMSt03AHa4ihP_PQhMC81PUnPq1Wl74-h5IdM4,6336
+openapi_client/models/export_request.py,sha256=d8EU8MofhAMwkbvO3_-itT4QRJfeZ0RcGrdPVWoEtdo,6442
+openapi_client/models/export_status_response.py,sha256=kwNnUvH8ifnWRdyxe5EtsaSVDLIqru_MJwhNIKEW1dA,8996
+openapi_client/models/exportnotfound.py,sha256=eVsmVwdXT4UFDE7U4C3wVu1NA14aLyNyTrrreqBvqc8,5693
+openapi_client/models/forbidden.py,sha256=pb4Xjxx_s2P17lnyKASrVi9t1D_bCkbHq4UMDxIAfD4,5673
+openapi_client/models/geo.py,sha256=IM5MNzvO9AIxNhj5gxdWZ0YtGwqCI9YL_fk93kLv6dw,9893
+openapi_client/models/get_email_batch_export_status400_response.py,sha256=UGvjTnoZEmXNH6QdYqLMYHU1WmpH5kSTVKeQFCenRS8,5781
+openapi_client/models/get_email_batch_export_status404_response.py,sha256=A0p8ePEHe7Oh1zLYnb1kLbI6Hbrkript_jr5AtAWsQU,8418
+openapi_client/models/get_email_batch_status200_response.py,sha256=ac0k9kYzpSw7NBSX0AM0N2ucD4BEkQoqMIgzTfCESCU,7073
+openapi_client/models/get_email_batch_status200_response_download_urls.py,sha256=j-Dc9MnA-Z0AsWNrSAi_3fAIeIky6iLd7APBOgtMKvE,6392
+openapi_client/models/get_email_batch_status404_response.py,sha256=5jTygEf24vfkj2gdGN-8WuTJSBrdOJ2KDFX3lL8ad8A,5757
+openapi_client/models/get_ip_batch_status200_response.py,sha256=WRKKwC1WKFJZf2L9BBXnqDM9l1XE099JwVl5PAE141M,7061
+openapi_client/models/internalerror.py,sha256=0HRIZFjt495shZuEUVDYOCFQ8Xz9UMFjfm2jsKBBZF8,5689
+openapi_client/models/internalerror1.py,sha256=cyFySqczi0UTuKJxXcC5LS6sozqJGmw60kyCYqU32pQ,5693
+openapi_client/models/invaliddata.py,sha256=iydEUJnQGR1E2V9M3sXUFRoS9nskZXE-BVzJ9QTGSPk,5681
+openapi_client/models/invaliddata1.py,sha256=W4wHSJ2wjnI52cRDx1iVV9XTZBPDIUYfNnsStrr_um4,5685
+openapi_client/models/invalidemail.py,sha256=fma2UcdxyevV84EY-Ap68UUEUiSTOg5w1lXOxyJ_MlI,5685
+openapi_client/models/invalidplan.py,sha256=GHdH8D0PYIiyVC6CksHJqjm4YflaXCwOnHr9OMJ5lBE,5681
+openapi_client/models/invalidplan1.py,sha256=QQldNGSOiwsUQMGfq6eluWUf2qgGyiTKr8o-G1RwMh4,5685
+openapi_client/models/invalidtoken.py,sha256=yZPOwhLrhNMQK8SFO_gvErvMhhe8_-dd_g6LlN8Pb8A,5685
+openapi_client/models/ipvalidationfailed.py,sha256=dzEpDgxK0AHge1cofs8kCLADxgOqjNRPW56qFCo8_5g,5709
+openapi_client/models/jobnotfound.py,sha256=jM48C7CXhWOVDlDJWPF47WinYd45I0zeQeim9SBLqY8,5681
+openapi_client/models/jobnotready.py,sha256=VOAAKfqksuCSIVV65SITK7StMdb97NgipN9fYJ3Yrwo,5681
+openapi_client/models/malformedrequest.py,sha256=ne0f9kinBCWQ_OD0l9ayEkSBswwyguWlqBzObFVENt4,5701
+openapi_client/models/malformedrequest1.py,sha256=4_g0EvdJiJ9Lr7oQk2SOvKmChuivnlZRgTI76hOxoRU,5705
+openapi_client/models/malformedrequest2.py,sha256=stM9AxgT37DgT_eAm7lNl4KFP2M0FlxwYEGAcVFFS1Y,5705
+openapi_client/models/malformedrequest3.py,sha256=lBeU0qKzaLbbyzOkZMlXiID_86s_HOpR2_RN50MB7mA,5705
+openapi_client/models/manifestnotavailable.py,sha256=gieizvUhxn99PV6vkqGltPrENwfbs0HlDcwK6sOhP24,5717
+openapi_client/models/notfound.py,sha256=iGSh5DFWY3LR4ho7dgL_uZb6X1WwCUvq9CbDwdxDB8s,5669
+openapi_client/models/organization.py,sha256=GsSVDda1xq4QAM53OxM9J5ODoz4dtA7spfH1TCu07LE,7144
+openapi_client/models/quotaexceeded.py,sha256=WiDSz02Fn3DNr6C0RFCqoFWvSHm6m3jY0uwQk9ftPus,5689
+openapi_client/models/risk_report_email.py,sha256=U_KwYTS26tKEcNlc4VXRmkTh5kn7QY5Cm-P5B595XdM,10166
+openapi_client/models/risk_report_ip.py,sha256=MJRduy5LBXtT4sSwhrwQ416hFe0ibp2KCTe_QtKseQc,9002
+openapi_client/models/tech_contact.py,sha256=BV7SWTM5FV9GA__a5spB2ouApzvkg6vs9GW7Fmnt6Aw,6563
+openapi_client/models/toomanyrequests.py,sha256=-AupD-6sWaMFSlQlNhWYejZlbd-n93er4WwGKBE5NVg,5697
+openapi_client/models/trusted_provider.py,sha256=fFcUAi6efmYldLM1qCqDfYbVbfET12O_60MFZw_LFSc,6188
+openapi_client/models/whois.py,sha256=oI2N973wKRAdZsN0LfQRH9PMzyjEimmuG_Jo4GOu5io,8447
+opportify_sdk/__init__.py,sha256=b5dO5TZ0ac8L7meGstmpAzIWXS9jwPqV1EruY32dffk,139
+opportify_sdk/email_insights.py,sha256=OPb6NEQH_kmWODHuyIZBiNRjLz2M6QRl1S0IK7gcEVs,16717
+opportify_sdk/ip_insights.py,sha256=OWWPQa2pAzHFX-z_mWaaoeTqqZRFWKLYpGJwAzhBspw,15507
+opportify_sdk-0.3.1.dist-info/METADATA,sha256=h6GDrJCRL8v9V5rMK1M9zfDguYdT-bYq_bszt0bEJf8,9105
+opportify_sdk-0.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+opportify_sdk-0.3.1.dist-info/top_level.txt,sha256=90CufmKPfMOr0lxs06ndbpvXPdVbmArXAorIu2p-giU,29
+opportify_sdk-0.3.1.dist-info/RECORD,,

{opportify_sdk-0.1.1.dist-info → opportify_sdk-0.3.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

opportify_sdk-0.3.1.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+openapi_client
+opportify_sdk

lib/v1/openapi_client/__init__.py

@@ -1,63 +0,0 @@
-# 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-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. 
-
-    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_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.block_listed import BlockListed
-from openapi_client.models.email_dns import EmailDNS
-from openapi_client.models.geo import Geo
-from openapi_client.models.internalerror import INTERNALERROR
-from openapi_client.models.invalidemail import INVALIDEMAIL
-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.notfound import NOTFOUND
-from openapi_client.models.organization import Organization
-from openapi_client.models.risk_report import RiskReport
-from openapi_client.models.tech_contact import TechContact
-from openapi_client.models.trusted_provider import TrustedProvider
-from openapi_client.models.whois import Whois