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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of opportify-sdk might be problematic. Click here for more details.

Files changed (79) hide show
  1. openapi_client/__init__.py +86 -0
  2. openapi_client/api/email_insights_api.py +883 -0
  3. openapi_client/api/ip_insights_api.py +886 -0
  4. {lib/v1/openapi_client → openapi_client}/api_client.py +2 -2
  5. {lib/v1/openapi_client → openapi_client}/configuration.py +1 -1
  6. {lib/v1/openapi_client → openapi_client}/exceptions.py +18 -1
  7. openapi_client/models/__init__.py +68 -0
  8. {lib/v1/openapi_client → openapi_client}/models/abuse_contact.py +1 -1
  9. {lib/v1/openapi_client → openapi_client}/models/admin_contact.py +1 -1
  10. {lib/v1/openapi_client → openapi_client}/models/analyze_email200_response.py +9 -7
  11. {lib/v1/openapi_client → openapi_client}/models/analyze_email400_response.py +1 -1
  12. {lib/v1/openapi_client → openapi_client}/models/analyze_email400_response_error.py +1 -1
  13. openapi_client/models/analyze_email403_response.py +91 -0
  14. openapi_client/models/analyze_email403_response_error.py +137 -0
  15. {lib/v1/openapi_client → openapi_client}/models/analyze_email500_response.py +1 -1
  16. {lib/v1/openapi_client → openapi_client}/models/analyze_email500_response_error.py +1 -1
  17. {lib/v1/openapi_client → openapi_client}/models/analyze_email_request.py +1 -1
  18. {lib/v1/openapi_client → openapi_client}/models/analyze_ip200_response.py +4 -4
  19. {lib/v1/openapi_client → openapi_client}/models/analyze_ip400_response.py +1 -1
  20. {lib/v1/openapi_client → openapi_client}/models/analyze_ip400_response_error.py +1 -1
  21. {lib/v1/openapi_client → openapi_client}/models/analyze_ip404_response.py +1 -1
  22. {lib/v1/openapi_client → openapi_client}/models/analyze_ip500_response.py +1 -1
  23. {lib/v1/openapi_client → openapi_client}/models/analyze_ip_request.py +1 -1
  24. {lib/v1/openapi_client → openapi_client}/models/asn.py +1 -1
  25. openapi_client/models/batch_analyze_emails202_response.py +101 -0
  26. openapi_client/models/batch_analyze_emails400_response.py +91 -0
  27. openapi_client/models/batch_analyze_emails400_response_error.py +137 -0
  28. openapi_client/models/batch_analyze_emails403_response.py +91 -0
  29. openapi_client/models/batch_analyze_emails403_response_error.py +89 -0
  30. openapi_client/models/batch_analyze_emails413_response.py +91 -0
  31. openapi_client/models/batch_analyze_emails413_response_error.py +89 -0
  32. openapi_client/models/batch_analyze_emails_request.py +91 -0
  33. openapi_client/models/batch_analyze_ips400_response.py +91 -0
  34. openapi_client/models/batch_analyze_ips400_response_error.py +137 -0
  35. openapi_client/models/batch_analyze_ips_request.py +89 -0
  36. {lib/v1/openapi_client → openapi_client}/models/block_listed.py +1 -1
  37. {lib/v1/openapi_client → openapi_client}/models/email_dns.py +1 -1
  38. {lib/v1/openapi_client → openapi_client}/models/geo.py +1 -1
  39. openapi_client/models/get_email_batch_status200_response.py +109 -0
  40. openapi_client/models/get_email_batch_status200_response_download_urls.py +93 -0
  41. openapi_client/models/get_email_batch_status404_response.py +91 -0
  42. openapi_client/models/get_email_batch_status404_response_error.py +89 -0
  43. {lib/v1/openapi_client → openapi_client}/models/internalerror.py +1 -1
  44. openapi_client/models/invaliddata.py +89 -0
  45. openapi_client/models/invaliddata1.py +89 -0
  46. {lib/v1/openapi_client → openapi_client}/models/invalidemail.py +1 -1
  47. openapi_client/models/invalidplan.py +89 -0
  48. openapi_client/models/invalidtoken.py +89 -0
  49. {lib/v1/openapi_client → openapi_client}/models/ipvalidationfailed.py +1 -1
  50. {lib/v1/openapi_client → openapi_client}/models/malformedrequest.py +1 -1
  51. {lib/v1/openapi_client → openapi_client}/models/malformedrequest1.py +1 -1
  52. openapi_client/models/malformedrequest2.py +89 -0
  53. {lib/v1/openapi_client → openapi_client}/models/notfound.py +1 -1
  54. {lib/v1/openapi_client → openapi_client}/models/organization.py +1 -1
  55. openapi_client/models/risk_report_email.py +91 -0
  56. lib/v1/openapi_client/models/risk_report.py → openapi_client/models/risk_report_ip.py +4 -4
  57. {lib/v1/openapi_client → openapi_client}/models/tech_contact.py +1 -1
  58. {lib/v1/openapi_client → openapi_client}/models/trusted_provider.py +1 -1
  59. {lib/v1/openapi_client → openapi_client}/models/whois.py +1 -1
  60. {lib/v1/openapi_client → openapi_client}/rest.py +1 -1
  61. {src → opportify_sdk}/email_insights.py +79 -0
  62. {src → opportify_sdk}/ip_insights.py +75 -1
  63. opportify_sdk-0.2.0.dist-info/METADATA +239 -0
  64. opportify_sdk-0.2.0.dist-info/RECORD +70 -0
  65. {opportify_sdk-0.1.1.dist-info → opportify_sdk-0.2.0.dist-info}/WHEEL +1 -1
  66. opportify_sdk-0.2.0.dist-info/top_level.txt +2 -0
  67. lib/__init__.py +0 -0
  68. lib/v1/__init__.py +0 -0
  69. lib/v1/openapi_client/__init__.py +0 -63
  70. lib/v1/openapi_client/api/email_insights_api.py +0 -317
  71. lib/v1/openapi_client/api/ip_insights_api.py +0 -322
  72. lib/v1/openapi_client/models/__init__.py +0 -45
  73. opportify_sdk-0.1.1.dist-info/METADATA +0 -108
  74. opportify_sdk-0.1.1.dist-info/RECORD +0 -49
  75. opportify_sdk-0.1.1.dist-info/top_level.txt +0 -2
  76. {lib/v1/openapi_client → openapi_client}/api/__init__.py +0 -0
  77. {lib/v1/openapi_client → openapi_client}/api_response.py +0 -0
  78. {lib/v1/openapi_client → openapi_client}/py.typed +0 -0
  79. {src → opportify_sdk}/__init__.py +0 -0
