Updating documentation

Author: ryan-lydz

socketlabs/injectionapi/core/sendvalidator.py

@@ -55,7 +55,9 @@ def has_subject(message: MessageBase):
 
 def has_message_body(message: MessageBase):
     """
-    Check if the message has a valid From Email Address
+    Check if the message has a Message Body.
+    If an Api Template is specified it will override the HtmlBody, AmpBody, and/or the textBody.
+    If no Api Template is specified the HtmlBody, AmpBody, and/or the textBody must be set
     :param message: message to validate
     :type message: MessageBase
     :return the result

socketlabs/injectionapi/message/basicmessage.py

@@ -182,6 +182,7 @@ def subject(self, val: str):
     def plain_text_body(self):
         """
         Get the plain text portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :return the plain text body
         :rtype str
         """
@@ -191,6 +192,7 @@ def plain_text_body(self):
     def plain_text_body(self, val: str):
         """
         Set the plain text portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :param val: the plain text body
         :type val: str
         """
@@ -200,6 +202,7 @@ def plain_text_body(self, val: str):
     def html_body(self):
         """
         Get the HTML portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :return the HTML body
         :rtype str
         """
@@ -209,6 +212,7 @@ def html_body(self):
     def html_body(self, val: str):
         """
         Set the HTML portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :param val: the HTML body
         :type val: str
         """
@@ -218,6 +222,7 @@ def html_body(self, val: str):
     def amp_body(self):
         """
         Get the AMP portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :return the AMP body
         :rtype str
         """
@@ -227,6 +232,7 @@ def amp_body(self):
     def amp_body(self, val: str):
         """
         Set the AMP portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :param val: the AMP body
         :type val: str
         """
@@ -236,6 +242,7 @@ def amp_body(self, val: str):
     def api_template(self):
         """
         Get the api template.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :return the api template
         :rtype str
         """
@@ -245,6 +252,7 @@ def api_template(self):
     def api_template(self, val: str):
         """
         Set the api template.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :param val: the api template
         :rtype str
         """

socketlabs/injectionapi/message/bulkmessage.py

@@ -143,6 +143,7 @@ def subject(self, val: str):
     def plain_text_body(self):
         """
         Get the plain text portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :return the plain text body
         :rtype str
         """
@@ -152,6 +153,7 @@ def plain_text_body(self):
     def plain_text_body(self, val: str):
         """
         Set the plain text portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :param val: the plain text body
         :type val: str
         """
@@ -161,6 +163,7 @@ def plain_text_body(self, val: str):
     def html_body(self):
         """
         Get the HTML portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :return the HTML body
         :rtype str
         """
@@ -170,6 +173,7 @@ def html_body(self):
     def html_body(self, val: str):
         """
         Set the HTML portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :param val: the HTML body
         :type val: str
         """
@@ -179,6 +183,7 @@ def html_body(self, val: str):
     def amp_body(self):
         """
         Get the AMP portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :return the AMP body
         :rtype str
         """
@@ -188,6 +193,7 @@ def amp_body(self):
     def amp_body(self, val: str):
         """
         Set the AMP portion of the message body.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :param val: the AMP body
         :type val: str
         """
@@ -197,6 +203,7 @@ def amp_body(self, val: str):
     def api_template(self):
         """
         Get the api template.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :return the api template
         :rtype str
         """
@@ -206,6 +213,7 @@ def api_template(self):
     def api_template(self, val: str):
         """
         Set the api template.
+        (Optional) Either TextBody or HtmlBody must be used with the AmpBody or use a ApiTemplate
         :param val: the api template
         :rtype str
         """

socketlabs/injectionapi/version.py

@@ -1,2 +1,2 @@
-version_info = (1, 0, 1)
+version_info = (1, 1, 0)
 __version__ = '.'.join(str(v) for v in version_info)