Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ 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.

## [v7.0.0] - eSignature API v2.1-26.2.01.01 - 2026-07-01
### Changed
- Fixed CreateChunkedUpload sending incorrect Content-Type: multipart/form-data instead of application/json.
- Added support for version v2.1-26.2.01.01 of the DocuSign ESignature API.
- Updated the SDK release version.

## [v7.0.0.rc1] - eSignature API v2.1-26.2.00.00 - 2026-06-03
### Breaking Changes
- Groups API: ListGroupUsers, ListGroupUsersAsync, and their WithHttpInfo variants now return GroupUsersResponse
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**: 7.0.0.rc1
- **Latest SDK version**: 7.0.0

<a id="requirements"></a>
## Requirements
Expand Down
1 change: 1 addition & 0 deletions lib/docusign_esign.rb
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
require 'docusign_esign/models/authentication_method'
require 'docusign_esign/models/authentication_status'
require 'docusign_esign/models/authorization_user'
require 'docusign_esign/models/authorized_signatory'
require 'docusign_esign/models/bcc_email_address'
require 'docusign_esign/models/bcc_email_archive'
require 'docusign_esign/models/bcc_email_archive_history'
Expand Down
118 changes: 16 additions & 102 deletions lib/docusign_esign/api/accounts_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,12 @@ class GetAgentUserAuthorizationsOptions
#
attr_accessor :start_position

#
attr_accessor :task_source

#
attr_accessor :task_type

#
attr_accessor :user_name_substring

Expand Down Expand Up @@ -218,6 +224,12 @@ class GetPrincipalUserAuthorizationsOptions
#
attr_accessor :start_position

#
attr_accessor :task_source

#
attr_accessor :task_type

#
attr_accessor :user_name_substring

Expand Down Expand Up @@ -1727,6 +1739,8 @@ def get_agent_user_authorizations_with_http_info(account_id, user_id, options =
query_params[:'include_closed_users'] = options.include_closed_users if !options.include_closed_users.nil?
query_params[:'permissions'] = options.permissions if !options.permissions.nil?
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
query_params[:'task_source'] = options.task_source if !options.task_source.nil?
query_params[:'task_type'] = options.task_type if !options.task_type.nil?
query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?

# header parameters
Expand Down Expand Up @@ -2133,108 +2147,6 @@ def get_brand_resources_by_content_type_with_http_info(account_id, brand_id, res
return data, status_code, headers
end

# Gets completion rate for the template
#
# @param account_id The external account number (int) or account ID Guid.
# @param template_id The ID of the template being accessed.
# @return [TemplateCompletionRateResponse]
def get_completion_rate_for_template(account_id, template_id)
data, _status_code, _headers = get_completion_rate_for_template_with_http_info(account_id, template_id)
return data
end

# Gets completion rate for the template
#
# @param account_id The external account number (int) or account ID Guid.
# @param template_id The ID of the template being accessed.
# @return [Array<(TemplateCompletionRateResponse, Fixnum, Hash)>] TemplateCompletionRateResponse data, response status code and response headers
def get_completion_rate_for_template_with_http_info(account_id, template_id)
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: AccountsApi.get_completion_rate_for_template ..."
end
# verify the required parameter 'account_id' is set
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_completion_rate_for_template" if account_id.nil?
# verify the required parameter 'template_id' is set
fail ArgumentError, "Missing the required parameter 'template_id' when calling AccountsApi.get_completion_rate_for_template" if template_id.nil?
# resource path
local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/insights/completionRate".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)

# query parameters
query_params = {}

# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])

# form parameters
form_params = {}

# http body (model)
post_body = nil
auth_names = []
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'TemplateCompletionRateResponse')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: AccountsApi#get_completion_rate_for_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end

# Gets completion rate for the user
#
# @param account_id The external account number (int) or account ID Guid.
# @return [UserCompletionRateResponse]
def get_completion_rate_for_template_owner(account_id)
data, _status_code, _headers = get_completion_rate_for_template_owner_with_http_info(account_id)
return data
end

# Gets completion rate for the user
#
# @param account_id The external account number (int) or account ID Guid.
# @return [Array<(UserCompletionRateResponse, Fixnum, Hash)>] UserCompletionRateResponse data, response status code and response headers
def get_completion_rate_for_template_owner_with_http_info(account_id)
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: AccountsApi.get_completion_rate_for_template_owner ..."
end
# verify the required parameter 'account_id' is set
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_completion_rate_for_template_owner" if account_id.nil?
# resource path
local_var_path = "/v2.1/accounts/{accountId}/templates/insights/completionRate".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)

