Skip to content

Commit

Permalink
Improve docstrings by using anchor tags instead of <see>
Browse files Browse the repository at this point in the history
  • Loading branch information
RobinTTY committed Nov 9, 2023
1 parent e7bc5f6 commit 40ff78a
Show file tree
Hide file tree
Showing 17 changed files with 152 additions and 76 deletions.
4 changes: 3 additions & 1 deletion src/RobinTTY.NordigenApiClient/Endpoints/AccountsEndpoint.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ namespace RobinTTY.NordigenApiClient.Endpoints;

/// <summary>
/// Provides support for the API operations of the accounts endpoint.
/// <para>Reference: <see href="https://developer.gocardless.com/bank-account-data/endpoints" /></para>
/// <para>
/// Reference: <a href="https://developer.gocardless.com/bank-account-data/endpoints">GoCardless Documentation</a>
/// </para>
/// </summary>
public class AccountsEndpoint
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ namespace RobinTTY.NordigenApiClient.Endpoints;

/// <summary>
/// Provides support for the API operations of the agreements endpoint.
/// <para>Reference: <see href="https://developer.gocardless.com/bank-account-data/endpoints" /></para>
/// <para>
/// Reference: <a href="https://developer.gocardless.com/bank-account-data/endpoints">GoCardless Documentation</a>
/// </para>
/// </summary>
public class AgreementsEndpoint
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ namespace RobinTTY.NordigenApiClient.Endpoints;

