sync from monorepo f925969b3a30

Author: FusionAuth Automation

src/main/java/io/fusionauth/client/json/MessageTemplateJacksonHelper.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020-2024, FusionAuth, All Rights Reserved
+ * Copyright (c) 2020-2026, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
 import io.fusionauth.domain.message.MessageTemplate;
 import io.fusionauth.domain.message.MessageType;
 import io.fusionauth.domain.message.sms.SMSMessageTemplate;
+import io.fusionauth.domain.message.voice.VoiceMessageTemplate;
 
 /**
  * @author Mikey Sleevi
@@ -49,10 +50,11 @@ public static MessageType extractType(DeserializationContext ctxt, JsonParser p,
   }
 
   public static MessageTemplate newMessageTemplate(MessageType type) {
-    //noinspection SwitchStatementWithTooFewBranches
     switch (type) {
       case SMS:
         return new SMSMessageTemplate();
+      case Voice:
+        return new VoiceMessageTemplate();
       default:
         throw new IllegalStateException("Unexpected type [" + type + "]. This is a FusionAuth bug, someone forgot to add a case statement for a new type.");
     }

src/main/java/io/fusionauth/client/json/PreviewMessageTemplateRequestDeserializer.java

@@ -52,7 +52,7 @@ public PreviewMessageTemplateRequest deserialize(JsonParser p, DeserializationCo
       req.messageTemplate = MessageTemplateJacksonHelper.newMessageTemplate(mType);
     }
 
-    if (req.locale == null) {
+    if (req.locale == null && !lNode.isMissingNode() && !lNode.isNull()) {
       req.locale = new Locale(lNode.asText());
     }
 

src/main/java/io/fusionauth/client/json/PreviewMessageTemplateResponseDeserializer.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2026-2026, FusionAuth, All Rights Reserved
+ */
+package io.fusionauth.client.json;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.stream.Collectors;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+import com.inversoft.error.Errors;
+import io.fusionauth.domain.api.PreviewMessageTemplateResponse;
+import io.fusionauth.domain.message.Message;
+import io.fusionauth.domain.message.MessageType;
+import io.fusionauth.domain.message.sms.SMSMessage;
+import io.fusionauth.domain.message.voice.VoiceMessage;
+
+/**
+ * @author Daniel King
+ */
+public class PreviewMessageTemplateResponseDeserializer extends StdDeserializer<PreviewMessageTemplateResponse> {
+  public PreviewMessageTemplateResponseDeserializer() {
+    super(PreviewMessageTemplateResponse.class);
+  }
+
+  private static MessageType extractType(DeserializationContext ctxt, JsonParser p, JsonNode messageNode) throws IOException {
+    JsonNode node = messageNode.at("/type");
+    MessageType type = MessageType.safeValueOf(node.asText());
+    if (type == null) {
+      String sorted = Arrays.stream(MessageType.values()).map(Enum::name).sorted().collect(Collectors.joining(", "));
+      return (MessageType) ctxt.handleUnexpectedToken(Message.class, node.asToken(), p,
+                                                      "Expected the type field to be one of [" + sorted + "], but found [" + node.asText() + "]");
+    }
+
+    return type;
+  }
+
+  @Override
+  public PreviewMessageTemplateResponse deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
+    return deserialize(p, ctxt, new PreviewMessageTemplateResponse());
+  }
+
+  @Override
+  public PreviewMessageTemplateResponse deserialize(JsonParser p, DeserializationContext ctxt, PreviewMessageTemplateResponse response)
+      throws IOException {
+    JsonNode node = p.getCodec().readTree(p);
+
+    JsonNode errorsNode = node.at("/errors");
+    if (!errorsNode.isMissingNode()) {
+      response.errors = p.getCodec().treeToValue(errorsNode, Errors.class);
+    }
+
+    JsonNode messageNode = node.at("/previewMessage");
+    MessageType messageType = extractType(ctxt, p, messageNode);
+    if (messageType == MessageType.Voice) {
+      response.previewMessage = new VoiceMessage();
+    } else {
+      SMSMessage message = new SMSMessage();
+      response.message = message;
+      response.previewMessage = message;
+    }
+    ((ObjectMapper) p.getCodec()).readerForUpdating(response.previewMessage).readValue(messageNode);
+
+    return response;
+  }
+}

