Skip to content

Commit

Permalink
Update remaining docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
RobinTTY committed Aug 12, 2024
1 parent 162f36b commit d117786
Show file tree
Hide file tree
Showing 23 changed files with 225 additions and 85 deletions.
23 changes: 23 additions & 0 deletions docs/docs/api-reference/events/token-pair-updated-event-args.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: TokenPairUpdatedEventArgs
---

Provides data for the [`NordigenClient.TokenPairUpdated`](/docs/api-reference/nordigen-client#tokenpairupdated---eventhandlertokenpairupdatedeventargs) event.

## Properties

### `JsonWebTokenPair` - [JsonWebTokenPair](/docs/api-reference/json-web-tokens/json-web-token-pair)

The updated `JsonWebTokenPair`.

## Constructor

```csharp
public TokenPairUpdatedEventArgs(JsonWebTokenPair jsonWebTokenPair)
```

### Parameters

#### `jsonWebTokenPair` - [JsonWebTokenPair](/docs/api-reference/json-web-tokens/json-web-token-pair)

The updated `JsonWebTokenPair`.
29 changes: 29 additions & 0 deletions docs/docs/api-reference/nordigen-client-credentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: NordigenClientCredentials
---

The `NordigenClientCredentials` class represents user secrets as provided by GoCardless. Used to acquire access-tokens to the API.

## Properties

### `SecretId` - [string](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/reference-types#the-string-type)

Secret GoCardless API credential id.

### `SecretKey` - [string](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/reference-types#the-string-type)

Secret GoCardless API credential key.

## Constructor

```csharp
public NordigenClientCredentials(string secretId, string secretKey)
```

### Parameters

#### `secretId` - [string](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/reference-types#the-string-type)

Secret GoCardless API credential id.

#### `secretKey` - [string](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/reference-types#the-string-type)
18 changes: 9 additions & 9 deletions docs/docs/api-reference/nordigen-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,33 @@ The `NordigenClient` class exposes the endpoints of the GoCardless API through i

## Properties

#### `JsonWebTokenPair` - JsonWebTokenPair?
#### `JsonWebTokenPair` - [JsonWebTokenPair](/docs/api-reference/json-web-tokens/json-web-token-pair)?

The JWT pair consisting of access and refresh token used to authenticate with the GoCardless API. This property can be used to set the token pair that is used when retrieving a new access/refresh token through the `TokenEndpoint`.

#### `TokenEndpoint` - ITokenEndpoint
#### `TokenEndpoint` - [ITokenEndpoint](/docs/api-reference/endpoints/token-endpoint)

Provides support for the API operations of the tokens endpoint.

#### `InstitutionsEndpoint` - IInstitutionsEndpoint
#### `InstitutionsEndpoint` - [IInstitutionsEndpoint](/docs/api-reference/endpoints/institutions-endpoint)

Provides support for the API operations of the institutions endpoint.

#### `AgreementsEndpoint` - IAgreementsEndpoint
#### `AgreementsEndpoint` - [IAgreementsEndpoint](/docs/api-reference/endpoints/agreements-endpoint)

Provides support for the API operations of the agreements endpoint.

#### `RequisitionsEndpoint` - IRequisitionsEndpoint
#### `RequisitionsEndpoint` - [IRequisitionsEndpoint](/docs/api-reference/endpoints/requisitions-endpoint)

Provides support for the API operations of the requisitions endpoint.

#### `AccountsEndpoint` - IAccountsEndpoint
#### `AccountsEndpoint` - [IAccountsEndpoint](/docs/api-reference/endpoints/accounts-endpoint)

Provides support for the API operations of the accounts endpoint.

## Events

#### `TokenPairUpdated` - EventHandler\<TokenPairUpdatedEventArgs\>?
#### `TokenPairUpdated` - [EventHandler](https://learn.microsoft.com/en-us/dotnet/api/system.eventhandler)\<[TokenPairUpdatedEventArgs](/docs/api-reference/events/token-pair-updated-event-args)\>?

Occurs whenever the `JsonWebTokenPair` property is successfully updated.
When the token is manually updated to be null, this event will not be raised.
Expand All @@ -51,10 +51,10 @@ public NordigenClient(HttpClient httpClient, NordigenClientCredentials credentia

The `HttpClient` instance that should be used to send all requests made by the `NordigenClient`. You can adjust the `BaseAddress` of the `HttpClient` as needed, for details see: [Using a different Base Address](/docs/using-a-different-base-address).

##### `credentials` - NordigenClientCredentials
##### `credentials` - [NordigenClientCredentials](/docs/api-reference/nordigen-client-credentials)

The credentials you get from the [GoCardless Bank Account Data portal](https://bankaccountdata.gocardless.com/login/) (User secrets).

##### `jsonWebTokenPair` - JsonWebTokenPair?
##### `jsonWebTokenPair` - [JsonWebTokenPair](/docs/api-reference/json-web-tokens/json-web-token-pair)?

An optional `JsonWebTokenPair` to reuse from an preceding successful authentication. These may for instance be retrieved from your database.
2 changes: 1 addition & 1 deletion docs/docs/api-reference/responses/access-scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: AccessScope Enum
---

Contains the available access scopes for banking institutions. Access scopes can be used to limit the access to the 3 major data blocks the GoCardless API is offering. This feature is not supported by all banks, check `Institution.SupportedFeatures` to verify if it is.
Contains the available access scopes for banking institutions. Access scopes can be used to limit the access to the 3 major data blocks the GoCardless API is offering. This feature is not supported by all banks, check [`Institution.SupportedFeatures`](/docs/api-reference/responses/institution#supportedfeatures---liststring) to verify if it is.

## Fields

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/api-reference/responses/account-transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ The `AccountTransactions` class holds transactions belonging to a bank account.

## Properties

### `BookedTransactions` - List\<Transaction\>
### `BookedTransactions` - [List](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)\<[Transaction](/docs/api-reference/responses/transaction)\>

Transactions which were already booked to the bank account.

### `PendingTransactions` - List\<Transaction\>
### `PendingTransactions` - [List](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)\<[Transaction](/docs/api-reference/responses/transaction)\>

Transactions which are currently pending and have not been booked yet.

Expand All @@ -23,10 +23,10 @@ public AccountTransactions(List<Transaction> bookedTransactions,

### Parameters

#### `bookedTransactions` - List\<Transaction\>
#### `bookedTransactions` - [List](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)\<[Transaction](/docs/api-reference/responses/transaction)\>

Transactions which were already booked to the bank account.

#### `pendingTransactions` - List\<Transaction\>
#### `pendingTransactions` - [List](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)\<[Transaction](/docs/api-reference/responses/transaction)\>

Transactions which are currently pending and have not been booked yet.
10 changes: 5 additions & 5 deletions docs/docs/api-reference/responses/balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Balance
---

The `Balance` class represents a balance of a [BankAccount](TODO).
The `Balance` class represents a balance of a [BankAccount](/docs/api-reference/responses/bank-account).

## Properties

### `BalanceAmount` - [AmountCurrencyPair](/docs/api-reference/responses/amount-currency-pair)

The balance amount including details about the currency the amount is denominated in.

### `BalanceType` - [BalanceType](TODO)
### `BalanceType` - [BalanceType](/docs/api-reference/responses/balance-type)

Type of the balance (e.g. [BalanceType.ClosingBooked](TODO)).
Type of the balance (e.g. [BalanceType.ClosingBooked](/docs/api-reference/responses/balance-type#closingbooked)).

### `ReferenceDate` - [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime)

Expand Down Expand Up @@ -43,9 +43,9 @@ public Balance(AmountCurrencyPair balanceAmount, BalanceType balanceType, DateTi

The balance amount including details about the currency the amount is denominated in.

#### `balanceType` - [BalanceType](TODO)
#### `balanceType` - [BalanceType](/docs/api-reference/responses/balance-type)

Type of the balance (e.g. [BalanceType.ClosingBooked](TODO)).
Type of the balance (e.g. [BalanceType.ClosingBooked](/docs/api-reference/responses/balance-type#closingbooked)).

#### `referenceDate` - [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime)

Expand Down
12 changes: 6 additions & 6 deletions docs/docs/api-reference/responses/bank-account-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Name of the account as defined by the end user within online channels.

Product name of the bank for this account.

### `CashAccountType` - [CashAccountType](TODO)?
### `CashAccountType` - [CashAccountType](/docs/api-reference/responses/cash-account-type)?

Specifies the nature, or use, of the cash account as defined by ISO 20022.

Expand All @@ -70,11 +70,11 @@ A financial institution might name a cash account associated with pending card t

An alias to a payment account via a registered mobile phone number.

### `Status` - [IsoBankAccountStatus](TODO)?
### `Status` - [IsoBankAccountStatus](/docs/api-reference/responses/iso-bank-account-status)?

The status of the account.

### `Usage` - [BankAccountUsage](TODO)?
### `Usage` - [BankAccountUsage](/docs/api-reference/responses/bank-account-usage)?

Specifies the usage of the account.

Expand Down Expand Up @@ -134,7 +134,7 @@ Name of the account as defined by the end user within online channels.

Product name of the bank for this account.

#### `cashAccountType` - [CashAccountType](TODO)?
#### `cashAccountType` - [CashAccountType](/docs/api-reference/responses/cash-account-type)?

Specifies the nature, or use, of the cash account as defined by ISO 20022.

Expand All @@ -154,10 +154,10 @@ A financial institution might name a cash account associated with pending card t

An alias to a payment account via a registered mobile phone number.

#### `status` - [IsoBankAccountStatus](TODO)?
#### `status` - [IsoBankAccountStatus](/docs/api-reference/responses/iso-bank-account-status)?

The status of the account.

#### `usage` - [BankAccountUsage](TODO)?
#### `usage` - [BankAccountUsage](/docs/api-reference/responses/bank-account-usage)?

Specifies the usage of the account.
4 changes: 2 additions & 2 deletions docs/docs/api-reference/responses/bank-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ 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.

### `Status` - [BankAccountStatus](TODO)
### `Status` - [BankAccountStatus](/docs/api-reference/responses/bank-account-status-enum)

The status of the account (e.g. user has successfully authenticated and account is discovered).

Expand Down Expand Up @@ -67,6 +67,6 @@ 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.

#### `status` - [BankAccountStatus](TODO)
#### `status` - [BankAccountStatus](/docs/api-reference/responses/bank-account-status-enum)

The status of the account (e.g. user has successfully authenticated and account is discovered).
16 changes: 8 additions & 8 deletions docs/docs/api-reference/responses/institution.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ The countries the institution operates in.

A URI for the logo of the institution.

### `SupportedPayments` - [SupportedPayments](TODO)
### `SupportedPayments` - [SupportedPayments](/docs/api-reference/responses/supported-payments)

Supported payment products for this institution. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](TODO).
Supported payment products for this institution. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](/docs/api-reference/endpoints/institutions-endpoint#getinstitution).

### `SupportedFeatures` - [List](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)\<[string](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/reference-types#the-string-type)\>?

Supported features for this institution. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](TODO).
Supported features for this institution. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](/docs/api-reference/endpoints/institutions-endpoint#getinstitution).

### `IdentificationCodes` - [List](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)\<[string](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/reference-types#the-string-type)\>?

Undocumented field returned by the GoCardless API. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](TODO).
Undocumented field returned by the GoCardless API. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](/docs/api-reference/endpoints/institutions-endpoint#getinstitution).

## Constructor

Expand Down Expand Up @@ -76,14 +76,14 @@ The countries the institution operates in.

A URI for the logo of the institution.

#### `supportedPayments` - [SupportedPayments](TODO)
#### `supportedPayments` - [SupportedPayments](/docs/api-reference/responses/supported-payments)

Supported payment products for this institution. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](TODO).
Supported payment products for this institution. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](/docs/api-reference/endpoints/institutions-endpoint#getinstitution).

#### `supportedFeatures` - [List](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)\<[string](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/reference-types#the-string-type)\>?

Supported features for this institution. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](TODO).
Supported features for this institution. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](/docs/api-reference/endpoints/institutions-endpoint#getinstitution).

#### `identificationCodes` - [List](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)\<[string](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/reference-types#the-string-type)\>?

Undocumented field returned by the GoCardless API. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](TODO).
Undocumented field returned by the GoCardless API. Only populated when calling [`InstitutionsEndpoint.GetInstitution`](/docs/api-reference/endpoints/institutions-endpoint#getinstitution).
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: IsoBankAccountStatus Enum
---

Identifies the status of the bank account as defined by the ISO 20022 standard.
Identifies the status of the bank account as defined by the [ISO 20022](https://en.wikipedia.org/wiki/ISO_20022) standard.

## Fields

Expand Down
46 changes: 45 additions & 1 deletion docs/docs/api-reference/responses/requisition-status.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,47 @@
---
title: RequisitionStatus
title: RequisitionStatus Enum
---

Indicates the status of a [`Requisition`](/docs/api-reference/responses/requisition). A requisition can assume one of nine statuses. The sequence of statuses is given in stages. Reference: [GoCardless Documentation](https://developer.gocardless.com/bank-account-data/statuses)

## Fields

### Undefined

An undefined requisition status. Assigned if the status couldn't be matched to any known option.

### Created

Indicates that the requisition has been successfully created (stage 1).

### GivingConsent

Indicates that the account holder is currently in the process of giving consent through Nordigen's consent screen (stage 2).

### UndergoingAuthentication

Indicates that the account holder has been redirected to the financial institution for authentication (stage 3).

### Rejected

Indicates that either the SSN verification has failed or the account holder has entered incorrect credentials (stage 4).

### SelectingAccounts

Indicates that the account holder is currently in the process of selecting accounts (stage 5).

### GrantingAccess

Indicates that the end user is currently in the process of granting access to their account information (stage 6).

### Linked

Indicates that an account has been successfully linked to the requisition (stage 7).

### Suspended

Indicates that the requisition is suspended due to numerous consecutive errors that happened while accessing one of the linked accounts (stage 8).

### Expired

Indicates that access to the linked accounts has expired as defined in the end user agreement (stage 9).
8 changes: 6 additions & 2 deletions docs/docs/api-reference/responses/requisition.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ The id of the requisition assigned by the Nordigen API.

### `Created` - [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime)

### `Status` - [RequisitionStatus](TODO)
The time this requisition was created.

### `Status` - [RequisitionStatus](/docs/api-reference/responses/requisition-status)

The status of the requisition.

Expand Down Expand Up @@ -72,7 +74,9 @@ The id of the requisition assigned by the Nordigen API.

#### `created` - [DateTime](https://learn.microsoft.com/en-us/dotnet/api/system.datetime)

#### `status` - [RequisitionStatus](TODO)
The time this requisition was created.

#### `status` - [RequisitionStatus](/docs/api-reference/responses/requisition-status)

The status of the requisition.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/api-reference/responses/response-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ A token to signal cancellation of the operation.

#### Returns

`Task<NordigenApiResponse<ResponsePage<T>, BasicResponse>?>`
[Task](https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)\<[NordigenApiResponse](/docs/api-reference/responses/nordigen-api-response)\<[ResponsePage\<T\>](/docs/api-reference/responses/response-page), [BasicResponse](/docs/api-reference/responses/basic-response)>?\>

A `NordigenApiResponse` containing either the next `ResponsePage<T>` or null if there is no next page to retrieve (if the request is successful).

Expand All @@ -92,6 +92,6 @@ A token to signal cancellation of the operation.

#### Returns

`Task<NordigenApiResponse<ResponsePage<T>, BasicResponse>?>`
[Task](https://learn.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)\<[NordigenApiResponse](/docs/api-reference/responses/nordigen-api-response)\<[ResponsePage\<T\>](/docs/api-reference/responses/response-page), [BasicResponse](/docs/api-reference/responses/basic-response)>?\>

A `NordigenApiResponse` containing either the previous `ResponsePage<T>` or null if there is no previous page to retrieve (if the request is successful).
Loading

0 comments on commit d117786

Please sign in to comment.