Text Notifications

@startuml patron-notices-immediate-sequence title mod-circulation – Immediate Patron Notice\n(Checkout / Checkin / Renew / Request events) skinparam defaultFontSize 13 skinparam sequenceMessageAlign center participant "mod-circulation" as modCirc #moccasin participant "mod-circulation-storage" as modCircStorage #moccasin queue "Apache Kafka" as kafka #moccasin participant "mod-notify" as modNotify #darkSeaGreen participant "mod-template-engine" as modTemplateEngine #darkSeaGreen participant "mod-sender" as modSender #darkSeaGreen participant "mod-event-config" as modEventConfig #darkSeaGreen participant "mod-email" as modEmail #darkSeaGreen participant "mod-sms" as modSms #hotPink participant "mod-batch-print" as modBatchPrint #darkSeaGreen participant "mod-users" as modUsers #moccasin [-> modCirc ++ #moccasin : Perform circulation operation\n(Checkout / Checkin / Renew / Request events) modCirc -> modCirc: //Execute business logic; build PatronNoticeEvent// modCirc -> modCircStorage ++ #moccasin : //GET /patron-notice-policy-storage/patron-notice-policies// modCirc <-- modCircStorage -- : //found PatronNoticePolicies (can be empty)// modCirc -> modCirc : //find matching NoticeConfiguration for event type; build PatronNotice// alt NoticeConfiguration found modCirc -> modNotify ++ #darkSeaGreen : //POST /patron-notice// note right of modCirc { "recipientId": <uuid>, "templateId": <uuid>, "deliveryChannel": "email|sms|print", "context": { <loan|request|item|user> } } end note modNotify -> modEventConfig ++ #darkSeaGreen: //GET /event-config// modNotify <-- modEventConfig -- : //200 OK [Message Body]// modNotify -> modTemplateEngine ++ #darkSeaGreen: // POST /template-request // note right of modNotify { "templateId": <uuid>, "lang": <string>, "outputFormat": <string>, "context": { <loan|request|item|user> } } end note modNotify <-- modTemplateEngine -- : //200 OK [Message Body]// modNotify -> modSender ++ #darkSeaGreen : //POST /message-delivery// note right of modNotify { "notificationId": <uuid>, "recipientUserId": <uuid>, "messages": [ { "deliveryChannel": <email|sms|print>, "from": <string>, "to": <string>, "header": <string>, "body": <string>, "outputFormat": <string>, "attachments": [ { "contentType": <string>, "name": <string>, "description": <string>, "data": <string>, "disposition": <string>, "contentId": <string>, } ] } ], "metadata": <Metadata> } end note modSender -> modSender : // Validate delivery channel // alt delivery channel exists modSender -> modUsers ++ #moccasin : //GET /users/{recipientUserId}// modSender <-- modUsers -- : //200 OK// alt deliveryChannel == sms modSender -> modSender : //Validate user's phone number// modSender -> modSms ++ #hotPink : //POST /sms// note right of modSender { "notificationId": <uuid>, "recipientUserId": <uuid>, "body": <string> } end note modSms -> modUsers ++ #moccasin : //GET /users/{recipientUserId}// modSms <-- modUsers -- : //200 OK [user data with phone number]// modSender <-- modSms -- : //200 OK// else deliveryChannel == email modSender -> modEmail ++ #darkSeaGreen : // POST /email // note right of modSender { "notificationId": <uuid>, "recipientUserId": <uuid>, "from": <string>, "to": <string>, "header": <string>, "outputFormat": <string>, "body": <string>, "attachments": [ { "contentType": <string>, "name": <string>, "description": <string>, "data": <string>, "disposition": <string>, "contentId": <string>, } ], "additionalProperties": <map[string,object]> } end note modSender <-- modEmail -- : //200 OK// else deliveryChannel == mail modSender -> modBatchPrint ++ #darkSeaGreen : //POST /mail// note right of modSender { "notificationId": <string>, "from": <string>, "to": <string>, "outputFormat": <string>, "body": <string> } end note modSender <-- modBatchPrint -- : //200 OK// end end modNotify <-- modSender -- : //204 No Content// modCirc <-- modNotify --: //200 OK// modCirc -> kafka ++ #moccasin : //send NoticeLogEvent message// modCirc <-- kafka -- : //accepted message & acks// end [<-- modCirc -- : 201 Created @enduml