src/main/java/io/fusionauth/domain/ApplicationMultiFactorConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021-2022, FusionAuth, All Rights Reserved
+ * Copyright (c) 2021-2026, FusionAuth, All Rights Reserved
  */
 package io.fusionauth.domain;
 
@@ -21,6 +21,8 @@ public class ApplicationMultiFactorConfiguration {
 
   public ApplicationMultiFactorTrustPolicy trustPolicy;
 
+  public MultiFactorVoiceTemplate voice = new MultiFactorVoiceTemplate();
+
   @JacksonConstructor
   public ApplicationMultiFactorConfiguration() {
   }
@@ -30,6 +32,7 @@ public ApplicationMultiFactorConfiguration(ApplicationMultiFactorConfiguration o
     this.loginPolicy = other.loginPolicy;
     this.sms = new MultiFactorSMSTemplate(other.sms);
     this.trustPolicy = other.trustPolicy;
+    this.voice = new MultiFactorVoiceTemplate(other.voice);
   }
 
   @Override
@@ -44,12 +47,13 @@ public boolean equals(Object o) {
     return Objects.equals(email, that.email) &&
            loginPolicy == that.loginPolicy &&
            Objects.equals(sms, that.sms) &&
-           trustPolicy == that.trustPolicy;
+           trustPolicy == that.trustPolicy &&
+           Objects.equals(voice, that.voice);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(email, loginPolicy, sms, trustPolicy);
+    return Objects.hash(email, loginPolicy, sms, trustPolicy, voice);
   }
 
   @Override
@@ -114,4 +118,33 @@ public int hashCode() {
       return Objects.hash(templateId);
     }
   }
+
+  public static class MultiFactorVoiceTemplate {
+    public UUID templateId;
+
+    @JacksonConstructor
+    public MultiFactorVoiceTemplate() {
+    }
+
+    public MultiFactorVoiceTemplate(MultiFactorVoiceTemplate other) {
+      this.templateId = other.templateId;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+      if (this == o) {
+        return true;
+      }
+      if (o == null || getClass() != o.getClass()) {
+        return false;
+      }
+      MultiFactorVoiceTemplate that = (MultiFactorVoiceTemplate) o;
+      return Objects.equals(templateId, that.templateId);
+    }
+
+    @Override
+    public int hashCode() {
+      return Objects.hash(templateId);
+    }
+  }
 }

src/main/java/io/fusionauth/domain/TenantMultiFactorConfiguration.java

@@ -1,5 +1,17 @@
 /*
- * Copyright (c) 2021-2022, FusionAuth, All Rights Reserved
+ * Copyright (c) 2021-2026, FusionAuth, All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 package io.fusionauth.domain;
 
@@ -23,6 +35,8 @@ public class TenantMultiFactorConfiguration implements Buildable<TenantMultiFact
 
   public MultiFactorSMSMethod sms = new MultiFactorSMSMethod();
 
+  public MultiFactorVoiceMethod voice = new MultiFactorVoiceMethod();
+
   @JacksonConstructor
   public TenantMultiFactorConfiguration() {
   }
@@ -32,16 +46,15 @@ public TenantMultiFactorConfiguration(TenantMultiFactorConfiguration other) {
     this.email = new MultiFactorEmailMethod(other.email);
     this.loginPolicy = other.loginPolicy;
     this.sms = new MultiFactorSMSMethod(other.sms);
+    this.voice = new MultiFactorVoiceMethod(other.voice);
   }
 
   /**
-   * Returns true if at least one Multi-Factor method is enabled.
-   *
    * @return true if at least one Multi-Factor method is enabled
    */
   @JsonIgnore
   public boolean anyEnabled() {
-    return authenticator.enabled || sms.enabled || email.enabled;
+    return authenticator.enabled || sms.enabled || email.enabled || voice.enabled;
   }
 
   @Override
