Remove need for AcceptAgreementRequest, use additional params for Acc…

…eptAgreement method instead

src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AgreementsEndpointTests.cs

@@ -121,8 +121,7 @@ public async Task CreateAcceptAndDeleteAgreement()
         });
 
         // Accept the agreement (should fail)
-        var acceptMetadata = new AcceptAgreementRequest("example_user_agent", "192.168.178.1");
-        var acceptResponse = await _apiClient.AgreementsEndpoint.AcceptAgreement(response.Result!.Id, acceptMetadata);
+        var acceptResponse = await _apiClient.AgreementsEndpoint.AcceptAgreement(response.Result!.Id, "example_user_agent", "192.168.178.1");
         AssertionHelpers.AssertNordigenApiResponseIsUnsuccessful(acceptResponse, HttpStatusCode.Forbidden);
         Assert.That(acceptResponse.Error!.Detail,
             Is.EqualTo(

src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AgreementsEndpointTests.cs

@@ -1,5 +1,4 @@
 using FakeItEasy;
-using RobinTTY.NordigenApiClient.Models.Requests;
 using RobinTTY.NordigenApiClient.Models.Responses;
 using RobinTTY.NordigenApiClient.Tests.Shared;
 
@@ -99,6 +98,28 @@ public async Task CreateAgreement()
         });
     }
 
+    /// <summary>
+    /// Tests the process of accepting an end user agreement.
+    /// </summary>
+    [Test]
+    public async Task AcceptAgreement()
+    {
+        var apiClient = TestHelpers.GetMockClient(TestHelpers.MockData.AgreementsEndpointMockData.AcceptAgreement,
+            HttpStatusCode.Forbidden);
+
+        var result =
+            await apiClient.AgreementsEndpoint.AcceptAgreement(A.Dummy<Guid>(), A.Dummy<string>(), A.Dummy<string>());
+
+        AssertionHelpers.AssertNordigenApiResponseIsUnsuccessful(result, HttpStatusCode.Forbidden);
+        Assert.Multiple(() =>
+        {
+            Assert.That(result.Error?.Summary, Is.EqualTo("Insufficient permissions"));
+            Assert.That(result.Error?.Detail,
+                Is.EqualTo(
+                    "Your company doesn't have permission to accept EUA. You'll have to use our default form for this action."));
+        });
+    }
+
     /// <summary>
     /// Tests the creation of end user agreements.
     /// </summary>
@@ -109,6 +130,7 @@ public async Task DeleteAgreement()
             HttpStatusCode.OK);
 
         var result = await apiClient.AgreementsEndpoint.DeleteAgreement(A.Dummy<Guid>());
+
         AssertionHelpers.AssertNordigenApiResponseIsSuccessful(result, HttpStatusCode.OK);
         Assert.Multiple(() =>
         {
@@ -246,4 +268,4 @@ public async Task CreateAgreementWithInvalidParamsAtPolishInstitution()
     }
 
     #endregion
-}
+}

src/RobinTTY.NordigenApiClient.Tests/Mocks/Responses/MockResponsesModel.cs

