[OSDEV-1721] SLC. Customer Comms for SLC workflow

doc/release/RELEASE-NOTES.md

@@ -31,7 +31,11 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 * [OSDEV-1778](https://opensupplyhub.atlassian.net/browse/OSDEV-1778) - Fixed the validation for number of workers field in POST, PATCH production locations API. The min field must be less than or equal to the max field.
 
 ### What's new
-* *Describe what's new here. The changes that can impact user experience should be listed in this section.*
+* [OSDEV-1721](https://opensupplyhub.atlassian.net/browse/OSDEV-1721) - Added new email templates for Moderation/SLC workflow:
+    * Email #1 SLC additional contribution to existing production location - Pending moderation.
+    * Email #2 SLC contribution - Moderation complete. APPROVED.
+    * Email #3 SLC contribution - Moderation complete. REJECTED.
+    * Email #4 SLC new production location contribution - Pending moderation.
 
 ### Release instructions:
 * Ensure that the following commands are included in the `post_deployment` command:

src/django/api/mail.py

@@ -35,6 +35,23 @@ def make_claimed_url(request):
     return '{}/claimed'.format(make_oar_url(request))
 
 
+def make_pl_search_url(request):
+    return (
+        "{}/contribute/single-location".format(
+            make_oar_url(request)
+        )
+    )
+
+
+def make_pl_claim_url(request, facility):
+    return (
+        "{}/facilities/{}/claim".format(
+            make_oar_url(request),
+            facility.id,
+        )
+    )
+
+
 def send_claim_facility_confirmation_email(request, facility_claim):
     subj_template = get_template('mail/claim_facility_submitted_subject.txt')
     text_template = get_template('mail/claim_facility_submitted_body.txt')
@@ -408,3 +425,127 @@ def send_facility_list_rejection_email(request, facility_list):
         [facility_list.source.contributor.admin.email],
         html_message=html_template.render(denial_dictionary)
     )
+
+
+def send_slc_additional_info_confirmation_email(moderation_event):
+    subj_template = get_template(
+        'mail/slc_additional_info_confirmation_subject.txt'
+    )
+    text_template = get_template(
+        'mail/slc_additional_info_confirmation_body.txt'
+    )
+    html_template = get_template(
+        'mail/slc_additional_info_confirmation_body.html'
+    )
+
+    additional_info_dictionary = {
+        'pl_name': moderation_event.cleaned_data.get("name", ''),
+        'pl_address': moderation_event.cleaned_data.get("address", ''),
+        'pl_country': (
+            moderation_event.cleaned_data.get("country_code", '')
+        ),
+    }
+
+    send_mail(
+        subj_template.render().rstrip(),
+        text_template.render(additional_info_dictionary),
+        settings.DEFAULT_FROM_EMAIL,
+        [moderation_event.contributor.admin.email],
+        html_message=html_template.render(additional_info_dictionary)
+    )
+
+
+def send_slc_new_location_confirmation_email(moderation_event):
+    subj_template = get_template(
+        'mail/slc_new_location_confirmation_subject.txt'
+    )
+    text_template = get_template(
+        'mail/slc_new_location_confirmation_body.txt'
+    )
+    html_template = get_template(
+        'mail/slc_new_location_confirmation_body.html'
+    )
+
+    send_mail(
+        subj_template.render().rstrip(),
+        text_template.render(),
+        settings.DEFAULT_FROM_EMAIL,
+        [moderation_event.contributor.admin.email],
+        html_message=html_template.render()
+    )
+
+
+def send_slc_contribution_approval_email(
+    request,
+    moderation_event,
+    facility_list_item
+):
+    subj_template = get_template(
+        'mail/slc_contribution_approval_subject.txt'
+    )
+    text_template = get_template(
+        'mail/slc_contribution_approval_body.txt'
+    )
+    html_template = get_template(
+        'mail/slc_contribution_approval_body.html'
+    )
+
+    approval_dictionary = {
+        'is_claimed': moderation_event.claim is not None,
+        'pl_claim_url': make_pl_claim_url(
+            request,
+            facility_list_item.facility
+        ),
+        'os_id': facility_list_item.facility.id,
+        'location_url': make_facility_url(
+            request,
+            facility_list_item.facility
+        ),
+    }
+
+    send_mail(
+        subj_template.render().rstrip(),
+        text_template.render(approval_dictionary),
+        settings.DEFAULT_FROM_EMAIL,
+        [moderation_event.contributor.admin.email],
+        html_message=html_template.render(approval_dictionary)
+    )
+
+
+def send_slc_contribution_rejected_email(request, moderation_event):
+    subj_template = get_template(
+        'mail/slc_contribution_rejected_subject.txt'
+    )
+    text_template = get_template(
+        'mail/slc_contribution_rejected_body.txt'
+    )
+    html_template = get_template(
+        'mail/slc_contribution_rejected_body.html'
+    )
+
+    rejected_dictionary = {
+        'action_reason_text_cleaned': getattr(
+            moderation_event,
+            "action_reason_text_cleaned",
+            None
+        ),
+        'action_reason_text_raw': getattr(
+            moderation_event,
+            "action_reason_text_raw",
+            None
+        ),
+        'pl_search_url': make_pl_search_url(request),
+        'pl_name': moderation_event.cleaned_data.get("name", ''),
+        'pl_address': moderation_event.cleaned_data.get("address", ''),
+        'pl_country': (
+            moderation_event.cleaned_data.get("country_code", '')
+        ),
+    }
+
+    send_mail(
+        subj_template.render().rstrip(),
+        text_template.render(rejected_dictionary),
+        settings.DEFAULT_FROM_EMAIL,
+        [moderation_event.contributor.admin.email],
+        html_message=html_template.render(rejected_dictionary)
+    )

src/django/api/templates/mail/slc_additional_info_confirmation_body.html

@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <title>
+            Thank You for Your Submission – It Is Now Being Reviewed
+        </title>
+    </head>
+    <body>
+        <p>Hello,</p>
+        <p>
+            Thank you for submitting your production location information to <a href="https://info.opensupplyhub.org/">Open Supply Hub</a> (OS Hub)!
+        </p>
+        <p>
+            Our team is now reviewing your submission to ensure it can be assigned an <a href="https://info.opensupplyhub.org/resources/a-free-universal-id-matching-algorithm">OS ID</a>. This
+            process may take up to 15 business days.
+        </p>
+        <p>
+            Once the review is complete, you will receive an email confirming your OS ID. If we need any
+            additional information, we will contact you at this email address.
+        </p>
+        <p>
+            <b>Here are the details of your submission:</b>
+        </p>
+        <ul>
+            <li>Production Location Name: {{ pl_name }}</li>
+            <li>Production Location Address: {{ pl_address }}</li>
+            <li>Production Location Country: {{ pl_country }}</li>
+        </ul>
+        <p>
+            <b>If you have also requested to <a href="https://info.opensupplyhub.org/resources/claim-a-facility">claim this location</a>:</b> After your OS ID is confirmed, we will
+            review the documents you submitted to claim the location and either approve or deny the claim.
+            You will also receive an email when this stage is complete.
+        </p>
+        <p>
+            Thank you for sharing your information! Your data helps open doors to safe and sustainable
+            supply chains.
+        </p>
+        <p>Best Regards,</p>
+        {% include "mail/signature_block.html" %}
+    </body>
+</html>

src/django/api/templates/mail/slc_additional_info_confirmation_body.txt

@@ -0,0 +1,27 @@
+{% block content %}
+Hello,
+
+Thank you for submitting your production location information to Open Supply Hub (https://info.opensupplyhub.org/) (OS Hub)!
+
+Our team is now reviewing your submission to ensure it can be assigned an OS ID.
+This process may take up to 15 business days.
+
+Once the review is complete, you will receive an email confirming your OS ID (https://info.opensupplyhub.org/resources/a-free-universal-id-matching-algorithm).
+If we need any additional information, we will contact you at this email address.
+
+Here are the details of your submission:
+- Production Location Name: {{ pl_name }}
+- Production Location Address: {{ pl_address }}
+- Production Location Country: {{ pl_country }}
+
+If you have also requested to claim this location (https://info.opensupplyhub.org/resources/claim-a-facility): After your OS ID is confirmed, we will
+review the documents you submitted to claim the location and either approve or deny the claim.
+You will also receive an email when this stage is complete.
+
+Thank you for sharing your information! Your data helps open doors to safe and sustainable
+supply chains.
+
+Best Regards,
+
+{% include "mail/signature_block.txt" %}
+{% endblock content %}

src/django/api/templates/mail/slc_additional_info_confirmation_subject.txt

@@ -0,0 +1 @@
+Thank You for Your Submission – It Is Now Being Reviewed

src/django/api/templates/mail/slc_contribution_approval_body.html

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>
+      Great News: your OS ID is ready!
+    </title>
+  </head>
+  <body>
+    <p>
+      Hello,
+    </p>
+    <p>
+      Thank you for submitting your production location information to <a href="https://info.opensupplyhub.org/">Open Supply Hub</a> (OS Hub)!
+    </p>
+    <p>
+      You can now:
+    </p>
+    <ol>
+      <li>
+        <p>
+          <b>Save your OS ID and the public link</b> to your production location profile and share it
+          with clients and stakeholders:
+        </p>
+        <ul>
+          <li>OS ID: {{ os_id }}</li>
+          <li>Public link: {{ location_url }}</li>
+        </ul>
+      </li>
+      {% if not is_claimed %}
+      <li>
+        <p>
+          <b>Claim your production location</b> to take control of
+          your data and make it visible to more global partners. It’s free and only takes a few
+          steps! <b><a href="{{ pl_claim_url }}">Claim my production location now</a></b>.
+        </p>
+      </li>
+      {% endif %}
+      <li>
+        <p>
+          <b>Learn more about the OS ID</b> and how to use it to advance your business
+          in this <a href="https://info.opensupplyhub.org/facilities">Guide for Facilities</a>.
+        </p>
+      </li>
+    </ol>
+    {% if is_claimed %}
+    <p>
+      <b>We will now review the documents you submitted to <a href="https://info.opensupplyhub.org/resources/claim-a-facility">claim the location</a>
+      and either approve or deny the claim.</b> Review of claims typically takes 7 - 10 business days.
+      You will receive another email when this stage is complete.
+    </p>
+    {% endif %}
+    <p>
+      Thank you for sharing your information! Your data helps open doors to safe and sustainable
+      supply chains.
+    </p>
+    {% include "mail/signature_block.html" %}
+  </body>
+</html>

src/django/api/templates/mail/slc_contribution_approval_body.txt

@@ -0,0 +1,32 @@
+{% block content %}
+Hello,
+
+Thank you for submitting your production location information to Open Supply Hub (https://info.opensupplyhub.org/) (OS Hub)!
+
+You can now:
+1. Save your OS ID and the public link to your production location profile and share it
+with clients and stakeholders:
+    - OS ID: {{ os_id }}
+    - Public link: {{ location_url }}
+{% if not is_claimed %}
+2. Claim your production location to take control of
+your data and make it visible to more global partners. It’s free and only takes a few
+steps! Claim my production location now ({{ pl_claim_url }}).
+3. Learn more about the OS ID and how to use it to advance your business in this Guide for Facilities (https://info.opensupplyhub.org/facilities).
+{% else %}
+2. Learn more about the OS ID and how to use it to advance your business in this Guide for Facilities (https://info.opensupplyhub.org/facilities).
+{% endif %}
+
+{% if is_claimed %}
+We will now review the documents you submitted to claim the location (https://info.opensupplyhub.org/resources/claim-a-facility)
+and either approve or deny the claim. Review of claims typically takes 7 - 10 business days.
+You will receive another email when this stage is complete.
+{% endif %}
+
+Thank you for sharing your information! Your data helps open doors to safe and sustainable
+supply chains.
+
+Best Regards,
+
+{% include "mail/signature_block.txt" %}
+{% endblock content %}

src/django/api/templates/mail/slc_contribution_approval_subject.txt

@@ -0,0 +1 @@
+Great News: your OS ID is ready!

src/django/api/templates/mail/slc_contribution_rejected_body.html

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>
+      ACTION REQUESTED: We need more information to process your submission and provide an OS ID
+    </title>
+  </head>
+  <body>
+    <p>
+      Hello,
+    </p>
+    <p>
+      Thank you for submitting your production location information to <a href="https://info.opensupplyhub.org/">Open Supply Hub</a> (OS Hub)!
+    </p>
+    <p>
+      We weren’t able to accept your submission as provided.
+      To move forward and get an OS ID, please follow these steps:
+    </p>
+    <ol>
+      <li>
+        <p>
+          <b>Review the feedback below:</b>
+        </p>
+        <ul>
+          <li>{{ action_reason_text_raw }}</li>
+        </ul>
+      </li>
+      <li>
+        <p>
+          <b>Make the necessary updates</b> based on the feedback and <b>resubmit your information</b>
+          using this link: <b><a href="{{ pl_search_url }}">Resubmit Your Production Location</a></b>
+        </p>
+      </li>
+    </ol>
+    <p>
+      <b>Here are the details of your submission:</b>
+    </p>
+    <ul>
+      <li>Production Location Name: {{ pl_name }}</li>
+      <li>Production Location Address: {{ pl_address }}</li>
+      <li>Production Location Country: {{ pl_country }}</li>
+    </ul>
+    <p>
+      Thank you for sharing your information! Your data helps open doors to safe and sustainable
+      supply chains.
+    </p>
+    <p>Best Regards,</p>
+    {% include "mail/signature_block.html" %}
+  </body>
+</html>