PROD-2058 implement endpoints for property specific messaging

src/fides/api/api/v1/endpoints/messaging_endpoints.py

@@ -21,41 +21,58 @@
 from fides.api.common_exceptions import (
     MessageDispatchException,
     MessagingConfigNotFoundException,
+    EmailTemplateNotFoundException,
+    MessagingTemplateValidationException,
 )
 from fides.api.models.messaging import (
     MessagingConfig,
     default_messaging_config_key,
     default_messaging_config_name,
     get_schema_for_secrets,
 )
-from fides.api.models.messaging_template import DEFAULT_MESSAGING_TEMPLATES
+from fides.api.models.messaging_template import (
+    DEFAULT_MESSAGING_TEMPLATES,
+    MessagingTemplate,
+)
 from fides.api.oauth.utils import verify_oauth_client
 from fides.api.schemas.api import BulkUpdateFailed
 from fides.api.schemas.messaging.messaging import (
-    BulkPutMessagingTemplateResponse,
+    BulkPutBasicMessagingTemplateResponse,
     MessagingActionType,
     MessagingConfigRequest,
     MessagingConfigRequestBase,
     MessagingConfigResponse,
     MessagingConfigStatus,
     MessagingConfigStatusMessage,
     MessagingServiceType,
-    MessagingTemplateRequest,
-    MessagingTemplateResponse,
+    BasicMessagingTemplateRequest,
+    BasicMessagingTemplateResponse,
     TestMessagingStatusMessage,
+    MessagingTemplateWithPropertiesSummary,
+    MessagingTemplateWithPropertiesDetail,
+    MessagingTemplateWithPropertiesBodyParams,
+    MessagingTemplateDefault,
+    MessagingTemplateWithPropertiesPatchBodyParams,
 )
 from fides.api.schemas.messaging.messaging_secrets_docs_only import (
     possible_messaging_secrets,
 )
 from fides.api.schemas.redis_cache import Identity
 from fides.api.service.messaging.message_dispatch_service import dispatch_message
 from fides.api.service.messaging.messaging_crud_service import (
-    create_or_update_basic_templates,
     create_or_update_messaging_config,
     delete_messaging_config,
     get_all_basic_messaging_templates,
     get_messaging_config_by_key,
     update_messaging_config,
+    create_or_update_basic_templates,
+    get_default_template_by_type,
+    create_property_specific_template_by_type,
+    get_template_by_id,
+    update_property_specific_template,
+    delete_template_by_id,
+    save_defaults_for_all_messaging_template_types,
+    patch_property_specific_template,
 )
 from fides.api.util.api_router import APIRouter
 from fides.api.util.logger import Pii
@@ -74,9 +91,13 @@
     MESSAGING_DEFAULT_SECRETS,
     MESSAGING_SECRETS,
     MESSAGING_STATUS,
-    MESSAGING_TEMPLATES,
+    BASIC_MESSAGING_TEMPLATES,
     MESSAGING_TEST,
     V1_URL_PREFIX,
+    MESSAGING_TEMPLATES_SUMMARY,
+    MESSAGING_TEMPLATES_BY_TEMPLATE_TYPE,
+    MESSAGING_TEMPLATE_DEFAULT_BY_TEMPLATE_TYPE,
+    MESSAGING_TEMPLATE_BY_ID,
 )
 from fides.config.config_proxy import ConfigProxy
 
