Version 5.0.0.rc1-v2.1-24.2.00.00 release (#130)

Co-authored-by: root <[email protected]>

.swagger-codegen-ignore

@@ -25,7 +25,6 @@
 .swagger-codegen-ignore
 git_push.sh
 .gitignore
-README.md
 CHANGELOG.md
 best_practices.md
 
@@ -41,4 +40,4 @@ Rakefile
 .rspec
 docs/
 spec/
-tests/
+tests/

CHANGELOG.md

@@ -3,6 +3,77 @@ All notable changes to this project will be documented in this file.
 
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v5.0.0.rc1] - eSignature API v2.1-24.2.00.00 - 2024-06-28
+### Breaking Changes
+
+<details>
+<summary>API Changes (Click to expand)</summary>
+
+<div style="margin-left: 20px;">
+
+<br/>
+Added support for version v2.1-24.2.00.00 of the Docusign ESignature API.
+
+  ## Endpoint-Specific Changes
+
+  ### Updated [Envelopes: get](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/)
+  Added new optional query parameter named `include_anchor_tab_locations` of type string.
+
+  ### Updated [Envelopes: update](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/)
+  Added new optional query parameter named `recycle_on_void` of type string.
+
+  ### Updated [EnvelopeViews : createCorrect](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/)
+  Request body object `correctViewRequest` has been changed to `envelopeViewRequest`.
+
+  ## Model Changes
+
+  ### Updated existing models
+
+  ### `accountInformation`
+
+  - **Added fields:**
+    - `freeEnvelopeSendsRemainingForAdvancedDocGen`
+
+  ### `accountSettingsInformation`
+
+  - **Added fields:**
+    - `defaultSigningResponsiveView`
+    - `defaultSigningResponsiveViewMetadata`
+    - `dss_SCOREFDN_196_Rebrand_DocuSignIsNotAVerb`
+    - `enableAdditionalAdvancedWebFormsFeatures`
+    - `enableAdditionalAdvancedWebFormsFeaturesMetadata`
+
+- **Removed fields:**
+    - `enableSaveAsEnvelopeCustomFieldInWebForms`
+    - `enableSaveAsEnvelopeCustomFieldInWebFormsMetadata`
+
+### `bulksendingCopyDocGenFormField`
+
+- **Added field:**
+  - `rowValues`
+
+### `notaryRecipient`
+
+- **Added field:**
+  - `canNotaryCorrectEnvelope`
+
+### `tabAccountSettings`
+
+- **Added field:**
+  - `enableTabAgreementDetails`
+  - `enableTabAgreementDetailsMetadata`
+
+
+### Newly added Models
+
+- `bulkSendingCopyDocGenFormFieldRowValue`
+
+</div>
+</details>
+
+### Other Changes
+- Updated the SDK release version.
+
 ## [v4.0.0] - eSignature API v2.1-24.1.01.00 - 2024-05-22
 ## Endpoint-Specific Changes
 

README.md

@@ -1,51 +1,95 @@
-# The Official DocuSign eSignature Ruby Client SDK
+# The Official Docusign eSignature Ruby Client SDK
 
-[![RubyGems version][rubygems-image]][rubygems-url]
-[![RubyGems downloads][downloads-image]][downloads-url]
-[![Build status][travis-image]][travis-url]
+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)
+	* [Installation via your application's Gemfile](#installationViaGem)
+	* [Manual Installation](#manualInstallation)
+- [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.
+
+<a id="versionInformation"></a>
+### Version Information
+- **API version**: v2.1
+- **Latest SDK version**: 5.0.0.rc1
+
+<a id="requirements"></a>
 ## Requirements
 *   Ruby 1.9+
-*   Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
+*   Free [developer account](https://go.docusign.com/o/sandbox/?postActivateUrl=https://developers.docusign.com/)
 
+<a id="compatibility"></a>
 ## Compatibility
 *   Ruby 1.9+
 
-## 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="installationViaGem"></a>
 ### Installation via your application's Gemfile:
 1. In your application's Gemfile, add:  
     `gem 'docusign_esign'`
 2. Open your preferred console.
 3. In your project directory, execute the installer by typing: **bundle install**
 
-### Manual installation:
+<a id="manualInstallation"></a>
+### Manual Installation:
 1. Open your preferred console.
 2. In the console, type: **gem install docusign_esign**
 
-### Dependencies
+<a id="dependencies"></a>
+### SDK Dependencies
 This client has the following external dependencies:
-*   Jwt>=1.5.2
-*   Json>=2.1.0
-*   Typhoeus>=1.0.1
+*   Jwt v2.2.1
+*   Json v2.1.0
+*   addressable v2.7.0
+*   Typhoeus v1.0.1
 
+<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
-You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-ruby/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
+Explore our GitHub repository for the [Launcher](https://github.com/docusign/code-examples-ruby/), a self-executing package housing code examples for the eSignature Ruby 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.
 
+<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 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.
 
-For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
+<a id="changeLog"></a>
+## Changelog
+You can refer to the complete changelog [here](https://github.com/docusign/docusign-esign-ruby-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 Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
+The Docusign eSignature Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-esign-ruby-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)
-*   [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)
+*   [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)

docusign_esign.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
 
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.authors     = ["DocuSign"]
   s.email       = ["[email protected]"]
   s.homepage    = "https://github.com/docusign/docusign-esign-ruby-client"
-  s.summary     = "DocuSign REST API Ruby Gem"
+  s.summary     = "Docusign eSignature REST API Ruby Gem"
   s.description = "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-esign-ruby-client repository. Join the eSign revolution!"
   s.license     = "MIT"
   s.required_ruby_version = ">= 1.9"

lib/docusign_esign.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]
@@ -120,6 +120,7 @@
 require 'docusign_esign/models/bulk_send_test_response'
 require 'docusign_esign/models/bulk_sending_copy'
 require 'docusign_esign/models/bulk_sending_copy_custom_field'
+require 'docusign_esign/models/bulk_sending_copy_doc_gen_form_field_row_value'
 require 'docusign_esign/models/bulk_sending_copy_recipient'
 require 'docusign_esign/models/bulk_sending_copy_tab'
 require 'docusign_esign/models/bulk_sending_list'

lib/docusign_esign/api/accounts_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/authentication_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/billing_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/bulk_envelopes_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/bulk_process_data_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/bulk_process_data_send_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/cloud_storage_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/connect_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/custom_tabs_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/diagnostics_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]

lib/docusign_esign/api/email_archive_api.rb

@@ -1,7 +1,7 @@
 =begin
-#DocuSign REST API
+#Docusign eSignature REST API
 
-#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+#The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.
 
 OpenAPI spec version: v2.1
 Contact: [email protected]