docs: Deprecate NI RealTimeData (#562)

Vonage · Jan 31, 2025 · 4e22067 · 4e22067
1 parent 8a33be6
commit 4e22067
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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;