refactor: deprecated fraud detcetcion and real-time-insights

Vonage · Jan 20, 2025 · c725438 · c725438
1 parent be51dae
commit c725438
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 0 deletions.
diff --git a/packages/number-insight-v2/lib/numberInsightV2.ts b/packages/number-insight-v2/lib/numberInsightV2.ts
@@ -11,6 +11,7 @@ export class NumberInsightV2 extends Client {
   /**
    * Make a fraud check request with the provided parameters.
    *
+   * @deprecated This service is deprecated and will be turned off.
    * @param {FraudCheckParameters} params - The parameters for the fraud check request.
    * @return {Promise<FraudScore>} - A Promise that resolves with the fraud score response.
    * @example

diff --git a/packages/number-insight-v2/lib/types/fraudCheck.ts b/packages/number-insight-v2/lib/types/fraudCheck.ts
@@ -4,6 +4,8 @@ import { SimSwap } from './simSwap';
 
 /**
  * Represents the result of a fraud check request.
+ *
+ * @deprecated This service is deprecated and will be turned off.
  */
 export type FraudCheck = {
   /**

diff --git a/packages/number-insight-v2/lib/types/fraudScore.ts b/packages/number-insight-v2/lib/types/fraudScore.ts
@@ -2,6 +2,8 @@ import { RiskRecommendation, Label, Status } from '../enums';
 
 /**
  * Represents the result of the fraud_score insight operation.
+ *
+ * @deprecated This service is deprecated and will be turned off.
  */
 export type FraudScore = {
   /**

diff --git a/packages/number-insight-v2/lib/types/parameters/fraudParameters.ts b/packages/number-insight-v2/lib/types/parameters/fraudParameters.ts
@@ -2,6 +2,8 @@ import { Insight } from '../../enums/';
 
 /**
  * Represents the parameters for making a fraud check request.
+ *
+ * @deprecated This service is deprecated and will be turned off.
  */
 export type FraudCheckParameters = {
   /**

diff --git a/packages/number-insights/lib/types/Responses/RealTimeDataResponse.ts b/packages/number-insights/lib/types/Responses/RealTimeDataResponse.ts
@@ -1,6 +1,8 @@
 /**
  * Type representing real-time data related to a phone number.
  *
+ * @deprecated This service will be removed
+ *
  * @remarks
  * Vonage API's will return information using `snake_case`. This represents the
  * pure response before the client will transform the keys into `camelCase`.
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,8 @@ import { SimSwap } from './simSwap'; @@
     /**
      * Represents the result of a fraud check request.
+     *
+     * @deprecated This service is deprecated and will be turned off.
      */
     export type FraudCheck = {
       /**
@@ Expand Down @@