@@ -496,16 +517,16 @@ def send_test_message(
 
 
 @router.get(
-    MESSAGING_TEMPLATES,
+    BASIC_MESSAGING_TEMPLATES,
     dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
-    response_model=List[MessagingTemplateResponse],
+    response_model=List[BasicMessagingTemplateResponse],
 )
 def get_basic_messaging_templates(
     *, db: Session = Depends(deps.get_db)
-) -> List[MessagingTemplateResponse]:
+) -> List[BasicMessagingTemplateResponse]:
     """Returns the available messaging templates, augments the models with labels to be used in the UI."""
     return [
-        MessagingTemplateResponse(
+        BasicMessagingTemplateResponse(
             type=template.type,
             content=template.content,
             label=DEFAULT_MESSAGING_TEMPLATES.get(template.type, {}).get("label", None),
@@ -515,12 +536,14 @@ def get_basic_messaging_templates(
 
 
 @router.put(
-    MESSAGING_TEMPLATES,
+    BASIC_MESSAGING_TEMPLATES,
     dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
 )
 def update_basic_messaging_templates(
-    templates: List[MessagingTemplateRequest], *, db: Session = Depends(deps.get_db)
-) -> BulkPutMessagingTemplateResponse:
+    templates: List[BasicMessagingTemplateRequest],
+    *,
+    db: Session = Depends(deps.get_db),
+) -> BulkPutBasicMessagingTemplateResponse:
     """Updates the messaging templates and reverts empty subject or body values to the default values."""
 
     succeeded = []
@@ -535,9 +558,7 @@ def update_basic_messaging_templates(
             if not default_template:
                 raise ValueError("Invalid template type.")
 
-            content["subject"] = (
-                content["subject"] or default_template["content"]["subject"]
-            )
+            content["subject"] = content["subject"] or default_template["content"]["subject"]
             content["body"] = content["body"] or default_template["content"]["body"]
 
             # For Basic Messaging Templates, we ignore the is_enabled flag at runtime. This is because
@@ -549,7 +570,7 @@ def update_basic_messaging_templates(
             )
 
             succeeded.append(
-                MessagingTemplateResponse(
+                BasicMessagingTemplateResponse(
                     type=template_type,
                     content=content,
                     label=default_template.get("label"),
@@ -565,4 +586,196 @@ def update_basic_messaging_templates(
                 )
             )
 
-    return BulkPutMessagingTemplateResponse(succeeded=succeeded, failed=failed)
+    return BulkPutBasicMessagingTemplateResponse(succeeded=succeeded, failed=failed)
+
+
+@router.get(
+    MESSAGING_TEMPLATES_SUMMARY,
+    dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
+    response_model=Page[MessagingTemplateWithPropertiesSummary],
+)
+def get_property_specific_messaging_templates_summary(
+    *, db: Session = Depends(deps.get_db), params: Params = Depends()
+) -> AbstractPage[MessagingTemplate]:
+    """
+    Returns all messaging templates, automatically saving any missing message template types to the db.
+    """
+    # First save any missing template types to db
+    save_defaults_for_all_messaging_template_types(db)
+    ordered_templates = MessagingTemplate.query(db=db).order_by(
+        MessagingTemplate.created_at.desc()
+    )
+    # Now return all templates
+    return paginate(
+        ordered_templates,
+        params=params,
+    )
+
+
+@router.get(
+    MESSAGING_TEMPLATE_DEFAULT_BY_TEMPLATE_TYPE,
+    dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
+    response_model=MessagingTemplateDefault,
+)
+def get_default_messaging_template(
+    template_type: MessagingActionType,
+) -> MessagingTemplateDefault:
+    """
+    Retrieves default messaging template by template type.
+    """
+    logger.info(
+        "Finding default messaging template of template type '{}'", template_type
+    )
+    try:
+        return get_default_template_by_type(template_type)
+    except MessagingTemplateValidationException as e:
+        raise HTTPException(
+            status_code=HTTP_400_BAD_REQUEST,
+            detail=e.message,
+        )
+
+
+@router.post(
+    MESSAGING_TEMPLATES_BY_TEMPLATE_TYPE,
+    dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
+    response_model=Optional[MessagingTemplateWithPropertiesDetail],
+)
+def create_property_specific_messaging_template(
+    template_type: MessagingActionType,
+    *,
+    db: Session = Depends(deps.get_db),
+    messaging_template_create_body: MessagingTemplateWithPropertiesBodyParams,
+) -> Optional[MessagingTemplate]:
+    """
+    Creates property-specific messaging template by template type.
+    """
+    logger.info(
+        "Creating new property-specific messaging template of type '{}'", template_type
+    )
+    try:
+        return create_property_specific_template_by_type(
+            db, template_type, messaging_template_create_body
+        )
+    except MessagingTemplateValidationException as e:
+        raise HTTPException(
+            status_code=HTTP_400_BAD_REQUEST,
+            detail=e.message,
+        )
+
+
+@router.put(
+    MESSAGING_TEMPLATE_BY_ID,
+    dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
+    response_model=Optional[MessagingTemplateWithPropertiesDetail],
+)
+def update_property_specific_messaging_template(
+    template_id: str,
+    *,
+    db: Session = Depends(deps.get_db),
+    messaging_template_update_body: MessagingTemplateWithPropertiesBodyParams,
+) -> Optional[MessagingTemplate]:
+    """
+    Updates property-specific messaging template by template id.
+    """
+    logger.info("Updating property-specific messaging template of id '{}'", template_id)
+    try:
+        return update_property_specific_template(
+            db, template_id, messaging_template_update_body
+        )
+    except EmailTemplateNotFoundException as e:
+        raise HTTPException(
+            status_code=HTTP_404_NOT_FOUND,
+            detail=e.message,
+        )
+    except MessagingTemplateValidationException as e:
+        raise HTTPException(
+            status_code=HTTP_400_BAD_REQUEST,
+            detail=e.message,
+        )
+
+
+@router.patch(
+    MESSAGING_TEMPLATE_BY_ID,
+    dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
+    response_model=Optional[MessagingTemplateWithPropertiesDetail],
+)
+def patch_property_specific_messaging_template(
+    template_id: str,
+    *,
+    db: Session = Depends(deps.get_db),
+    messaging_template_update_body: MessagingTemplateWithPropertiesPatchBodyParams,
+) -> Optional[MessagingTemplate]:
+    """
+    Updates property-specific messaging template by template id.
+    """
+    logger.info("Patching property-specific messaging template of id '{}'", template_id)
+    try:
+        data = messaging_template_update_body.dict(exclude_none=True)
+        return patch_property_specific_template(db, template_id, data)
+    except EmailTemplateNotFoundException as e:
+        raise HTTPException(
+            status_code=HTTP_404_NOT_FOUND,
+            detail=e.message,
+        )
+    except MessagingTemplateValidationException as e:
+        raise HTTPException(
+            status_code=HTTP_400_BAD_REQUEST,
+            detail=e.message,
+        )
+
+
+@router.get(
+    MESSAGING_TEMPLATE_BY_ID,
+    dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
+    response_model=MessagingTemplateWithPropertiesDetail,
+)
+def get_messaging_template_by_id(
+    template_id: str,
+    *,
+    db: Session = Depends(deps.get_db),
+) -> MessagingTemplateWithPropertiesDetail:
+    """
+    Retrieves messaging template by template tid.
+    """
+    logger.info("Finding messaging template with id '{}'", template_id)
+
+    try:
+        messaging_template = get_template_by_id(db, template_id)
+        return MessagingTemplateWithPropertiesDetail(
+            id=template_id,
+            type=messaging_template.type,
+            content=messaging_template.content,
+            is_enabled=messaging_template.is_enabled,
+            properties=messaging_template.properties,
+        )
+    except EmailTemplateNotFoundException as e:
+        raise HTTPException(
+            status_code=HTTP_404_NOT_FOUND,
+            detail=e.message,
+        )
+
+
+@router.delete(
+    MESSAGING_TEMPLATE_BY_ID,
+    dependencies=[Security(verify_oauth_client, scopes=[MESSAGING_TEMPLATE_UPDATE])],
+    status_code=HTTP_204_NO_CONTENT,
+    response_model=None,
+)
+def delete_messaging_template_by_id(
+    template_id: str,
+    *,
+    db: Session = Depends(deps.get_db),
+) -> None:
+    """
+    Deletes messaging template by template id.
+    """
+    logger.info("Deleting messaging template with id '{}'", template_id)
+    try:
+        delete_template_by_id(db, template_id)
+    except EmailTemplateNotFoundException as e:
+        raise HTTPException(
+            status_code=HTTP_404_NOT_FOUND,
+            detail=e.message,
+        )
+    except MessagingTemplateValidationException as e:
+        raise HTTPException(status_code=HTTP_400_BAD_REQUEST, detail=e.message)

src/fides/api/common_exceptions.py

@@ -203,6 +203,14 @@ class EmailTemplateUnhandledActionType(FidesopsException):
     """Custom Exception - Email Template Unhandled ActionType Error"""
 
 
+class EmailTemplateNotFoundException(FidesopsException):
+    """Custom Exception - Email Template Not Found"""
+
+
+class MessagingTemplateValidationException(FidesopsException):
+    """Custom Exception - Messaging Template Could Not Be Created, Updated, or Deleted"""
+
+
 class OAuth2TokenException(FidesopsException):
     """Custom Exception - Unable to access or refresh OAuth2 tokens for SaaS connector"""