docs!: Code visualization for sendgrid-python

.codeboarding/Email Validation & Utilities.md

@@ -0,0 +1,102 @@
+```mermaid
+graph LR
+    Email_Validation_Utilities["Email Validation & Utilities"]
+    ContentBase["ContentBase"]
+    PlainTextContent["PlainTextContent"]
+    AmpHtmlContent["AmpHtmlContent"]
+    HtmlContent["HtmlContent"]
+    ApiKeyValidator["ApiKeyValidator"]
+    ApiKeyException["ApiKeyException"]
+    PlainTextContent -- "inherits from" --> ContentBase
+    AmpHtmlContent -- "inherits from" --> ContentBase
+    HtmlContent -- "inherits from" --> ContentBase
+    ContentBase -- "uses" --> ApiKeyValidator
+    PlainTextContent -- "uses" --> ApiKeyValidator
+    AmpHtmlContent -- "uses" --> ApiKeyValidator
+    HtmlContent -- "uses" --> ApiKeyValidator
+    ApiKeyValidator -- "raises" --> ApiKeyException
+```
+[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/GeneratedOnBoardings)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/demo)[![Contact](https://img.shields.io/badge/Contact%20us%20-%[email protected]?style=flat-square)](mailto:[email protected])
+
+## Component Details
+
+This system provides robust email content validation, primarily focusing on preventing the accidental inclusion of SendGrid API keys within email messages. It defines a base structure for various email content types (plain text, HTML, AMP HTML) and integrates a dedicated API key validation mechanism. The system ensures that all content, regardless of its type, is scanned for sensitive information before being processed, and raises a specific exception if an API key is detected, thereby enhancing security.
+
+### Email Validation & Utilities
+Provides utility functions for validating email message components, particularly to prevent sensitive information like API keys from being included in email content, and defines related exceptions.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/validators.py#L4-L69" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.validators.ValidateApiKey` (4:69)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/exceptions.py#L11-L65" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.exceptions.ApiKeyIncludedException` (11:65)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/mime_type.py#L1-L6" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.mime_type.MimeType` (1:6)</a>
+
+
+### ContentBase
+Provides the foundational structure and properties for various email content types, including MIME type and content value. It also integrates with the API key validation mechanism.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/content.py#L5-L81" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.content.Content` (5:81)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/content.py#L11-L27" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.content.Content:__init__` (11:27)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/content.py#L51-L56" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.content.Content:content` (51:56)</a>
+
+
+### PlainTextContent
+Represents plain text email content, inheriting from the ContentBase. It ensures that plain text content is validated for API keys before being set.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/plain_text_content.py#L5-L60" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.plain_text_content.PlainTextContent` (5:60)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/plain_text_content.py#L9-L19" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.plain_text_content.PlainTextContent:__init__` (9:19)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/plain_text_content.py#L30-L35" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.plain_text_content.PlainTextContent:content` (30:35)</a>
+
+
+### AmpHtmlContent
+Represents AMP HTML email content, inheriting from the ContentBase. It validates AMP HTML content for API keys.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/amp_html_content.py#L5-L59" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.amp_html_content.AmpHtmlContent` (5:59)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/amp_html_content.py#L8-L18" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.amp_html_content.AmpHtmlContent:__init__` (8:18)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/amp_html_content.py#L29-L34" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.amp_html_content.AmpHtmlContent:content` (29:34)</a>
+
+
+### HtmlContent
+Represents standard HTML email content, inheriting from the ContentBase. It validates HTML content for API keys.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/html_content.py#L5-L59" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.html_content.HtmlContent` (5:59)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/html_content.py#L8-L18" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.html_content.HtmlContent:__init__` (8:18)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/html_content.py#L29-L34" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.html_content.HtmlContent:content` (29:34)</a>
+
+
+### ApiKeyValidator
+Responsible for scanning email content (both dictionary and string formats) to detect and prevent the accidental inclusion of SendGrid API keys, raising an exception if found.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/validators.py#L4-L69" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.validators.ValidateApiKey` (4:69)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/validators.py#L30-L55" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.validators.ValidateApiKey:validate_message_dict` (30:55)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/validators.py#L57-L69" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.validators.ValidateApiKey:validate_message_text` (57:69)</a>
+
+
+### ApiKeyException
+Defines the specific exception raised when a SendGrid API key is detected within the email content during validation.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/mail/exceptions.py#L11-L65" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.mail.exceptions.ApiKeyIncludedException` (11:65)</a>
+
+
+
+
+### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)

.codeboarding/Event Webhook Handling.md

@@ -0,0 +1,35 @@
+```mermaid
+graph LR
+    EventWebhook_Handler["EventWebhook Handler"]
+    Webhook_Header_Constants["Webhook Header Constants"]
+    EventWebhook_Handler -- "relies on" --> Webhook_Header_Constants
+```
+[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/GeneratedOnBoardings)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/demo)[![Contact](https://img.shields.io/badge/Contact%20us%20-%[email protected]?style=flat-square)](mailto:[email protected])
+
+## Component Details
+
+This subsystem is responsible for handling incoming SendGrid event webhooks. Its primary function is to verify the authenticity of these webhooks by converting public keys to ECDSA format and using predefined header constants for signature and timestamp validation, ensuring that only legitimate event data is processed.
+
+### EventWebhook Handler
+Manages the processing of SendGrid event webhooks, including the necessary public key conversion for signature verification to ensure webhook authenticity.
+
+
+**Related Classes/Methods**:
+
+- `sendgrid.helpers.eventwebhook.EventWebhook` (full file reference)
+- `sendgrid.helpers.eventwebhook.EventWebhook:__init__` (full file reference)
+- `sendgrid.helpers.eventwebhook.EventWebhook.convert_public_key_to_ecdsa` (full file reference)
+
+
+### Webhook Header Constants
+Defines constant string values for HTTP headers expected in SendGrid event webhooks, such as the signature and timestamp headers. These constants are used by other components, like the EventWebhook Handler, to correctly identify and extract information from webhook requests.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/eventwebhook/eventwebhook_header.py#L1-L10" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.eventwebhook.eventwebhook_header.EventWebhookHeader` (1:10)</a>
+
+
+
+
+### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)

.codeboarding/IP Endpoint Utilities.md

@@ -0,0 +1,33 @@
+```mermaid
+graph LR
+    IP_Unassigned_Processor["IP Unassigned Processor"]
+    Return_Data_Formatter["Return Data Formatter"]
+    IP_Unassigned_Processor -- "invokes" --> Return_Data_Formatter
+```
+[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/GeneratedOnBoardings)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/demo)[![Contact](https://img.shields.io/badge/Contact%20us%20-%[email protected]?style=flat-square)](mailto:[email protected])
+
+## Component Details
+
+This subsystem is responsible for identifying and formatting unassigned IP addresses from a given dataset. The main flow involves processing IP data to find IPs without subusers, and then formatting these unassigned IPs into a structured output, either as a list of dictionaries or a JSON object.
+
+### IP Unassigned Processor
+This component is responsible for processing a list of IP addresses and identifying those that have no subusers assigned. It takes raw IP data as input and prepares a set of unassigned IPs for further formatting.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/endpoints/ip/unassigned.py#L18-L59" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.endpoints.ip.unassigned:unassigned` (18:59)</a>
+
+
+### Return Data Formatter
+This component handles the formatting of a set of IP addresses into a structured output, either as a list of dictionaries or a JSON object. It serves as a utility to standardize the return type for IP-related data.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/endpoints/ip/unassigned.py#L4-L15" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.endpoints.ip.unassigned:format_ret` (4:15)</a>
+
+
+
+
+### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)

.codeboarding/Inbound Email Processing.md

@@ -0,0 +1,53 @@
+```mermaid
+graph LR
+    InboundParseDataParser["InboundParseDataParser"]
+    ConfigurationManagement["ConfigurationManagement"]
+    TestPayloadSender["TestPayloadSender"]
+    InboundParseDataParser -- "uses configuration from" --> ConfigurationManagement
+    TestPayloadSender -- "retrieves configuration from" --> ConfigurationManagement
+    TestPayloadSender -- "simulates input for" --> InboundParseDataParser
+```
+[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/GeneratedOnBoardings)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/demo)[![Contact](https://img.shields.io/badge/Contact%20us%20-%[email protected]?style=flat-square)](mailto:[email protected])
+
+## Component Details
+
+The Inbound Email Processing subsystem is designed to handle and parse incoming emails received via SendGrid's Inbound Parse webhook. It leverages a Configuration Management component to load necessary settings, such as parsing keys and environment variables. The core parsing functionality is provided by the Inbound Parse Data Parser, which extracts key-value pairs and decodes attachments from the incoming payload. A Test Payload Sender component is also included to facilitate the simulation of inbound parse webhooks for testing purposes, utilizing the same configuration settings.
+
+### InboundParseDataParser
+This component is responsible for parsing incoming data from SendGrid's Inbound Parse webhook. It extracts key-value pairs from the payload and specifically handles the extraction and decoding of attachments, supporting both standard multipart form data and raw email formats.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/parse.py#L9-L100" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.parse.Parse` (9:100)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/parse.py#L40-L52" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.parse.Parse:attachments` (40:52)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/parse.py#L54-L64" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.parse.Parse._get_attachments` (54:64)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/parse.py#L29-L38" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.parse.Parse.get_raw_email` (29:38)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/parse.py#L66-L84" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.parse.Parse._get_attachments_raw` (66:84)</a>
+
+
+### ConfigurationManagement
+This component is responsible for loading configuration settings for the application. It initializes environment variables from a .env file and loads application-specific settings from config.yml, providing access to properties like debug mode, endpoint, host, keys, and port.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/config.py#L6-L65" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.config.Config` (6:65)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/config.py#L9-L24" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.config.Config:__init__` (9:24)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/config.py#L27-L38" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.config.Config.init_environment` (27:38)</a>
+
+
+### TestPayloadSender
+This component facilitates sending test payloads to a specified URL, simulating an inbound parse webhook. It handles the creation of HTTP requests with appropriate headers and data, and reports the response status, headers, and body.
+
+
+**Related Classes/Methods**:
+
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/send.py#L14-L38" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.send.Send` (14:38)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/send.py#L41-L57" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.send:main` (41:57)</a>
+- <a href="https://github.com/sendgrid/sendgrid-python/blob/master/sendgrid/helpers/inbound/send.py#L20-L33" target="_blank" rel="noopener noreferrer">`sendgrid.helpers.inbound.send.Send.test_payload` (20:33)</a>
+
+
+
+
+### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)