@@ -1,45 +0,0 @@
1
- # coding: utf-8
2
-
3
- # flake8: noqa
4
- """
5
- Opportify Insights API
6
-
7
- ## 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.
8
-
9
- The version of the OpenAPI document: 1.0.0
10
- Generated by OpenAPI Generator (https://openapi-generator.tech)
11
-
12
- Do not edit the class manually.
13
- """ # noqa: E501
14
-
15
-
16
- # import models into model package
17
- from openapi_client.models.abuse_contact import AbuseContact
18
- from openapi_client.models.admin_contact import AdminContact
19
- from openapi_client.models.analyze_email200_response import AnalyzeEmail200Response
20
- from openapi_client.models.analyze_email400_response import AnalyzeEmail400Response
21
- from openapi_client.models.analyze_email400_response_error import AnalyzeEmail400ResponseError
22
- from openapi_client.models.analyze_email500_response import AnalyzeEmail500Response
23
- from openapi_client.models.analyze_email500_response_error import AnalyzeEmail500ResponseError
24
- from openapi_client.models.analyze_email_request import AnalyzeEmailRequest
25
- from openapi_client.models.analyze_ip200_response import AnalyzeIp200Response
26
- from openapi_client.models.analyze_ip400_response import AnalyzeIp400Response
27
- from openapi_client.models.analyze_ip400_response_error import AnalyzeIp400ResponseError
28
- from openapi_client.models.analyze_ip404_response import AnalyzeIp404Response
29
- from openapi_client.models.analyze_ip500_response import AnalyzeIp500Response
30
- from openapi_client.models.analyze_ip_request import AnalyzeIpRequest
31
- from openapi_client.models.asn import Asn
32
- from openapi_client.models.block_listed import BlockListed
33
- from openapi_client.models.email_dns import EmailDNS
34
- from openapi_client.models.geo import Geo
35
- from openapi_client.models.internalerror import INTERNALERROR
36
- from openapi_client.models.invalidemail import INVALIDEMAIL
37
- from openapi_client.models.ipvalidationfailed import IPVALIDATIONFAILED
38
- from openapi_client.models.malformedrequest import MALFORMEDREQUEST
39
- from openapi_client.models.malformedrequest1 import MALFORMEDREQUEST1
40
- from openapi_client.models.notfound import NOTFOUND
41
- from openapi_client.models.organization import Organization
42
- from openapi_client.models.risk_report import RiskReport
43
- from openapi_client.models.tech_contact import TechContact
44
- from openapi_client.models.trusted_provider import TrustedProvider
45
- from openapi_client.models.whois import Whois
@@ -1,108 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: opportify_sdk
3
- Version: 0.1.1
4
- Summary: Opportify Insights API
5
- Home-page: https://github.com/opportify/opportify-sdk-python
6
- Author: Opportify & OpenAPI-Generator
7
- Author-email:
8
- Keywords: OpenAPI,OpenAPI-Generator,Opportify Insights API,Opportify
9
- Description-Content-Type: text/markdown
10
- Requires-Dist: urllib3<3.0.0,>=1.25.3
11
- Requires-Dist: python-dateutil>=2.8.2
12
- Requires-Dist: pydantic>=2
13
- Requires-Dist: typing-extensions>=4.7.1
14
-
15
- # Opportify-SDK-Python
16
-
17
- ## Overview
18
-
19
- 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.
20
-
21
- [Sign Up Free](https://www.opportify.ai)
22
-
23
- ### Base URL
24
- Use the following base URL for all API requests:
25
-
26
- ```plaintext
27
- https://api.opportify.ai/insights/v1/<service>/<endpoint>
28
- ```
29
-
30
- ## Requirements
31
-
32
- Requires Python v3.8 or later
33
-
34
- ## Getting Started
35
-
36
- First, install Opportify SDK via PyPI manager:
37
-
38
- ```
39
- pip install opportify-sdk
40
- ```
41
-
42
- ### Calling Email Insights
43
-
44
- ```python
45
- from opportify_sdk import EmailInsights
46
-
47
- # Initialize the wrapper with your API key
48
- api_key = "<YOUR-API-KEY-HERE>"
49
- email_insights = EmailInsights(api_key)
50
-
51
- # Optional: Configure host, version, and debug mode
52
- email_insights.set_version("v1")
53
-
54
- # Define request parameters
55
- params = {
56
- "email": "<SOME-EMAIL-HERE>",
57
- "enableAutoCorrection": True,
58
- "enableAi": True
59
- }
60
-
61
- # Call the API
62
- try:
63
- result = email_insights.analyze(params)
64
- print("Response:", result)
65
- except Exception as e:
66
- print(f"Error: {e}")
67
- ```
68
-
69
- ### Calling IP Insights
70
-
71
- ```python
72
-
73
- from opportify_sdk import IpInsights
74
-
75
- # Initialize the wrapper with your API key
76
- api_key = "<YOUR-API-KEY-HERE>"
77
- ip_insights = IpInsights(api_key)
78
-
79
- # Optional: Configure host, version, and debug mode
80
- ip_insights.set_version("v1")
81
-
82
- # Define request parameters
83
- params = {
84
- "ip": "<SOME-IP-HERE>",
85
- "enableAi": True
86
- }
87
-
88
- # Call the API
89
- try:
90
- result = ip_insights.analyze(params)
91
- print("Response:", result)
92
- except Exception as e:
93
- print(f"Error: {e}")
94
- ```
95
-
96
- ### Enable Debug Mode
97
-
98
- ```python
99
- ip_insights.set_version("v1").set_debug_mode(True)
100
- email_insights.set_version("v1").set_debug_mode(False)
101
- ```
102
-
103
- ## About this package
104
-
105
- This Python package is a customization of the base generated by:
106
-
107
- - [OpenAPI Generator](https://openapi-generator.tech) project.
108
-
@@ -1,49 +0,0 @@
1
- lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
- lib/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
- lib/v1/openapi_client/__init__.py,sha256=4YbyZsJjF4Ig1mWXt6fxS7uhdr0uDEQPZQ-xsbDIwDI,5986
4
- lib/v1/openapi_client/api_client.py,sha256=v_S3upItmHMMZXNSWYBtFIy2SSjt_MLAOcXpMiBST8g,30433
5
- lib/v1/openapi_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
6
- lib/v1/openapi_client/configuration.py,sha256=8U7Zd4rziMXTXvviDquxlSdDgSuSmsttGYeGDNOkod0,21544
7
- lib/v1/openapi_client/exceptions.py,sha256=tHCC6Ij9c8ScVmZyCL5thgYXpopuUG1NSpILlHI_-Sg,8938
8
- lib/v1/openapi_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
- lib/v1/openapi_client/rest.py,sha256=QwKi4N39ZgYVtBPrXQzw8bkhpiZbfUUPuWhi44tMst0,12378
10
- lib/v1/openapi_client/api/__init__.py,sha256=_2MpmNT7so7K9CyzP-_2Sd_1EU8-Gq10jtUKccY86-Q,176
11
- lib/v1/openapi_client/api/email_insights_api.py,sha256=bbstLmF0CoBah5qxImN--ic1lBD1uMZ7jr0-ZpWUoAc,20667
12
- lib/v1/openapi_client/api/ip_insights_api.py,sha256=oCmkRBxVMaVBzrBsA6BoumRl7PvhlyMJla-xYPHMxww,21817
13
- lib/v1/openapi_client/models/__init__.py,sha256=9VT3hqjFqoCePDx2FhQ2qHjG4dIUbzc8VkBWgsrPtyc,5314
14
- lib/v1/openapi_client/models/abuse_contact.py,sha256=MqF8oUU6hxU4vLXlC6ykcpJiZhjRw6EiJDfeDWYCBxQ,6560
15
- lib/v1/openapi_client/models/admin_contact.py,sha256=HOmd_CnYyKtOPR-mGL3hbMZ8E5_TKlBlFgMVZOvfGH8,6560
16
- lib/v1/openapi_client/models/analyze_email200_response.py,sha256=0YCuUfjKTB_J7FPCHeiPDG-bK5NMf-U-qFvGtQG6h-c,8043
17
- lib/v1/openapi_client/models/analyze_email400_response.py,sha256=BrhikNZYFE0L1SScOlmZKh1CQNsOWi8m8e1fOzG9nus,5843
18
- lib/v1/openapi_client/models/analyze_email400_response_error.py,sha256=oxfixZuiMnwbqRwdDzO7q4MKhQgVyFwxjOKdXpVLc_E,8391
19
- lib/v1/openapi_client/models/analyze_email500_response.py,sha256=gAKw0QyVwBZdr52qCrSbRA8kdtBcIn-oW83hvK411j0,5843
20
- lib/v1/openapi_client/models/analyze_email500_response_error.py,sha256=LuKvELP551F70uAKOnQ_0eVI9fK1V5RLdksgCMtTEwA,5615
21
- lib/v1/openapi_client/models/analyze_email_request.py,sha256=yzu8AV6wBKWhbBUO7GtsCuKgX_KYJAg9c8bIWjMPJc4,6063
22
- lib/v1/openapi_client/models/analyze_ip200_response.py,sha256=_8uU_YPLrwTc-Mth3keN7TlWkm7jCiIYi2i1UHzWySk,9143
23
- lib/v1/openapi_client/models/analyze_ip400_response.py,sha256=aLPWgDU-QbKLzTD1KzHna3VURVRfqwP5m8WM4GINZPM,5819
24
- lib/v1/openapi_client/models/analyze_ip400_response_error.py,sha256=X2wjsiTtaSWmC-zeKYgwtlQ-N_onhB3Fv2pvFhsOWmg,8486
25
- lib/v1/openapi_client/models/analyze_ip404_response.py,sha256=mzS98l1DlVKFCFaOmhBc9XjUA7DdGJSXDBmFuL8Yjyk,5748
26
- lib/v1/openapi_client/models/analyze_ip500_response.py,sha256=FPgWlfRyaFWGNk4xmh6UBiG_Xiys-i7IMZOWu2HoCY8,5768
27
- lib/v1/openapi_client/models/analyze_ip_request.py,sha256=SZHr8Gd0mRrziip0VH5bgPZu84JCXGKjTSOzO8iSczc,5741
28
- lib/v1/openapi_client/models/asn.py,sha256=_PtsmGJCAogM2DryLp5SuIgKZ_5H4zkLQvBcYV8-F90,6237
29
- lib/v1/openapi_client/models/block_listed.py,sha256=UK0LxB8cPQzr6RP18p1GfLiLyVNJqPdYYrJyuhQiwdU,6815
30
- lib/v1/openapi_client/models/email_dns.py,sha256=0Ttu0-pEQke0lnwkA4Tq8ZKvED6nRn6abSGkPqVEa24,5546
31
- lib/v1/openapi_client/models/geo.py,sha256=GtTV2s0pDguxBBCbkViNidTmFmRsxfMqMwbb0IWnYkQ,9879
32
- lib/v1/openapi_client/models/internalerror.py,sha256=_LhOiY2kPKsN_WDU7tVuY65A9-mNiamedWqJddWKRZQ,5555
33
- lib/v1/openapi_client/models/invalidemail.py,sha256=-ofiTmHw2O61p_hzzELf_wpa9zgi5FjV_Kc-duJFY-o,5551
34
- lib/v1/openapi_client/models/ipvalidationfailed.py,sha256=Clmw3EqB48h6mfhUzNnWvgO5IzfLq03pMbtWfzxD8xo,5575
35
- lib/v1/openapi_client/models/malformedrequest.py,sha256=gaOr0Bh_d_Fy0gstnQzurGUD6JAF_kk2fi7Y7PnitB0,5567
36
- lib/v1/openapi_client/models/malformedrequest1.py,sha256=PZ1e26zin5yhpjwnsuht8XNIHweURLb3n1NwR8rTvV8,5571
37
- lib/v1/openapi_client/models/notfound.py,sha256=HifW-VdCOp0mn5RQdeM6QVQR1kZc5PlENAik0b9SGDo,5535
38
- lib/v1/openapi_client/models/organization.py,sha256=IcJr7vJXyKwE9VjlWwJh1PeRar3_gQ4sNkvniMSLQzk,7130
39
- lib/v1/openapi_client/models/risk_report.py,sha256=ANg1NOURvS-2mXbU8lNHgAlTNuNUYw4NkF43TR5ujsc,9132
40
- lib/v1/openapi_client/models/tech_contact.py,sha256=AF9myIFacYEMknGN_gGrqjRn8_mpiI7Y_fGhp1wHWpE,6549
41
- lib/v1/openapi_client/models/trusted_provider.py,sha256=DI33v3eTc6fUhx5NqbjOE7ZpA2VcKbNLSV5MWqodGB0,6174
42
- lib/v1/openapi_client/models/whois.py,sha256=Yoo9QsUHPMjo9nwSR_H8ZHMhP2fYNRug3jBk3Do6vcw,8833
43
- src/__init__.py,sha256=b5dO5TZ0ac8L7meGstmpAzIWXS9jwPqV1EruY32dffk,139
44
- src/email_insights.py,sha256=i4NaYLZiJfXeHaNRZz3V15q8nsgGMcC37iBG5AaDj-Q,3283
45
- src/ip_insights.py,sha256=yaydXslmi5e_cSFCniJTFCWazE1Zw4K-ZlXiLxGbfkU,3008
46
- opportify_sdk-0.1.1.dist-info/METADATA,sha256=6bRgIBmdzuGi30ooeYSN51obEPgcVW-etXYZI7SwV8o,2459
47
- opportify_sdk-0.1.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
48
- opportify_sdk-0.1.1.dist-info/top_level.txt,sha256=4zVviOxxwoucHwO4Z7OzyNBMPn7vZjaTdyfvDO-OZfg,8
49
- opportify_sdk-0.1.1.dist-info/RECORD,,
@@ -1,2 +0,0 @@
1
- lib
2
- src
File without changes
File without changes