docusign_esign 3.27.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fda7f3b24d8427f5c1d26f4df78172ac0670366d4cb6b3b40ae3141e82fcbe76
-  data.tar.gz: 6ed609fdda99e1b2720c4a37aeb3836c709f597d9a8d760a69c755d76940ccce
+  metadata.gz: 9a2448d1483b401a9f642bba0b8b2933494bd6f71ffb15439e7b2c03c604ec39
+  data.tar.gz: 93ef566f0099ef25f6f0ed8533685b92cb0f750b1c4188be8da1d7cb398b8752
 SHA512:
-  metadata.gz: c04a659a25d914dd52ae44e1bf33ba65492bd7712921a02f6e3bdc91fdbd7f2d29e0f7dedae59e92097d134cb35ba1539c3af9134b431036e38c764e4dfe2d11
-  data.tar.gz: 678efae5bd7250c03b655b10bde8f572c1e31c13714d71eb7bc47978c72581784d590034cd2dd799efd0352b9410e37f712e6486eb514d9296cd18cb84627d57
+  metadata.gz: b4667559c1bcf7ce8a64e7afd6cf302f985788f8e4b75baa6337a36263e972c45b5f4657496ab4719c6f1adbd9c9e75f4619710853e77184aa099d124b4c8d47
+  data.tar.gz: 337924c7f2364cd5affb51ed9a273d3bc938d5cf897ae8050bfad0195e75eacd907b50629856e0f6a1d3208150d48dfcb73787bdfe67c12ab0a0d98fc7083408

data/CHANGELOG.md

@@ -3,6 +3,116 @@ 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.
 
+## [v4.0.0] - eSignature API v2.1-24.1.01.00 - 2024-05-22
+## 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`
+
+## [v4.0.0.rc1] - eSignature API v2.1-24.1.01.00 - 2024-05-02
+### Changed
+- Added support for version v2.1-24.1.01.00 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
 ## [v3.27.0] - eSignature API v2.1-23.4.02.00 - 2024-04-30
 ### Changed
 - Updated logic to derive the `oauth_base_path` from `base_path`.

data/lib/docusign_esign/api/envelopes_api.rb

@@ -61,6 +61,15 @@ module DocuSign_eSign
     end
   end
 
+  class CreateRecipientProofFileResourceTokenOptions
+    # 
+    attr_accessor :token_scopes
+
+    def self.default
+      @@default ||= CreateRecipientProofFileResourceTokenOptions.new
+    end
+  end
+
   class GetChunkedUploadOptions
     # 
     attr_accessor :include
@@ -80,7 +89,7 @@ module DocuSign_eSign
   end
 
   class GetConsumerDisclosureOptions
-    # 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.
+    # 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.
     attr_accessor :lang_code2
 
     def self.default
@@ -1011,10 +1020,10 @@ module DocuSign_eSign
     # Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view.   Upon sending completion, the user is returned to the return URL provided by the API application.  Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param return_url_request  (optional parameter)
+    # @param envelope_view_request  (optional parameter)
     # @return [ViewUrl]
-    def create_edit_view(account_id, envelope_id, return_url_request)
-      data, _status_code, _headers = create_edit_view_with_http_info(account_id, envelope_id,  return_url_request)
+    def create_edit_view(account_id, envelope_id, envelope_view_request)
+      data, _status_code, _headers = create_edit_view_with_http_info(account_id, envelope_id,  envelope_view_request)
       return data
     end
 
@@ -1022,9 +1031,9 @@ module DocuSign_eSign
     # Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view.   Upon sending completion, the user is returned to the return URL provided by the API application.  Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param return_url_request  (optional parameter)
+    # @param envelope_view_request  (optional parameter)
     # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
-    def create_edit_view_with_http_info(account_id, envelope_id, return_url_request)
+    def create_edit_view_with_http_info(account_id, envelope_id, envelope_view_request)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: EnvelopesApi.create_edit_view ..."
       end
@@ -1047,7 +1056,7 @@ module DocuSign_eSign
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(return_url_request)
+      post_body = @api_client.object_to_http_body(envelope_view_request)
       auth_names = []
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -1729,10 +1738,10 @@ module DocuSign_eSign
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
     # @param recipient_id The ID of the recipient being accessed.
-    # @param token_scopes 
+    # @param DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions Options for modifying the behavior of the function.
     # @return [IdEvidenceResourceToken]
-    def create_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, token_scopes)
-      data, _status_code, _headers = create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes)
+    def create_recipient_proof_file_resource_token(account_id, envelope_id, recipient_id, options = DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions.default)
+      data, _status_code, _headers = create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, options)
       return data
     end
 