@@ -44,8 +44,9 @@ internal class AccountsEndpointMockData(
 
 internal class AgreementsEndpointMockData(
     ResponsePage<Agreement> getAgreements,
-    Agreement createAgreement,
     Agreement getAgreement,
+    Agreement createAgreement,
+    BasicResponse acceptAgreement,
     BasicResponse deleteAgreement,
     BasicResponse getAgreementWithInvalidGuid,
     CreateAgreementError createAgreementWithInvalidInstitutionId,
@@ -54,8 +55,9 @@ internal class AgreementsEndpointMockData(
     CreateAgreementError createAgreementWithInvalidParamsAtPolishInstitution)
 {
     public ResponsePage<Agreement> GetAgreements { get; set; } = getAgreements;
-    public Agreement CreateAgreement { get; set; } = createAgreement;
     public Agreement GetAgreement { get; set; } = getAgreement;
+    public Agreement CreateAgreement { get; set; } = createAgreement;
+    public BasicResponse AcceptAgreement { get; set; } = acceptAgreement;
     public BasicResponse DeleteAgreement { get; set; } = deleteAgreement;
 
     public BasicResponse GetAgreementWithInvalidGuid { get; set; } = getAgreementWithInvalidGuid;

src/RobinTTY.NordigenApiClient.Tests/Mocks/Responses/responses.json

@@ -196,6 +196,11 @@
         "transactions"
       ]
     },
+    "AcceptAgreement": {
+      "summary": "Insufficient permissions",
+      "detail": "Your company doesn't have permission to accept EUA. You'll have to use our default form for this action.",
+      "status_code": 403
+    },
     "DeleteAgreement": {
       "summary": "End User Agreement deleted",
       "detail": "End User Agreement bb37bc52-5b1d-44f9-b1cd-ec9594f25387 deleted"

src/RobinTTY.NordigenApiClient/Contracts/IAgreementsEndpoint.cs

@@ -1,5 +1,4 @@
 using RobinTTY.NordigenApiClient.Models.Errors;
-using RobinTTY.NordigenApiClient.Models.Requests;
 using RobinTTY.NordigenApiClient.Models.Responses;
 
 namespace RobinTTY.NordigenApiClient.Contracts;
@@ -79,19 +78,21 @@ Task<NordigenApiResponse<BasicResponse, BasicResponse>> DeleteAgreement(string i
     /// Accepts an end user agreement. Only available to customers with an enterprise contract at Nordigen.
     /// </summary>
     /// <param name="id">The id of the end user agreement to accept.</param>
-    /// <param name="metadata">The metadata required to accept the end user agreement.</param>
+    /// <param name="userAgent">User agent of the client that accepts the request.</param>
+    /// <param name="ipAddress">IP address of the client that accepts the request.</param>
     /// <param name="cancellationToken">Optional token to signal cancellation of the operation.</param>
     /// <returns>A <see cref="NordigenApiResponse{TResponse, TError}" /> which contains the accepted end user agreement.</returns>
-    Task<NordigenApiResponse<Agreement, BasicResponse>> AcceptAgreement(Guid id,
-        AcceptAgreementRequest metadata, CancellationToken cancellationToken = default);
+    Task<NordigenApiResponse<Agreement, BasicResponse>> AcceptAgreement(Guid id, string userAgent, string ipAddress,
+        CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Accepts an end user agreement. Only available to customers with an enterprise contract at Nordigen.
     /// </summary>
     /// <param name="id">The id of the end user agreement to accept.</param>
-    /// <param name="metadata">The metadata required to accept the end user agreement.</param>
+    /// <param name="userAgent">User agent of the client that accepts the request.</param>
+    /// <param name="ipAddress">IP address of the client that accepts the request.</param>
     /// <param name="cancellationToken">Optional token to signal cancellation of the operation.</param>
     /// <returns>A <see cref="NordigenApiResponse{TResponse, TError}" /> which contains the accepted end user agreement.</returns>
-    Task<NordigenApiResponse<Agreement, BasicResponse>> AcceptAgreement(string id,
-        AcceptAgreementRequest metadata, CancellationToken cancellationToken = default);
-}
+    Task<NordigenApiResponse<Agreement, BasicResponse>> AcceptAgreement(string id, string userAgent, string ipAddress,
+        CancellationToken cancellationToken = default);
+}

src/RobinTTY.NordigenApiClient/Endpoints/AgreementsEndpoint.cs

@@ -65,13 +65,13 @@ public async Task<NordigenApiResponse<BasicResponse, BasicResponse>> DeleteAgree
 
     /// <inheritdoc />
     public async Task<NordigenApiResponse<Agreement, BasicResponse>> AcceptAgreement(Guid id,
-        AcceptAgreementRequest metadata, CancellationToken cancellationToken = default) =>
-        await AcceptAgreementInternal(id.ToString(), metadata, cancellationToken);
+        string userAgent, string ipAddress, CancellationToken cancellationToken = default) =>
+        await AcceptAgreementInternal(id.ToString(), userAgent, ipAddress, cancellationToken);
 
     /// <inheritdoc />
     public async Task<NordigenApiResponse<Agreement, BasicResponse>> AcceptAgreement(string id,
-        AcceptAgreementRequest metadata, CancellationToken cancellationToken = default) =>
-        await AcceptAgreementInternal(id, metadata, cancellationToken);
+        string userAgent, string ipAddress, CancellationToken cancellationToken = default) =>
+        await AcceptAgreementInternal(id, userAgent, ipAddress, cancellationToken);
 
     private async Task<NordigenApiResponse<Agreement, BasicResponse>> GetAgreementInternal(string id,
         CancellationToken cancellationToken) =>
@@ -84,9 +84,10 @@ await _nordigenClient.MakeRequest<BasicResponse, BasicResponse>(
             $"{NordigenEndpointUrls.AgreementsEndpoint}{id}/", HttpMethod.Delete, cancellationToken);
 
     private async Task<NordigenApiResponse<Agreement, BasicResponse>> AcceptAgreementInternal(string id,
-        AcceptAgreementRequest metadata, CancellationToken cancellationToken)
+        string userAgent, string ipAddress, CancellationToken cancellationToken)
     {
-        var body = JsonContent.Create(metadata);
+        var acceptAgreementRequest = new AcceptAgreementRequest(userAgent, ipAddress);
+        var body = JsonContent.Create(acceptAgreementRequest);
         return await _nordigenClient.MakeRequest<Agreement, BasicResponse>(
             $"{NordigenEndpointUrls.AgreementsEndpoint}{id}/accept/", HttpMethod.Put, cancellationToken, body: body);
     }

src/RobinTTY.NordigenApiClient/Models/Requests/AcceptAgreementRequest.cs

@@ -5,7 +5,7 @@ namespace RobinTTY.NordigenApiClient.Models.Requests;
 /// <summary>
 /// The metadata required to accept an end user agreement via the Nordigen API.
 /// </summary>
-public class AcceptAgreementRequest
+internal class AcceptAgreementRequest
 {
     /// <summary>
     /// User agent of the client that accepts the request.
@@ -14,7 +14,7 @@ public class AcceptAgreementRequest
     public string UserAgent { get; set; }
 
     /// <summary>
-    /// IP address of the client.
+    /// IP address of the client that accepts the request.
     /// </summary>
     [JsonPropertyName("ip_address")]
     public string IpAddress { get; set; }
@@ -23,7 +23,7 @@ public class AcceptAgreementRequest
     /// Creates a new instance of <see cref="AcceptAgreementRequest" />.
     /// </summary>
     /// <param name="userAgent">User agent of the client that accepts the request.</param>
-    /// <param name="ipAddress">IP address of the client.</param>
+    /// <param name="ipAddress">IP address of the client that accepts the request.</param>
     public AcceptAgreementRequest(string userAgent, string ipAddress)
     {
         UserAgent = userAgent;