Implement keyword-based dynamic text replacement

src/Altinn.Notifications.Core/Extensions/ServiceCollectionExtensions.cs

@@ -46,6 +46,7 @@ public static void AddCoreServices(this IServiceCollection services, IConfigurat
             .AddSingleton<INotificationsEmailServiceUpdateService, NotificationsEmailServiceUpdateService>()
             .AddSingleton<IMetricsService, MetricsService>()
             .AddSingleton<INotificationScheduleService, NotificationScheduleService>()
+            .AddSingleton<IKeywordsService, KeywordsService>()
             .Configure<KafkaSettings>(config.GetSection("KafkaSettings"))
             .Configure<NotificationConfig>(config.GetSection("NotificationConfig"));
     }

src/Altinn.Notifications.Core/Integrations/IRegisterClient.cs

@@ -1,17 +1,40 @@
 using Altinn.Notifications.Core.Models.ContactPoints;
+using Altinn.Notifications.Core.Models.Parties;
 
-namespace Altinn.Notifications.Core.Integrations
+namespace Altinn.Notifications.Core.Integrations;
+
+/// <summary>
+/// Defines a contract for interacting with the register service.
+/// </summary>
+public interface IRegisterClient
 {
     /// <summary>
-    /// Interface describing a client for the register service
+    /// Asynchronously retrieves contact point details for the specified organizations.
+    /// </summary>
+    /// <param name="organizationNumbers">A collection of organization numbers for which contact point details are requested.</param>
+    /// <returns>
+    /// A task that represents the asynchronous operation. 
+    /// The task result contains a list of <see cref="OrganizationContactPoints"/> representing the contact points of the specified organizations.
+    /// </returns>
+    Task<List<OrganizationContactPoints>> GetOrganizationContactPoints(List<string> organizationNumbers);
+
+    /// <summary>
+    /// Asynchronously retrieves party details for the specified organizations.
+    /// </summary>
+    /// <param name="organizationNumbers">A collection of organization numbers for which party details are requested.</param>
+    /// <returns>
+    /// A task that represents the asynchronous operation. 
+    /// The task result contains a list of <see cref="PartyDetails"/> representing the details of the specified organizations.
+    /// </returns>
+    Task<List<PartyDetails>> GetPartyDetailsForOrganizations(List<string> organizationNumbers);
+
+    /// <summary>
+    /// Asynchronously retrieves party details for the specified persons.
     /// </summary>
-    public interface IRegisterClient
-    {
-        /// <summary>
-        /// Retrieves contact points for a list of organizations
-        /// </summary>
-        /// <param name="organizationNumbers">A list of organization numbers to look up contact points for</param>
-        /// <returns>A list of <see cref="OrganizationContactPoints"/> for the provided organizations</returns>
-        public Task<List<OrganizationContactPoints>> GetOrganizationContactPoints(List<string> organizationNumbers);
-    }
+    /// <param name="socialSecurityNumbers">A collection of social security numbers for which party details are requested.</param>
+    /// <returns>
+    /// A task that represents the asynchronous operation. 
+    /// The task result contains a list of <see cref="PartyDetails"/> representing the details of the specified individuals.
+    /// </returns>
+    Task<List<PartyDetails>> GetPartyDetailsForPersons(List<string> socialSecurityNumbers);
 }

src/Altinn.Notifications.Core/Models/NotificationTemplate/EmailTemplate.cs

@@ -3,43 +3,51 @@
 namespace Altinn.Notifications.Core.Models.NotificationTemplate;
 
 /// <summary>
