From 4e220673348838c152fdf64a385dfb9820b0c35d Mon Sep 17 00:00:00 2001
From: Sina Madani <sina.madani@vonage.com>
Date: Fri, 31 Jan 2025 11:37:11 +0000
Subject: [PATCH] docs: Deprecate NI RealTimeData (#562)

---
 CHANGELOG.md                                                  | 1 +
 .../com/vonage/client/insight/AdvancedInsightRequest.java     | 4 ++++
 .../com/vonage/client/insight/AdvancedInsightResponse.java    | 3 +++
 3 files changed, 8 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7196b5357..c9cbe1864 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Added logging for requests & responses based on `java.util.logging`
 - Improved SMS API documentation
 - Deprecated Number Insight v2 / Fraud Score API
+- Deprecated `real_time_data` in Number Insight API
 - Minor internal refactoring based on code coverage improvements
 
 # [8.15.1] - 2024-12-19
diff --git a/src/main/java/com/vonage/client/insight/AdvancedInsightRequest.java b/src/main/java/com/vonage/client/insight/AdvancedInsightRequest.java
index d409403df..3611b3fa2 100644
--- a/src/main/java/com/vonage/client/insight/AdvancedInsightRequest.java
+++ b/src/main/java/com/vonage/client/insight/AdvancedInsightRequest.java
@@ -58,6 +58,7 @@ public static Builder builder() {
         return new Builder();
     }
 
+    @Deprecated
     public Boolean getRealTimeData() {
         return realTimeData;
     }
@@ -180,7 +181,10 @@ public Builder callback(String url) {
          *                     This only applies when {@link #async(boolean)} is {@code false}.
          *
          * @return This builder.
+         *
+         * @deprecated This feature will be removed in the next major release.
          */
+        @Deprecated
         public Builder realTimeData(boolean realTimeData) {
             this.realTimeData = realTimeData;
             return this;
diff --git a/src/main/java/com/vonage/client/insight/AdvancedInsightResponse.java b/src/main/java/com/vonage/client/insight/AdvancedInsightResponse.java
index 298f1908f..7b54bd723 100644
--- a/src/main/java/com/vonage/client/insight/AdvancedInsightResponse.java
+++ b/src/main/java/com/vonage/client/insight/AdvancedInsightResponse.java
@@ -77,7 +77,10 @@ public RoamingDetails getRoaming() {
 
     /**
      * @return Real-time data about the number if it was requested, {@code null} otherwise.
+     *
+     * @deprecated This feature will be removed in the next major release.
      */
+    @Deprecated
     @JsonProperty("real_time_data")
     public RealTimeData getRealTimeData() {
         return realTimeData;