Skip to content

Commit

Permalink
Add SupportedCountry enum documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RobinTTY committed Aug 8, 2024
1 parent 6b63e2d commit c6ca13d
Show file tree
Hide file tree
Showing 4 changed files with 138 additions and 10 deletions.
131 changes: 131 additions & 0 deletions docs/docs/api-reference/supported-country.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
---
title: SupportedCountry Enum
---

Contains countries which are supported by the GoCardless API.

## Fields

### `Austria`

The country of Austria.

### `Belgium`

The country of Belgium.

### `Bulgaria`

The country of Bulgaria.

### `Croatia`

The country of Croatia.

### `Cyprus`

The country of Cyprus.

### `Czechia`

The country of Czechia.

### `Germany`

The country of Germany.

### `Denmark`

The country of Denmark.

### `Estonia`

The country of Estonia.

### `Spain`

The country of Spain.

### `Finland`

The country of Finland.

### `France`

The country of France.

### `UnitedKingdom`

The country of the United Kingdom.

### `Greece`

The country of Greece.

### `Hungary`

The country of Hungary.

### `Iceland`

The country of Iceland.

### `Ireland`

The country of Ireland.

### `Italy`

The country of Italy.

### `Latvia`

The country of Latvia.

### `Liechtenstein`

The country of Liechtenstein.

### `Lithuania`

The country of Lithuania.

### `Luxembourg`

The country of Luxembourg.

### `Malta`

The country of Malta.

### `Netherlands`

The country of Netherlands.

### `Norway`

The country of Norway.

### `Poland`

The country of Poland.

### `Portugal`

The country of Portugal.

### `Romania`

The country of Romania.

### `Sweden`

The country of Sweden.

### `Slovakia`

The country of Slovakia.

### `Slovenia`

The country of Slovenia.
1 change: 1 addition & 0 deletions docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const sidebars: SidebarsConfig = {
label: "API Reference",
items: [
"api-reference/nordigen-client",
"api-reference/supported-country",
{
type: "category",
label: "Endpoints",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,40 +11,36 @@ namespace RobinTTY.NordigenApiClient.Models.Errors;
public class CreateAgreementError : BasicResponse
{
/// <summary>
/// An error that was returned related to the <see cref="CreateAgreementRequest.InstitutionId" /> property sent during
/// the request.
/// An error that was returned related to the institutionId sent during the request.
/// </summary>
[JsonPropertyName("institution_id")]
[JsonConverter(typeof(StringArrayToBasicResponseConverter))]
public BasicResponse? InstitutionIdError { get; }

/// <summary>
/// An error that was returned related to the <see cref="CreateAgreementRequest.AccessScope" /> property sent during
/// the request.
/// An error that was returned related to the accessScope property sent during the request.
/// </summary>
[JsonPropertyName("access_scope")]
[JsonConverter(typeof(StringArrayToBasicResponseConverter))]
public BasicResponse? AccessScopeError { get; }

/// <summary>
/// An error that was returned related to the <see cref="CreateAgreementRequest.MaxHistoricalDays" /> property sent
/// An error that was returned related to the maxHistoricalDays property sent during the request.
/// during the request.
/// </summary>
[JsonPropertyName("max_historical_days")]
[JsonConverter(typeof(StringArrayToBasicResponseConverter))]
public BasicResponse? MaxHistoricalDaysError { get; }

/// <summary>
/// An error that was returned related to the <see cref="CreateAgreementRequest.AccessValidForDays" /> property sent
/// during the request.
/// An error that was returned related to the accessValidForDays property sent during the request.
/// </summary>
[JsonPropertyName("access_valid_for_days")]
[JsonConverter(typeof(StringArrayToBasicResponseConverter))]
public BasicResponse? AccessValidForDaysError { get; }

/// <summary>
/// An error that was returned related to the <see cref="CreateAgreementRequest.InstitutionId" /> property sent during
/// the request.
/// An error that was returned related to the institutionId property sent during the request.
/// </summary>
[JsonPropertyName("agreement")]
[JsonConverter(typeof(StringArrayToBasicResponseConverter))]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public enum SupportedCountry
France,

/// <summary>
/// The country of UnitedKingdom.
/// The country of the United Kingdom.
/// </summary>
[Description("GB")]
UnitedKingdom,
Expand Down

0 comments on commit c6ca13d

Please sign in to comment.