# query parameters
query_params = {}

# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])

# form parameters
form_params = {}

# http body (model)
post_body = nil
auth_names = []
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'UserCompletionRateResponse')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: AccountsApi#get_completion_rate_for_template_owner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end

# Gets the Electronic Record and Signature Disclosure.
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
# @param account_id The external account number (int) or account ID Guid.
Expand Down Expand Up @@ -2722,6 +2634,8 @@ def get_principal_user_authorizations_with_http_info(account_id, user_id, option
query_params[:'include_closed_users'] = options.include_closed_users if !options.include_closed_users.nil?
query_params[:'permissions'] = options.permissions if !options.permissions.nil?
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
query_params[:'task_source'] = options.task_source if !options.task_source.nil?
query_params[:'task_type'] = options.task_type if !options.task_type.nil?
query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?

# header parameters
Expand Down
112 changes: 110 additions & 2 deletions lib/docusign_esign/api/envelopes_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -715,8 +715,6 @@ def create_chunked_upload_with_http_info(account_id, chunked_upload_request)
header_params = {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

# form parameters
form_params = {}
Expand Down Expand Up @@ -4657,6 +4655,116 @@ def get_envelope_workflow_step_definition_with_http_info(account_id, envelope_id
return data, status_code, headers
end

# Gets a single envelope share by shareId
#
# @param account_id The external account number (int) or account ID Guid.
# @param envelope_id The envelopeId Guid of the envelope being accessed.
# @param share_id
# @return [EnvelopesShareResponse]
def get_envelopes_share(account_id, envelope_id, share_id)
data, _status_code, _headers = get_envelopes_share_with_http_info(account_id, envelope_id, share_id)
return data
end

# Gets a single envelope share by shareId
#
# @param account_id The external account number (int) or account ID Guid.
# @param envelope_id The envelopeId Guid of the envelope being accessed.
# @param share_id
# @return [Array<(EnvelopesShareResponse, Fixnum, Hash)>] EnvelopesShareResponse data, response status code and response headers
def get_envelopes_share_with_http_info(account_id, envelope_id, share_id)
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelopes_share ..."
end
# verify the required parameter 'account_id' is set
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelopes_share" if account_id.nil?
# verify the required parameter 'envelope_id' is set
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelopes_share" if envelope_id.nil?
# verify the required parameter 'share_id' is set
fail ArgumentError, "Missing the required parameter 'share_id' when calling EnvelopesApi.get_envelopes_share" if share_id.nil?
# resource path
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'shareId' + '}', share_id.to_s)

# query parameters
query_params = {}

# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])

# form parameters
form_params = {}

# http body (model)
post_body = nil
auth_names = []
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'EnvelopesShareResponse')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: EnvelopesApi#get_envelopes_share\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end

# Gets all shares for an envelope
#
# @param account_id The external account number (int) or account ID Guid.
# @param envelope_id The envelopeId Guid of the envelope being accessed.
# @return [EnvelopesSharesResponse]
def get_envelopes_shares(account_id, envelope_id)
data, _status_code, _headers = get_envelopes_shares_with_http_info(account_id, envelope_id)
return data
end

# Gets all shares for an envelope
#
# @param account_id The external account number (int) or account ID Guid.
# @param envelope_id The envelopeId Guid of the envelope being accessed.
# @return [Array<(EnvelopesSharesResponse, Fixnum, Hash)>] EnvelopesSharesResponse data, response status code and response headers
def get_envelopes_shares_with_http_info(account_id, envelope_id)
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelopes_shares ..."
end
# verify the required parameter 'account_id' is set
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelopes_shares" if account_id.nil?
# verify the required parameter 'envelope_id' is set
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelopes_shares" if envelope_id.nil?
# resource path
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)

# query parameters
query_params = {}

# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])

# form parameters
form_params = {}

# http body (model)
post_body = nil
auth_names = []
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'EnvelopesSharesResponse')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: EnvelopesApi#get_envelopes_shares\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end

# Returns envelope form data for an existing envelope.
# This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. **Note:** To use this feature, the Sending Setting \"Allow sender to download form data\" must be enabled for the account. ### Related topics - [How to get envelope tab values](/docs/esign-rest-api/how-to/get-envelope-tab-values/)
# @param account_id The external account number (int) or account ID Guid.
Expand Down
Loading