/// <summary>
/// Provides support for the API operations of the institutions endpoint.
/// <para>Reference: <see href="https://developer.gocardless.com/bank-account-data/endpoints" /></para>
/// <para>
/// Reference: <a href="https://developer.gocardless.com/bank-account-data/endpoints">GoCardless Documentation</a>
/// </para>
/// </summary>
public class InstitutionsEndpoint
{
Expand All @@ -24,7 +26,7 @@ internal InstitutionsEndpoint(NordigenClient client)
/// Gets a list of institutions supported by the Nordigen API (optionally filtered by country and supported features).
/// </summary>
/// <param name="country">
/// The two-letter country code (<see href="https://wikipedia.org/wiki/ISO_3166-1">ISO 3166</see>) in
/// The two-letter country code (<a href="https://wikipedia.org/wiki/ISO_3166-1">ISO 3166</a>) in
/// which the institutions operate. Parameter won't be sent in the query if <see langword="null" />.
/// </param>
/// <param name="accessScopesSupported">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ namespace RobinTTY.NordigenApiClient.Endpoints;

/// <summary>
/// Provides support for the API operations of the requisitions endpoint.
/// <para>Reference: <see href="https://developer.gocardless.com/bank-account-data/endpoints" /></para>
/// <para>
/// Reference: <a href="https://developer.gocardless.com/bank-account-data/endpoints">GoCardless Documentation</a>
/// </para>
/// </summary>
public class RequisitionsEndpoint
{
Expand Down
4 changes: 3 additions & 1 deletion src/RobinTTY.NordigenApiClient/Endpoints/TokenEndpoint.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ namespace RobinTTY.NordigenApiClient.Endpoints;

/// <summary>
/// Provides support for the API operations of the tokens endpoint.
/// <para>Reference: <see href="https://developer.gocardless.com/bank-account-data/endpoints" /></para>
/// <para>
/// Reference: <a href="https://developer.gocardless.com/bank-account-data/endpoints">GoCardless Documentation</a>
/// </para>
/// </summary>
public class TokenEndpoint
{
Expand Down
79 changes: 39 additions & 40 deletions src/RobinTTY.NordigenApiClient/Models/Errors/AccountsError.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,45 @@ namespace RobinTTY.NordigenApiClient.Models.Errors;
/// </summary>
public class AccountsError : BasicError
{
/// <summary>
/// The type of the error.
/// </summary>
[JsonPropertyName("type")]
public string? Type { get; }
#if NET6_0_OR_GREATER
/// <summary>
/// An error that was returned related to the
/// <see cref="AccountsEndpoint.GetTransactions(Guid, DateOnly?, DateOnly?, CancellationToken)" /> or
/// <see cref="AccountsEndpoint.GetTransactions(string, DateOnly?, DateOnly?, CancellationToken)" /> method because the
/// start date value was not accepted.
/// </summary>
#else
/// <summary>
/// An error that was returned related to the
/// <see cref="AccountsEndpoint.GetTransactions(Guid, DateTime?, DateTime?, CancellationToken)" /> or
/// <see cref="AccountsEndpoint.GetTransactions(string, DateTime?, DateTime?, CancellationToken)" /> method because the
/// start date value was not accepted.
/// </summary>
#endif
[JsonPropertyName("date_from")]
public BasicError? StartDateError { get; }
#if NET6_0_OR_GREATER
/// <summary>
/// An error that was returned related to the
/// <see cref="AccountsEndpoint.GetTransactions(Guid, DateOnly?, DateOnly?, CancellationToken)" /> or
/// <see cref="AccountsEndpoint.GetTransactions(string, DateOnly?, DateOnly?, CancellationToken)" /> method because the
/// end date value was not accepted.
/// </summary>
#else
/// <summary>
/// An error that was returned related to the
/// <see cref="AccountsEndpoint.GetTransactions(Guid, DateTime?, DateTime?, CancellationToken)" /> or
/// <see cref="AccountsEndpoint.GetTransactions(string, DateTime?, DateTime?, CancellationToken)" /> method because the end
/// date value was not accepted.
/// </summary>
#endif
[JsonPropertyName("date_to")]
public BasicError? EndDateError { get; }
#if NET6_0_OR_GREATER
/// <summary>
/// Creates a new instance of <see cref="AccountsError" />.
Expand Down Expand Up @@ -55,44 +94,4 @@ public AccountsError(string summary, string detail, string? type, BasicError? st
StartDateError = startDateError;
EndDateError = endDateError;
}

/// <summary>
/// The type of the error.
/// </summary>
[JsonPropertyName("type")]
public string? Type { get; }
#if NET6_0_OR_GREATER
/// <summary>
/// An error that was returned related to the
/// <see cref="AccountsEndpoint.GetTransactions(Guid, DateOnly?, DateOnly?, CancellationToken)" /> or
/// <see cref="AccountsEndpoint.GetTransactions(string, DateOnly?, DateOnly?, CancellationToken)" /> method because the
/// start date value was not accepted.
/// </summary>
#else
/// <summary>
/// An error that was returned related to the
/// <see cref="AccountsEndpoint.GetTransactions(Guid, DateTime?, DateTime?, CancellationToken)" /> or
/// <see cref="AccountsEndpoint.GetTransactions(string, DateTime?, DateTime?, CancellationToken)" /> method because the
/// start date value was not accepted.
/// </summary>
#endif
[JsonPropertyName("date_from")]
public BasicError? StartDateError { get; }
#if NET6_0_OR_GREATER
/// <summary>
/// An error that was returned related to the
/// <see cref="AccountsEndpoint.GetTransactions(Guid, DateOnly?, DateOnly?, CancellationToken)" /> or
/// <see cref="AccountsEndpoint.GetTransactions(string, DateOnly?, DateOnly?, CancellationToken)" /> method because the
/// end date value was not accepted.
/// </summary>
#else
/// <summary>
/// An error that was returned related to the
/// <see cref="AccountsEndpoint.GetTransactions(Guid, DateTime?, DateTime?, CancellationToken)" /> or
/// <see cref="AccountsEndpoint.GetTransactions(string, DateTime?, DateTime?, CancellationToken)" /> method because the end
/// date value was not accepted.
/// </summary>
#endif
[JsonPropertyName("date_to")]
public BasicError? EndDateError { get; }
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public class CreateRequisitionRequest

/// <summary>
/// Enforces a language for all end user steps hosted by Nordigen passed as a two-letter country code
/// <see href="https://wikipedia.org/wiki/ISO_639-1">(ISO 639-1)</see>.
/// <a href="https://wikipedia.org/wiki/ISO_639-1">(ISO 639-1)</a>.
/// </summary>
[JsonPropertyName("user_language")]
public string UserLanguage { get; set; }
Expand All @@ -43,7 +43,10 @@ public class CreateRequisitionRequest
/// Some European banks allow sending an end-user's SSN to check whether the SSN is valid.
/// <para>
/// For bank availability check:
/// <see href="https://nordigen.zendesk.com/hc/en-gb/articles/6761166365085-SSN-verification-feature-for-specific-banks" />
/// <a href="https://nordigen.zendesk.com/hc/en-gb/articles/6761166365085-SSN-verification-feature-for-specific-banks">
/// GoCardless
/// Documentation
/// </a>
/// .
/// </para>
/// </summary>
Expand All @@ -56,7 +59,11 @@ public class CreateRequisitionRequest
/// if set to true.
/// <para>
/// For details see:
/// <see href="https://nordigen.zendesk.com/hc/en-gb/articles/6760703821725-Account-selection-feature" />.
/// <a href="https://nordigen.zendesk.com/hc/en-gb/articles/6760703821725-Account-selection-feature">
/// GoCardless
/// Documentation
/// </a>
/// .
/// </para>
/// </summary>
[JsonPropertyName("account_selection")]
Expand All @@ -70,8 +77,11 @@ public class CreateRequisitionRequest
/// before you're able to query the transactions.
/// <para>
/// For details see:
/// <see
/// href="https://nordigen.zendesk.com/hc/en-gb/articles/6772857816477-Immediate-end-user-redirect-from-bank-after-consent" />
/// <a
/// href="https://nordigen.zendesk.com/hc/en-gb/articles/6772857816477-Immediate-end-user-redirect-from-bank-after-consent">
/// GoCardless
/// Documentation
/// </a>
/// .
/// </para>
/// </summary>
Expand All @@ -87,20 +97,30 @@ public class CreateRequisitionRequest
/// <param name="reference">A unique ID set by the user of the API for internal referencing.</param>
/// <param name="userLanguage">
/// Enforces a language for all end user steps hosted by Nordigen passed as a two-letter country
/// code <see href="https://wikipedia.org/wiki/ISO_639-1">(ISO 639-1)</see>.
/// code <a href="https://wikipedia.org/wiki/ISO_639-1">(ISO 639-1)</a>.
/// </param>
/// <param name="socialSecurityNumber">
/// Some European banks allow sending an end-user's SSN to check whether the SSN is valid.
/// <para>
/// For bank availability check:
/// <see href="https://nordigen.zendesk.com/hc/en-gb/articles/6761166365085-SSN-verification-feature-for-specific-banks/" />
/// <a href="https://nordigen.zendesk.com/hc/en-gb/articles/6761166365085-SSN-verification-feature-for-specific-banks/">
/// GoCardless
/// Documentation
/// </a>
/// .
/// </para>
/// </param>
/// <param name="accountSelection">
/// Enables the end user to select which accounts they want to share (like joint accounts, accounts of children, etc.)
/// if set to true.
/// <para>For details see: <see href="https://ob.helpscoutdocs.com/article/142-account-selection-feature" />.</para>
/// <para>
/// For details see:
/// <a href="https://nordigen.zendesk.com/hc/en-gb/articles/6760703821725-Account-selection-feature">
/// GoCardless
/// Documentation
/// </a>
/// .
/// </para>
/// </param>
/// <param name="redirectImmediate">
/// Enables you to redirect end users back to your app immediately after they have given their consent to access the
Expand All @@ -110,7 +130,12 @@ public class CreateRequisitionRequest
/// before you're able to query the transactions.
/// <para>
/// For details see:
/// <see href="https://ob.helpscoutdocs.com/article/145-immediate-end-user-redirect-from-bank-after-consent" />.
/// <a
/// href="https://nordigen.zendesk.com/hc/en-gb/articles/6772857816477-Immediate-end-user-redirect-from-bank-after-consent">
/// GoCardless
/// Documentation
/// </a>
/// .
/// </para>
/// </param>
public CreateRequisitionRequest(Uri redirect, string institutionId, string reference, string userLanguage,
Expand Down
4 changes: 3 additions & 1 deletion src/RobinTTY.NordigenApiClient/Models/Responses/Balance.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ namespace RobinTTY.NordigenApiClient.Models.Responses;

/// <summary>
/// A balance of a <see cref="BankAccount" />.
/// <para>Reference: <see href="https://developer.gocardless.com/bank-account-data/balance" /></para>
/// <para>
/// Reference: <a href="https://developer.gocardless.com/bank-account-data/balance">GoCardless Documentation</a>
/// </para>
/// </summary>
public class Balance
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ namespace RobinTTY.NordigenApiClient.Models.Responses;

/// <summary>
/// An account at a banking institution.
/// <para>Reference: <see href="https://developer.gocardless.com/bank-account-data/account-details" /></para>
/// <para>
/// Reference:
/// <a href="https://developer.gocardless.com/bank-account-data/account-details">GoCardless Documentation</a>
/// </para>
/// </summary>
public class BankAccount : MinimalBankAccount
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public class BankAccountDetails
/// Resource id used by the PSD2 interface.
/// <para>
/// For reference see:
/// <see href="https://www.berlin-group.org/_files/ugd/c2914b_fec1852ec9c640568f5c0b420acf67d2.pdf" />
/// <a href="https://www.berlin-group.org/_files/ugd/c2914b_fec1852ec9c640568f5c0b420acf67d2.pdf">Berlin Group PSD2</a>
/// </para>
/// </summary>
[JsonPropertyName("resourceId")]
Expand Down Expand Up @@ -144,7 +144,10 @@ public class BankAccountDetails
/// <param name="msisdn">An alias to a payment account via a registered mobile phone number.</param>
/// <param name="status">The account status.</param>
/// <param name="usage">Specifies whether the account is used by an institution or a private individual.</param>
/// <param name="maskedPan">Masked primary account number (unique identifier on credit cards, debit cards, and other types of payment cards).</param>
/// <param name="maskedPan">
/// Masked primary account number (unique identifier on credit cards, debit cards, and other types
/// of payment cards).
/// </param>
[JsonConstructor]
public BankAccountDetails(string resourceId, string iban, string? bic, string? bban, string currency,
string ownerName, string? ownerAddressUnstructured, string name, string product,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ namespace RobinTTY.NordigenApiClient.Models.Responses;
/// Specifies the nature, or use, of a cash account as defined by ISO 20022.
/// <para>
/// Reference:
/// <see href="https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets" />
/// <a href="https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets">
/// ISO20022 External
/// Code Sets
/// </a>
/// </para>
/// </summary>
[JsonConverter(typeof(EnumDescriptionConverter<BankAccountUsage>))]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ namespace RobinTTY.NordigenApiClient.Models.Responses;
/// Specifies the nature, or use, of a cash account as defined by ISO 20022.
/// <para>
/// Reference:
/// <see href="https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets" />
/// <a href="https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets">
/// ISO20022 External
/// Code Sets
/// </a>
/// </para>
/// </summary>
[JsonConverter(typeof(EnumDescriptionConverter<CashAccountType>))]
Expand Down
13 changes: 10 additions & 3 deletions src/RobinTTY.NordigenApiClient/Models/Responses/Requisition.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,16 @@ public class Requisition : CreateRequisitionRequest
/// <param name="reference">A unique ID set by the user of the API for internal referencing.</param>
/// <param name="userLanguage">
/// Enforces a language for all end user steps hosted by Nordigen passed as a two-letter country
/// code <see href="https://wikipedia.org/wiki/ISO_639-1">(ISO 639-1)</see>.
/// code <a href="https://wikipedia.org/wiki/ISO_639-1">(ISO 639-1)</a>.
/// </param>
/// <param name="socialSecurityNumber">
/// Some European banks allow sending an end-user's SSN to check whether the SSN is valid.
/// <para>
/// For bank availability check:
/// <see href="https://nordigen.zendesk.com/hc/en-gb/articles/6761166365085-SSN-verification-feature-for-specific-banks" />
/// <a href="https://nordigen.zendesk.com/hc/en-gb/articles/6761166365085-SSN-verification-feature-for-specific-banks">
/// GoCardless
/// Documentation
/// </a>
/// .
/// </para>
/// </param>
Expand All @@ -67,7 +70,11 @@ public class Requisition : CreateRequisitionRequest
/// if set to true.
/// <para>
/// For details see:
/// <see href="https://nordigen.zendesk.com/hc/en-gb/articles/6760703821725-Account-selection-feature" />.
/// <a href="https://nordigen.zendesk.com/hc/en-gb/articles/6760703821725-Account-selection-feature">
/// GoCardless
/// Documentation
/// </a>
/// .
/// </para>
/// </param>
/// <param name="redirectImmediate">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ namespace RobinTTY.NordigenApiClient.Models.Responses;
/// <summary>
/// Indicates the status of a <see cref="Requisition" />.
/// A requisition can assume one of nine statuses. The sequence of statuses is given in stages.
/// <para>Reference: <see href="https://developer.gocardless.com/bank-account-data/statuses" /></para>
/// <para>
/// Reference: <a href="https://developer.gocardless.com/bank-account-data/statuses">GoCardless Documentation</a>
/// </para>
/// </summary>
[JsonConverter(typeof(EnumDescriptionConverter<RequisitionStatus>))]
public enum RequisitionStatus
Expand Down
Loading

0 comments on commit 40ff78a

Please sign in to comment.