Skip to content

Commit

Permalink
Version 7.0.0-v2.1-24.1.01.00 release (#447)
Browse files Browse the repository at this point in the history
Co-authored-by: root <[email protected]>
  • Loading branch information
garg-mudit and root authored Jun 28, 2024
1 parent a6cc0ce commit e06f67d
Show file tree
Hide file tree
Showing 6 changed files with 180 additions and 23 deletions.
116 changes: 116 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,121 @@
# DocuSign C# Client Changelog

## [v7.0.0] - eSignature API v2.1-24.1.01.00 - 2024-06-28
### Breaking Changes

<details>
<summary>API Changes (Click to expand)</summary>

<div style="margin-left: 20px;">

## Endpoint-Specific Changes

### Updated [EnvelopeRecipients: createRecipientProofFileResourceToken](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/createrecipientprooffileresourcetoken/)
The `"token_scopes"` parameter has been moved from path parameters to query parameters for the above mentioned endpoint.

### Updated [EnvelopeView:CreateSender](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) and [EnvelopeView:CreateEdit](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createedit/)
The body parameter `returnUrlRequest` has been changed to `envelopeViewRequest`.
`envelopeViewRequest` has the same properties as the previous `returnUrlRequest` but now includes additional `viewAccess` and `settings` properties, where settings is a complex object with several UI controls for the view experience.

### Updated [TemplateViews: createEdit](https://developers.docusign.com/docs/esign-rest-api/reference/templates/templateviews/createedit/)
The body parameter `returnUrlRequest` has been changed to `templateViewRequest`.
`templateViewRequest` has the same properties as the previous `returnUrlRequest` but now includes an additional `viewAccess` string.

## Model Changes

- Updated existing models

### `accountSettingsInformation`

- **Added fields:**
- `allowConnectEnvelopeRemovedEvent`
- `allowOrganizationBranding`
- `allowOrganizationBrandingMetadata`
- `allowPendingDestinationUrlEdition`
- `allowPendingDestinationUrlEditionMetadata`
- `disableBulkSendRecipientLimit`
- `disableBulkSendRecipientLimitMetaData`
- `enableAdvancedSearch`
- `enableAdvancedSearchMetadata`
- `enableContentSearch`
- `enableContentSearchMetadata`
- `enableMultiUserRepositoryFeatures`
- `enableMultiUserRepositoryFeaturesMetadata`
- `enablePremiumDataVerificationExtensions`
- `enablePremiumDataVerificationExtensionsMetadata`
- `enableSaveAsEnvelopeCustomFieldInWebForms`
- `enableSaveAsEnvelopeCustomFieldInWebFormsMetadata`
- `enableScheduledRelease`
- `enableScheduledReleaseMetadata`
- `isvOemEmbed`
- `isvOemEmbedMetaData`

- **Removed fields:**
- `enableInboxRelevanceSortForRecentAccounts`
- `enableInboxRelevanceSortForRecentAccountsMetadata`
- `enableScheduledRelease`
- `enableScheduledReleaseMetadata`
- `enableSearch`
- `enableSearchMetadata`
- `enableSearchUI`
- `enableSearchUIMetadata`

### `accountUISettings`

- **Added fields:**
- `enableEnvelopeTypes`
- `enableEnvelopeTypesMetadata`

### `envelopDefinitions`

- **Added field:**
- `uSigState`

### `envelopTemplate`

- **Added field:**
- `uSigState`

### `group`

- **Added property:**
- `lastModifiedOn`

### `receipientViewRequest`

- **Added property:**
- `displayFormat`

### `userSettingsInformation`

- **Added properties:**
- `accountAgreementsAccessType`
- `accountAgreementsAccessTypeMetadata`
- `canBulkUploadAgreements`
- `canBulkUploadAgreementsMetadata`
- `canManageAgreementParties`
- `canManageAgreementPartiesMetadata`

### Newly added Models

- `envelopeViewDocumentSettings`
- `envelopeViewEnvelopeCustomFieldSettings`
- `envelopeViewRecipientSettings`
- `envelopeViewRequest`
- `envelopeViewSettings`
- `envelopeViewTaggerSettings`
- `envelopeViewTemplateSettings`
- `paletteItemSettings`
- `paletteSettings`
- `templateViewRequest`

### Removed Models
- `returnUrlRequest`

</div>
</details>


## [v7.0.0-rc3] - eSignature API v2.1-24.1.01.00 - 2024-05-20
### Changed
- Updated C# SDK dependencies.
Expand Down
69 changes: 55 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,69 @@
[![Nuget version][nuget-image]][nuget-url]
[![Nuget downloads][downloads-image]][downloads-url]

The Docusign REST API makes integrating Docusign into your apps and websites a super fast and painless process.
The Docusign SDK makes integrating Docusign into your apps and websites a seamless experience.

## Table of Contents
- [Introduction](#introduction)
- [Installation](#installation)
* [Version Information](#versionInformation)
* [Requirements](#requirements)
* [Compatibility](#compatibility)
* [NuGet Package Manager](#nugetPackageManager)
* [Package Manager Console](#packageManagerConsole)
- [Dependencies](#dependencies)
- [API Reference](#apiReference)
- [Code Examples](#codeExamples)
- [OAuth Implementations](#oauthImplementations)
- [Changelog](#changeLog)
- [Support](#support)
- [License](#license)
- [Additional Resources](#additionalResources)

<a id="introduction"></a>
## Introduction
Integrate eSignatures into your application in minutes. The secure and award-winning Docusign eSignature API makes requesting signatures, automating forms, and tracking documents directly from your app easy.

<a id="installation"></a>
## Installation
This client 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/esign-rest-api/how-to/) from the [Docusign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.

## Version Information
<a id="versionInformation"></a>
### Version Information
- **API version**: v2.1
- **Latest SDK version (Including prerelease)**: 7.0.0-rc3
- **Latest SDK version (Including prerelease)**: 7.0.0

## Requirements
<a id="requirements"></a>
### Requirements
* Microsoft .NET version 4.6.2+ (4.7 recommended)
* Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)

## Compatibility
<a id="compatibility"></a>
### 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/esign-rest-api/how-to/) from the [Docusign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.

<a id="nugetPackageManager"></a>
### NuGet Package Manager:
1. Create a new C# project, or open an existing one.
2. Select **Tools** -> **NuGet Package Manager** -> **Manage NuGet Packages for Solution.**
3. Search for **DocuSign**.
3. Search for **Docusign**.
4. Select **DocuSign.eSign.dll**.
5. Select the check box next to your project name.
6. Click **Install.**

<a id="packageManagerConsole"></a>
### 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.eSign.dll**

## Dependencies
<a id="dependencies"></a>
## SDK Dependencies
This client has the following external dependencies:

### .NET Standard v2 and .NET Core:
Expand All @@ -52,20 +80,33 @@ This client has the following external dependencies:
* System.ComponentModel.Annotations v5.0.0
* Microsoft.IdentityModel.JsonWebTokens v7.5.2

## Code examples
<a id="apiReference"></a>
## API Reference
You can refer to the API reference [here](https://developers.docusign.com/docs/esign-rest-api/reference/).

<a id="codeExamples"></a>
## 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 eSignature 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.

## OAuth implementations
<a id="oauthImplementations"></a>
## 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.

<a id="changeLog"></a>
## Changelog
You can refer to the complete changelog [here](https://github.com/docusign/docusign-esign-csharp-client/blob/master/CHANGELOG.md).

<a id="support"></a>
## Support
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
Log issues against this client SDK through GitHub. You can also reach out to us through [Docusign Community](https://community.docusign.com/developer-59) and [Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).

<a id="license"></a>
## License
The Docusign eSignature C# Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-esign-csharp-client/blob/master/LICENSE).

<a id="additionalResources"></a>
## Additional resources
* [Docusign Developer Center](https://developers.docusign.com/)
* [Docusign API on Twitter](https://twitter.com/docusignapi)
Expand All @@ -75,4 +116,4 @@ The Docusign eSignature C# Client SDK is licensed under the [MIT License](https:
[nuget-image]: https://img.shields.io/nuget/v/DocuSign.eSign.dll.svg?style=flat
[nuget-url]: https://www.nuget.org/packages/DocuSign.eSign.dll
[downloads-image]: https://img.shields.io/nuget/dt/DocuSign.eSign.dll.svg?style=flat
[downloads-url]: https://www.nuget.org/packages/DocuSign.eSign.dll
[downloads-url]: https://www.nuget.org/packages/DocuSign.eSign.dll
10 changes: 5 additions & 5 deletions sdk/DocuSign.eSign.sln
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@ 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.eSign", "src\DocuSign.eSign\DocuSign.eSign.csproj", "{50A81B2E-8DB8-4087-9BD2-B15C431BE503}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DocuSign.eSign", "src\DocuSign.eSign\DocuSign.eSign.csproj", "{B7899DE6-565C-4B1A-A1FB-596FE40EE0FE}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{50A81B2E-8DB8-4087-9BD2-B15C431BE503}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{50A81B2E-8DB8-4087-9BD2-B15C431BE503}.Debug|Any CPU.Build.0 = Debug|Any CPU
{50A81B2E-8DB8-4087-9BD2-B15C431BE503}.Release|Any CPU.ActiveCfg = Release|Any CPU
{50A81B2E-8DB8-4087-9BD2-B15C431BE503}.Release|Any CPU.Build.0 = Release|Any CPU
{B7899DE6-565C-4B1A-A1FB-596FE40EE0FE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{B7899DE6-565C-4B1A-A1FB-596FE40EE0FE}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B7899DE6-565C-4B1A-A1FB-596FE40EE0FE}.Release|Any CPU.ActiveCfg = Release|Any CPU
{B7899DE6-565C-4B1A-A1FB-596FE40EE0FE}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
2 changes: 1 addition & 1 deletion sdk/src/DocuSign.eSign/Client/Configuration.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public class Configuration
/// Version of the package.
/// </summary>
/// <value>Version of the package.</value>
public const string Version = "7.0.0-rc3";
public const string Version = "7.0.0";

/// <summary>
/// Identifier for ISO 8601 DateTime Format
Expand Down
4 changes: 2 additions & 2 deletions sdk/src/DocuSign.eSign/DocuSign.eSign.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<RootNamespace>DocuSign.eSign</RootNamespace>
<AssemblyName>DocuSign.eSign</AssemblyName>
<NeutralLanguage>en-US</NeutralLanguage>
<VersionPrefix>7.0.0-rc3</VersionPrefix>
<VersionPrefix>7.0.0</VersionPrefix>
<VersionSuffix/>
<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
Expand All @@ -26,7 +26,7 @@
<PackageLicenseUrl>https://github.com/docusign/docusign-csharp-client/blob/master/LICENSE</PackageLicenseUrl>
<RepositoryUrl>https://github.com/docusign/docusign-csharp-client</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageReleaseNotes>[v7.0.0-rc3] - ESignature API v2.1-24.1.01.00 - 5/19/2024</PackageReleaseNotes>
<PackageReleaseNotes>[v7.0.0] - ESignature API v2.1-24.1.01.00 - 6/28/2024</PackageReleaseNotes>
</PropertyGroup>
<PropertyGroup Condition=" '$(TargetFramework)' == 'net462'">
<DefineConstants>NET462</DefineConstants>
Expand Down
2 changes: 1 addition & 1 deletion sdk/src/DocuSign.eSign/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@
// [assembly: AssemblyVersion("1.0.*")]
internal class AssemblyInformation
{
public const string AssemblyInformationalVersion = "7.0.0-rc3";
public const string AssemblyInformationalVersion = "7.0.0";
}

0 comments on commit e06f67d

Please sign in to comment.