@@ -56,12 +69,13 @@ public boolean equals(Object o) {
     return Objects.equals(authenticator, that.authenticator) &&
            Objects.equals(email, that.email) &&
            loginPolicy == that.loginPolicy &&
-           Objects.equals(sms, that.sms);
+           Objects.equals(sms, that.sms) &&
+           Objects.equals(voice, that.voice);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(authenticator, email, loginPolicy, sms);
+    return Objects.hash(authenticator, email, loginPolicy, sms, voice);
   }
 
   @Override
@@ -191,4 +205,45 @@ public String toString() {
       return ToString.toString(this);
     }
   }
+
+  public static class MultiFactorVoiceMethod extends Enableable implements Buildable<MultiFactorVoiceMethod> {
+    public UUID messengerId;
+
+    public UUID templateId;
+
+    @JacksonConstructor
+    public MultiFactorVoiceMethod() {
+    }
+
+    public MultiFactorVoiceMethod(MultiFactorVoiceMethod other) {
+      this.enabled = other.enabled;
+      this.messengerId = other.messengerId;
+      this.templateId = other.templateId;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+      if (this == o) {
+        return true;
+      }
+      if (o == null || getClass() != o.getClass()) {
+        return false;
+      }
+      if (!super.equals(o)) {
+        return false;
+      }
+      MultiFactorVoiceMethod that = (MultiFactorVoiceMethod) o;
+      return Objects.equals(messengerId, that.messengerId) && Objects.equals(templateId, that.templateId);
+    }
+
+    @Override
+    public int hashCode() {
+      return Objects.hash(super.hashCode(), messengerId, templateId);
+    }
+
+    @Override
+    public String toString() {
+      return ToString.toString(this);
+    }
+  }
 }

src/main/java/io/fusionauth/domain/TwoFactorMethod.java

@@ -24,10 +24,20 @@
  * @author Daniel DeGroff
  */
 public class TwoFactorMethod implements Buildable<TwoFactorMethod> {
+
+  /**
+   * Method which authenticates using a code generated client-side using TOTP.
+   */
   public static final String Authenticator = "authenticator";
 
+  /**
+   * Method which authenticates using a code sent via email.
+   */
   public static final String Email = "email";
 
+  /**
+   * Method which authenticates using a code sent to a phone via SMS or voice.
+   */
   public static final String SMS = "sms";
 
   public AuthenticatorConfiguration authenticator;

src/main/java/io/fusionauth/domain/api/PreviewMessageTemplateResponse.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, FusionAuth, All Rights Reserved
+ * Copyright (c) 2020-2026, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,14 +15,24 @@
  */
 package io.fusionauth.domain.api;
 
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.inversoft.error.Errors;
+import io.fusionauth.client.json.PreviewMessageTemplateResponseDeserializer;
+import io.fusionauth.domain.message.Message;
 import io.fusionauth.domain.message.sms.SMSMessage;
 
 /**
  * @author Michael Sleevi
  */
+@JsonDeserialize(using = PreviewMessageTemplateResponseDeserializer.class)
 public class PreviewMessageTemplateResponse {
   public Errors errors;
 
+  /**
+   * @deprecated value will be null if the requested template is of type {@code VoiceMessageTemplate}. Use {@code previewMessage} instead
+   */
+  @Deprecated
   public SMSMessage message;
+
+  public Message previewMessage;
 }

src/main/java/io/fusionauth/domain/api/TwoFactorRequest.java

@@ -1,5 +1,17 @@
 /*
- * Copyright (c) 2018-2022, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2026, FusionAuth, All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 package io.fusionauth.domain.api;
 

src/main/java/io/fusionauth/domain/api/twoFactor/TwoFactorSendRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2023, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2026, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@
 
 import com.inversoft.json.JacksonConstructor;
 import io.fusionauth.domain.Buildable;
+import io.fusionauth.domain.message.MessageType;
 
 /**
  * @author Daniel DeGroff
@@ -28,6 +29,8 @@ public class TwoFactorSendRequest implements Buildable<TwoFactorSendRequest> {
 
   public String email;
 
+  public MessageType messageType;
+
   public String method;
 
   public String methodId;