Version 5.2.0-v2.1-25.2.00.00 release (#134)

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

Author: Nandsingh90

CHANGELOG.md

@@ -3,6 +3,11 @@ 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.2.0] - eSignature API v2.1-25.2.00.00 - 2025-05-21
+### Changed
+- Added support for version v2.1-25.2.00.00 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
 ## [v5.1.0] - eSignature API v2.1-25.1.00.02 - 2025-04-24
 ### Changed
 - Added support for version v2.1-25.1.00.02 of the DocuSign ESignature API.

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.1.0
+- **Latest SDK version**: 5.2.0
 
 <a id="requirements"></a>
 ## Requirements

lib/docusign_esign/api/accounts_api.rb

@@ -241,10 +241,22 @@ def self.default
     end
   end
 
+  class ListAuditEventsOptions
+    # Locale setting for the response, e.g., 'en-US'.
+    attr_accessor :locale
+
+    def self.default
+      @@default ||= ListAuditEventsOptions.new
+    end
+  end
+
   class ListDocumentsOptions
     # 
     attr_accessor :documents_by_userid
 
+    # 
+    attr_accessor :include_agreement_type
+
     # 
     attr_accessor :include_docgen_formfields
 
@@ -3575,7 +3587,7 @@ def get_comments_transcript_with_http_info(account_id, envelope_id, options = Do
     # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
+    # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
     # @param recipient_id The ID of the recipient being accessed.
     # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
     # @return [ConsumerDisclosure]
@@ -3588,7 +3600,7 @@ def get_consumer_disclosure(account_id, envelope_id, lang_code, recipient_id, op
     # Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
+    # @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
     # @param recipient_id The ID of the recipient being accessed.
     # @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
     # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -5291,18 +5303,20 @@ def get_template_workflow_step_definition_with_http_info(account_id, template_id
     # Gets the envelope audit events for the specified envelope.
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @param DocuSign_eSign::ListAuditEventsOptions Options for modifying the behavior of the function.
     # @return [EnvelopeAuditEventResponse]
-    def list_audit_events(account_id, envelope_id)
-      data, _status_code, _headers = list_audit_events_with_http_info(account_id, envelope_id)
+    def list_audit_events(account_id, envelope_id, options = DocuSign_eSign::ListAuditEventsOptions.default)
+      data, _status_code, _headers = list_audit_events_with_http_info(account_id, envelope_id, options)
       return data
     end
 
     # Gets the envelope audit events for an envelope.
     # Gets the envelope audit events for the specified envelope.
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @param DocuSign_eSign::ListAuditEventsOptions Options for modifying the behavior of the function.
     # @return [Array<(EnvelopeAuditEventResponse, Fixnum, Hash)>] EnvelopeAuditEventResponse data, response status code and response headers
-    def list_audit_events_with_http_info(account_id, envelope_id)
+    def list_audit_events_with_http_info(account_id, envelope_id, options = DocuSign_eSign::ListAuditEventsOptions.default)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: EnvelopesApi.list_audit_events ..."
       end
@@ -5315,6 +5329,7 @@ def list_audit_events_with_http_info(account_id, envelope_id)
 
       # query parameters
       query_params = {}
+      query_params[:'locale'] = options.locale if !options.locale.nil?
 
       # header parameters
       header_params = {}
@@ -5481,6 +5496,7 @@ def list_documents_with_http_info(account_id, envelope_id, options = DocuSign_eS
       # query parameters
       query_params = {}
       query_params[:'documents_by_userid'] = options.documents_by_userid if !options.documents_by_userid.nil?
+      query_params[:'include_agreement_type'] = options.include_agreement_type if !options.include_agreement_type.nil?
       query_params[:'include_docgen_formfields'] = options.include_docgen_formfields if !options.include_docgen_formfields.nil?
       query_params[:'include_document_size'] = options.include_document_size if !options.include_document_size.nil?
       query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?

lib/docusign_esign/api/envelopes_api.rb

@@ -101,6 +101,9 @@ def self.default
   end
 
   class ListDocumentsOptions
+    # 
+    attr_accessor :include_agreement_type
+
     # 
     attr_accessor :include_tabs
 
@@ -2162,6 +2165,7 @@ def list_documents_with_http_info(account_id, template_id, options = DocuSign_eS
 
       # query parameters
       query_params = {}
+      query_params[:'include_agreement_type'] = options.include_agreement_type if !options.include_agreement_type.nil?
       query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
 
       # header parameters

lib/docusign_esign/api/templates_api.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.1.0/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
+      @user_agent = "Swagger-Codegen/v2.1/5.2.0/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent

lib/docusign_esign/client/api_client.rb

@@ -95,6 +95,9 @@ class AccountInformation
     # 
     attr_accessor :is_downgrade
 
+    # 
+    attr_accessor :is_free_to_trial_eligible
+
     # 
     attr_accessor :payment_method
 
@@ -161,6 +164,7 @@ def self.attribute_map
         :'forgotten_password_questions_count' => :'forgottenPasswordQuestionsCount',
         :'free_envelope_sends_remaining_for_advanced_doc_gen' => :'freeEnvelopeSendsRemainingForAdvancedDocGen',
         :'is_downgrade' => :'isDowngrade',
+        :'is_free_to_trial_eligible' => :'isFreeToTrialEligible',
         :'payment_method' => :'paymentMethod',
         :'plan_classification' => :'planClassification',
         :'plan_end_date' => :'planEndDate',
@@ -206,6 +210,7 @@ def self.swagger_types
         :'forgotten_password_questions_count' => :'String',
         :'free_envelope_sends_remaining_for_advanced_doc_gen' => :'Integer',
         :'is_downgrade' => :'String',
+        :'is_free_to_trial_eligible' => :'String',
         :'payment_method' => :'String',
         :'plan_classification' => :'String',
         :'plan_end_date' => :'String',
@@ -339,6 +344,10 @@ def initialize(attributes = {})
         self.is_downgrade = attributes[:'isDowngrade']
       end
 
+      if attributes.has_key?(:'isFreeToTrialEligible')
+        self.is_free_to_trial_eligible = attributes[:'isFreeToTrialEligible']
+      end
+
       if attributes.has_key?(:'paymentMethod')
         self.payment_method = attributes[:'paymentMethod']
       end
@@ -435,6 +444,7 @@ def ==(o)
           forgotten_password_questions_count == o.forgotten_password_questions_count &&
           free_envelope_sends_remaining_for_advanced_doc_gen == o.free_envelope_sends_remaining_for_advanced_doc_gen &&
           is_downgrade == o.is_downgrade &&
+          is_free_to_trial_eligible == o.is_free_to_trial_eligible &&
           payment_method == o.payment_method &&
           plan_classification == o.plan_classification &&
           plan_end_date == o.plan_end_date &&
@@ -458,7 +468,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_id_guid, account_name, account_settings, allow_transaction_rooms, billing_period_days_remaining, billing_period_end_date, billing_period_envelopes_allowed, billing_period_envelopes_sent, billing_period_start_date, billing_profile, brands, can_upgrade, connect_permission, created_date, currency_code, current_plan_id, display_appliance_start_url, display_appliance_url, distributor_code, docu_sign_landing_url, dss_values, envelope_sending_blocked, envelope_unit_price, external_account_id, forgotten_password_questions_count, free_envelope_sends_remaining_for_advanced_doc_gen, is_downgrade, payment_method, plan_classification, plan_end_date, plan_name, plan_start_date, recipient_domains, seats_allowed, seats_in_use, status21_cfr_part11, suspension_date, suspension_status, use_display_appliance].hash
+      [account_id_guid, account_name, account_settings, allow_transaction_rooms, billing_period_days_remaining, billing_period_end_date, billing_period_envelopes_allowed, billing_period_envelopes_sent, billing_period_start_date, billing_profile, brands, can_upgrade, connect_permission, created_date, currency_code, current_plan_id, display_appliance_start_url, display_appliance_url, distributor_code, docu_sign_landing_url, dss_values, envelope_sending_blocked, envelope_unit_price, external_account_id, forgotten_password_questions_count, free_envelope_sends_remaining_for_advanced_doc_gen, is_downgrade, is_free_to_trial_eligible, payment_method, plan_classification, plan_end_date, plan_name, plan_start_date, recipient_domains, seats_allowed, seats_in_use, status21_cfr_part11, suspension_date, suspension_status, use_display_appliance].hash
     end
 
     # Builds the object from hash