From c9216e59b616ea31b80c1539e06a31e897780bfd Mon Sep 17 00:00:00 2001 From: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Date: Wed, 22 May 2024 01:59:19 +0000 Subject: [PATCH] SDK regeneration --- README.md | 102 ------------------ src/SchematicHQ.Client.sln | 20 ++-- src/SchematicHQ.Client/Schematic.cs | 2 +- .../SchematicHQ.Client.csproj | 2 - 4 files changed, 11 insertions(+), 115 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 613d406..0000000 --- a/README.md +++ /dev/null @@ -1,102 +0,0 @@ -# Schematic .NET Library - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) - -The official Schematic C# library, supporting .NET Standard, .NET Core, and .NET Framework. - -## Installation - -Using the .NET Core command-line interface (CLI) tools: - -```sh -dotnet add package SchematicHQ.Client -``` - -Using the NuGet Command Line Interface (CLI): - -```sh -nuget install SchematicHQ.Client -``` - -## Instantiation -Instantiate the SDK using the `Schematic` client class. Note that all -of the SDK methods are awaitable! - -```csharp -using Schematic; - -Schematic schematic = new Schematic("YOUR_API_KEY") -``` - -## HTTP Client -You can override the HttpClient by passing in `ClientOptions`. - -```csharp -schematic = new Schematic("YOUR_API_KEY", new ClientOptions{ - HttpClient = ... // Override the Http Client - BaseURL = ... // Override the Base URL -}) -``` - -## Exception Handling -When the API returns a non-zero status code, (4xx or 5xx response), -a subclass of SchematicException will be thrown: - -```csharp -using Schematic; -using Schematic.Accounts; - -try { - schematic.Accounts.ListApiKeysAsync(...); -} catch (SchematicException e) { - System.Console.WriteLine(e.Message) - System.Console.WriteLine(e.StatusCode) -} -``` - -## Usage - -Below are code snippets of how you can use the C# SDK. - -```csharp -using Schematic; -using Schematic.Accounts; - -SchematicClient schematic = new Schematic("YOUR_API_KEY") -Employee employee = schematic.Accounts.ListApiKeysAsync( - new ListApiKeysRequest{ - RequireEnvironment = true - } -); -``` - -## Retries -429 Rate Limit, and >=500 Internal errors will all be -retried twice with exponential backoff. You can override this behavior -globally or per-request. - -```csharp -var schematic = new Schematic("...", new ClientOptions{ - MaxRetries = 1 // Only retry once -}); -``` - -## Timeouts -The SDK defaults to a 60s timeout. You can override this behaviour -globally or per-request. - -```csharp -var schematic = new Schematic("...", new ClientOptions{ - TimeoutInSeconds = 20 // Lower timeout -}); -``` - -## Contributing -While we value open-source contributions to this SDK, this library -is generated programmatically. Additions made directly to this library -would have to be moved over to our generation code, otherwise they would -be overwritten upon the next generated release. Feel free to open a PR as a -proof of concept, but know that we will not be able to schematic it as-is. -We suggest opening an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome! diff --git a/src/SchematicHQ.Client.sln b/src/SchematicHQ.Client.sln index 9577a39..4a0de85 100644 --- a/src/SchematicHQ.Client.sln +++ b/src/SchematicHQ.Client.sln @@ -3,9 +3,9 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.0.31903.59 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SchematicHQ.Client", "SchematicHQ.Client\SchematicHQ.Client.csproj", "{EE8E0485-C844-4D5A-A5CB-F2805679CCFD}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SchematicHQ.Client", "SchematicHQ.Client\SchematicHQ.Client.csproj", "{642A9849-7457-4F8D-8AA5-299F6EDABC24}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SchematicHQ.Client.Test", "SchematicHQ.Client.Test\SchematicHQ.Client.Test.csproj", "{3F0DC5BA-F8CF-4D81-85F8-284C421A69DC}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SchematicHQ.Client.Test", "SchematicHQ.Client.Test\SchematicHQ.Client.Test.csproj", "{DB43F450-D369-4A66-BADA-80B0C29CA3C5}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -16,13 +16,13 @@ Global HideSolutionNode = FALSE EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {EE8E0485-C844-4D5A-A5CB-F2805679CCFD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {EE8E0485-C844-4D5A-A5CB-F2805679CCFD}.Debug|Any CPU.Build.0 = Debug|Any CPU - {EE8E0485-C844-4D5A-A5CB-F2805679CCFD}.Release|Any CPU.ActiveCfg = Release|Any CPU - {EE8E0485-C844-4D5A-A5CB-F2805679CCFD}.Release|Any CPU.Build.0 = Release|Any CPU - {3F0DC5BA-F8CF-4D81-85F8-284C421A69DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {3F0DC5BA-F8CF-4D81-85F8-284C421A69DC}.Debug|Any CPU.Build.0 = Debug|Any CPU - {3F0DC5BA-F8CF-4D81-85F8-284C421A69DC}.Release|Any CPU.ActiveCfg = Release|Any CPU - {3F0DC5BA-F8CF-4D81-85F8-284C421A69DC}.Release|Any CPU.Build.0 = Release|Any CPU + {642A9849-7457-4F8D-8AA5-299F6EDABC24}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {642A9849-7457-4F8D-8AA5-299F6EDABC24}.Debug|Any CPU.Build.0 = Debug|Any CPU + {642A9849-7457-4F8D-8AA5-299F6EDABC24}.Release|Any CPU.ActiveCfg = Release|Any CPU + {642A9849-7457-4F8D-8AA5-299F6EDABC24}.Release|Any CPU.Build.0 = Release|Any CPU + {DB43F450-D369-4A66-BADA-80B0C29CA3C5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {DB43F450-D369-4A66-BADA-80B0C29CA3C5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {DB43F450-D369-4A66-BADA-80B0C29CA3C5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {DB43F450-D369-4A66-BADA-80B0C29CA3C5}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection EndGlobal diff --git a/src/SchematicHQ.Client/Schematic.cs b/src/SchematicHQ.Client/Schematic.cs index 37fb18f..9e22b3d 100644 --- a/src/SchematicHQ.Client/Schematic.cs +++ b/src/SchematicHQ.Client/Schematic.cs @@ -14,7 +14,7 @@ public Schematic(string apiKey = null, ClientOptions clientOptions = null) { "X-Schematic-Api-Key", apiKey }, { "X-Fern-Language", "C#" }, { "X-Fern-SDK-Name", "schematic_fern_api_sdk" }, - { "X-Fern-SDK-Version", "0.0.10" }, + { "X-Fern-SDK-Version", "0.0.11" }, }, clientOptions ?? new ClientOptions() ); diff --git a/src/SchematicHQ.Client/SchematicHQ.Client.csproj b/src/SchematicHQ.Client/SchematicHQ.Client.csproj index 8204165..49f1228 100644 --- a/src/SchematicHQ.Client/SchematicHQ.Client.csproj +++ b/src/SchematicHQ.Client/SchematicHQ.Client.csproj @@ -3,8 +3,6 @@ net7.0 enable - false - 0.0.10