diff --git a/.fernignore b/.fernignore index 43ca0d22..b7ad8d97 100644 --- a/.fernignore +++ b/.fernignore @@ -1,3 +1,5 @@ # Specify files that shouldn't be modified by Fern +src/Merge.Client/MergeClient.cs + README.md diff --git a/README.md b/README.md index 818af610..81788db2 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,10 @@ Instantiate the SDK using the `MergeClient` class. Note that all of the SDK methods are awaitable! ```csharp -using Merge; -using Merge.Ats; +using Merge.Client; +using Merge.Client.Ats; -Merge merge = new Merge( +var merge = new MergeClient( "YOUR_API_KEY", "YOUR_ACCOUNT_TOKEN" ) ``` @@ -41,7 +41,7 @@ using more than one Merge API category right now, the SDK provides upgrade-flexi Each category is namespaced: ```csharp -Merge merge = new Merge( +var merge = new MergeClient( "YOUR_API_KEY", "YOUR_ACCOUNT_TOKEN" ) @@ -54,7 +54,7 @@ merge.HRIS. # APIs specific to the HRIS Category You can override the HttpClient by passing in `ClientOptions`. ```csharp -merge = new Merge("YOUR_API_KEY", "YOUR_ACCOUNT_ID", new ClientOptions{ +var merge = new MergeClient("YOUR_API_KEY", "YOUR_ACCOUNT_ID", new ClientOptions{ HttpClient = ... // Override the Http Client BaseURL = ... // Override the Base URL }) @@ -65,7 +65,7 @@ When the API returns a non-zero status code, (4xx or 5xx response), a subclass of MergeException will be thrown: ```csharp -using Merge; +using Merge.Client; try { merge.Ats.Candidates.Retrieve(...); @@ -82,10 +82,10 @@ Below are code snippets of how you can use the C# SDK. ### Create Link Token ```c# -using Merge; -using Merge.Ats; +using Merge.Client; +using Merge.Client.Ats; -Merge merge = new Merge("YOUR_API_KEY", "YOUR_ACCOUNT_TOKEN") +var merge = new MergeClient("YOUR_API_KEY", "YOUR_ACCOUNT_TOKEN") merge.Ats.LinkToken.Create(new EndUserDetailsRequest{ EndUserEmailAddress = "john.smith@gmail.com", @@ -97,10 +97,10 @@ merge.Ats.LinkToken.Create(new EndUserDetailsRequest{ ### Get Employee ```c# -using Merge; -using Merge.Hris; +using Merge.Client; +using Merge.Client.Hris; -MergeClient merge = new Merge( +var merge = new MergeClient( "YOUR_API_KEY", "YOUR_ACCOUNT_ID" ) Employee employee = merge.Hris.Employees.RetrieveAsync("0958cbc6-6040-430a-848e-aafacbadf4ae", @@ -116,7 +116,7 @@ retried twice with exponential backoff. You can override this behavior globally or per-request. ```csharp -var merge = new Merge("...", new ClientOptions{ +var merge = new MergeClient("...", new ClientOptions{ MaxRetries = 1 // Only retry once }); ``` @@ -126,7 +126,7 @@ The SDK defaults to a 60s timeout. You can override this behaviour globally or per-request. ```csharp -var merge = new Merge("...", new ClientOptions{ +var merge = new MergeClient("...", new ClientOptions{ TimeoutInSeconds = 20 // Lower timeout }); ``` diff --git a/src/Merge.Client/MergeClient.cs b/src/Merge.Client/MergeClient.cs new file mode 100644 index 00000000..272df7f5 --- /dev/null +++ b/src/Merge.Client/MergeClient.cs @@ -0,0 +1,11 @@ +namespace Merge.Client; + +public class MergeClient : Merge +{ + public MergeClient( + string apiKey, + string accountToken = null, + ClientOptions clientOptions = null + ) + : base(apiKey, accountToken, clientOptions) { } +}