diff --git a/CHANGELOG.md b/CHANGELOG.md index c91e3c7..17a34ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,9 @@ # DocuSign Click C# Client Changelog See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes. +## [v2.0.0-rc2] - Click API v1-22.4.02.00 - 2024-04-29 +### Breaking Changes +- Updated from System.IdentityModel.Tokens.Jwt to Microsoft.IdentityModel.JsonWebTokens for token handling. ## [v2.0.0-rc1] - Click API v1-22.4.02.00 - 2024-04-05 ### Breaking Changes - Updated C# SDK dependencies. diff --git a/README.md b/README.md index c26b3e0..8d9bb44 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,78 @@ -# The Official DocuSign Click C# Client +# The Official Docusign Click C# Client SDK [![Nuget version][nuget-image]][nuget-url] [![Nuget downloads][downloads-image]][downloads-url] -## Requirements - -- Microsoft .NET version 4.5.2+ (4.7 recommended) -- Free [Developer Account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531) - -## Compatibility +Elastic signing (also known as Docusign Click) lets you capture consent to standard agreement terms with a single click: terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable elastic template solution in your Docusign integrations. -- .NET Standard 2.0. See [.NET Standard Selector](https://immo.landwerth.net/netstandard-versions/) for details on versioning for the individual components in .NET Standard -- .NET Core 2.0 -- Microsoft .NET version 4.5.2+ We no longer support [version 4.5.1](https://devblogs.microsoft.com/dotnet/support-ending-for-the-net-framework-4-4-5-and-4-5-1/) -- TLS 1.2 +## Version Information +- **API version**: v1 +- **Latest SDK version (Including prerelease)**: 2.0.0-rc2 -## Note +## Requirements +* Microsoft .NET version 4.6.2+ (4.7 recommended) +* Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/) -This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below. +## Compatibility +* .NET Standard 2.0. See [.NET Standard Selector](https://immo.landwerth.net/netstandard-versions/) for details on versioning for the individual components in .NET Standard. +* .NET Core 2.0 or above. +* Microsoft .NET version 4.6.2+. +* TLS 1.2 ## Installation +This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/click-api/how-to/) from the [Docusign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below. ### NuGet Package Manager: - 1. Create a new C# project, or open an existing one. -2. Click **Tools** -> **NuGet Package Manager** -> **Manage NuGet Packages for Solution**. +2. Select **Tools** -> **NuGet Package Manager** -> **Manage NuGet Packages for Solution.** 3. Search for **DocuSign**. 4. Select **DocuSign.Click**. -5. Click the check box next to your project name. -6. Click **Install**. +5. Select the check box next to your project name. +6. Click **Install.** ### Package Manager Console: - -1. Open or create a new C# project. -2. Open the **Package Manager Console** by either: - 1. Clicking **Package Manager Console** along the bottom of Visual Studio - 2. Clicking **Tools** -> **NuGet Package Manager** -> **Package Manager Console** +1. Create a new C# project, or open an existing one. +2. Open the **Package Manager Console** by either method: + 1. Clicking **Package Manager Console** along the bottom of Visual Studio + 2. Clicking **Tools** -> **NuGet Package Manager** -> **Package Manager Console** 3. In the **Package Manager Console**, type: **Install-Package DocuSign.Click** ## Dependencies - This client has the following external dependencies: ### .NET Standard v2 and .NET Core: +* Newtonsoft.Json v13.0.3 +* BouncyCastle.Cryptography v2.3.0 +* System.ComponentModel.Annotations v5.0.0 +* Microsoft.IdentityModel.JsonWebTokens v7.5.1 -- Microsoft.CSharp v4.5.0 -- Microsoft.IdentityModel.Protocols v5.4.0 -- Newtonsoft.Json 11.0.2 -- Portable.BouncyCastle v1.8.2 -- RestSharp v106.3.1 -- System.ComponentModel.Annotations v4.5.0 -- System.IdentityModel.tokens.Jwt v5.4.0 - +### .NET Framework, version 4.6.2: +* Newtonsoft.Json v13.0.3 +* BouncyCastle.Cryptography v2.3.0 +* System.ComponentModel.Annotations v5.0.0 +* Microsoft.IdentityModel.JsonWebTokens v7.5.1 -### .NET Framework, version 4.5.2: +## Code examples +Explore our GitHub repository for the [Launcher](https://github.com/docusign/code-examples-csharp/), a self-executing package housing code examples for the Click C# SDK. This package showcases several common use cases and their respective source files. Additionally, you can download a version preconfigured for your Docusign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples support both the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) and [JSON Web Token (JWT)](https://developers.docusign.com/platform/auth/jwt/) authentication workflows. -- BouncyCastle v1.8.1 -- Microsoft.CSharp v4.5.0 -- Microsoft.IdentityModel.Protocols v5.4.0 -- Newtonsoft.Json 11.0.2 -- RestSharp v106.3.1 -- System.ComponentModel.Annotations v4.5.0 -- System.IdentityModel.tokens.Jwt v5.4.0 - - -## Code Examples - -### Launchers - -DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-csharp). The Launcher contains a set of 6 common use cases and associated source files. These examples use either DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows. - -## OAuth Implementations - -For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/). - -For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow. +## OAuth implementations +For details regarding which type of OAuth grant will work best for your Docusign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [Docusign Developer Center](https://developers.docusign.com/). +For security purposes, Docusign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) flow. ## Support - Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi). ## License +The Docusign Click C# Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-esign-csharp-client/blob/master/LICENSE). -The DocuSign Rooms C# Client is licensed under the [MIT License](https://github.com/docusign/docusign-click-csharp-client/blob/master/LICENSE). - +## Additional resources +* [Docusign Developer Center](https://developers.docusign.com/) +* [Docusign API on Twitter](https://twitter.com/docusignapi) +* [Docusign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/) +* [Docusign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ) [nuget-image]: https://img.shields.io/nuget/v/DocuSign.Click.svg?style=flat [nuget-url]: https://www.nuget.org/packages/DocuSign.Click -[downloads-image]: https://img.shields.io/nuget/dt/DocuSign.Click +[downloads-image]: https://img.shields.io/nuget/dt/DocuSign.Click.svg?style=flat [downloads-url]: https://www.nuget.org/packages/DocuSign.Click - -### Additional Resources -* [DocuSign Developer Center](https://developers.docusign.com) -* [DocuSign API on Twitter](https://twitter.com/docusignapi) -* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/) -* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ) diff --git a/sdk/DocuSign.Click.sln b/sdk/DocuSign.Click.sln index 04aa221..760224e 100644 --- a/sdk/DocuSign.Click.sln +++ b/sdk/DocuSign.Click.sln @@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 2012 VisualStudioVersion = 12.0.0.0 MinimumVisualStudioVersion = 10.0.0.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocuSign.Click", "src\DocuSign.Click\DocuSign.Click.csproj", "{842DCB39-5959-472B-89A7-2EA888BFF2E3}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocuSign.Click", "src\DocuSign.Click\DocuSign.Click.csproj", "{750FEB7C-6BC0-4DB4-81A2-16042A94F670}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -10,10 +10,10 @@ Global Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {842DCB39-5959-472B-89A7-2EA888BFF2E3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {842DCB39-5959-472B-89A7-2EA888BFF2E3}.Debug|Any CPU.Build.0 = Debug|Any CPU - {842DCB39-5959-472B-89A7-2EA888BFF2E3}.Release|Any CPU.ActiveCfg = Release|Any CPU - {842DCB39-5959-472B-89A7-2EA888BFF2E3}.Release|Any CPU.Build.0 = Release|Any CPU + {750FEB7C-6BC0-4DB4-81A2-16042A94F670}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {750FEB7C-6BC0-4DB4-81A2-16042A94F670}.Debug|Any CPU.Build.0 = Debug|Any CPU + {750FEB7C-6BC0-4DB4-81A2-16042A94F670}.Release|Any CPU.ActiveCfg = Release|Any CPU + {750FEB7C-6BC0-4DB4-81A2-16042A94F670}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/sdk/README.md b/sdk/README.md deleted file mode 100644 index e601be4..0000000 --- a/sdk/README.md +++ /dev/null @@ -1,109 +0,0 @@ -# DocuSign.Click - the C# library for the DocuSign Click API - v1 - -The DocuSign package makes integrating DocuSign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-click-csharp-client repository. - -This C# SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - -- API version: v1 -- SDK version: 1.0.0 -- Build package: io.swagger.codegen.languages.CSharpClientCodegen - For more information, please visit [https://developers.docusign.com](https://developers.docusign.com) - - -## Frameworks supported -- .NET 4.0 or later -- Windows Phone 7.1 (Mango) - - -## Dependencies -- [RestSharpSigned](https://www.nuget.org/packages/RestSharpSigned) - 105.1.0 or later -- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 8.0.3 or later - -The DLLs included in the package may not be the latest version. We recommned using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages: -``` -Install-Package RestSharp -Install-Package Newtonsoft.Json -``` - -NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742) - - -## Installation -Run the following command to generate the DLL -- [Mac/Linux] `/bin/sh build.sh` -- [Windows] `build.bat` - -Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces: -```csharp -using DocuSign.Click.Api; -using DocuSign.Click.Client; -using DocuSign.Click.Model; -``` - - -## Packaging - -A `.nuspec` is included with the project. You can follow the Nuget quickstart to [create](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#create-the-package) and [publish](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#publish-the-package) packages. - -This `.nuspec` uses placeholders from the `.csproj`, so build the `.csproj` directly: - -``` -nuget pack -Build -OutputDirectory out DocuSign.Click.csproj -``` - -Then, publish to a [local feed](https://docs.microsoft.com/en-us/nuget/hosting-packages/local-feeds) or [other host](https://docs.microsoft.com/en-us/nuget/hosting-packages/overview) and consume the new package via Nuget as usual. - - -## Getting Started - -```csharp -using System; -using System.Diagnostics; -using DocuSign.Click.Api; -using DocuSign.Click.Client; -using DocuSign.Click.Model; - -namespace Example -{ - public class Example - { - public void main() - { - - // Configure OAuth2 access token for authorization: docusignAccessCode - Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN"; - - var apiInstance = new AccountsApi(); - var accountId = accountId_example; // string | - - try - { - // Get information about the account. - AccountSummary result = apiInstance.GetAccountInformation(accountId); - Debug.WriteLine(result); - } - catch (Exception e) - { - Debug.Print("Exception when calling AccountsApi.GetAccountInformation: " + e.Message ); - } - } - } -} -``` - - -## Documentation for API Endpoints - -All URIs are relative to *https://demo.docusign.net/clickapi* - - -## Documentation for Authorization - - -### docusignAccessCode - -- **Type**: OAuth -- **Flow**: accessCode -- **Authorization URL**: https://account.docusign.com/oauth/auth -- **Scopes**: N/A - diff --git a/sdk/src/DocuSign.Click/Client/Configuration.cs b/sdk/src/DocuSign.Click/Client/Configuration.cs index 22be598..1f9fdcc 100644 --- a/sdk/src/DocuSign.Click/Client/Configuration.cs +++ b/sdk/src/DocuSign.Click/Client/Configuration.cs @@ -26,7 +26,7 @@ public class Configuration /// Version of the package. /// /// Version of the package. - public const string Version = "2.0.0-rc1"; + public const string Version = "2.0.0-rc2"; /// /// Identifier for ISO 8601 DateTime Format diff --git a/sdk/src/DocuSign.Click/Client/DocuSignClient.cs b/sdk/src/DocuSign.Click/Client/DocuSignClient.cs index 48819bb..2a1ec3f 100644 --- a/sdk/src/DocuSign.Click/Client/DocuSignClient.cs +++ b/sdk/src/DocuSign.Click/Client/DocuSignClient.cs @@ -9,6 +9,7 @@ */ using DocuSign.Click.Client.Auth; +using Microsoft.IdentityModel.JsonWebTokens; using Microsoft.IdentityModel.Tokens; using Newtonsoft.Json; using Org.BouncyCastle.Crypto; @@ -18,7 +19,6 @@ using System; using System.Collections; using System.Collections.Generic; -using System.IdentityModel.Tokens.Jwt; using System.IO; using System.Linq; using System.Net; @@ -915,7 +915,7 @@ public OAuth.OAuthToken RequestJWTUserToken(string clientId, string userId, stri { string privateKey = Encoding.UTF8.GetString(privateKeyBytes); - JwtSecurityTokenHandler handler = new JwtSecurityTokenHandler + JsonWebTokenHandler handler = new JsonWebTokenHandler { SetDefaultTimesOnTokenCreation = false }; @@ -953,12 +953,13 @@ public OAuth.OAuthToken RequestJWTUserToken(string clientId, string userId, stri throw new ApiException(400, "Private key not supplied or is invalid!"); } - var token = handler.CreateToken(descriptor); - string jwtToken = handler.WriteToken(token); + var jwtToken = handler.CreateToken(descriptor); - var localVarFormParams = new Dictionary(); - localVarFormParams.Add("grant_type", OAuth.Grant_Type_JWT); - localVarFormParams.Add("assertion", jwtToken); + var localVarFormParams = new Dictionary + { + { "grant_type", OAuth.Grant_Type_JWT }, + { "assertion", jwtToken } + }; DocuSignRequest request = PrepareOAuthRequest(oauthBasePath, $"oauth/token", HttpMethod.Post, Configuration.DefaultHeader?.ToList(), localVarFormParams.ToList()); DocuSignResponse response = RestClient.SendRequest(request); @@ -1003,7 +1004,7 @@ public OAuth.OAuthToken RequestJWTApplicationToken(string clientId, string oauth { string privateKey = Encoding.UTF8.GetString(privateKeyBytes); - JwtSecurityTokenHandler handler = new JwtSecurityTokenHandler(); + JsonWebTokenHandler handler = new JsonWebTokenHandler(); SecurityTokenDescriptor descriptor = new SecurityTokenDescriptor() { @@ -1028,12 +1029,13 @@ public OAuth.OAuthToken RequestJWTApplicationToken(string clientId, string oauth throw new ApiException(400, "Private key not supplied or is invalid!"); } - var token = handler.CreateToken(descriptor); - string jwtToken = handler.WriteToken(token); + var jwtToken = handler.CreateToken(descriptor); - var localVarFormParams = new Dictionary(); - localVarFormParams.Add("grant_type", OAuth.Grant_Type_JWT); - localVarFormParams.Add("assertion", jwtToken); + var localVarFormParams = new Dictionary + { + { "grant_type", OAuth.Grant_Type_JWT }, + { "assertion", jwtToken } + }; DocuSignRequest request = PrepareOAuthRequest(oauthBasePath, $"oauth/token", HttpMethod.Post, Configuration.DefaultHeader?.ToList(), localVarFormParams.ToList()); DocuSignResponse response = RestClient.SendRequest(request); diff --git a/sdk/src/DocuSign.Click/DocuSign.Click.csproj b/sdk/src/DocuSign.Click/DocuSign.Click.csproj index 8a8c8b9..771bf0c 100644 --- a/sdk/src/DocuSign.Click/DocuSign.Click.csproj +++ b/sdk/src/DocuSign.Click/DocuSign.Click.csproj @@ -4,7 +4,7 @@ net462;netstandard2.0 true DocuSign.Click - The DocuSign NuGet package makes integrating DocuSign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-Click-csharp-client repository. + The Docusign NuGet package makes integrating Docusign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-Click-csharp-client repository. DocuSign Inc. DocuSign Copyright © DocuSign 2024 @@ -16,7 +16,7 @@ DocuSign.Click DocuSign.Click en-US - 2.0.0-rc1 + 2.0.0-rc2 true true @@ -26,7 +26,7 @@ https://github.com/docusign/docusign-csharp-client/blob/master/LICENSE https://github.com/docusign/docusign-csharp-client git - [v2.0.0-rc1] - Click API v1-22.4.02.00 - 4/5/2024 + [v2.0.0-rc2] - Click API v1-22.4.02.00 - 4/29/2024 NET462 @@ -38,11 +38,9 @@ - + - - diff --git a/sdk/src/DocuSign.Click/Properties/AssemblyInfo.cs b/sdk/src/DocuSign.Click/Properties/AssemblyInfo.cs index 116e725..4ebcc78 100644 --- a/sdk/src/DocuSign.Click/Properties/AssemblyInfo.cs +++ b/sdk/src/DocuSign.Click/Properties/AssemblyInfo.cs @@ -22,5 +22,5 @@ // [assembly: AssemblyVersion("1.0.*")] internal class AssemblyInformation { - public const string AssemblyInformationalVersion = "2.0.0-rc1"; + public const string AssemblyInformationalVersion = "2.0.0-rc2"; } \ No newline at end of file diff --git a/test/SdkNetCoreTests/SdkNetCoreTests.csproj b/test/SdkNetCoreTests/SdkNetCoreTests.csproj index bdaf6f2..b4a7dec 100644 --- a/test/SdkNetCoreTests/SdkNetCoreTests.csproj +++ b/test/SdkNetCoreTests/SdkNetCoreTests.csproj @@ -1,29 +1,26 @@  - - netcoreapp2.0 + + net6.0 - false - + false + - - - - - + + + + + - - - - - - - + + + + - - - ..\..\sdk\src\DocuSign.Click\bin\Debug\netstandard2.0\DocuSign.Click.dll - - + + + ..\..\sdk\src\DocuSign.Click\bin\Debug\netstandard2.0\DocuSign.Click.dll + + diff --git a/test/SdkTests/SdkTests.csproj b/test/SdkTests/SdkTests.csproj index b48b66c..f365816 100644 --- a/test/SdkTests/SdkTests.csproj +++ b/test/SdkTests/SdkTests.csproj @@ -53,17 +53,17 @@ ..\packages\Microsoft.Bcl.AsyncInterfaces.1.1.0\lib\net461\Microsoft.Bcl.AsyncInterfaces.dll - - ..\packages\Microsoft.IdentityModel.Abstractions.7.3.1\lib\net462\Microsoft.IdentityModel.Abstractions.dll + + ..\packages\Microsoft.IdentityModel.Abstractions.7.5.1\lib\net462\Microsoft.IdentityModel.Abstractions.dll - - ..\packages\Microsoft.IdentityModel.JsonWebTokens.7.3.1\lib\net462\Microsoft.IdentityModel.JsonWebTokens.dll + + ..\packages\Microsoft.IdentityModel.JsonWebTokens.7.5.1\lib\net462\Microsoft.IdentityModel.JsonWebTokens.dll - - ..\packages\Microsoft.IdentityModel.Logging.7.3.1\lib\net462\Microsoft.IdentityModel.Logging.dll + + ..\packages\Microsoft.IdentityModel.Logging.7.5.1\lib\net462\Microsoft.IdentityModel.Logging.dll - - ..\packages\Microsoft.IdentityModel.Tokens.7.3.1\lib\net462\Microsoft.IdentityModel.Tokens.dll + + ..\packages\Microsoft.IdentityModel.Tokens.7.5.1\lib\net462\Microsoft.IdentityModel.Tokens.dll ..\packages\MSTest.TestFramework.2.1.2\lib\net45\Microsoft.VisualStudio.TestPlatform.TestFramework.dll @@ -84,9 +84,6 @@ - - ..\packages\System.IdentityModel.Tokens.Jwt.7.3.1\lib\net462\System.IdentityModel.Tokens.Jwt.dll - ..\packages\System.Memory.4.5.5\lib\net461\System.Memory.dll diff --git a/test/SdkTests/packages.config b/test/SdkTests/packages.config index af8d11f..ccb926f 100644 --- a/test/SdkTests/packages.config +++ b/test/SdkTests/packages.config @@ -3,16 +3,14 @@ - - - - + + + + - -