Added the parser for the dtmf data. (#45347)

* Added the parser for the dtmf data.

* Removed dtmf meta data.

---------

Co-authored-by: Vinothini Dharmaraj <[email protected]>

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/implementation/accesshelpers/DtmfDataContructorProxy.java

@@ -0,0 +1,86 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.communication.callautomation.implementation.accesshelpers;
+
+import com.azure.communication.callautomation.implementation.converters.DtmfDataConverter;
+import com.azure.communication.callautomation.models.DtmfData;
+
+/**
+ * Helper class to access private values of {@link DtmdfData} across package boundaries.
+ */
+public final class DtmfDataContructorProxy {
+    private static DtmfDataContructorProxyAccessor accessor;
+
+    private DtmfDataContructorProxy() {
+    }
+
+    /**
+    * Type defining the methods to set the non-public properties of a {@link DtmfDataContructorProxyAccessor}
+    * instance.
+    */
+    public interface DtmfDataContructorProxyAccessor {
+        /**
+         * Creates a new instance of {@link DtmfData} backed by an internal instance of
+         * {@link DtmfDataConvertor}.
+         *
+         * @param internalResponse The internal response.
+         * @return A new instance of {@link DtmfData}.
+         */
+        DtmfData create(DtmfDataConverter internalResponse);
+
+        /**
+         * Creates a new instance of {@link DtmfData}
+         *
+         * @param data The internal response.
+         * @return A new instance of {@link DtmfData}.
+         */
+        DtmfData create(String data);
+    }
+
+    /**
+    * The method called from {@link DtmfData} to set it's accessor.
+    *
+    * @param accessor The accessor.
+    */
+    public static void setAccessor(final DtmfDataContructorProxyAccessor accessor) {
+        DtmfDataContructorProxy.accessor = accessor;
+    }
+
+    /**
+    * Creates a new instance of {@link DtmfData} backed by an internal instance of
+    * {@link DtmfDataConverter}.
+    *
+    * @param internalResponse The internal response.
+    * @return A new instance of {@link DtmfData}.
+    */
+    public static DtmfData create(DtmfDataConverter internalResponse) {
+        // This looks odd but is necessary, it is possible to engage the access helper before anywhere else in the
+        // application accesses DtmfData which triggers the accessor to be configured. So, if the accessor
+        // is null this effectively pokes the class to set up the accessor.
+        if (accessor == null) {
+            new DtmfData();
+        }
+
+        assert accessor != null;
+        return accessor.create(internalResponse);
+    }
+
+    /**
+     * Creates a new instance of {@link DtmfData} 
+     *
+     * @param data The dtmf data.
+     * @return A new instance of {@link DtmfData}.
+     */
+    public static DtmfData create(String data) {
+        // This looks odd but is necessary, it is possible to engage the access helper before anywhere else in the
+        // application accesses DtmfData which triggers the accessor to be configured. So, if the accessor
+        // is null this effectively pokes the class to set up the accessor.
+        if (accessor == null) {
+            new DtmfData();
+        }
+
+        assert accessor != null;
+        return accessor.create(data);
+    }
+}

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/implementation/converters/DtmfDataConverter.java

@@ -0,0 +1,87 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.communication.callautomation.implementation.converters;
+
+import java.io.IOException;
+
+import com.azure.json.JsonReader;
+import com.azure.json.JsonToken;
+
+/** The DtmfDataInternal model. */
+public final class DtmfDataConverter {
+
+    /*
+     * The dtmf data.
+     */
+    private String data;
+
+    /*
+     * The timestamp of when the media was sourced.
+     */
+    private String timestamp;
+
+    /*
+     * The participantId.
+     */
+    private String participantRawID;
+
+    /**
+     * Get the data property.
+     *
+     * @return the data value.
+     */
+    public String getData() {
+        return data;
+    }
+
+    /**
+     * Get the timestamp property.
+     *
+     * @return the timestamp value.
+     */
+    public String getTimestamp() {
+        return timestamp;
+    }
+
+    /**
+     * Get the participantRawID property.
+     *
+     * @return the participantRawID value.
+     */
+    public String getParticipantRawID() {
+        return participantRawID;
+    }
+
+    /**
+     * Reads an instance of DtmfMetadataConverter from the JsonReader.
+     *<p>
+     * Note: DtmfDataConverter does not have to implement JsonSerializable, model is only used in deserialization
+     * context internally by {@link StreamingDataParser} and not serialized.
+     *</p>
+     * @param jsonReader The JsonReader being read.
+     * @return An instance of FileSource if the JsonReader was pointing to an instance of it, or
+     * null if it was pointing to JSON null.
+     * @throws IOException If an error occurs while reading the FileSource.
+     */
+    public static DtmfDataConverter fromJson(JsonReader jsonReader) throws IOException {
+        return jsonReader.readObject(reader -> {
+            final DtmfDataConverter converter = new DtmfDataConverter();
+            while (reader.nextToken() != JsonToken.END_OBJECT) {
+                String fieldName = reader.getFieldName();
+                reader.nextToken();
+
+                if ("data".equals(fieldName)) {
+                    converter.data = reader.getString();
+                } else if ("timestamp".equals(fieldName)) {
+                    converter.timestamp = reader.getString();
+                } else if ("participantRawID".equals(fieldName)) {
+                    converter.participantRawID = reader.getString();
+                } else {
+                    reader.skipChildren();
+                }
+            }
+            return converter;
+        });
+    }
+}

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/implementation/converters/TranscriptionMetadataConverter.java

@@ -33,6 +33,11 @@ public final class TranscriptionMetadataConverter {
      */
     private String correlationId;
 
+    /*
+     * The custom speech recognition model endpoint id
+     */
+    private String speechRecognitionModelEndpointId;
+
     /**
      * Get the transcriptionSubscriptionId property.
      *
@@ -69,6 +74,15 @@ public String getCorrelationId() {
         return correlationId;
     }
 
+    /**
+     * Get the speechRecognitionModelEndpointId property.
+     *
+     * @return the speechRecognitionModelEndpointId value.
+     */
+    public String getSpeechRecognitionModelEndpointId() {
+        return speechRecognitionModelEndpointId;
+    }
+
     /**
      * Reads an instance of TranscriptionMetadataConverter from the JsonReader.
      *<p>
@@ -94,6 +108,8 @@ public static TranscriptionMetadataConverter fromJson(JsonReader jsonReader) thr
                     converter.callConnectionId = reader.getString();
                 } else if ("correlationId".equals(fieldName)) {
                     converter.correlationId = reader.getString();
+                } else if ("speechRecognitionModelEndpointId".equals(fieldName)) {
+                    converter.speechRecognitionModelEndpointId = reader.getString();
                 } else {
                     reader.skipChildren();
                 }

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/models/DtmfData.java

@@ -0,0 +1,106 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.communication.callautomation.models;
+
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeFormatter;
+
+import com.azure.communication.callautomation.implementation.accesshelpers.DtmfDataContructorProxy;
+import com.azure.communication.callautomation.implementation.converters.DtmfDataConverter;
+import com.azure.communication.common.CommunicationIdentifier;
+
+/** The dtmf data model. */
+public final class DtmfData extends StreamingData {
+    /*
+     * The dtmf data.
+     */
+    private final String data;
+
+    /*
+     * The timestamp indicating when the media content was received by the bot, or if the bot is sending media, 
+     * the timestamp of when the media was sourced. The format is ISO 8601 (yyyy-mm-ddThh:mm)
+     */
+    private final OffsetDateTime timestamp;
+
+    /*
+     * The raw ID of the participant.
+     */
+    private final CommunicationIdentifier participant;
+
+    static {
+        DtmfDataContructorProxy.setAccessor(new DtmfDataContructorProxy.DtmfDataContructorProxyAccessor() {
+            @Override
+            public DtmfData create(DtmfDataConverter internalData) {
+                return new DtmfData(internalData);
+            }
+
+            @Override
+            public DtmfData create(String data) {
+                return new DtmfData(data);
+            }
+        });
+    }
+
+    /**
+     * Package-private constructor of the class, used internally.
+     *
+     * @param internalData The DtmfDataconvertor
+     */
+    DtmfData(DtmfDataConverter internalData) {
+        this.data = internalData.getData();
+        this.timestamp = OffsetDateTime.parse(internalData.getTimestamp(), DateTimeFormatter.ISO_OFFSET_DATE_TIME);
+        if (internalData.getParticipantRawID() != null && !internalData.getParticipantRawID().isEmpty()) {
+            this.participant = CommunicationIdentifier.fromRawId(internalData.getParticipantRawID());
+        } else {
+            participant = null;
+        }
+    }
+
+    /**
+     * The constructor
+     */
+    public DtmfData() {
+        this.data = null;
+        this.timestamp = null;
+        this.participant = null;
+    }
+
+    /**
+     * The constructor
+     *
+     * @param data The dtmf data.
+     */
+    DtmfData(String data) {
+        this.data = data;
+        this.timestamp = null;
+        this.participant = null;
+    }
+
+    /**
+     * Get the data property.
+     *
+     * @return the data value.
+     */
+    public String getData() {
+        return data;
+    }
+
+    /**
+     * Get the timestamp property.
+     *
+     * @return the timestamp value.
+     */
+    public OffsetDateTime getTimestamp() {
+        return timestamp;
+    }
+
+    /**
+     * Get the participantRawID property.
+     *
+     * @return the participantRawID value.
+     */
+    public CommunicationIdentifier getParticipant() {
+        return participant;
+    }
+}

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/models/StreamingData.java

@@ -7,10 +7,12 @@
 
 import com.azure.communication.callautomation.implementation.accesshelpers.AudioDataContructorProxy;
 import com.azure.communication.callautomation.implementation.accesshelpers.AudioMetadataContructorProxy;
+import com.azure.communication.callautomation.implementation.accesshelpers.DtmfDataContructorProxy;
 import com.azure.communication.callautomation.implementation.accesshelpers.TranscriptionDataContructorProxy;
 import com.azure.communication.callautomation.implementation.accesshelpers.TranscriptionMetadataContructorProxy;
 import com.azure.communication.callautomation.implementation.converters.AudioDataConverter;
 import com.azure.communication.callautomation.implementation.converters.AudioMetadataConverter;
+import com.azure.communication.callautomation.implementation.converters.DtmfDataConverter;
 import com.azure.communication.callautomation.implementation.converters.TranscriptionDataConverter;
 import com.azure.communication.callautomation.implementation.converters.TranscriptionMetadataConverter;
 import com.azure.json.JsonProviders;
@@ -96,6 +98,11 @@ private static StreamingData parseStreamingData(String data) {
                             audioMetadata.setStreamingDataKind(StreamingDataKind.AUDIO_METADATA);
                             return audioMetadata;
 
+                        case "dtmfData":
+                            DtmfData dtmfData = DtmfDataContructorProxy.create(DtmfDataConverter.fromJson(jsonReader));
+                            dtmfData.setStreamingDataKind(StreamingDataKind.DTMF_DATA);
+                            return dtmfData;
+
                         case "transcriptionData":
                             TranscriptionData transcriptionData = TranscriptionDataContructorProxy
                                 .create(TranscriptionDataConverter.fromJson(jsonReader));

sdk/communication/azure-communication-callautomation/src/main/java/com/azure/communication/callautomation/models/StreamingDataKind.java

@@ -3,9 +3,10 @@
 
 package com.azure.communication.callautomation.models;
 
-import com.azure.core.util.ExpandableStringEnum;
 import java.util.Collection;
 
+import com.azure.core.util.ExpandableStringEnum;
+
 /**
  * Specifies the streaming data kind
  */
@@ -20,6 +21,11 @@ public final class StreamingDataKind extends ExpandableStringEnum<StreamingDataK
      */
     public static final StreamingDataKind AUDIO_METADATA = fromString("audioMetadata");
 
+    /**
+     * Streamind Data kind "dtmfData"
+     */
+    public static final StreamingDataKind DTMF_DATA = fromString("dtmfData");
+
     /**
     * Streamind Data kind "transcriptionData".
     */