Flag sync methods as obsolete

Vonage · Oct 17, 2023 · 23210df · 23210df
1 parent 0d21dd1
commit 23210df
Show file tree

Hide file tree

Showing 6 changed files with 247 additions and 179 deletions.
diff --git a/Vonage/Numbers/NumbersClient.cs b/Vonage/Numbers/NumbersClient.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Net.Http;
 using System.Threading.Tasks;
 using Vonage.Common;
@@ -35,6 +36,7 @@ internal NumbersClient(Credentials credentials, Configuration configuration, ITi
     }
 
     /// <inheritdoc />
+    [Obsolete("Favor asynchronous version instead.")]
     public NumberTransactionResponse BuyANumber(NumberTransactionRequest request, Credentials creds = null)
     {
         var response = ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -64,6 +66,7 @@ public async Task<NumberTransactionResponse> BuyANumberAsync(NumberTransactionRe
     }
 
     /// <inheritdoc />
+    [Obsolete("Favor asynchronous version instead.")]
     public NumberTransactionResponse CancelANumber(NumberTransactionRequest request, Credentials creds = null)
     {
         var response = ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -93,6 +96,7 @@ public async Task<NumberTransactionResponse> CancelANumberAsync(NumberTransactio
     }
 
     /// <inheritdoc />
+    [Obsolete("Favor asynchronous version instead.")]
     public NumbersSearchResponse GetAvailableNumbers(NumberSearchRequest request, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
             .DoGetRequestWithQueryParameters<NumbersSearchResponse>(
@@ -112,6 +116,7 @@ public Task<NumbersSearchResponse> GetAvailableNumbersAsync(NumberSearchRequest
             );
 
     /// <inheritdoc />
+    [Obsolete("Favor asynchronous version instead.")]
     public NumbersSearchResponse GetOwnedNumbers(NumberSearchRequest request, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
             .DoGetRequestWithQueryParameters<NumbersSearchResponse>(
@@ -131,6 +136,7 @@ public Task<NumbersSearchResponse>
             );
 
     /// <inheritdoc />
+    [Obsolete("Favor asynchronous version instead.")]
     public NumberTransferResponse TransferANumber(NumberTransferRequest request, string apiKey,
         Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -153,6 +159,7 @@ public Task<NumberTransferResponse> TransferANumberAsync(NumberTransferRequest r
             );
 
     /// <inheritdoc />
+    [Obsolete("Favor asynchronous version instead.")]
     public NumberTransactionResponse UpdateANumber(UpdateNumberRequest request, Credentials creds = null)
     {
         var response = ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)

diff --git a/Vonage/Pricing/PricingClient.cs b/Vonage/Pricing/PricingClient.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Threading.Tasks;
 using Vonage.Common;
 using Vonage.Request;
@@ -24,13 +25,15 @@ internal PricingClient(Credentials credentials, Configuration configuration, ITi
     }
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public PricingResult RetrievePrefixPricing(string type, PricingPrefixRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParameters<PricingResult>
-        (
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, $"/account/get-prefix-pricing/outbound/{type}"),
-            AuthType.Query,
-            request
-        );
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParameters<PricingResult>
+            (
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, $"/account/get-prefix-pricing/outbound/{type}"),
+                AuthType.Query,
+                request
+            );
 
     /// <inheritdoc/>
     public Task<PricingResult> RetrievePrefixPricingAsync(string type, PricingPrefixRequest request,
@@ -44,12 +47,14 @@ public Task<PricingResult> RetrievePrefixPricingAsync(string type, PricingPrefix
             );
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public PricingResult RetrievePricingAllCountries(string type, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParameters<PricingResult>
-        (
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, $"/account/get-pricing/outbound/{type}"),
-            AuthType.Query
-        );
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParameters<PricingResult>
+            (
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, $"/account/get-pricing/outbound/{type}"),
+                AuthType.Query
+            );
 
     /// <inheritdoc/>
     public Task<PricingResult> RetrievePricingAllCountriesAsync(string type, Credentials creds = null) =>
@@ -61,23 +66,26 @@ public Task<PricingResult> RetrievePricingAllCountriesAsync(string type, Credent
             );
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public Country RetrievePricingCountry(string type, PricingCountryRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParameters<Country>
-        (
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, $"/account/get-pricing/outbound/{type}"),
-            AuthType.Query,
-            request
-        );
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParameters<Country>
+            (
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, $"/account/get-pricing/outbound/{type}"),
+                AuthType.Query,
+                request
+            );
 
     /// <inheritdoc/>
     public Task<Country> RetrievePricingCountryAsync(string type, PricingCountryRequest request,
         Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParametersAsync<Country>
-        (
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, $"/account/get-pricing/outbound/{type}"),
-            AuthType.Query,
-            request
-        );
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParametersAsync<Country>
+            (
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, $"/account/get-pricing/outbound/{type}"),
+                AuthType.Query,
+                request
+            );
 
     private Credentials GetCredentials(Credentials overridenCredentials) => overridenCredentials ?? this.Credentials;
 }
diff --git a/Vonage/Redaction/RedactClient.cs b/Vonage/Redaction/RedactClient.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Net.Http;
 using System.Threading.Tasks;
 using Vonage.Common;
@@ -23,32 +24,35 @@ internal RedactClient(Credentials credentials, Configuration configuration, ITim
         this.configuration = configuration;
         this.timeProvider = timeProvider;
     }
-
-    private Credentials GetCredentials(Credentials overridenCredentials) => overridenCredentials ?? this.Credentials;
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public bool Redact(RedactRequest request, Credentials creds = null)
     {
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoRequestWithJsonContent<object>
-        (
-            HttpMethod.Post,
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Api, "/v1/redact/transaction"),
-            request,
-            AuthType.Basic
-        );
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoRequestWithJsonContent<object>
+            (
+                HttpMethod.Post,
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Api, "/v1/redact/transaction"),
+                request,
+                AuthType.Basic
+            );
         return true;
     }
 
     /// <inheritdoc/>
     public async Task<bool> RedactAsync(RedactRequest request, Credentials creds = null)
     {
-        await ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoRequestWithJsonContentAsync<object>
-        (
-            HttpMethod.Post,
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Api, "/v1/redact/transaction"),
-            request,
-            AuthType.Basic
-        );
+        await ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoRequestWithJsonContentAsync<object>
+            (
+                HttpMethod.Post,
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Api, "/v1/redact/transaction"),
+                request,
+                AuthType.Basic
+            );
         return true;
     }
+
+    private Credentials GetCredentials(Credentials overridenCredentials) => overridenCredentials ?? this.Credentials;
 }
diff --git a/Vonage/ShortCodes/ShortCodesClient.cs b/Vonage/ShortCodes/ShortCodesClient.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Threading.Tasks;
 using Vonage.Common;
 using Vonage.Request;
@@ -22,62 +23,74 @@ internal ShortCodesClient(Credentials credentials, Configuration configuration,
         this.configuration = configuration;
         this.timeProvider = timeProvider;
     }
-
-    private Credentials GetCredentials(Credentials overridenCredentials) => overridenCredentials ?? this.Credentials;
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public OptInRecord ManageOptIn(OptInManageRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParameters<OptInRecord>(
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/opt-in/manage/json"),
-            AuthType.Query,
-            request);
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParameters<OptInRecord>(
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/opt-in/manage/json"),
+                AuthType.Query,
+                request);
 
     /// <inheritdoc/>
     public Task<OptInRecord> ManageOptInAsync(OptInManageRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParametersAsync<OptInRecord>(
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/opt-in/manage/json"),
-            AuthType.Query,
-            request);
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParametersAsync<OptInRecord>(
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/opt-in/manage/json"),
+                AuthType.Query,
+                request);
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public OptInSearchResponse QueryOptIns(OptInQueryRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParameters<OptInSearchResponse>(
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/opt-in/query/json"),
-            AuthType.Query,
-            request);
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParameters<OptInSearchResponse>(
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/opt-in/query/json"),
+                AuthType.Query,
+                request);
 
     /// <inheritdoc/>
     public Task<OptInSearchResponse> QueryOptInsAsync(OptInQueryRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParametersAsync<OptInSearchResponse>(
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/opt-in/query/json"),
-            AuthType.Query,
-            request);
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParametersAsync<OptInSearchResponse>(
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/opt-in/query/json"),
+                AuthType.Query,
+                request);
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public AlertResponse SendAlert(AlertRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParameters<AlertResponse>(
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/json"),
-            AuthType.Query,
-            request);
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParameters<AlertResponse>(
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/json"),
+                AuthType.Query,
+                request);
 
     /// <inheritdoc/>
     public Task<AlertResponse> SendAlertAsync(AlertRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParametersAsync<AlertResponse>(
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/json"),
-            AuthType.Query,
-            request);
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParametersAsync<AlertResponse>(
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/alert/json"),
+                AuthType.Query,
+                request);
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public TwoFactorAuthResponse SendTwoFactorAuth(TwoFactorAuthRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParameters<TwoFactorAuthResponse>(
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/2fa/json"),
-            AuthType.Query,
-            request);
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParameters<TwoFactorAuthResponse>(
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/2fa/json"),
+                AuthType.Query,
+                request);
 
     /// <inheritdoc/>
     public Task<TwoFactorAuthResponse> SendTwoFactorAuthAsync(TwoFactorAuthRequest request, Credentials creds = null) =>
-        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider).DoGetRequestWithQueryParametersAsync<TwoFactorAuthResponse>(
-            ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/2fa/json"),
-            AuthType.Query,
-            request);
+        ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
+            .DoGetRequestWithQueryParametersAsync<TwoFactorAuthResponse>(
+                ApiRequest.GetBaseUri(ApiRequest.UriType.Rest, "/sc/us/2fa/json"),
+                AuthType.Query,
+                request);
+
+    private Credentials GetCredentials(Credentials overridenCredentials) => overridenCredentials ?? this.Credentials;
 }
diff --git a/Vonage/Verify/VerifyClient.cs b/Vonage/Verify/VerifyClient.cs
@@ -1,4 +1,5 @@
-using System.Threading.Tasks;
+using System;
+using System.Threading.Tasks;
 using Vonage.Common;
 using Vonage.Request;
 
@@ -34,6 +35,7 @@ public void ValidateVerifyResponse(VerifyResponseBase response)
     }
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public VerifyCheckResponse VerifyCheck(VerifyCheckRequest request, Credentials creds = null)
     {
         var response = ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -58,6 +60,7 @@ public async Task<VerifyCheckResponse> VerifyCheckAsync(VerifyCheckRequest reque
     }
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public VerifyControlResponse VerifyControl(VerifyControlRequest request, Credentials creds = null)
     {
         var response = ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -82,6 +85,7 @@ public async Task<VerifyControlResponse> VerifyControlAsync(VerifyControlRequest
     }
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public VerifyResponse VerifyRequest(VerifyRequest request, Credentials creds = null)
     {
         var response = ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -106,6 +110,7 @@ public async Task<VerifyResponse> VerifyRequestAsync(VerifyRequest request, Cred
     }
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public VerifyResponse VerifyRequestWithPSD2(Psd2Request request, Credentials creds = null)
     {
         var response = ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
@@ -130,6 +135,7 @@ public async Task<VerifyResponse> VerifyRequestWithPSD2Async(Psd2Request request
     }
 
     /// <inheritdoc/>
+    [Obsolete("Favor asynchronous version instead.")]
     public VerifySearchResponse VerifySearch(VerifySearchRequest request, Credentials creds = null) =>
         ApiRequest.Build(this.GetCredentials(creds), this.configuration, this.timeProvider)
             .DoGetRequestWithQueryParameters<VerifySearchResponse>(