Mark TerminalCloudApi, TerminalLocalApi and TerminalLocalApiUnencrypt…

…ed as obsolete
Adyen · Sep 24, 2024 · a0e0303 · a0e0303
1 parent a104b12
commit a0e0303
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 15 deletions.
diff --git a/Adyen.Test/TerminalApiAsyncServiceTest.cs b/Adyen.Test/TerminalApiAsyncServiceTest.cs
@@ -33,7 +33,6 @@ public async Task RequestEncryptedAsync_Success() {
                 Assert.Fail();
             }
         }
-
 
         [TestMethod]
         public void RequestEncrypted_Success() {
@@ -92,7 +91,7 @@ public void Request_Success() {
         }
 
         [TestMethod]
-        public void TestDecryptNotification()
+        public void DecryptNotification_Success()
         {
             try
             {

diff --git a/Adyen.Test/TerminalApiLocalServiceTest.cs b/Adyen.Test/TerminalApiLocalServiceTest.cs
@@ -34,7 +34,6 @@ public async Task RequestEncryptedAsync_Success() {
             }
         }
 
-
         [TestMethod]
         public void RequestEncrypted_Success() {
             try
@@ -92,7 +91,7 @@ public void Request_Success() {
         }
 
         [TestMethod]
-        public void TestDecryptNotification()
+        public void DecryptNotification_Success()
         {
             try
             {

diff --git a/Adyen/Service/TerminalCloudApi.cs b/Adyen/Service/TerminalCloudApi.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 using Adyen.ApiSerialization;
@@ -6,20 +7,23 @@
 
 namespace Adyen.Service
 {
+    [Obsolete("Use ITerminalApiSyncService or ITerminalApiAsyncService instead.")]
     public interface ITerminalCloudApi
     {
         /// <summary>
         /// CloudApi asynchronous call
         /// </summary>
         /// <param name="saleToPoiRequest"></param>
         /// <returns></returns>
+        [Obsolete("Use ITerminalApiAsyncService.Request(..) instead.")]
         SaleToPOIResponse TerminalRequestAsync(SaleToPOIMessage saleToPoiRequest);
-
+        
         /// <summary>
         /// CloudApi synchronous call
         /// </summary>
         /// <param name="saleToPoiRequest"></param>
         /// <returns></returns>
+        [Obsolete("Use ITerminalApiSyncService.Request(..) instead.")]
         SaleToPOIResponse TerminalRequestSync(SaleToPOIMessage saleToPoiRequest);
 
         /// <summary>
@@ -28,6 +32,7 @@ public interface ITerminalCloudApi
         /// <param name="saleToPoiRequest"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
+        [Obsolete("Use ITerminalApiAsyncService.RequestAsync(..) instead.")]
         Task<SaleToPOIResponse> TerminalRequestAsynchronousAsync(SaleToPOIMessage saleToPoiRequest, CancellationToken cancellationToken = default);
 
         /// <summary>
@@ -36,16 +41,19 @@ public interface ITerminalCloudApi
         /// <param name="saleToPoiRequest"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
+        [Obsolete("Use ITerminalApiSyncService.RequestAsync(..) instead.")]
         Task<SaleToPOIResponse> TerminalRequestSynchronousAsync(SaleToPOIMessage saleToPoiRequest, CancellationToken cancellationToken = default);
     }
+
+    [Obsolete("Use TerminalApiSyncService or TerminalApiAsyncService instead.")]
     public class TerminalCloudApi : AbstractService, ITerminalCloudApi 
     {
         private readonly TerminalApi _terminalApiAsync;
         private readonly TerminalApi _terminalApiSync;
         private readonly SaleToPoiMessageSerializer _saleToPoiMessageSerializer;
         private readonly string _baseUrl;
 
-
+        [Obsolete("Use TerminalApiSyncService or TerminalApiAsyncService instead.")]
         public TerminalCloudApi(Client client)
             : base(client)
         {
@@ -55,7 +63,8 @@ public TerminalCloudApi(Client client)
             _baseUrl = client.GetCloudApiEndpoint();
 
         }
-
+
+        [Obsolete("Use TerminalApiAsyncService.Request(..) instead.")]
         public SaleToPOIResponse TerminalRequestAsync(SaleToPOIMessage saleToPoiRequest)
         {
             var serializedMessage = _saleToPoiMessageSerializer.Serialize(saleToPoiRequest);
@@ -69,6 +78,7 @@ public SaleToPOIResponse TerminalRequestAsync(SaleToPOIMessage saleToPoiRequest)
             return _saleToPoiMessageSerializer.Deserialize(response);
         }
 
+        [Obsolete("Use TerminalApiSyncService.Request(..) instead.")]
         public SaleToPOIResponse TerminalRequestSync(SaleToPOIMessage saleToPoiRequest)
         {
             var serializedMessage = _saleToPoiMessageSerializer.Serialize(saleToPoiRequest);
@@ -82,6 +92,7 @@ public SaleToPOIResponse TerminalRequestSync(SaleToPOIMessage saleToPoiRequest)
             return _saleToPoiMessageSerializer.Deserialize(response);
         }
 
+        [Obsolete("Use TerminalApiAsyncService.RequestAsync(..) instead.")]
         public async Task<SaleToPOIResponse> TerminalRequestAsynchronousAsync(SaleToPOIMessage saleToPoiRequest, CancellationToken cancellationToken = default)
         {
             var serializedMessage = _saleToPoiMessageSerializer.Serialize(saleToPoiRequest);
@@ -95,6 +106,7 @@ public async Task<SaleToPOIResponse> TerminalRequestAsynchronousAsync(SaleToPOIM
             return _saleToPoiMessageSerializer.Deserialize(response);
         }
 
+        [Obsolete("Use TerminalApiSyncService.RequestAsync(..) instead.")]
         public async Task<SaleToPOIResponse> TerminalRequestSynchronousAsync(SaleToPOIMessage saleToPoiRequest, CancellationToken cancellationToken = default)
         {
             var serializedMessage = _saleToPoiMessageSerializer.Serialize(saleToPoiRequest);

diff --git a/Adyen/Service/TerminalLocalApi.cs b/Adyen/Service/TerminalLocalApi.cs
@@ -18,7 +18,7 @@ public interface ITerminalLocalApi
         /// <param name="saleToPoiRequest"></param>
         /// <param name="encryptionCredentialDetails"></param>
         /// <returns></returns>
-        [Obsolete("Use ITerminalApiLocalService instead.")]
+        [Obsolete("Use ITerminalApiLocalService.RequestEncrypted(..) instead.")]
         SaleToPOIResponse TerminalRequest(SaleToPOIMessage saleToPoiRequest, EncryptionCredentialDetails encryptionCredentialDetails);
 
         /// <summary>
@@ -27,7 +27,7 @@ public interface ITerminalLocalApi
         /// <param name="saleToPoiRequest"></param>
         /// <param name="encryptionCredentialDetails"></param>
         /// <returns></returns>
-        [Obsolete("Use ITerminalApiLocalService instead.")]
+        [Obsolete("Use ITerminalApiLocalService.RequestEncryptedAsync(..) instead.")]
         Task<SaleToPOIResponse> TerminalRequestAsync(SaleToPOIMessage saleToPoiRequest, EncryptionCredentialDetails encryptionCredentialDetails, CancellationToken cancellationToken = default);
 
         /// <summary>
@@ -37,7 +37,7 @@ public interface ITerminalLocalApi
         /// <param name="encryptionCredentialDetails"></param>
         /// <param name="remoteCertificateValidationCallback"></param>
         /// <returns></returns>
-        [Obsolete("Use ITerminalApiLocalService instead.")]
+        [Obsolete("Use ITerminalApiLocalService.RequestEncrypted(..) instead, you can pass the RemoteCertificateValidationCallback on the HttpClient-level.")]
         SaleToPOIResponse TerminalRequest(SaleToPOIMessage saleToPoiRequest, EncryptionCredentialDetails encryptionCredentialDetails, RemoteCertificateValidationCallback remoteCertificateValidationCallback);
 
         /// <summary>
@@ -46,7 +46,7 @@ public interface ITerminalLocalApi
         /// <param name="notification"></param>
         /// <param name="encryptionCredentialDetails"></param>
         /// <returns></returns>
-        [Obsolete("Use ITerminalApiLocalService instead.")]
+        [Obsolete("Use ITerminalApiLocalService.DecryptNotification(..) instead.")]
         string DecryptNotification(string notification, EncryptionCredentialDetails encryptionCredentialDetails);
     }
 
@@ -58,7 +58,6 @@ public class TerminalLocalApi: AbstractService, ITerminalLocalApi
         private readonly SaleToPoiMessageSecuredEncryptor _messageSecuredEncryptor;
         private readonly SaleToPoiMessageSecuredSerializer _saleToPoiMessageSecuredSerializer;
 
-
         [Obsolete("Use TerminalApiLocalService instead.")]
         public TerminalLocalApi(Client client)
             : base(client)
@@ -69,7 +68,7 @@ public TerminalLocalApi(Client client)
             _saleToPoiMessageSecuredSerializer = new SaleToPoiMessageSecuredSerializer();
         }
 
-        [Obsolete("Use TerminalApiLocalService instead.")]
+        [Obsolete("Use TerminalApiLocalService.RequestEncrypted(..) instead.")]
         public SaleToPOIResponse TerminalRequest(SaleToPOIMessage saleToPoiRequest, EncryptionCredentialDetails encryptionCredentialDetails)
         {
             var saleToPoiRequestMessageSerialized = _saleToPoiMessageSerializer.Serialize(saleToPoiRequest);
@@ -87,7 +86,7 @@ public SaleToPOIResponse TerminalRequest(SaleToPOIMessage saleToPoiRequest, Encr
             return _saleToPoiMessageSerializer.Deserialize(decryptResponse);
         }
 
-        [Obsolete("Use TerminalApiLocalService instead.")]
+        [Obsolete("Use TerminalApiLocalService.RequestEncryptedAsync(..) instead.")]
         public async Task<SaleToPOIResponse> TerminalRequestAsync(SaleToPOIMessage saleToPoiRequest, EncryptionCredentialDetails encryptionCredentialDetails, CancellationToken cancellationToken = default)
         {
             var saleToPoiRequestMessageSerialized = _saleToPoiMessageSerializer.Serialize(saleToPoiRequest);
@@ -111,7 +110,7 @@ public SaleToPOIResponse TerminalRequest(SaleToPOIMessage saleToPoiRequest, Encr
             return TerminalRequest(saleToPoiRequest: saleToPoiRequest, encryptionCredentialDetails: encryptionCredentialDetails);
         }
 
-        [Obsolete("Use TerminalApiLocalService instead.")]
+        [Obsolete("Use TerminalApiLocalService.DecryptNotification(..) instead.")]
         public string DecryptNotification(string notification, EncryptionCredentialDetails encryptionCredentialDetails)
         {
             var saleToPoiMessageSecured = _saleToPoiMessageSecuredSerializer.Deserialize(notification);

diff --git a/Adyen/Service/TerminalLocalApiUnencrypted.cs b/Adyen/Service/TerminalLocalApiUnencrypted.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
@@ -7,6 +8,7 @@
 
 namespace Adyen.Service
 {
+    [Obsolete("Use TerminalApiLocalService instead.")]
     public class TerminalLocalApiUnencrypted : AbstractService
     {
         private readonly TerminalApiLocal _terminalApiLocal;
@@ -19,6 +21,8 @@ public class TerminalLocalApiUnencrypted : AbstractService
         /// </summary>
         /// <param name="client">Client</param>
         /// <returns></returns>
+
+        [Obsolete("Use TerminalApiLocalService instead.")]
         public TerminalLocalApiUnencrypted(Client client)
             : base(client)
         {
@@ -34,6 +38,7 @@ public TerminalLocalApiUnencrypted(Client client)
         /// </summary>
         /// <param name="saleToPoiRequest">SaleToPOIMessage</param>
         /// <returns>SaleToPOIResponse</returns>
+        [Obsolete("Use TerminalApiLocalService.Request(..) instead.")]
         public SaleToPOIResponse TerminalRequest(SaleToPOIMessage saleToPoiRequest)
         {
             var saleToPoiRequestJson = _saleToPoiMessageSerializer.Serialize(saleToPoiRequest);
@@ -49,6 +54,7 @@ public SaleToPOIResponse TerminalRequest(SaleToPOIMessage saleToPoiRequest)
         /// <param name="saleToPoiRequest">SaleToPOIMessage</param>
         /// <param name="cancellationToken">CancellationToken</param>
         /// <returns>Task of SaleToPOIResponse</returns>
+        [Obsolete("Use TerminalApiLocalService.RequestAsync(..) instead.")]
         public async Task<SaleToPOIResponse> TerminalRequestAsync(SaleToPOIMessage saleToPoiRequest, CancellationToken cancellationToken = default)
         {
             var saleToPoiRequestJson = _saleToPoiMessageSerializer.Serialize(saleToPoiRequest);