@@ -1741,9 +1750,9 @@ module DocuSign_eSign
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
     # @param recipient_id The ID of the recipient being accessed.
-    # @param token_scopes 
+    # @param DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions Options for modifying the behavior of the function.
     # @return [Array<(IdEvidenceResourceToken, Fixnum, Hash)>] IdEvidenceResourceToken data, response status code and response headers
-    def create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, token_scopes)
+    def create_recipient_proof_file_resource_token_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::CreateRecipientProofFileResourceTokenOptions.default)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: EnvelopesApi.create_recipient_proof_file_resource_token ..."
       end
@@ -1753,13 +1762,12 @@ module DocuSign_eSign
       fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.create_recipient_proof_file_resource_token" if envelope_id.nil?
       # verify the required parameter 'recipient_id' is set
       fail ArgumentError, "Missing the required parameter 'recipient_id' when calling EnvelopesApi.create_recipient_proof_file_resource_token" if recipient_id.nil?
-      # verify the required parameter 'token_scopes' is set
-      fail ArgumentError, "Missing the required parameter 'token_scopes' when calling EnvelopesApi.create_recipient_proof_file_resource_token" if token_scopes.nil?
       # resource path
-      local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'token_scopes' + '}', token_scopes.to_s)
+      local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
 
       # query parameters
       query_params = {}
+      query_params[:'token_scopes'] = options.token_scopes if !options.token_scopes.nil?
 
       # header parameters
       header_params = {}
@@ -1899,10 +1907,10 @@ module DocuSign_eSign
     # Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view.   Upon sending completion, the user is returned to the return URL provided by the API application.  Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param return_url_request  (optional parameter)
+    # @param envelope_view_request  (optional parameter)
     # @return [ViewUrl]
-    def create_sender_view(account_id, envelope_id, return_url_request)
-      data, _status_code, _headers = create_sender_view_with_http_info(account_id, envelope_id,  return_url_request)
+    def create_sender_view(account_id, envelope_id, envelope_view_request)
+      data, _status_code, _headers = create_sender_view_with_http_info(account_id, envelope_id,  envelope_view_request)
       return data
     end
 
@@ -1910,9 +1918,9 @@ module DocuSign_eSign
     # Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view.   Upon sending completion, the user is returned to the return URL provided by the API application.  Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param return_url_request  (optional parameter)
+    # @param envelope_view_request  (optional parameter)
     # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
-    def create_sender_view_with_http_info(account_id, envelope_id, return_url_request)
+    def create_sender_view_with_http_info(account_id, envelope_id, envelope_view_request)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: EnvelopesApi.create_sender_view ..."
       end
@@ -1935,7 +1943,7 @@ module DocuSign_eSign
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(return_url_request)
+      post_body = @api_client.object_to_http_body(envelope_view_request)
       auth_names = []
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,

data/lib/docusign_esign/api/templates_api.rb

@@ -355,10 +355,10 @@ module DocuSign_eSign
     # This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
     # @param account_id The external account number (int) or account ID Guid.
     # @param template_id The ID of the template being accessed.
-    # @param return_url_request  (optional parameter)
+    # @param template_view_request  (optional parameter)
     # @return [ViewUrl]
-    def create_edit_view(account_id, template_id, return_url_request)
-      data, _status_code, _headers = create_edit_view_with_http_info(account_id, template_id,  return_url_request)
+    def create_edit_view(account_id, template_id, template_view_request)
+      data, _status_code, _headers = create_edit_view_with_http_info(account_id, template_id,  template_view_request)
       return data
     end
 
@@ -366,9 +366,9 @@ module DocuSign_eSign
     # This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
     # @param account_id The external account number (int) or account ID Guid.
     # @param template_id The ID of the template being accessed.
-    # @param return_url_request  (optional parameter)
+    # @param template_view_request  (optional parameter)
     # @return [Array<(ViewUrl, Fixnum, Hash)>] ViewUrl data, response status code and response headers
-    def create_edit_view_with_http_info(account_id, template_id, return_url_request)
+    def create_edit_view_with_http_info(account_id, template_id, template_view_request)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: TemplatesApi.create_edit_view ..."
       end
@@ -391,7 +391,7 @@ module DocuSign_eSign
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(return_url_request)
+      post_body = @api_client.object_to_http_body(template_view_request)
       auth_names = []
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,

data/lib/docusign_esign/client/api_client.rb

@@ -35,7 +35,7 @@ module DocuSign_eSign
     # @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/3.27.0/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
+      @user_agent = "Swagger-Codegen/v2.1/4.0.0/ruby-#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent