about summary refs log tree commit diff
path: root/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/subscription_tracking.py
diff options
context:
space:
mode:
authorS. Solomon Darnell2025-03-28 21:52:21 -0500
committerS. Solomon Darnell2025-03-28 21:52:21 -0500
commit4a52a71956a8d46fcb7294ac71734504bb09bcc2 (patch)
treeee3dc5af3b6313e921cd920906356f5d4febc4ed /.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/subscription_tracking.py
parentcc961e04ba734dd72309fb548a2f97d67d578813 (diff)
downloadgn-ai-master.tar.gz
two version of R2R are here HEAD master
Diffstat (limited to '.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/subscription_tracking.py')
-rw-r--r--.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/subscription_tracking.py142
1 files changed, 142 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/subscription_tracking.py b/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/subscription_tracking.py
new file mode 100644
index 00000000..8db65372
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/sendgrid/helpers/mail/subscription_tracking.py
@@ -0,0 +1,142 @@
+class SubscriptionTracking(object):
+    """Allows you to insert a subscription management link at the bottom of the
+    text and html bodies of your email. If you would like to specify the
+    location of the link within your email, you may use the substitution_tag.
+    """
+
+    def __init__(
+            self, enable=None, text=None, html=None, substitution_tag=None):
+        """Create a SubscriptionTracking to customize subscription management.
+
+        :param enable: Whether this setting is enabled.
+        :type enable: boolean, optional
+        :param text: Text to be appended to the email with the link as "<% %>".
+        :type text: SubscriptionText, optional
+        :param html: HTML to be appended to the email with the link as "<% %>".
+        :type html: SubscriptionHtml, optional
+        :param substitution_tag: Tag replaced with URL. Overrides text, html
+                                 params.
+        :type substitution_tag: SubscriptionSubstitutionTag, optional
+        """
+        self._enable = None
+        self._text = None
+        self._html = None
+        self._substitution_tag = None
+
+        if enable is not None:
+            self.enable = enable
+        if text is not None:
+            self.text = text
+        if html is not None:
+            self.html = html
+        if substitution_tag is not None:
+            self.substitution_tag = substitution_tag
+
+    @property
+    def enable(self):
+        """Indicates if this setting is enabled.
+
+        :rtype: boolean
+        """
+        return self._enable
+
+    @enable.setter
+    def enable(self, value):
+        """Indicates if this setting is enabled.
+
+        :param value: Indicates if this setting is enabled.
+        :type value: boolean
+        """
+        self._enable = value
+
+    @property
+    def text(self):
+        """Text to be appended to the email, with the subscription tracking
+        link. You may control where the link is by using the tag <% %>
+
+        :rtype: string
+        """
+        return self._text
+
+    @text.setter
+    def text(self, value):
+        """Text to be appended to the email, with the subscription tracking
+        link. You may control where the link is by using the tag <% %>
+
+        :param value: Text to be appended to the email, with the subscription
+                      tracking link. You may control where the link is by
+                      using the tag <% %>
+        :type value: string
+        """
+        self._text = value
+
+    @property
+    def html(self):
+        """HTML to be appended to the email, with the subscription tracking
+        link. You may control where the link is by using the tag <% %>
+
+        :rtype: string
+        """
+        return self._html
+
+    @html.setter
+    def html(self, value):
+        """HTML to be appended to the email, with the subscription tracking
+        link. You may control where the link is by using the tag <% %>
+
+        :param value: HTML to be appended to the email, with the subscription
+                      tracking link. You may control where the link is by
+                      using the tag <% %>
+        :type value: string
+        """
+        self._html = value
+
+    @property
+    def substitution_tag(self):
+        """"A tag that will be replaced with the unsubscribe URL. for example:
+        [unsubscribe_url]. If this parameter is used, it will override both the
+        `text` and `html` parameters. The URL of the link will be placed at the
+        substitution tag's location, with no additional formatting.
+
+        :rtype: string
+        """
+        return self._substitution_tag
+
+    @substitution_tag.setter
+    def substitution_tag(self, value):
+        """"A tag that will be replaced with the unsubscribe URL. for example:
+        [unsubscribe_url]. If this parameter is used, it will override both the
+        `text` and `html` parameters. The URL of the link will be placed at the
+        substitution tag's location, with no additional formatting.
+
+        :param value: A tag that will be replaced with the unsubscribe URL.
+                      For example: [unsubscribe_url]. If this parameter is
+                      used, it will override both the `text` and `html`
+                      parameters. The URL of the link will be placed at the
+                      substitution tag's location, with no additional
+                      formatting.
+        :type value: string
+        """
+        self._substitution_tag = value
+
+    def get(self):
+        """
+        Get a JSON-ready representation of this SubscriptionTracking.
+
+        :returns: This SubscriptionTracking, ready for use in a request body.
+        :rtype: dict
+        """
+        subscription_tracking = {}
+        if self.enable is not None:
+            subscription_tracking["enable"] = self.enable
+
+        if self.text is not None:
+            subscription_tracking["text"] = self.text.get()
+
+        if self.html is not None:
+            subscription_tracking["html"] = self.html.get()
+
+        if self.substitution_tag is not None:
+            subscription_tracking["substitution_tag"] = \
+                self.substitution_tag.get()
+        return subscription_tracking