diff --git a/README.md b/README.md index 257cf22..5210108 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@

- +

# NordigenApiClient -This library provides a .NET client for the [GoCardless Bank Account Data API](https://gocardless.com/bank-account-data/) (formerly Nordigen API). The following API endpoints are supported: +This library provides a .NET client for +the [GoCardless Bank Account Data API](https://gocardless.com/bank-account-data/) (formerly Nordigen API). The following +API endpoints are supported: - Token - Institutions @@ -12,7 +14,9 @@ This library provides a .NET client for the [GoCardless Bank Account Data API](h - Requisitions - Accounts -You can get started with the Quickstart Guide below or take a look at the [full documentation](https://robintty.github.io/NordigenApiClient/). You can find the nuget package [here](https://www.nuget.org/packages/RobinTTY.NordigenApiClient). +You can get started with the Quickstart Guide below or take a look at +the [full documentation](https://robintty.github.io/NordigenApiClient/). You can find the nuget +package [here](https://www.nuget.org/packages/RobinTTY.NordigenApiClient). ## Quickstart Guide @@ -61,11 +65,13 @@ You can get started with the Quickstart Guide below or take a look at the [full Console.WriteLine($"Requisition couldn't be created: {requisitionResponse.Error.Summary}"); ``` -5. You will now need to accept the end user agreement by following the authentication link you got in the last step. The authentication flow will roughly look like this: +5. You will now need to accept the end user agreement by following the authentication link you got in the last step. The + authentication flow will roughly look like this: ![authentication-flow](docs/static/img/authentication_flow.png) -6. Now that you have accepted the agreement we once again need to retrieve the requisition we created in step 4. This time the response will include the accounts you are now able to access. +6. Now that you have accepted the agreement we once again need to retrieve the requisition we created in step 4. This + time the response will include the accounts you are now able to access. ```cs var requisitionId = "your-requisition-id"; @@ -79,7 +85,8 @@ You can get started with the Quickstart Guide below or take a look at the [full Console.WriteLine($"Accounts couldn't be retrieved: {accountsResponse.Error.Summary}"); ``` -7. Now you can retrieve details about your bank account and the balances/transactions using the account ID(s) we just acquired: +7. Now you can retrieve details about your bank account and the balances/transactions using the account ID(s) we just + acquired: ```cs var accountId = "your-account-id"; @@ -110,4 +117,6 @@ You can get started with the Quickstart Guide below or take a look at the [full }); ``` -That's it! You are now able to retrieve the account details, balances and transactions of your bank account. If you wanna learn more about this library please refer to the [full documentation](https://robintty.github.io/NordigenApiClient/). +That's it! You are now able to retrieve the account details, balances and transactions of your bank account. If you +wanna learn more about this library please refer to +the [full documentation](https://robintty.github.io/NordigenApiClient/). diff --git a/docs/docs/api-reference/responses/api-rate-limits.md b/docs/docs/api-reference/responses/api-rate-limits.md new file mode 100644 index 0000000..af22d8d --- /dev/null +++ b/docs/docs/api-reference/responses/api-rate-limits.md @@ -0,0 +1,64 @@ +--- +title: ApiRateLimits +--- + +The `ApiRateLimits` class represents the rate limits of the GoCardless API. + +## Properties + +### `RequestLimit` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32) + +Indicates the maximum number of allowed requests within the defined time window. Usually populated in every response. + +### `RemainingRequests` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32) + +Indicates the number of remaining requests you can make in the current time window. Usually populated in every response. + +### `RemainingSecondsInTimeWindow` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32) + +Indicates the time remaining in the current time window (in seconds). Usually populated in every response. + +### `RequestLimitAccountsEndpoint` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32) + +Indicates the maximum number of allowed requests to the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint) within the defined time window. Only populated in responses from the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint). + +### `RemainingRequestsAccountsEndpoint` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32) + +Indicates the number of remaining requests to the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint) you can make in the current time window. Only populated in responses from the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint). + +### `RemainingSecondsInTimeWindowAccountsEndpoint` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32) + +Indicates the time remaining in the current time window (in seconds) for requests to the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint). Only populated in responses from the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint). + +## Constructor + +```csharp +public ApiRateLimits(int requestLimit, int remainingRequests, int remainingTimeInTimeWindow, + int maxAccountRequests, int remainingAccountRequests, int remainingTimeInAccountTimeWindow) +``` + +### Parameters + +#### `requestLimit` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32)? + +Indicates the maximum number of allowed requests within the defined time window. Usually populated in every response. + +#### `remainingRequests` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32)? + +Indicates the number of remaining requests you can make in the current time window. Usually populated in every response. + +#### `remainingSecondsInTimeWindow` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32)? + +Indicates the time remaining in the current time window (in seconds). Usually populated in every response. + +#### `requestLimitAccountsEndpoint` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32)? + +Indicates the maximum number of allowed requests to the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint) within the defined time window. Only populated in responses from the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint). + +#### `remainingRequestsAccountsEndpoint` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32)? + +Indicates the number of remaining requests to the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint) you can make in the current time window. Only populated in responses from the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint). + +#### `remainingSecondsInTimeWindowAccountsEndpoint` - [int](https://learn.microsoft.com/en-us/dotnet/fundamentals/runtime-libraries/system-int32)? + +Indicates the time remaining in the current time window (in seconds) for requests to the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint). Only populated in responses from the [AccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint). diff --git a/docs/docs/api-reference/responses/nordigen-api-response.md b/docs/docs/api-reference/responses/nordigen-api-response.md index 617519d..9dfbe74 100644 --- a/docs/docs/api-reference/responses/nordigen-api-response.md +++ b/docs/docs/api-reference/responses/nordigen-api-response.md @@ -22,10 +22,15 @@ The result returned by the API. Null if the the HTTP response was not successful The error returned by the API. Null if the HTTP response was successful. +### `RateLimits` - [ApiRateLimits](/docs/api-reference/responses/api-rate-limits) + +The rate limits of the GoCardless API. + ## Constructor ```csharp -public NordigenApiResponse(HttpStatusCode statusCode, bool isSuccess, TResult? result, TError? apiError) +public NordigenApiResponse(HttpStatusCode statusCode, bool isSuccess, + TResult? result, TError? apiError, ApiRateLimits rateLimits) ``` ### Parameters @@ -46,6 +51,10 @@ The result returned by the API. Null if the the HTTP response was not successful The error returned by the API. Null if the HTTP response was successful. +#### `rateLimits` - [ApiRateLimits](/docs/api-reference/responses/api-rate-limits) + +The rate limits of the GoCardless API. + ## Handling the `NordigenApiResponse` type To learn more about how to best work with the `NordigenApiResponse` type see the [Handling API responses](/docs/handling-api-responses) guide. diff --git a/docs/docs/handling-rate-limits.md b/docs/docs/handling-rate-limits.md new file mode 100644 index 0000000..07ea907 --- /dev/null +++ b/docs/docs/handling-rate-limits.md @@ -0,0 +1,31 @@ +--- +title: Handling Rate Limits +--- + +The GoCardless API has [rate limits](https://bankaccountdata.zendesk.com/hc/en-gb/articles/11529637772188-Bank-Account-Data-API-Rate-Limits) depending on the endpoint you are using. With most endpoints you shouldn't run into problems since these limits are usually high enough for most uses. + +The [Accounts endpoint](/docs/api-reference/endpoints/accounts-endpoint) has very tight limitations though. It currently has a limit of 10 requests a day per access scope. That means 10 requests to each of the [details](/docs/api-reference/endpoints/accounts-endpoint#getaccountdetails), [balances](/docs/api-reference/endpoints/accounts-endpoint#getbalances) and [transactions](/docs/api-reference/endpoints/accounts-endpoint#gettransactions) endpoints. In the future this limit will be lowered to 4 per day (no date on this as of now). + +Unsuccessful requests to the API will count towards the general rate limits but not the more stringent limits of the [Accounts endpoint](/docs/api-reference/endpoints/accounts-endpoint). Only successful requests will count towards those. + +## Checking API rate limits + +You can check the rate limits as well as remaining requests with each request you make to the API. The property [`NordigenApiResponse.RateLimits`](/docs/api-reference/responses/nordigen-api-response#ratelimits---apiratelimits) will hold the returned information about the current API limits. + +You can check the limits as follows: + +```csharp +// Execute the request you want to make: +var bankAccountDetailsResponse = await client.AccountsEndpoint.GetAccountDetails(accountId); + +Console.WriteLine(bankAccountDetailsResponse.RateLimits.RequestLimit); +Console.WriteLine(bankAccountDetailsResponse.RateLimits.RemainingRequests); +Console.WriteLine(bankAccountDetailsResponse.RateLimits.RemainingSecondsInTimeWindow); +Console.WriteLine(bankAccountDetailsResponse.RateLimits.RequestLimitAccountsEndpoint); +Console.WriteLine(bankAccountDetailsResponse.RateLimits.RemainingRequestsAccountsEndpoint); +Console.WriteLine(bankAccountDetailsResponse.RateLimits.RemainingSecondsInTimeWindowAccountsEndpoint); +``` + +It's important to handle these limits so your applications user experience isn't degraded. Refreshing data from bank accounts should be handled consciously, so you don't use up all your requests in a short time frame and aren't able to update for the rest of the day. + +If you are a company with a contract with GoCardless you can probably get in contact with their team about increasing these limits. diff --git a/docs/release-notes/v10_0_0.md b/docs/release-notes/v10_0_0.md index 83a0167..cea4c17 100644 --- a/docs/release-notes/v10_0_0.md +++ b/docs/release-notes/v10_0_0.md @@ -39,8 +39,8 @@ public async Task, BasicResponse>> GetInst The `TokenPairUpdated` event is now raised whenever the `JsonWebTokenPair` property is successfully updated. Not only when it was automatically updated but also when done so by the user. -**Full Changelog**: [v9.0.0...v10.0.0](https://github.com/RobinTTY/NordigenApiClient/compare/v9.0.0...v10.0.0) - ## Other improvements A full documentation of the library is now available at: [https://robintty.github.io/NordigenApiClient/](https://robintty.github.io/NordigenApiClient/) + +**Full Changelog**: [v9.0.0...v10.0.0](https://github.com/RobinTTY/NordigenApiClient/compare/v9.0.0...v10.0.0) diff --git a/docs/release-notes/v10_1_0.md b/docs/release-notes/v10_1_0.md new file mode 100644 index 0000000..e8cb6a4 --- /dev/null +++ b/docs/release-notes/v10_1_0.md @@ -0,0 +1,11 @@ +--- +slug: v10.1.0 +title: v10.1.0 +date: 2024-08-19T00:00 +--- + +Added the ability to check newly introduced rate limits in the GoCardless API. + +Please refer to the [documentation](/docs/handling-rate-limits) for more information. You can also see the [announcement from GoCardless](https://bankaccountdata.zendesk.com/hc/en-gb/articles/11529584398236-Bank-API-Rate-Limits-and-Rate-Limit-Headers). + +**Full Changelog**: [v10.0.0...v10.1.0](https://github.com/RobinTTY/NordigenApiClient/compare/v10.0.0...v10.1.0) diff --git a/docs/sidebars.ts b/docs/sidebars.ts index eb9e3fa..2cb5bbe 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -6,6 +6,7 @@ const sidebars: SidebarsConfig = { "quickstart-guide", "handling-api-responses", "handling-authentication-tokens", + "handling-rate-limits", "using-a-different-base-address", "usage-with-older-dotnet-versions", "testing", @@ -38,6 +39,7 @@ const sidebars: SidebarsConfig = { "api-reference/responses/address", "api-reference/responses/agreement", "api-reference/responses/amount-currency-pair", + "api-reference/responses/api-rate-limits", "api-reference/responses/balance", "api-reference/responses/balance-type", "api-reference/responses/bank-account", diff --git a/src/RobinTTY.NordigenApiClient.ExampleApplication/Program.cs b/src/RobinTTY.NordigenApiClient.ExampleApplication/Program.cs index 7fb9570..f5f959f 100644 --- a/src/RobinTTY.NordigenApiClient.ExampleApplication/Program.cs +++ b/src/RobinTTY.NordigenApiClient.ExampleApplication/Program.cs @@ -72,4 +72,4 @@ Console.WriteLine($"Remittance: {transaction.RemittanceInformationUnstructured}"); Console.WriteLine($"Booking date:{transaction.ValueDate}"); Console.WriteLine($"Amount: {transactionAmount.Amount} {transactionAmount.Currency}"); - }); + }); \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/.gitignore b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/.gitignore new file mode 100644 index 0000000..6898b60 --- /dev/null +++ b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/.gitignore @@ -0,0 +1,13 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Rider ignored files +/modules.xml +/.idea.RobinTTY.NordigenApiClient.iml +/contentModel.xml +/projectSettingsUpdater.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/.name b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/.name new file mode 100644 index 0000000..611320e --- /dev/null +++ b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/.name @@ -0,0 +1 @@ +RobinTTY.NordigenApiClient \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/encodings.xml b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/encodings.xml new file mode 100644 index 0000000..df87cf9 --- /dev/null +++ b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/encodings.xml @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/indexLayout.xml b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/indexLayout.xml new file mode 100644 index 0000000..7b08163 --- /dev/null +++ b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/indexLayout.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/vcs.xml b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/vcs.xml new file mode 100644 index 0000000..b2bdec2 --- /dev/null +++ b/src/RobinTTY.NordigenApiClient.Tests/.idea/.idea.RobinTTY.NordigenApiClient.dir/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/AuthenticationTests.cs b/src/RobinTTY.NordigenApiClient.Tests/AuthenticationTests.cs index c778001..9eafc69 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/AuthenticationTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/AuthenticationTests.cs @@ -75,4 +75,4 @@ public void CheckForTokenExpiry() Assert.That(token.IsExpired(diffInvalid), Is.True); }); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/EnumDescriptionConverterTests.cs b/src/RobinTTY.NordigenApiClient.Tests/EnumDescriptionConverterTests.cs index 885a63f..00669e1 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/EnumDescriptionConverterTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/EnumDescriptionConverterTests.cs @@ -66,4 +66,4 @@ public void DeserializeEnum(string descriptor, T expectedDeserializedValue) var enumValue = JsonSerializer.Deserialize($"\"{descriptor}\""); Assert.That(enumValue, Is.EqualTo(expectedDeserializedValue)); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/CredentialTests.cs b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/CredentialTests.cs index 92a98f1..7085e5a 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/CredentialTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/CredentialTests.cs @@ -17,7 +17,8 @@ public void Setup() #region RequestsWithSuccessfulResponse /// - /// Tests that is populated after the first authenticated request is made. + /// Tests that is populated after the first authenticated request is + /// made. /// [Test] public async Task CheckValidTokensAfterRequest() @@ -105,4 +106,4 @@ public async Task ExecuteRequestWithUnauthorizedIp() } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AccountsEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AccountsEndpointTests.cs index a2608a4..ec5b3b9 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AccountsEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AccountsEndpointTests.cs @@ -210,7 +210,8 @@ public async Task GetTransactionRangeInFuture() } /// - /// Tests the retrieval of transactions within a specific time frame where the date range is incorrect, since the endDate is before the startDate. This should throw an exception. + /// Tests the retrieval of transactions within a specific time frame where the date range is incorrect, since the + /// endDate is before the startDate. This should throw an exception. /// [Test] public void GetTransactionRangeWithIncorrectRange() @@ -237,4 +238,4 @@ await _apiClient.AccountsEndpoint.GetTransactions(_accountId, DateOnly.FromDateT } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AgreementsEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AgreementsEndpointTests.cs index 015b1b1..bb0d1c4 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AgreementsEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/AgreementsEndpointTests.cs @@ -201,7 +201,8 @@ await _apiClient.AgreementsEndpoint.CreateAgreement(null!, uint.MaxValue, uint.M } /// - /// Tests the creation of an end user agreement with invalid accessValidForDays and maxHistoricalDays for that particular institution. + /// Tests the creation of an end user agreement with invalid accessValidForDays and maxHistoricalDays for that + /// particular institution. /// [Test] public async Task CreateAgreementWithInvalidArgumentsForInstitution() @@ -237,11 +238,12 @@ await _apiClient.AgreementsEndpoint.CreateAgreement("PKO_BPKOPLPW", Assert.That(response.Error!.AccessScopeError!.Detail, Is.EqualTo("For this institution the following scopes are required together: ['details', 'balances']")); - Assert.That(response.Error!.AccessScopeError.Summary, Is.EqualTo("Institution access scope dependencies error")); + Assert.That(response.Error!.AccessScopeError.Summary, + Is.EqualTo("Institution access scope dependencies error")); Assert.That(new[] {response.Error!.InstitutionIdError, response.Error!.AgreementError}, Has.All.Null); }); } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/InstitutionsEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/InstitutionsEndpointTests.cs index 5a91c64..cfcc3b4 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/InstitutionsEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/InstitutionsEndpointTests.cs @@ -144,4 +144,4 @@ public async Task GetNonExistingInstitution() } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/RequisitionsEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/RequisitionsEndpointTests.cs index 75de8d1..c005721 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/RequisitionsEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/RequisitionsEndpointTests.cs @@ -208,4 +208,4 @@ await _apiClient.RequisitionsEndpoint.CreateRequisition("", redirect, agreementI } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/TokenEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/TokenEndpointTests.cs index cf48537..5e62447 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/TokenEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/Endpoints/TokenEndpointTests.cs @@ -48,8 +48,8 @@ public async Task ReuseExpiredToken() } /// - /// Tests whether the event is raised when the token pair is updated - /// automatically by the client itself. + /// Tests whether the event is raised when the token pair is updated + /// automatically by the client itself. /// [Test] public async Task TokenPairUpdateIsRaisedOnInternalUpdate() @@ -68,10 +68,10 @@ public async Task TokenPairUpdateIsRaisedOnInternalUpdate() Assert.That(eventArgs.JsonWebTokenPair.RefreshToken.EncodedToken, Is.Not.Empty); }); } - + /// - /// Tests whether the event is raised when the token pair is updated - /// by the user. + /// Tests whether the event is raised when the token pair is updated + /// by the user. /// [Test] public void TokenPairUpdateIsRaisedOnManualUpdate() @@ -117,4 +117,4 @@ public async Task GetTokenWithInvalidCredentials() } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/NordigenApiClientTests.cs b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/NordigenApiClientTests.cs index 7895e27..db1fcd3 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/LiveApi/NordigenApiClientTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/LiveApi/NordigenApiClientTests.cs @@ -71,4 +71,4 @@ private async Task ExecuteExampleRequest(NordigenClient apiClient) } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Mocks/CredentialTests.cs b/src/RobinTTY.NordigenApiClient.Tests/Mocks/CredentialTests.cs index b12c819..a0bfd95 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Mocks/CredentialTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Mocks/CredentialTests.cs @@ -9,7 +9,8 @@ public class CredentialTests #region RequestsWithSuccessfulResponse /// - /// Tests that is populated after the first authenticated request is made. + /// Tests that is populated after the first authenticated request is + /// made. /// [Test] public async Task CheckValidTokensAfterRequest() @@ -29,8 +30,8 @@ public async Task CheckValidTokensAfterRequest() } /// - /// Tests whether the event is raised when the token pair is updated - /// automatically by the client itself. + /// Tests whether the event is raised when the token pair is updated + /// automatically by the client itself. /// [Test] public async Task TokenPairUpdateIsRaisedOnInternalUpdate() @@ -52,8 +53,8 @@ public async Task TokenPairUpdateIsRaisedOnInternalUpdate() } /// - /// Tests whether the event is raised when the token pair is updated - /// by the user. + /// Tests whether the event is raised when the token pair is updated + /// by the user. /// [Test] public void TokenPairUpdateIsRaisedOnManualUpdate() @@ -120,4 +121,4 @@ public async Task ExecuteRequestWithUnauthorizedIp() } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AccountsEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AccountsEndpointTests.cs index 116a243..6969572 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AccountsEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AccountsEndpointTests.cs @@ -234,7 +234,8 @@ public async Task GetTransactionRangeInFuture() } /// - /// Tests the retrieval of transactions within a specific time frame where the date range is incorrect, since the endDate is before the startDate. This should throw an exception. + /// Tests the retrieval of transactions within a specific time frame where the date range is incorrect, since the + /// endDate is before the startDate. This should throw an exception. /// [Test] public void GetTransactionRangeWithIncorrectRange() @@ -262,4 +263,4 @@ await apiClient.AccountsEndpoint.GetTransactions(A.Dummy(), DateOnly.FromD } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AgreementsEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AgreementsEndpointTests.cs index 38bdad7..84a0a88 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AgreementsEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/AgreementsEndpointTests.cs @@ -268,4 +268,4 @@ public async Task CreateAgreementWithInvalidParamsAtPolishInstitution() } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/InstitutionsEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/InstitutionsEndpointTests.cs index 023d426..905813c 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/InstitutionsEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/InstitutionsEndpointTests.cs @@ -126,4 +126,4 @@ public async Task GetNonExistingInstitution() } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/RequisitionsEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/RequisitionsEndpointTests.cs index 0c040df..dbc00a6 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/RequisitionsEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/RequisitionsEndpointTests.cs @@ -235,4 +235,4 @@ await apiClient.RequisitionsEndpoint.CreateRequisition("", redirect, agreementId } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/TokenEndpointTests.cs b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/TokenEndpointTests.cs index 025b788..bbb7521 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/TokenEndpointTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Endpoints/TokenEndpointTests.cs @@ -66,4 +66,4 @@ public async Task RefreshAccessToken() } #endregion -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Mocks/FakeHttpMessageHandler.cs b/src/RobinTTY.NordigenApiClient.Tests/Mocks/FakeHttpMessageHandler.cs index b184a01..e898e68 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Mocks/FakeHttpMessageHandler.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Mocks/FakeHttpMessageHandler.cs @@ -7,6 +7,6 @@ public abstract Task FakeSendAsync( // sealed so FakeItEasy won't intercept calls to this method protected sealed override Task SendAsync( - HttpRequestMessage request, CancellationToken cancellationToken) - => FakeSendAsync(request, cancellationToken); -} + HttpRequestMessage request, CancellationToken cancellationToken) => + FakeSendAsync(request, cancellationToken); +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Responses/MockResponsesModel.cs b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Responses/MockResponsesModel.cs index 3ea34b5..245de2d 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Mocks/Responses/MockResponsesModel.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Mocks/Responses/MockResponsesModel.cs @@ -122,4 +122,4 @@ internal class CredentialMockData(BasicResponse noAccountForGivenCredentialsErro { public BasicResponse NoAccountForGivenCredentialsError { get; set; } = noAccountForGivenCredentialsError; public BasicResponse IpNotWhitelistedError { get; set; } = ipNotWhitelistedError; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/RobinTTY.NordigenApiClient.Tests.csproj b/src/RobinTTY.NordigenApiClient.Tests/RobinTTY.NordigenApiClient.Tests.csproj index 08a954f..3c7eb42 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/RobinTTY.NordigenApiClient.Tests.csproj +++ b/src/RobinTTY.NordigenApiClient.Tests/RobinTTY.NordigenApiClient.Tests.csproj @@ -11,10 +11,10 @@ - - - - + + + + @@ -40,7 +40,7 @@ Always - PreserveNewest + PreserveNewest diff --git a/src/RobinTTY.NordigenApiClient.Tests/Serialization/CreateAgreementErrorTests.cs b/src/RobinTTY.NordigenApiClient.Tests/Serialization/CreateAgreementErrorTests.cs index a76c792..ebde002 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Serialization/CreateAgreementErrorTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Serialization/CreateAgreementErrorTests.cs @@ -32,4 +32,4 @@ public void DeserializeTransactionWithSingleCurrencyExchange() "For this institution the following scopes are required together: ['details', 'balances']; Some Other Error Detail")); }); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Serialization/TransactionTests.cs b/src/RobinTTY.NordigenApiClient.Tests/Serialization/TransactionTests.cs index 252df09..818adfa 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Serialization/TransactionTests.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Serialization/TransactionTests.cs @@ -90,4 +90,4 @@ public async Task DeserializeWithException() "The following JSON content caused the problem: { \"transactionId\": \"AB123456789\", \"entryReference\": \"123456789\", \"bookingDate\": \"2023-03-20\", \"bookingDateTime\":")); } } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Shared/AssertionHelpers.cs b/src/RobinTTY.NordigenApiClient.Tests/Shared/AssertionHelpers.cs index 3d5a5b1..8bf4952 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Shared/AssertionHelpers.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Shared/AssertionHelpers.cs @@ -51,4 +51,4 @@ internal static void AssertBasicResponseMatchesExpectations(BasicResponse? respo Assert.That(response?.Detail, Is.EqualTo(detail)); }); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Shared/TestHelpers.cs b/src/RobinTTY.NordigenApiClient.Tests/Shared/TestHelpers.cs index e83b96f..5d58e7e 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Shared/TestHelpers.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Shared/TestHelpers.cs @@ -12,6 +12,7 @@ namespace RobinTTY.NordigenApiClient.Tests.Shared; internal static class TestHelpers { private static readonly JsonSerializerOptions JsonSerializerOptions; + public static TestSecrets Secrets { get; } public static MockResponsesModel MockData { get; } @@ -41,8 +42,9 @@ internal static NordigenClient GetConfiguredClient(string? baseAddress = null) } internal static NordigenClient GetMockClient(object? value, HttpStatusCode statusCode, - bool addDefaultAuthToken = true) => GetMockClient([new ValueTuple(value, statusCode)], - addDefaultAuthToken); + bool addDefaultAuthToken = true) => + GetMockClient([new ValueTuple(value, statusCode)], + addDefaultAuthToken); private static NordigenClient GetMockClient(List<(object? Value, HttpStatusCode StatusCode)> responses, bool addDefaultAuthToken = true) @@ -79,10 +81,10 @@ private static NordigenClient GetMockClient(List<(object? Value, HttpStatusCode var credentials = new NordigenClientCredentials(Secrets.ValidSecretId, Secrets.ValidSecretKey); return new NordigenClient(mockHttpClient, credentials); } - + private static TestSecrets? GetSecrets() => new ConfigurationBuilder() .AddJsonFile("appsettings.test.json") .AddUserSecrets() .Build().Get(); -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Shared/TestSecrets.cs b/src/RobinTTY.NordigenApiClient.Tests/Shared/TestSecrets.cs index 4675a55..a2484b5 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Shared/TestSecrets.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Shared/TestSecrets.cs @@ -18,4 +18,4 @@ public class TestSecrets( public string ValidSecretIdWithWhitelist { get; init; } = validSecretIdWithWhitelist; public string ValidSecretKeyWithWhitelist { get; init; } = validSecretKeyWithWhitelist; public string UnauthorizedJwtToken { get; init; } = unauthorizedJwtToken; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/Usings.cs b/src/RobinTTY.NordigenApiClient.Tests/Usings.cs index 6c7f844..d49d29e 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/Usings.cs +++ b/src/RobinTTY.NordigenApiClient.Tests/Usings.cs @@ -1,3 +1,3 @@ global using System.Net; global using System.Net.Http; -global using NUnit.Framework; +global using NUnit.Framework; \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient.Tests/appsettings.test.json b/src/RobinTTY.NordigenApiClient.Tests/appsettings.test.json index 1e0aaeb..13baabe 100644 --- a/src/RobinTTY.NordigenApiClient.Tests/appsettings.test.json +++ b/src/RobinTTY.NordigenApiClient.Tests/appsettings.test.json @@ -1,10 +1,10 @@ { - "ValidSecretId": "", - "ValidSecretKey": "", - "ExpiredJwtAccessToken": "", - "ValidJwtRefreshToken": "", - "ValidAccountId": "", - "ValidSecretIdWithWhitelist": "", - "ValidSecretKeyWithWhitelist": "", - "UnauthorizedJwtToken": "" + "ValidSecretId": "", + "ValidSecretKey": "", + "ExpiredJwtAccessToken": "", + "ValidJwtRefreshToken": "", + "ValidAccountId": "", + "ValidSecretIdWithWhitelist": "", + "ValidSecretKeyWithWhitelist": "", + "UnauthorizedJwtToken": "" } \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Contracts/IAccountsEndpoint.cs b/src/RobinTTY.NordigenApiClient/Contracts/IAccountsEndpoint.cs index dc1f507..1c5618c 100644 --- a/src/RobinTTY.NordigenApiClient/Contracts/IAccountsEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Contracts/IAccountsEndpoint.cs @@ -34,7 +34,10 @@ Task> GetAccount(string id, /// /// The id of the account for which to get the balances. /// Optional token to signal cancellation of the operation. - /// A which contains a of the balances for the specified account. + /// + /// A which contains a of the + /// balances for the specified account. + /// Task, AccountsError>> GetBalances(Guid accountId, CancellationToken cancellationToken = default); @@ -43,7 +46,10 @@ Task, AccountsError>> GetBalances(Guid account /// /// The id of the account for which to get the balances. /// Optional token to signal cancellation of the operation. - /// A which contains a of the balances for the specified account. + /// + /// A which contains a of the + /// balances for the specified account. + /// Task, AccountsError>> GetBalances(string accountId, CancellationToken cancellationToken = default); @@ -108,4 +114,4 @@ Task> GetTransactions(st Task> GetTransactions(string id, DateTime? startDate = null, DateTime? endDate = null, CancellationToken cancellationToken = default); #endif -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Contracts/IAgreementsEndpoint.cs b/src/RobinTTY.NordigenApiClient/Contracts/IAgreementsEndpoint.cs index f257222..4556064 100644 --- a/src/RobinTTY.NordigenApiClient/Contracts/IAgreementsEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Contracts/IAgreementsEndpoint.cs @@ -48,8 +48,10 @@ Task> GetAgreement(string id, /// The institution this agreement will refer to. /// The length the access to the account will be valid for to request. /// The length of the transaction history in days to request. - /// The scope of information that will be available for access to request. By default all access scopes - /// (balances, transactions and details) will be requested. + /// + /// The scope of information that will be available for access to request. By default all access scopes + /// (balances, transactions and details) will be requested. + /// /// Optional token to signal cancellation of the operation. /// A containing the created . Task> CreateAgreement(string institutionId, @@ -95,4 +97,4 @@ Task> AcceptAgreement(Guid id, str /// A which contains the accepted end user agreement. Task> AcceptAgreement(string id, string userAgent, string ipAddress, CancellationToken cancellationToken = default); -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Contracts/IInstitutionsEndpoint.cs b/src/RobinTTY.NordigenApiClient/Contracts/IInstitutionsEndpoint.cs index 176285b..41a3e14 100644 --- a/src/RobinTTY.NordigenApiClient/Contracts/IInstitutionsEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Contracts/IInstitutionsEndpoint.cs @@ -128,8 +128,10 @@ Task, BasicResponse>> GetInstitutions(Supp /// /// Gets a specific institution by id. /// - /// The id of the institution to retrieve (can be retrieved via - /// ). + /// + /// The id of the institution to retrieve (can be retrieved via + /// ). + /// /// >Optional token to signal cancellation of the operation. /// /// A containing the institution matching the id if the diff --git a/src/RobinTTY.NordigenApiClient/Contracts/INordigenClient.cs b/src/RobinTTY.NordigenApiClient/Contracts/INordigenClient.cs index 16cb4b3..880a37b 100644 --- a/src/RobinTTY.NordigenApiClient/Contracts/INordigenClient.cs +++ b/src/RobinTTY.NordigenApiClient/Contracts/INordigenClient.cs @@ -58,4 +58,4 @@ public interface INordigenClient /// When the token is manually updated to be null, this event will not be raised. /// event EventHandler? TokenPairUpdated; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Contracts/IRequisitionsEndpoint.cs b/src/RobinTTY.NordigenApiClient/Contracts/IRequisitionsEndpoint.cs index 368259d..222192f 100644 --- a/src/RobinTTY.NordigenApiClient/Contracts/IRequisitionsEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Contracts/IRequisitionsEndpoint.cs @@ -48,15 +48,22 @@ Task> GetRequisition(string id, /// The id of the institution this requisition will be linked to. /// URI where the end user will be redirected after finishing authentication. /// The agreement this requisition will be linked to. - /// A unique ID which can be used for internal referencing. By default, set to a random - /// . - /// Enforces a language for all end user steps hosted by GoCardless. Passed as a two-letter country code + /// + /// A unique ID which can be used for internal referencing. By default, set to a random + /// . + /// + /// + /// Enforces a language for all end user steps hosted by GoCardless. Passed as a two-letter country code /// adhering to ISO 639-1. For a list of all possible languages /// see the /// GoCardless documentation - /// . - /// Some European banks allow sending an end-user's SSN to check whether the SSN is valid. + /// href="https://bankaccountdata.zendesk.com/hc/en-gb/articles/11529165730332-Is-it-possible-to-change-language-for-GoCardless-consent-step"> + /// GoCardless documentation + /// + /// . + /// + /// + /// Some European banks allow sending an end-user's SSN to check whether the SSN is valid. /// For bank availability see the /// /// GoCardless @@ -64,22 +71,29 @@ Task> GetRequisition(string id, /// /// . /// - /// Enables the end user to select which accounts they want to share (like joint accounts, accounts of children, etc.) + /// + /// Enables the end user to select which accounts they want to share (like joint accounts, accounts of children, etc.) /// if set to true. For details see the /// /// GoCardless /// Documentation /// - /// . - /// Enables you to redirect end users back to your app immediately after they have given their consent to access the account - /// information data from the bank, instead of waiting for transaction data being processed. Accounts endpoint status will be - /// PROCESSING and you have to wait until account status is READY before you're able to query the transactions. For details see the + /// . + /// + /// + /// Enables you to redirect end users back to your app immediately after they have given their consent to access the + /// account + /// information data from the bank, instead of waiting for transaction data being processed. Accounts endpoint status + /// will be + /// PROCESSING and you have to wait until account status is READY before you're able to query the transactions. For + /// details see the /// /// GoCardless /// Documentation /// - /// . + /// . + /// /// Optional token to signal cancellation of the operation. /// A which contains the created requisition. Task> CreateRequisition(string institutionId, @@ -104,4 +118,4 @@ Task> DeleteRequisition(Guid i /// A containing a confirmation of the deletion. Task> DeleteRequisition(string id, CancellationToken cancellationToken = default); -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Contracts/ITokenEndpoint.cs b/src/RobinTTY.NordigenApiClient/Contracts/ITokenEndpoint.cs index 8c517a7..f9d883b 100644 --- a/src/RobinTTY.NordigenApiClient/Contracts/ITokenEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Contracts/ITokenEndpoint.cs @@ -27,8 +27,10 @@ Task> GetTokenPair( /// /// Refreshes the JWT access token. /// - /// The refresh token previously obtained through the - /// method. + /// + /// The refresh token previously obtained through the + /// method. + /// /// Optional token to signal cancellation of the operation. /// /// A containing the refreshed @@ -36,4 +38,4 @@ Task> GetTokenPair( /// Task> RefreshAccessToken(JsonWebToken refreshToken, CancellationToken cancellationToken = default); -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Endpoints/AccountsEndpoint.cs b/src/RobinTTY.NordigenApiClient/Endpoints/AccountsEndpoint.cs index 4113822..089435c 100644 --- a/src/RobinTTY.NordigenApiClient/Endpoints/AccountsEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Endpoints/AccountsEndpoint.cs @@ -46,8 +46,9 @@ private async Task, AccountsError>> GetBalance { var response = await _nordigenClient.MakeRequest( $"{NordigenEndpointUrls.AccountsEndpoint}{accountId}/balances/", HttpMethod.Get, cancellationToken); + return new NordigenApiResponse, AccountsError>(response.StatusCode, response.IsSuccess, - response.Result?.Balances, response.Error); + response.Result?.Balances, response.Error, response.RateLimits); } /// @@ -65,8 +66,9 @@ private async Task> GetAc { var response = await _nordigenClient.MakeRequest( $"{NordigenEndpointUrls.AccountsEndpoint}{id}/details/", HttpMethod.Get, cancellationToken); + return new NordigenApiResponse(response.StatusCode, response.IsSuccess, - response.Result?.Account, response.Error); + response.Result?.Account, response.Error, response.RateLimits); } /// @@ -111,8 +113,9 @@ private async Task> GetT var response = await _nordigenClient.MakeRequest( $"{NordigenEndpointUrls.AccountsEndpoint}{id}/transactions/", HttpMethod.Get, cancellationToken, query); + return new NordigenApiResponse(response.StatusCode, response.IsSuccess, - response.Result?.Transactions, response.Error); + response.Result?.Transactions, response.Error, response.RateLimits); } #if NET6_0_OR_GREATER @@ -120,4 +123,4 @@ private async Task> GetT #else private string DateToIso8601(DateTime date) => date.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture); #endif -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Endpoints/AgreementsEndpoint.cs b/src/RobinTTY.NordigenApiClient/Endpoints/AgreementsEndpoint.cs index d225e88..999fb48 100644 --- a/src/RobinTTY.NordigenApiClient/Endpoints/AgreementsEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Endpoints/AgreementsEndpoint.cs @@ -91,4 +91,4 @@ private async Task> AcceptAgreemen return await _nordigenClient.MakeRequest( $"{NordigenEndpointUrls.AgreementsEndpoint}{id}/accept/", HttpMethod.Put, cancellationToken, body: body); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Endpoints/InstitutionsEndpoint.cs b/src/RobinTTY.NordigenApiClient/Endpoints/InstitutionsEndpoint.cs index c2aa573..6115c5e 100644 --- a/src/RobinTTY.NordigenApiClient/Endpoints/InstitutionsEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Endpoints/InstitutionsEndpoint.cs @@ -60,8 +60,7 @@ public async Task, BasicResponse>> GetInst NordigenEndpointUrls.InstitutionsEndpoint, HttpMethod.Get, cancellationToken, query); return new NordigenApiResponse, BasicResponse>(response.StatusCode, response.IsSuccess, - response.Result, - response.Error); + response.Result, response.Error, response.RateLimits); } /// @@ -84,6 +83,6 @@ public async Task> GetInstitutio await _nordigenClient.MakeRequest( $"{NordigenEndpointUrls.InstitutionsEndpoint}{id}/", HttpMethod.Get, cancellationToken); - private static KeyValuePair GetSupportFlagQuery(string flag, bool value) - => new(flag, value.ToString().ToLower()); + private static KeyValuePair GetSupportFlagQuery(string flag, bool value) => + new(flag, value.ToString().ToLower()); } \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Endpoints/NordigenEndpointUrls.cs b/src/RobinTTY.NordigenApiClient/Endpoints/NordigenEndpointUrls.cs index 19ed865..d147ac2 100644 --- a/src/RobinTTY.NordigenApiClient/Endpoints/NordigenEndpointUrls.cs +++ b/src/RobinTTY.NordigenApiClient/Endpoints/NordigenEndpointUrls.cs @@ -8,4 +8,4 @@ internal static class NordigenEndpointUrls internal const string AgreementsEndpoint = "agreements/enduser/"; internal const string InstitutionsEndpoint = "institutions/"; internal const string RequisitionsEndpoint = "requisitions/"; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Endpoints/RequisitionsEndpoint.cs b/src/RobinTTY.NordigenApiClient/Endpoints/RequisitionsEndpoint.cs index 74c2309..b2a06ae 100644 --- a/src/RobinTTY.NordigenApiClient/Endpoints/RequisitionsEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Endpoints/RequisitionsEndpoint.cs @@ -74,4 +74,4 @@ private async Task> DeleteRequ CancellationToken cancellationToken) => await _nordigenClient.MakeRequest( $"{NordigenEndpointUrls.RequisitionsEndpoint}{id}/", HttpMethod.Delete, cancellationToken); -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Endpoints/TokenEndpoint.cs b/src/RobinTTY.NordigenApiClient/Endpoints/TokenEndpoint.cs index be6ce59..c56920a 100644 --- a/src/RobinTTY.NordigenApiClient/Endpoints/TokenEndpoint.cs +++ b/src/RobinTTY.NordigenApiClient/Endpoints/TokenEndpoint.cs @@ -37,4 +37,4 @@ public async Task> Refres $"{NordigenEndpointUrls.TokensEndpoint}refresh/", HttpMethod.Post, cancellationToken, body: requestBody, useAuthentication: false); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Events/TokenPairUpdatedEventArgs.cs b/src/RobinTTY.NordigenApiClient/Events/TokenPairUpdatedEventArgs.cs index 3e019f0..e900d6d 100644 --- a/src/RobinTTY.NordigenApiClient/Events/TokenPairUpdatedEventArgs.cs +++ b/src/RobinTTY.NordigenApiClient/Events/TokenPairUpdatedEventArgs.cs @@ -17,4 +17,4 @@ public class TokenPairUpdatedEventArgs : EventArgs /// /// The updated . public TokenPairUpdatedEventArgs(JsonWebTokenPair jsonWebTokenPair) => JsonWebTokenPair = jsonWebTokenPair; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/JsonConverters/CultureSpecificDecimalConverter.cs b/src/RobinTTY.NordigenApiClient/JsonConverters/CultureSpecificDecimalConverter.cs index c45b761..c4963d3 100644 --- a/src/RobinTTY.NordigenApiClient/JsonConverters/CultureSpecificDecimalConverter.cs +++ b/src/RobinTTY.NordigenApiClient/JsonConverters/CultureSpecificDecimalConverter.cs @@ -18,4 +18,4 @@ public override void Write(Utf8JsonWriter writer, decimal value, JsonSerializerO { writer.WriteStringValue(value.ToString(Culture)); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/JsonConverters/EnumDescriptionConverter.cs b/src/RobinTTY.NordigenApiClient/JsonConverters/EnumDescriptionConverter.cs index 06ad9d5..ca15418 100644 --- a/src/RobinTTY.NordigenApiClient/JsonConverters/EnumDescriptionConverter.cs +++ b/src/RobinTTY.NordigenApiClient/JsonConverters/EnumDescriptionConverter.cs @@ -16,4 +16,4 @@ public override void Write(Utf8JsonWriter writer, T value, JsonSerializerOptions { writer.WriteStringValue(value.GetDescription()); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/JsonConverters/GuidConverter.cs b/src/RobinTTY.NordigenApiClient/JsonConverters/GuidConverter.cs index d735e8e..a3f43c5 100644 --- a/src/RobinTTY.NordigenApiClient/JsonConverters/GuidConverter.cs +++ b/src/RobinTTY.NordigenApiClient/JsonConverters/GuidConverter.cs @@ -15,4 +15,4 @@ public override void Write(Utf8JsonWriter writer, Guid value, JsonSerializerOpti { writer.WriteStringValue(value.ToString()); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/JsonConverters/JsonWebTokenConverter.cs b/src/RobinTTY.NordigenApiClient/JsonConverters/JsonWebTokenConverter.cs index a6e54b6..7f8b325 100644 --- a/src/RobinTTY.NordigenApiClient/JsonConverters/JsonWebTokenConverter.cs +++ b/src/RobinTTY.NordigenApiClient/JsonConverters/JsonWebTokenConverter.cs @@ -15,4 +15,4 @@ public override void Write(Utf8JsonWriter writer, JsonWebToken value, JsonSerial { writer.WriteStringValue(value.EncodedToken); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/JsonConverters/SingleOrArrayConverter.cs b/src/RobinTTY.NordigenApiClient/JsonConverters/SingleOrArrayConverter.cs index bfd23da..063a982 100644 --- a/src/RobinTTY.NordigenApiClient/JsonConverters/SingleOrArrayConverter.cs +++ b/src/RobinTTY.NordigenApiClient/JsonConverters/SingleOrArrayConverter.cs @@ -42,4 +42,4 @@ public override void Write(Utf8JsonWriter writer, TCollection value, JsonSeriali writer.WriteEndArray(); } } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/JsonConverters/StringArrayConverters.cs b/src/RobinTTY.NordigenApiClient/JsonConverters/StringArrayConverters.cs index 20e1b2b..9650efa 100644 --- a/src/RobinTTY.NordigenApiClient/JsonConverters/StringArrayConverters.cs +++ b/src/RobinTTY.NordigenApiClient/JsonConverters/StringArrayConverters.cs @@ -6,7 +6,8 @@ namespace RobinTTY.NordigenApiClient.JsonConverters; /// -/// For some errors the GoCardless API returns arrays for Summary/Detail properties inside the +/// For some errors the GoCardless API returns arrays for Summary/Detail properties inside the +/// /// . /// I've never actually seen them contain multiple values, but this converter merges them into one string so that the /// can stay as simple as possible. @@ -34,14 +35,18 @@ internal class StringArrayMergeConverter : JsonConverter } } - public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options) => + public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options) + { JsonSerializer.Serialize(writer, value, options); + } } /// /// For some errors (so far only seen when creating requisitions) the GoCardless API returns a simple array of strings -/// as response to a field in the having an invalid value. To bring them in line -/// with errors from other fields in the response this converter converts them to the type. +/// as response to a field in the having an invalid value. To bring them in +/// line +/// with errors from other fields in the response this converter converts them to the +/// type. /// internal class StringArrayToBasicResponseConverter : JsonConverter { @@ -66,6 +71,8 @@ internal class StringArrayToBasicResponseConverter : JsonConverter + public override void Write(Utf8JsonWriter writer, BasicResponse value, JsonSerializerOptions options) + { JsonSerializer.Serialize(writer, value, options); -} + } +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Errors/AccountsError.cs b/src/RobinTTY.NordigenApiClient/Models/Errors/AccountsError.cs index d34520f..e45e637 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Errors/AccountsError.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Errors/AccountsError.cs @@ -54,7 +54,9 @@ public class AccountsError : BasicResponse /// /// Creates a new instance of . /// - public AccountsError() { } + public AccountsError() + { + } #if NET6_0_OR_GREATER /// @@ -103,4 +105,4 @@ public AccountsError(string? summary, string? detail, string? type, BasicRespons StartDateError = startDateError; EndDateError = endDateError; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Errors/CreateAgreementError.cs b/src/RobinTTY.NordigenApiClient/Models/Errors/CreateAgreementError.cs index 09995d5..e270c8e 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Errors/CreateAgreementError.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Errors/CreateAgreementError.cs @@ -1,6 +1,5 @@ using System.Text.Json.Serialization; using RobinTTY.NordigenApiClient.JsonConverters; -using RobinTTY.NordigenApiClient.Models.Requests; using RobinTTY.NordigenApiClient.Models.Responses; namespace RobinTTY.NordigenApiClient.Models.Errors; @@ -49,7 +48,9 @@ public class CreateAgreementError : BasicResponse /// /// Creates a new instance of . /// - public CreateAgreementError() { } + public CreateAgreementError() + { + } /// /// Creates a new instance of . @@ -88,4 +89,4 @@ public CreateAgreementError( AccessValidForDaysError = accessValidForDaysError; AgreementError = agreementError; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Errors/CreateRequisitionError.cs b/src/RobinTTY.NordigenApiClient/Models/Errors/CreateRequisitionError.cs index 0472dd2..9430e7a 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Errors/CreateRequisitionError.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Errors/CreateRequisitionError.cs @@ -1,6 +1,5 @@ using System.Text.Json.Serialization; using RobinTTY.NordigenApiClient.JsonConverters; -using RobinTTY.NordigenApiClient.Models.Requests; using RobinTTY.NordigenApiClient.Models.Responses; namespace RobinTTY.NordigenApiClient.Models.Errors; @@ -69,7 +68,9 @@ public class CreateRequisitionError : BasicResponse /// /// Creates a new instance of . /// - public CreateRequisitionError() { } + public CreateRequisitionError() + { + } /// /// Creates a new instance of . @@ -111,4 +112,4 @@ public CreateRequisitionError(string? summary, string? detail, BasicResponse? re AccountSelectionError = accountSelectionError; InstitutionIdError = institutionIdError; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Errors/InstitutionsErrorInternal.cs b/src/RobinTTY.NordigenApiClient/Models/Errors/InstitutionsErrorInternal.cs index fd64f05..2df7b7e 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Errors/InstitutionsErrorInternal.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Errors/InstitutionsErrorInternal.cs @@ -16,7 +16,9 @@ internal class InstitutionsErrorInternal : BasicResponse /// /// Creates a new instance of . /// - public InstitutionsErrorInternal() { } + public InstitutionsErrorInternal() + { + } /// /// Creates a new instance of . @@ -31,4 +33,4 @@ public InstitutionsErrorInternal(string? summary, string? detail, BasicResponse? Summary = country?.Summary ?? summary; Detail = country?.Detail ?? detail; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Jwt/JsonWebAccessToken.cs b/src/RobinTTY.NordigenApiClient/Models/Jwt/JsonWebAccessToken.cs index 48c709c..90faef9 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Jwt/JsonWebAccessToken.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Jwt/JsonWebAccessToken.cs @@ -31,4 +31,4 @@ public JsonWebAccessToken(JsonWebToken accessToken, int accessExpires) AccessToken = accessToken; AccessExpires = accessExpires; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Jwt/JsonWebTokenPair.cs b/src/RobinTTY.NordigenApiClient/Models/Jwt/JsonWebTokenPair.cs index c6c9d99..2e8efaa 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Jwt/JsonWebTokenPair.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Jwt/JsonWebTokenPair.cs @@ -61,4 +61,4 @@ public JsonWebTokenPair(string accessToken, string refreshToken) AccessExpires = (int) (AccessToken.ValidTo.ToUniversalTime() - DateTime.UtcNow).TotalSeconds; RefreshExpires = (int) (RefreshToken.ValidTo.ToUniversalTime() - DateTime.UtcNow).TotalSeconds; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/NordigenClientCredentials.cs b/src/RobinTTY.NordigenApiClient/Models/NordigenClientCredentials.cs index 7850497..4db61d1 100644 --- a/src/RobinTTY.NordigenApiClient/Models/NordigenClientCredentials.cs +++ b/src/RobinTTY.NordigenApiClient/Models/NordigenClientCredentials.cs @@ -29,4 +29,4 @@ public NordigenClientCredentials(string secretId, string secretKey) SecretId = secretId ?? throw new ArgumentNullException(nameof(secretId)); SecretKey = secretKey ?? throw new ArgumentNullException(nameof(secretKey)); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Requests/AcceptAgreementRequest.cs b/src/RobinTTY.NordigenApiClient/Models/Requests/AcceptAgreementRequest.cs index 9d62c2f..0f47784 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Requests/AcceptAgreementRequest.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Requests/AcceptAgreementRequest.cs @@ -29,4 +29,4 @@ public AcceptAgreementRequest(string userAgent, string ipAddress) UserAgent = userAgent; IpAddress = ipAddress; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Requests/CreateAgreementRequest.cs b/src/RobinTTY.NordigenApiClient/Models/Requests/CreateAgreementRequest.cs index c56a39d..3557a25 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Requests/CreateAgreementRequest.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Requests/CreateAgreementRequest.cs @@ -49,4 +49,4 @@ public CreateAgreementRequest(string institutionId, List accessScop AccessScope = accessScope; InstitutionId = institutionId; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Requests/CreateRequisitionRequest.cs b/src/RobinTTY.NordigenApiClient/Models/Requests/CreateRequisitionRequest.cs index 0ec710b..da3d75c 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Requests/CreateRequisitionRequest.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Requests/CreateRequisitionRequest.cs @@ -36,7 +36,9 @@ internal class CreateRequisitionRequest /// (ISO 639-1). For a list of all possible languages /// see the /// GoCardless documentation + /// href="https://bankaccountdata.zendesk.com/hc/en-gb/articles/11529165730332-Is-it-possible-to-change-language-for-GoCardless-consent-step"> + /// GoCardless documentation + /// /// . /// [JsonPropertyName("user_language")] @@ -68,9 +70,12 @@ internal class CreateRequisitionRequest public bool AccountSelection { get; set; } /// - /// Enables you to redirect end users back to your app immediately after they have given their consent to access the account - /// information data from the bank, instead of waiting for transaction data being processed. Accounts endpoint status will be - /// PROCESSING and you have to wait until account status is READY before you're able to query the transactions. For details see the + /// Enables you to redirect end users back to your app immediately after they have given their consent to access the + /// account + /// information data from the bank, instead of waiting for transaction data being processed. Accounts endpoint status + /// will be + /// PROCESSING and you have to wait until account status is READY before you're able to query the transactions. For + /// details see the /// /// GoCardless @@ -96,7 +101,8 @@ internal class CreateRequisitionRequest /// Some European banks allow sending an end-user's SSN to check whether the SSN is valid. /// /// For bank availability check: - /// + /// /// GoCardless /// Documentation /// @@ -144,4 +150,4 @@ public CreateRequisitionRequest(string institutionId, Uri redirect, string refer AccountSelection = accountSelection; RedirectImmediate = redirectImmediate; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Requests/SupportedCountry.cs b/src/RobinTTY.NordigenApiClient/Models/Requests/SupportedCountry.cs index 75d53af..ac13a47 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Requests/SupportedCountry.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Requests/SupportedCountry.cs @@ -195,4 +195,4 @@ public enum SupportedCountry /// [Description("SI")] Slovenia -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/AccessScope.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/AccessScope.cs index 78bb9f8..c2f009c 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/AccessScope.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/AccessScope.cs @@ -33,4 +33,4 @@ public enum AccessScope /// [Description("details")] Details -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/AccountDetails.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/AccountDetails.cs index 3df744f..bcb0ab2 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/AccountDetails.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/AccountDetails.cs @@ -48,10 +48,18 @@ public class AccountDetails /// Creates a new instance of . /// /// The IBAN of the bank account. - /// Basic Bank Account Number represents a country-specific bank account number. - /// This data element is used for payment accounts which have no IBAN. - /// Primary account number (unique identifier on credit cards, debit cards, and other types of payment cards). - /// Masked primary account number (unique identifier on credit cards, debit cards, and other types of payment cards). + /// + /// Basic Bank Account Number represents a country-specific bank account number. + /// This data element is used for payment accounts which have no IBAN. + /// + /// + /// Primary account number (unique identifier on credit cards, debit cards, and other types of payment + /// cards). + /// + /// + /// Masked primary account number (unique identifier on credit cards, debit cards, and other types + /// of payment cards). + /// /// An alias to a payment account via a registered mobile phone number. /// The currency the amount is denominated in. [JsonConstructor] @@ -64,4 +72,4 @@ public AccountDetails(string? iban, string? bban, string? pan, string? maskedPan Msisdn = msisdn; Currency = currency; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/AccountTransactions.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/AccountTransactions.cs index 56deaa3..bfdbb88 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/AccountTransactions.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/AccountTransactions.cs @@ -49,4 +49,4 @@ internal class AccountTransactionsWrapper /// A list of transactions. [JsonConstructor] public AccountTransactionsWrapper(AccountTransactions transactions) => Transactions = transactions; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/Address.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/Address.cs index d71e2ae..89a23a0 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/Address.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/Address.cs @@ -54,4 +54,4 @@ public Address(string? streetName, string? buildingNumber, string? postCode, str TownName = townName; Country = country; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/Agreement.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/Agreement.cs index 55c3b07..1249f42 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/Agreement.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/Agreement.cs @@ -71,4 +71,4 @@ public Agreement(Guid id, DateTime created, DateTime? accepted, string instituti MaxHistoricalDays = maxHistoricalDays; AccessValidForDays = accessValidForDays; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/AmountCurrencyPair.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/AmountCurrencyPair.cs index cf30676..5458c5e 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/AmountCurrencyPair.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/AmountCurrencyPair.cs @@ -30,4 +30,4 @@ public AmountCurrencyPair(decimal amount, string currency) Amount = amount; Currency = currency; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/ApiRateLimits.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/ApiRateLimits.cs new file mode 100644 index 0000000..29004e1 --- /dev/null +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/ApiRateLimits.cs @@ -0,0 +1,100 @@ +using System.Net.Http.Headers; +using RobinTTY.NordigenApiClient.Endpoints; + +namespace RobinTTY.NordigenApiClient.Models.Responses; + +/// +/// The rate limits of the GoCardless API. +/// +public class ApiRateLimits +{ + /// + /// Indicates the maximum number of allowed requests within the defined time window. + /// Usually populated in every response. + /// + public int? RequestLimit { get; set; } + + /// + /// Indicates the number of remaining requests you can make in the current time window. + /// Usually populated in every response. + /// + public int? RemainingRequests { get; set; } + + /// + /// Indicates the time remaining in the current time window (in seconds). + /// Usually populated in every response. + /// + public int? RemainingSecondsInTimeWindow { get; set; } + + /// + /// Indicates the maximum number of allowed requests to the + /// within the defined time window. Only populated in responses from the . + /// + public int? RequestLimitAccountsEndpoint { get; set; } + + /// + /// Indicates the number of remaining requests to the + /// you can make in the current time window. Only populated in responses from the . + /// + public int? RemainingRequestsAccountsEndpoint { get; set; } + + /// + /// Indicates the time remaining in the current time window (in seconds) for requests + /// to the . Only populated in responses from the . + /// + public int? RemainingSecondsInTimeWindowAccountsEndpoint { get; set; } + + /// + /// Creates a new instance of . + /// + /// Indicates the maximum number of allowed requests within the defined time window. + /// Indicates the number of remaining requests you can make in the current time window. + /// Indicates the time remaining in the current time window (in seconds). + /// + /// Indicates the maximum number of allowed requests to the + /// within the defined time window. + /// + /// + /// Indicates the number of remaining requests to the + /// you can make in the current time window. + /// + /// + /// Indicates the time remaining in the current time window (in seconds) for requests + /// to the . + /// + public ApiRateLimits(int? requestLimit, int? remainingRequests, int? remainingSecondsInTimeWindow, + int? requestLimitAccountsEndpoint, + int? remainingRequestsAccountsEndpoint, int? remainingSecondsInTimeWindowAccountsEndpoint) + { + RequestLimit = requestLimit; + RemainingRequests = remainingRequests; + RemainingSecondsInTimeWindow = remainingSecondsInTimeWindow; + RequestLimitAccountsEndpoint = requestLimitAccountsEndpoint; + RemainingRequestsAccountsEndpoint = remainingRequestsAccountsEndpoint; + RemainingSecondsInTimeWindowAccountsEndpoint = remainingSecondsInTimeWindowAccountsEndpoint; + } + + /// + /// Creates a new instance of . + /// + /// The headers of the HTTP response containing the rate limit information. + public ApiRateLimits(HttpHeaders headers) + { + RequestLimit = TryParseApiLimit(headers, "HTTP_X_RATELIMIT_LIMIT"); + RemainingRequests = TryParseApiLimit(headers, "HTTP_X_RATELIMIT_REMAINING"); + RemainingSecondsInTimeWindow = TryParseApiLimit(headers, "HTTP_X_RATELIMIT_RESET"); + RequestLimitAccountsEndpoint = TryParseApiLimit(headers, "HTTP_X_RATELIMIT_ACCOUNT_SUCCESS_LIMIT"); + RemainingRequestsAccountsEndpoint = TryParseApiLimit(headers, "HTTP_X_RATELIMIT_ACCOUNT_SUCCESS_REMAINING"); + RemainingSecondsInTimeWindowAccountsEndpoint = + TryParseApiLimit(headers, "HTTP_X_RATELIMIT_ACCOUNT_SUCCESS_RESET"); + } + + private static int? TryParseApiLimit(HttpHeaders headers, string headerName) + { + headers.TryGetValues(headerName, out var values); + var firstHeaderValue = values?.FirstOrDefault(); + var parseSuccess = int.TryParse(firstHeaderValue, out var limitValue); + + return parseSuccess ? limitValue : null; + } +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/Balance.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/Balance.cs index 2f8bd85..96108fb 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/Balance.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/Balance.cs @@ -96,4 +96,4 @@ internal class BalanceJsonWrapper /// /// A list of account balances. public BalanceJsonWrapper(List balances) => Balances = balances; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/BalanceType.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/BalanceType.cs index 09a2afe..5b5f73e 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/BalanceType.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/BalanceType.cs @@ -121,4 +121,4 @@ public enum BalanceType /// [Description("previouslyClosedBooked")] PreviouslyClosedBooked -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccount.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccount.cs index 9c76561..556d546 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccount.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccount.cs @@ -55,7 +55,10 @@ public class BankAccount : MinimalBankAccount /// The time this account was last accessed via the API. /// The IBAN of the account. /// The institution id this account belongs to. - /// Name of the legal account owner. If there is more than one owner, then two names might be noted here. + /// + /// Name of the legal account owner. If there is more than one owner, then two names might be noted + /// here. + /// /// The status of the account (e.g. user has successfully authenticated and account is discovered). [JsonConstructor] public BankAccount(Guid id, DateTime created, DateTime? lastAccessed, string iban, string institutionId, @@ -68,4 +71,4 @@ public BankAccount(Guid id, DateTime created, DateTime? lastAccessed, string iba OwnerName = ownerName; Status = status; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountDetails.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountDetails.cs index ee6d9f3..652d4d4 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountDetails.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountDetails.cs @@ -206,4 +206,4 @@ internal class BankAccountDetailsWrapper /// Detailed information about a bank account. [JsonConstructor] public BankAccountDetailsWrapper(BankAccountDetails account) => Account = account; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountStatus.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountStatus.cs index bf91707..f8ceea6 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountStatus.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountStatus.cs @@ -51,8 +51,9 @@ public enum BankAccountStatus Ready, /// - /// Indicates that the account has been suspended due to more than 10 consecutive failed attempts to access the account. + /// Indicates that the account has been suspended due to more than 10 consecutive failed attempts to access the + /// account. /// [Description("SUSPENDED")] Suspended -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountUsage.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountUsage.cs index 571f14c..6544ab6 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountUsage.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/BankAccountUsage.cs @@ -30,4 +30,4 @@ public enum BankAccountUsage /// A professional bank account. /// Organization -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/BasicResponse.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/BasicResponse.cs index a4d65f2..916bd8b 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/BasicResponse.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/BasicResponse.cs @@ -25,7 +25,9 @@ public class BasicResponse /// /// Creates a new instance of . /// - public BasicResponse() { } + public BasicResponse() + { + } /// /// Creates a new instance of . @@ -38,4 +40,4 @@ public BasicResponse(string? summary, string? detail) Summary = summary; Detail = detail; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/CashAccountType.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/CashAccountType.cs index 57c4e45..db31ab0 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/CashAccountType.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/CashAccountType.cs @@ -163,4 +163,4 @@ public enum CashAccountType /// [Description("NFCA")] NonResidentForeignCurrent -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/CurrencyExchange.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/CurrencyExchange.cs index 5256a3f..6f7865a 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/CurrencyExchange.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/CurrencyExchange.cs @@ -28,8 +28,8 @@ public class CurrencyExchange public string TargetCurrency { get; } /// - /// Currency in which the rate of exchange is expressed in a currency exchange. In the example 1 EUR = xxx USD, the unit - /// currency is EUR. ISO 4217 Alpha 3 currency code (e.g. "USD"). + /// Currency in which the rate of exchange is expressed in a currency exchange. In the example 1 EUR = xxx USD, the + /// unit currency is EUR. ISO 4217 Alpha 3 currency code (e.g. "USD"). /// [JsonPropertyName("unitCurrency")] public string UnitCurrency { get; } @@ -90,4 +90,4 @@ public CurrencyExchange(AmountCurrencyPair? instructedAmount, string sourceCurre QuotationDate = quotationDate; ContractIdentification = contractIdentification; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/Institution.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/Institution.cs index 21a6da5..5c7e5a1 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/Institution.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/Institution.cs @@ -53,7 +53,8 @@ public class Institution public SupportedPayments? SupportedPayments { get; } /// - /// Supported features for this institution. Only populated when calling . + /// Supported features for this institution. Only populated when calling + /// . /// [JsonPropertyName("supported_features")] public List? SupportedFeatures { get; } diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/IsoBankAccountStatus.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/IsoBankAccountStatus.cs index c85ca0f..4545139 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/IsoBankAccountStatus.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/IsoBankAccountStatus.cs @@ -32,4 +32,4 @@ public enum IsoBankAccountStatus /// [Description("blocked")] Blocked -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/MinimalBankAccount.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/MinimalBankAccount.cs index 4fd729b..209556e 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/MinimalBankAccount.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/MinimalBankAccount.cs @@ -18,4 +18,4 @@ public class MinimalBankAccount /// /// The IBAN of the account. public MinimalBankAccount(string iban) => Iban = iban; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/NordigenApiResponse.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/NordigenApiResponse.cs index 1b23285..8756439 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/NordigenApiResponse.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/NordigenApiResponse.cs @@ -35,6 +35,11 @@ public class NordigenApiResponse where TResult : class where TE /// public TError? Error { get; } + /// + /// The rate limits of the GoCardless API. + /// + public ApiRateLimits RateLimits { get; } + /// /// Creates a new instance of . /// @@ -42,12 +47,15 @@ public class NordigenApiResponse where TResult : class where TE /// Indicates whether the HTTP response was successful. /// The result returned by the API. Null if the the HTTP response was not successful. /// The error returned by the API. Null if the HTTP response was successful. - public NordigenApiResponse(HttpStatusCode statusCode, bool isSuccess, TResult? result, TError? apiError) + /// The rate limits of the GoCardless API. + public NordigenApiResponse(HttpStatusCode statusCode, bool isSuccess, TResult? result, + TError? apiError, ApiRateLimits rateLimits) { StatusCode = statusCode; IsSuccess = isSuccess; Result = result; Error = apiError; + RateLimits = rateLimits; } /// @@ -65,20 +73,19 @@ internal static async Task> FromHttpRespons #else var responseJson = await response.Content.ReadAsStringAsync(); #endif - try { if (response.IsSuccessStatusCode) { var result = await response.Content.ReadFromJsonAsync(options, cancellationToken); return new NordigenApiResponse(response.StatusCode, response.IsSuccessStatusCode, - result, null); + result, null, new ApiRateLimits(response.Headers)); } else { var result = await response.Content.ReadFromJsonAsync(options, cancellationToken); return new NordigenApiResponse(response.StatusCode, response.IsSuccessStatusCode, - null, result); + null, result, new ApiRateLimits(response.Headers)); } } catch (JsonException ex) @@ -88,4 +95,4 @@ internal static async Task> FromHttpRespons $"The following JSON content caused the problem: {responseJson}", ex); } } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/PaymentProduct.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/PaymentProduct.cs index a915556..8db2501 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/PaymentProduct.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/PaymentProduct.cs @@ -22,13 +22,15 @@ public enum PaymentProduct Target2Payments, /// - /// SEPA Credit Transfer, more commonly abbreviated as SCT, is a payment processing scheme used for making one-time, euro-denominated fund transfers between banks and payment service providers (PSPs) in the SEPA area. + /// SEPA Credit Transfer, more commonly abbreviated as SCT, is a payment processing scheme used for making one-time, + /// euro-denominated fund transfers between banks and payment service providers (PSPs) in the SEPA area. /// [Description("SCT")] SepaCreditTransfers, /// - /// Instant SEPA Credit Transfer supports money transfers of up to €100,000 between participating banks or PSPs in the SEPA area in real or near-real time. + /// Instant SEPA Credit Transfer supports money transfers of up to €100,000 between participating banks or PSPs in the + /// SEPA area in real or near-real time. /// [Description("ISCT")] InstantSepaCreditTransfer, @@ -40,19 +42,24 @@ public enum PaymentProduct CrossBorderCreditTransfers, /// - /// Bacs Payment Schemes Limited (Bacs), previously known as Bankers' Automated Clearing System, is responsible for the clearing and settlement of UK automated direct debit and Bacs Direct Credit and the provision of third-party services. + /// Bacs Payment Schemes Limited (Bacs), previously known as Bankers' Automated Clearing System, is responsible for the + /// clearing and settlement of UK automated direct debit and Bacs Direct Credit and the provision of third-party + /// services. /// [Description("BACS")] BacsPaymentSchemesLimited, /// - /// The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for sterling transactions in the United Kingdom. + /// The Clearing House Automated Payment System (CHAPS) is a real-time gross settlement payment system used for + /// sterling transactions in the United Kingdom. /// [Description("CHAPS")] ClearingHouseAutomatedPaymentSystem, /// - /// The Faster Payments Service (FPS) is a United Kingdom banking initiative to reduce payment times between different banks' customer accounts to typically a few seconds, from the three working days that transfers usually take using the long-established BACS system. + /// The Faster Payments Service (FPS) is a United Kingdom banking initiative to reduce payment times between different + /// banks' customer accounts to typically a few seconds, from the three working days that transfers usually take using + /// the long-established BACS system. /// [Description("FPS")] FasterPaymentScheme, @@ -64,7 +71,8 @@ public enum PaymentProduct SwiftPaymentService, /// - /// A balance transfer is the transfer of the balance in an account to another account, often held at another institution. It is most commonly used when describing a credit card balance transfer. + /// A balance transfer is the transfer of the balance in an account to another account, often held at another + /// institution. It is most commonly used when describing a credit card balance transfer. /// [Description("BT")] BalanceTransfer, @@ -82,8 +90,9 @@ public enum PaymentProduct DomesticCreditTransfer, /// - /// An instant domestic transfer is a transfer completed between accounts that are held in the same country in real-time. + /// An instant domestic transfer is a transfer completed between accounts that are held in the same country in + /// real-time. /// [Description("IDCT")] InstantDomesticCreditTransfer -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/Requisition.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/Requisition.cs index 121595f..ba3a4fb 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/Requisition.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/Requisition.cs @@ -72,7 +72,8 @@ public class Requisition /// Some European banks allow sending an end-user's SSN to check whether the SSN is valid. /// /// For bank availability check: - /// + /// /// GoCardless /// Documentation /// @@ -136,7 +137,8 @@ public class Requisition /// Some European banks allow sending an end-user's SSN to check whether the SSN is valid. /// /// For bank availability check: - /// + /// /// GoCardless /// Documentation /// @@ -187,4 +189,4 @@ public Requisition(Guid id, DateTime created, RequisitionStatus status, List [Description("EX")] Expired -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/ResponsePage.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/ResponsePage.cs index 5aa345a..48f6d51 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/ResponsePage.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/ResponsePage.cs @@ -81,4 +81,4 @@ public ResponsePage(uint count, Uri? next, Uri? previous, List results) return await nordigenClient.MakeRequest, BasicResponse>(Previous.AbsoluteUri, HttpMethod.Get, cancellationToken); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/SupportedPayments.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/SupportedPayments.cs index ed3b740..3bc9768 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/SupportedPayments.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/SupportedPayments.cs @@ -18,4 +18,4 @@ public class SupportedPayments /// /// Supported payment products in the single-payment category. public SupportedPayments(List singlePayment) => SinglePayment = singlePayment; -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Models/Responses/Transaction.cs b/src/RobinTTY.NordigenApiClient/Models/Responses/Transaction.cs index f25ca0a..3973362 100644 --- a/src/RobinTTY.NordigenApiClient/Models/Responses/Transaction.cs +++ b/src/RobinTTY.NordigenApiClient/Models/Responses/Transaction.cs @@ -6,7 +6,8 @@ namespace RobinTTY.NordigenApiClient.Models.Responses; /// /// A financial transaction. /// -/// Reference: GoCardless Documentation +/// Reference: +/// GoCardless Documentation /// /// public class Transaction @@ -381,4 +382,4 @@ public Transaction(string? transactionId, string? debtorName, AccountDetails? de MerchantCategoryCode = merchantCategoryCode; BookingDateTime = bookingDateTime; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/NordigenClient.cs b/src/RobinTTY.NordigenApiClient/NordigenClient.cs index a3ee5a0..37f9853 100644 --- a/src/RobinTTY.NordigenApiClient/NordigenClient.cs +++ b/src/RobinTTY.NordigenApiClient/NordigenClient.cs @@ -14,11 +14,38 @@ namespace RobinTTY.NordigenApiClient; /// public class NordigenClient : INordigenClient { - private JsonWebTokenPair? _jsonWebTokenPair; private static readonly SemaphoreSlim TokenSemaphore = new(1, 1); private readonly HttpClient _httpClient; private readonly JsonSerializerOptions _serializerOptions; internal readonly NordigenClientCredentials Credentials; + private JsonWebTokenPair? _jsonWebTokenPair; + + /// + public JsonWebTokenPair? JsonWebTokenPair + { + get => _jsonWebTokenPair; + set + { + _jsonWebTokenPair = value; + if (value is not null) + TokenPairUpdated?.Invoke(this, new TokenPairUpdatedEventArgs(value)); + } + } + + /// + public ITokenEndpoint TokenEndpoint { get; } + + /// + public IInstitutionsEndpoint InstitutionsEndpoint { get; } + + /// + public IAgreementsEndpoint AgreementsEndpoint { get; } + + /// + public IRequisitionsEndpoint RequisitionsEndpoint { get; } + + /// + public IAccountsEndpoint AccountsEndpoint { get; } /// /// Creates a new instance of . @@ -49,33 +76,6 @@ public NordigenClient(HttpClient httpClient, NordigenClientCredentials credentia AccountsEndpoint = new AccountsEndpoint(this); } - /// - public JsonWebTokenPair? JsonWebTokenPair - { - get => _jsonWebTokenPair; - set - { - _jsonWebTokenPair = value; - if (value is not null) - TokenPairUpdated?.Invoke(this, new TokenPairUpdatedEventArgs(value)); - } - } - - /// - public ITokenEndpoint TokenEndpoint { get; } - - /// - public IInstitutionsEndpoint InstitutionsEndpoint { get; } - - /// - public IAgreementsEndpoint AgreementsEndpoint { get; } - - /// - public IRequisitionsEndpoint RequisitionsEndpoint { get; } - - /// - public IAccountsEndpoint AccountsEndpoint { get; } - /// public event EventHandler? TokenPairUpdated; @@ -119,7 +119,8 @@ internal async Task> MakeRequest(tokenResponse.StatusCode, tokenResponse.IsSuccess, - null, new TError {Summary = tokenResponse.Error.Summary, Detail = tokenResponse.Error.Detail}); + null, new TError {Summary = tokenResponse.Error.Summary, Detail = tokenResponse.Error.Detail}, + tokenResponse.RateLimits); } finally { @@ -167,9 +168,7 @@ private async Task> TryGetV { // Request a new token if it is null or if the refresh token has expired if (JsonWebTokenPair == null || JsonWebTokenPair.RefreshToken.IsExpired(TimeSpan.FromMinutes(1))) - { return await TokenEndpoint.GetTokenPair(cancellationToken); - } // Refresh the current access token if it's expired (or valid for less than a minute) if (JsonWebTokenPair.AccessToken.IsExpired(TimeSpan.FromMinutes(1))) @@ -180,13 +179,13 @@ private async Task> TryGetV ? new JsonWebTokenPair(response.Result.AccessToken, JsonWebTokenPair.RefreshToken, response.Result!.AccessExpires, JsonWebTokenPair.RefreshExpires) : null; - + return new NordigenApiResponse(response.StatusCode, response.IsSuccess, - token, response.Error); + token, response.Error, response.RateLimits); } // Token pair is still valid and can be returned - wrap in NordigenApiResponse return new NordigenApiResponse(HttpStatusCode.OK, true, JsonWebTokenPair, - null); + null, new ApiRateLimits(-1, -1, -1, -1, 0, -1)); } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/RobinTTY.NordigenApiClient.csproj b/src/RobinTTY.NordigenApiClient/RobinTTY.NordigenApiClient.csproj index 956ad93..f783d9f 100644 --- a/src/RobinTTY.NordigenApiClient/RobinTTY.NordigenApiClient.csproj +++ b/src/RobinTTY.NordigenApiClient/RobinTTY.NordigenApiClient.csproj @@ -16,7 +16,7 @@ Nordigen; API; client $([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/release-notes.txt")) MIT - 10.0.0 + 10.1.0 true snupkg 12f53312-dcef-47c5-bc2e-0ce6f74609a6 diff --git a/src/RobinTTY.NordigenApiClient/Utility/EnumDescriptorExtension.cs b/src/RobinTTY.NordigenApiClient/Utility/EnumDescriptorExtension.cs index 405f2bb..f19047b 100644 --- a/src/RobinTTY.NordigenApiClient/Utility/EnumDescriptorExtension.cs +++ b/src/RobinTTY.NordigenApiClient/Utility/EnumDescriptorExtension.cs @@ -36,4 +36,4 @@ internal static T StringToEnumValue(string? description) where T : struct return default!; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Utility/HttpClientExtensions.cs b/src/RobinTTY.NordigenApiClient/Utility/HttpClientExtensions.cs index 365cff9..f661ad7 100644 --- a/src/RobinTTY.NordigenApiClient/Utility/HttpClientExtensions.cs +++ b/src/RobinTTY.NordigenApiClient/Utility/HttpClientExtensions.cs @@ -8,7 +8,10 @@ internal static class HttpClientExtensions /// /// Sets the authentication header needed for most of the Nordigen API requests. /// See: - /// GoCardless Documentation + /// + /// GoCardless + /// Documentation + /// /// /// The to apply the authentication header on. /// @@ -22,4 +25,4 @@ internal static HttpClient UseNordigenAuthenticationHeader(this HttpClient clien client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", rawToken); return client; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Utility/JsonWebTokenExtensions.cs b/src/RobinTTY.NordigenApiClient/Utility/JsonWebTokenExtensions.cs index 322e759..41ab329 100644 --- a/src/RobinTTY.NordigenApiClient/Utility/JsonWebTokenExtensions.cs +++ b/src/RobinTTY.NordigenApiClient/Utility/JsonWebTokenExtensions.cs @@ -12,4 +12,4 @@ internal static class JsonWebTokenExtensions /// True if token is expired otherwise false. internal static bool IsExpired(this SecurityToken token, TimeSpan timeToExpiry = default) => token.ValidTo.ToUniversalTime() < DateTime.UtcNow.Add(timeToExpiry); -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/Utility/UriQueryBuilder.cs b/src/RobinTTY.NordigenApiClient/Utility/UriQueryBuilder.cs index c69e50c..5fde202 100644 --- a/src/RobinTTY.NordigenApiClient/Utility/UriQueryBuilder.cs +++ b/src/RobinTTY.NordigenApiClient/Utility/UriQueryBuilder.cs @@ -18,4 +18,4 @@ internal static string GetQueryString(IEnumerable> foreach (var kvp in queryKeyValuePairs) query.Add(kvp.Key, kvp.Value); return query.ToString() is null ? string.Empty : $"?{query}"; } -} +} \ No newline at end of file diff --git a/src/RobinTTY.NordigenApiClient/release-notes.txt b/src/RobinTTY.NordigenApiClient/release-notes.txt index cdc48b7..4634324 100644 --- a/src/RobinTTY.NordigenApiClient/release-notes.txt +++ b/src/RobinTTY.NordigenApiClient/release-notes.txt @@ -1,2 +1,2 @@ -This version improves many aspects of the library. Since this version contains breaking changes please check the release notes before updating. -For the full release notes please see: https://github.com/RobinTTY/NordigenApiClient/releases/tag/v9.0.0 \ No newline at end of file +Added the ability to check newly introduced rate limits in the GoCardless API. +Also see: https://bankaccountdata.zendesk.com/hc/en-gb/articles/11529584398236-Bank-API-Rate-Limits-and-Rate-Limit-Headers \ No newline at end of file