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
@@ -0,0 +1,86 @@
1
+ # coding: utf-8
2
+
3
+ # flake8: noqa
4
+
5
+ """
6
+ Opportify Insights API
7
+
8
+ ## 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.
9
+
10
+ The version of the OpenAPI document: 1.0.0
11
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
12
+
13
+ Do not edit the class manually.
14
+ """ # noqa: E501
15
+
16
+
17
+ __version__ = "1.0.0"
18
+
19
+ # import apis into sdk package
20
+ from openapi_client.api.email_insights_api import EmailInsightsApi
21
+ from openapi_client.api.ip_insights_api import IPInsightsApi
22
+
23
+ # import ApiClient
24
+ from openapi_client.api_response import ApiResponse
25
+ from openapi_client.api_client import ApiClient
26
+ from openapi_client.configuration import Configuration
27
+ from openapi_client.exceptions import OpenApiException
28
+ from openapi_client.exceptions import ApiTypeError
29
+ from openapi_client.exceptions import ApiValueError
30
+ from openapi_client.exceptions import ApiKeyError
31
+ from openapi_client.exceptions import ApiAttributeError
32
+ from openapi_client.exceptions import ApiException
33
+
34
+ # import models into sdk package
35
+ from openapi_client.models.abuse_contact import AbuseContact
36
+ from openapi_client.models.admin_contact import AdminContact
37
+ from openapi_client.models.analyze_email200_response import AnalyzeEmail200Response
38
+ from openapi_client.models.analyze_email400_response import AnalyzeEmail400Response
39
+ from openapi_client.models.analyze_email400_response_error import AnalyzeEmail400ResponseError
40
+ from openapi_client.models.analyze_email403_response import AnalyzeEmail403Response
41
+ from openapi_client.models.analyze_email403_response_error import AnalyzeEmail403ResponseError
42
+ from openapi_client.models.analyze_email500_response import AnalyzeEmail500Response
43
+ from openapi_client.models.analyze_email500_response_error import AnalyzeEmail500ResponseError
44
+ from openapi_client.models.analyze_email_request import AnalyzeEmailRequest
45
+ from openapi_client.models.analyze_ip200_response import AnalyzeIp200Response
46
+ from openapi_client.models.analyze_ip400_response import AnalyzeIp400Response
47
+ from openapi_client.models.analyze_ip400_response_error import AnalyzeIp400ResponseError
48
+ from openapi_client.models.analyze_ip404_response import AnalyzeIp404Response
49
+ from openapi_client.models.analyze_ip500_response import AnalyzeIp500Response
50
+ from openapi_client.models.analyze_ip_request import AnalyzeIpRequest
51
+ from openapi_client.models.asn import Asn
52
+ from openapi_client.models.batch_analyze_emails202_response import BatchAnalyzeEmails202Response
53
+ from openapi_client.models.batch_analyze_emails400_response import BatchAnalyzeEmails400Response
54
+ from openapi_client.models.batch_analyze_emails400_response_error import BatchAnalyzeEmails400ResponseError
55
+ from openapi_client.models.batch_analyze_emails403_response import BatchAnalyzeEmails403Response
56
+ from openapi_client.models.batch_analyze_emails403_response_error import BatchAnalyzeEmails403ResponseError
57
+ from openapi_client.models.batch_analyze_emails413_response import BatchAnalyzeEmails413Response
58
+ from openapi_client.models.batch_analyze_emails413_response_error import BatchAnalyzeEmails413ResponseError
59
+ from openapi_client.models.batch_analyze_emails_request import BatchAnalyzeEmailsRequest
60
+ from openapi_client.models.batch_analyze_ips400_response import BatchAnalyzeIps400Response
61
+ from openapi_client.models.batch_analyze_ips400_response_error import BatchAnalyzeIps400ResponseError
62
+ from openapi_client.models.batch_analyze_ips_request import BatchAnalyzeIpsRequest
63
+ from openapi_client.models.block_listed import BlockListed
64
+ from openapi_client.models.email_dns import EmailDNS
65
+ from openapi_client.models.geo import Geo
66
+ from openapi_client.models.get_email_batch_status200_response import GetEmailBatchStatus200Response
67
+ from openapi_client.models.get_email_batch_status200_response_download_urls import GetEmailBatchStatus200ResponseDownloadUrls
68
+ from openapi_client.models.get_email_batch_status404_response import GetEmailBatchStatus404Response
69
+ from openapi_client.models.get_email_batch_status404_response_error import GetEmailBatchStatus404ResponseError
70
+ from openapi_client.models.internalerror import INTERNALERROR
71
+ from openapi_client.models.invaliddata import INVALIDDATA
72
+ from openapi_client.models.invaliddata1 import INVALIDDATA1
73
+ from openapi_client.models.invalidemail import INVALIDEMAIL
74
+ from openapi_client.models.invalidplan import INVALIDPLAN
75
+ from openapi_client.models.invalidtoken import INVALIDTOKEN
76
+ from openapi_client.models.ipvalidationfailed import IPVALIDATIONFAILED
77
+ from openapi_client.models.malformedrequest import MALFORMEDREQUEST
78
+ from openapi_client.models.malformedrequest1 import MALFORMEDREQUEST1
79
+ from openapi_client.models.malformedrequest2 import MALFORMEDREQUEST2
80
+ from openapi_client.models.notfound import NOTFOUND
81
+ from openapi_client.models.organization import Organization
82
+ from openapi_client.models.risk_report_email import RiskReportEmail
83
+ from openapi_client.models.risk_report_ip import RiskReportIp
84
+ from openapi_client.models.tech_contact import TechContact
85
+ from openapi_client.models.trusted_provider import TrustedProvider
86
+ from openapi_client.models.whois import Whois