Version 5.0.0-v2.1-24.2.00.00 release (#131)

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

Author: vinz

CHANGELOG.md

@@ -3,6 +3,78 @@ 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] - eSignature API v2.1-24.2.00.00 - 2024-07-23
+### 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.
+
 ## [v5.0.0.rc1] - eSignature API v2.1-24.2.00.00 - 2024-06-28
 ### Breaking Changes
 

README.md

@@ -30,7 +30,7 @@ This client SDK is provided as open source, which enables you to customize its f
 <a id="versionInformation"></a>
 ### Version Information
 - **API version**: v2.1
-- **Latest SDK version**: 5.0.0.rc1
+- **Latest SDK version**: 5.0.0
 
 <a id="requirements"></a>
 ## Requirements

docusign_esign.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.email       = ["[email protected]"]
   s.homepage    = "https://github.com/docusign/docusign-esign-ruby-client"
   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.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/client/api_client.rb

@@ -35,7 +35,7 @@ class ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/v2.1/5.0.0.rc1/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
+      @user_agent = "Swagger-Codegen/v2.1/5.0.0/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent
@@ -426,7 +426,7 @@ def get_oauth_base_path
     end
 
     # Helper method to configure the OAuth accessCode/implicit flow parameters
-    # @param [String] client_id DocuSign OAuth Client Id(AKA Integrator Key)
+    # @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
     # @param scopes The list of requested scopes.  Client applications may be scoped to a limited set of system access.
     # @param [String] redirect_uri This determines where to deliver the response containing the authorization code
     # @param [String] response_type Determines the response type of the authorization request, NOTE: these response types are mutually exclusive for a client application. A public/native client application may only request a response type
@@ -446,8 +446,8 @@ def get_authorization_uri(client_id, scopes, redirect_uri, response_type, state=
     end
 
     # Request JWT User Token
-    # @param [String] client_id DocuSign OAuth Client Id(AKA Integrator Key)
-    # @param [String] user_id DocuSign user Id to be impersonated
+    # @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
+    # @param [String] user_id Docusign user Id to be impersonated
     # @param [String] private_key_or_filename the RSA private key
     # @param [Number] expires_in number of seconds remaining before the JWT assertion is considered as invalid
     # @param scopes The list of requested scopes.  Client applications may be scoped to a limited set of system access.
@@ -497,7 +497,7 @@ def request_jwt_user_token(client_id, user_id, private_key_or_filename, expires_
     end
 
     # Request JWT User Token
-    # @param [String] client_id DocuSign OAuth Client Id(AKA Integrator Key)
+    # @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
     # @param [String] private_key_or_filename the RSA private key
     # @param [Number] expires_in number of seconds remaining before the JWT assertion is considered as invalid
     # @param scopes The list of requested scopes.  Client applications may be scoped to a limited set of system access.
@@ -559,8 +559,8 @@ def get_user_info(access_token)
     end
 
     # GenerateAccessToken will exchange the authorization code for an access token and refresh tokens.
-    # @param [String] client_id DocuSign OAuth Client Id(AKA Integrator Key)
-    # @param [String] client_secret The secret key you generated when you set up the integration in DocuSign Admin console.
+    # @param [String] client_id Docusign OAuth Client Id(AKA Integrator Key)
+    # @param [String] client_secret The secret key you generated when you set up the integration in Docusign Admin console.
     # @param [String] code The authorization code
     def generate_access_token(client_id, client_secret, code)
       raise ArgumentError.new('client_id cannot be empty')  if client_id.empty?

lib/docusign_esign/version.rb

@@ -10,5 +10,5 @@
 =end
 
 module DocuSign_eSign
-  VERSION = '5.0.0.rc1'
+  VERSION = '5.0.0'
 end