Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/nordtest
A csharp SDK for accessing the accounts API.
https://github.com/speakeasy-sdks/nordtest
Last synced: 2 days ago
JSON representation
A csharp SDK for accessing the accounts API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/nordtest
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-10-12T09:22:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:47:02.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:48.115Z (6 months ago)
- Language: C#
- Size: 202 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# accounts
## SDK Installation
### Nuget
```bash
dotnet add package accounts
```
## SDK Example Usage
### Example
```csharp
using Accounts;
using Accounts.Models.Shared;
using Accounts.Models.Operations;
var sdk = new AccountsSDK(security: new Security() {
DecoupledAuth = "Bearer ",
});
AccountDetailsUsingGETRequest req = new AccountDetailsUsingGETRequest() {
Signature = "",
XIBMClientId = "",
XIBMClientSecret = "",
XNordeaOriginatingDate = "",
XNordeaOriginatingHost = "",
Id = "",
};
var res = await sdk.CustomerAccounts.AccountDetailsUsingGETAsync(req);
// handle response
```
## Available Resources and Operations
### [CustomerAccounts](docs/sdks/customeraccounts/README.md)
* [AccountDetailsUsingGET](docs/sdks/customeraccounts/README.md#accountdetailsusingget) - Get account details by account id
* [AccountListUsingGET](docs/sdks/customeraccounts/README.md#accountlistusingget) - Get list of accounts
* [ConvertV4AccountIdToV5UsingGET](docs/sdks/customeraccounts/README.md#convertv4accountidtov5usingget) - Convert V4 technical account identifier to V5
* [ConvertV5AccountIdToV4UsingGET](docs/sdks/customeraccounts/README.md#convertv5accountidtov4usingget) - Convert V5 technical account identifier to V4
* [TransactionListUsingGET](docs/sdks/customeraccounts/README.md#transactionlistusingget) - Get account transactions
## Server Selection
### Select Server by Index
You can override the default server globally by passing a server index to the `serverIndex: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https:////api.nordeaopenbanking.com/personal/` | None |
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `serverUrl: str` optional parameter when initializing the SDK client instance. For example:
## Authentication
### Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme |
| --------------- | --------------- | --------------- |
| `DecoupledAuth` | oauth2 | OAuth2 token |
| `OAuth2` | oauth2 | OAuth2 token |
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```csharp
using Accounts;
using Accounts.Models.Shared;
using Accounts.Models.Operations;
var sdk = new AccountsSDK(security: new Security() {
DecoupledAuth = "Bearer ",
});
AccountDetailsUsingGETRequest req = new AccountDetailsUsingGETRequest() {
Signature = "",
XIBMClientId = "",
XIBMClientSecret = "",
XNordeaOriginatingDate = "",
XNordeaOriginatingHost = "",
Id = "",
};
var res = await sdk.CustomerAccounts.AccountDetailsUsingGETAsync(req);
// handle response
```
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or thow an exception. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate type.
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| Accounts.Models.Errors.ErrorResponse | 400,401,403,404 | application/json |
| Accounts.Models.Errors.SDKException | 4xx-5xx | */* |
### Example
```csharp
using Accounts;
using Accounts.Models.Shared;
using System;
using Accounts.Models.Errors;
using Accounts.Models.Operations;
var sdk = new AccountsSDK(security: new Security() {
DecoupledAuth = "Bearer ",
});
AccountDetailsUsingGETRequest req = new AccountDetailsUsingGETRequest() {
Signature = "",
XIBMClientId = "",
XIBMClientSecret = "",
XNordeaOriginatingDate = "",
XNordeaOriginatingHost = "",
Id = "",
};
try
{
var res = await sdk.CustomerAccounts.AccountDetailsUsingGETAsync(req);
// handle response
}
catch (Exception ex)
{
if (ex is ErrorResponse)
{
// handle exception
}
else if (ex is Accounts.Models.Errors.SDKException)
{
// handle exception
}
}
```
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)