Symxify.Client
1.0.2
dotnet add package Symxify.Client --version 1.0.2
NuGet\Install-Package Symxify.Client -Version 1.0.2
<PackageReference Include="Symxify.Client" Version="1.0.2" />
<PackageVersion Include="Symxify.Client" Version="1.0.2" />
<PackageReference Include="Symxify.Client" />
paket add Symxify.Client --version 1.0.2
#r "nuget: Symxify.Client, 1.0.2"
#:package Symxify.Client@1.0.2
#addin nuget:?package=Symxify.Client&version=1.0.2
#tool nuget:?package=Symxify.Client&version=1.0.2
Symxify C# Client
PLEASE READ:
For the best expierience, ensure your editor has the EditorBrowsable state set to something among the lines of "Let the package decide". The Symxify client relies on EditorBrowsable to hide not-needed fields, such as the *Specified fields.
Quick start
To get started, clone this repo and navigate to the demo/net9 folder. There, you can see how to use the Symxify client with DI, and how to send requests.
Want to get started writing core in under 5 minutes? Shoot us a message on our website.
Featrures
Modern dependency injection
Easily inject the client into your app by using modern .NET dependency injection
<pre><code>builder.Services.AddSymxifyClient(options ⇒ builder.Configuration.GetSection("Symxify").Bind(options));</code></pre>
Fully featured intellisense
Every server and every operation will auto complete.
<pre><code>var resp = await _client.GetAccountSelectFields(new AccountSelectFieldsRequest() { SelectableFields = new AccountSingleSelectableFields() { IncludeAllAccountFields = true }, Credentials = new CredentialsChoice() { AdministrativeCredentials = new AdministrativeCredentials() { Password = "<PASSWORD>" } }, AccountNumber = "99", DeviceInformation = new DeviceInformation() { DeviceNumber = 20548, DeviceType = "MYSYMX" }, MessageId = "Getting this account!", });</code></pre>
Compatible with Managed Symxify and Self-hosted Symxify
To use this client with your existing managed Symxify instance, simply add the <code>SymxifyKey</code> object to your appsettings.json file
<pre><code>"Symxify": { "SymxifyUrl": "https://localhost:7036/api/v1/symxchange", "SymxifyKey": "Your long secret key here" }</code></pre>
Predictable responses
All respones are wrapped in a Result pattern, making it easy to check the status of a response and get error messages.
<pre><code> if (resp.Success) { return Results.OK(resp.Data) } else { return Results.BadRequest(resp.Error) } </pre></code>
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net6.0
- Microsoft.Extensions.Configuration (>= 9.0.4)
- Microsoft.Extensions.Http (>= 9.0.4)
- Microsoft.Extensions.Logging (>= 9.0.4)
-
net7.0
- Microsoft.Extensions.Configuration (>= 9.0.4)
- Microsoft.Extensions.Http (>= 9.0.4)
- Microsoft.Extensions.Logging (>= 9.0.4)
-
net8.0
- Microsoft.Extensions.Configuration (>= 9.0.4)
- Microsoft.Extensions.Http (>= 9.0.4)
- Microsoft.Extensions.Logging (>= 9.0.4)
-
net9.0
- Microsoft.Extensions.Configuration (>= 9.0.4)
- Microsoft.Extensions.Http (>= 9.0.4)
- Microsoft.Extensions.Logging (>= 9.0.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.