-/// Template for an email notification
+/// Represents a template for an email notification.
 /// </summary>
 public class EmailTemplate : INotificationTemplate
 {
-    /// <inheritdoc/>
-    public NotificationTemplateType Type { get; internal set; }
+    /// <summary>
+    /// Gets the body of the email.
+    /// </summary>
+    public string Body { get; internal set; } = string.Empty;
 
     /// <summary>
-    /// Gets the from adress of emails created by the template    
+    /// Gets the content type of the email.
     /// </summary>
-    public string FromAddress { get; internal set; } = string.Empty;
+    public EmailContentType ContentType { get; internal set; }
 
     /// <summary>
-    /// Gets the subject of emails created by the template    
+    /// Gets the sender address of the email.
     /// </summary>
-    public string Subject { get; internal set; } = string.Empty;
+    public string FromAddress { get; internal set; } = string.Empty;
 
     /// <summary>
-    /// Gets the body of emails created by the template    
+    /// Gets the subject of the email.
     /// </summary>
-    public string Body { get; internal set; } = string.Empty;
+    public string Subject { get; internal set; } = string.Empty;
 
     /// <summary>
-    /// Gets the content type of emails created by the template
+    /// Gets the type of the notification template.
     /// </summary>
-    public EmailContentType ContentType { get; internal set; }
+    /// <value>
+    /// The type of the notification template, represented by the <see cref="NotificationTemplateType"/> enum.
+    /// </value>
+    public NotificationTemplateType Type { get; } = NotificationTemplateType.Email;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="EmailTemplate"/> class.
+    /// Initializes a new instance of the <see cref="EmailTemplate"/> class with the specified from address, subject, body, and content type.
     /// </summary>
+    /// <param name="fromAddress">The sender address of the email. If null, an empty string is used.</param>
+    /// <param name="subject">The subject of the email.</param>
+    /// <param name="body">The body of the email.</param>
+    /// <param name="contentType">The content type of the email.</param>
     public EmailTemplate(string? fromAddress, string subject, string body, EmailContentType contentType)
     {
-        FromAddress = fromAddress ?? string.Empty;
-        Subject = subject;
         Body = body;
+        Subject = subject;
         ContentType = contentType;
-        Type = NotificationTemplateType.Email;
+        FromAddress = fromAddress ?? string.Empty;
     }
 
     /// <summary>

src/Altinn.Notifications.Core/Models/NotificationTemplate/INotificationTemplate.cs

@@ -5,15 +5,15 @@
 namespace Altinn.Notifications.Core.Models.NotificationTemplate;
 
 /// <summary>
-/// Base class for a notification template
+/// Represents a base notification template.
 /// </summary>
 [JsonDerivedType(typeof(EmailTemplate), "email")]
 [JsonDerivedType(typeof(SmsTemplate), "sms")]
 [JsonPolymorphic(TypeDiscriminatorPropertyName = "$")]
 public interface INotificationTemplate
 {
     /// <summary>
-    /// Gets the type for the template
+    /// Gets the type of the notification template.
     /// </summary>
-    public NotificationTemplateType Type { get; }
+    NotificationTemplateType Type { get; }
 }

src/Altinn.Notifications.Core/Models/NotificationTemplate/SmsTemplate.cs

@@ -3,31 +3,37 @@
 namespace Altinn.Notifications.Core.Models.NotificationTemplate;
 
 /// <summary>
-/// Template for an SMS notification
+/// Represents a template for an SMS notification.
 /// </summary>
 public class SmsTemplate : INotificationTemplate
 {
-    /// <inheritdoc/>
-    public NotificationTemplateType Type { get; internal set; }
+    /// <summary>
+    /// Gets the body of the SMS.
+    /// </summary>
+    public string Body { get; internal set; } = string.Empty;
 
     /// <summary>
-    /// Gets the number from which the SMS is created by the template    
+    /// Gets the number from which the SMS is sent.
     /// </summary>
     public string SenderNumber { get; internal set; } = string.Empty;
 
     /// <summary>
-    /// Gets the body of SMSs created by the template    
+    /// Gets the type of the notification template.
     /// </summary>
-    public string Body { get; internal set; } = string.Empty;
+    /// <value>
+    /// The type of the notification template, represented by the <see cref="NotificationTemplateType"/> enum.
+    /// </value>
+    public NotificationTemplateType Type { get; } = NotificationTemplateType.Sms;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="SmsTemplate"/> class.
+    /// Initializes a new instance of the <see cref="SmsTemplate"/> class with the specified sender number and body.
     /// </summary>
+    /// <param name="senderNumber">The number from which the SMS is sent. If null, an empty string is used.</param>
+    /// <param name="body">The body of the SMS.</param>
     public SmsTemplate(string? senderNumber, string body)
     {
-        SenderNumber = senderNumber ?? string.Empty;
         Body = body;
-        Type = NotificationTemplateType.Sms;
+        SenderNumber = senderNumber ?? string.Empty;
     }
 
     /// <summary>

src/Altinn.Notifications.Core/Models/Parties/PartyDetails.cs

@@ -0,0 +1,27 @@
+using System.Text.Json.Serialization;
+
+namespace Altinn.Notifications.Core.Models.Parties;
+
+/// <summary>
+/// Represents the details for a specific party.
+/// </summary>
+public class PartyDetails
+{
+    /// <summary>
+    /// Gets or sets the name of the party.
+    /// </summary>
+    [JsonPropertyName("name")]
+    public string? Name { get; set; }
+
+    /// <summary>
+    /// Gets or sets the organization number of the party, if applicable.
+    /// </summary>
+    [JsonPropertyName("orgNo")]
+    public string? OrganizationNumber { get; set; }
+
+    /// <summary>
+    /// Gets or sets the social security number of the party, if applicable.
+    /// </summary>
+    [JsonPropertyName("ssn")]
+    public string? NationalIdentityNumber { get; set; }
+}

src/Altinn.Notifications.Core/Models/Parties/PartyDetailsLookupBatch.cs

@@ -0,0 +1,57 @@
+using System.Text.Json.Serialization;
+
+namespace Altinn.Notifications.Core.Models.Parties;
+
+/// <summary>
+/// Represents a request to look up party details by their identifiers.
+/// </summary>
+public class PartyDetailsLookupBatch
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PartyDetailsLookupBatch"/> class.
+    /// </summary>
+    /// <param name="organizationNumbers">A list of organization numbers to look up.</param>
+    /// <param name="socialSecurityNumbers">A list of social security numbers to look up.</param>
+    /// <exception cref="ArgumentException">Thrown when both <paramref name="organizationNumbers"/> and <paramref name="socialSecurityNumbers"/> are null or empty.</exception>
+    [JsonConstructor]
+    public PartyDetailsLookupBatch(List<string>? organizationNumbers = null, List<string>? socialSecurityNumbers = null)
+    {
+        if ((organizationNumbers == null || organizationNumbers.Count == 0) && (socialSecurityNumbers == null || socialSecurityNumbers.Count == 0))
+        {
+            throw new ArgumentException("At least one of organizationNumbers or socialSecurityNumbers must be provided.");
+        }
+
+        OrganizationNumbers = organizationNumbers ?? [];
+        SocialSecurityNumbers = socialSecurityNumbers ?? [];
+
+        PartyDetailsLookupRequestList = [];
+
+        if (OrganizationNumbers.Count != 0)
+        {
+            PartyDetailsLookupRequestList.AddRange(OrganizationNumbers.Select(orgNum => new PartyDetailsLookupRequest(organizationNumber: orgNum)));
+        }
+
+        if (SocialSecurityNumbers.Count != 0)
+        {
+            PartyDetailsLookupRequestList.AddRange(SocialSecurityNumbers.Select(ssn => new PartyDetailsLookupRequest(socialSecurityNumber: ssn)));
+        }
+    }
+
+    /// <summary>
+    /// Gets the organization numbers to look up.
+    /// </summary>
+    [JsonPropertyName("organizationNumbers")]
+    public List<string> OrganizationNumbers { get; }
+
+    /// <summary>
+    /// Gets the social security numbers to look up.
+    /// </summary>
+    [JsonPropertyName("socialSecurityNumbers")]
+    public List<string> SocialSecurityNumbers { get; }
+
+    /// <summary>
+    /// Gets the list of lookup criteria for parties.
+    /// </summary>
+    [JsonPropertyName("parties")]
+    public List<PartyDetailsLookupRequest> PartyDetailsLookupRequestList { get; private set; }
+}

src/Altinn.Notifications.Core/Models/Parties/PartyDetailsLookupRequest.cs

@@ -0,0 +1,43 @@
+using System.Text.Json.Serialization;
+
+namespace Altinn.Notifications.Core.Models.Parties;
+
+/// <summary>
+/// Represents a lookup criterion for a single party.
+/// </summary>
+public record PartyDetailsLookupRequest
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PartyDetailsLookupRequest"/> class.
+    /// Ensures that only one of <see cref="OrganizationNumber"/> or <see cref="SocialSecurityNumber"/> is set.
+    /// </summary>
+    /// <param name="organizationNumber">The organization number of the party.</param>
+    /// <param name="socialSecurityNumber">The social security number of the party.</param>
+    /// <exception cref="ArgumentException">Thrown when both <paramref name="organizationNumber"/> and <paramref name="socialSecurityNumber"/> are set.</exception>
+    public PartyDetailsLookupRequest(string? organizationNumber = null, string? socialSecurityNumber = null)
+    {
+        if (!string.IsNullOrEmpty(organizationNumber) && !string.IsNullOrEmpty(socialSecurityNumber))
+        {
+            throw new ArgumentException("You can specify either an OrganizationNumber or a SocialSecurityNumber, but not both.");
+        }
+
+        OrganizationNumber = organizationNumber;
+        SocialSecurityNumber = socialSecurityNumber;
+    }
+
+    /// <summary>
+    /// Gets the organization number of the party.
+    /// </summary>
+    /// <value>The organization number of the party.</value>
+    [JsonPropertyName("orgNo")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+    public string? OrganizationNumber { get; }
+
+    /// <summary>
+    /// Gets the social security number of the party.
+    /// </summary>
+    /// <value>The social security number of the party.</value>
+    [JsonPropertyName("ssn")]
+    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+    public string? SocialSecurityNumber { get; }
+}

src/Altinn.Notifications.Core/Models/Parties/PartyDetailsLookupResult.cs

@@ -0,0 +1,15 @@
+using System.Text.Json.Serialization;
+
+namespace Altinn.Notifications.Core.Models.Parties;
+
+/// <summary>
+/// Represents the response for a party details lookup operation.
+/// </summary>
+public class PartyDetailsLookupResult
+{
+    /// <summary>
+    /// Gets or sets the list of party details.
+    /// </summary>
+    [JsonPropertyName("partyNames")]
+    public List<PartyDetails>? PartyDetailsList { get; set; } = [];
+}