docusign_esign 3.20.0 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 477e5213535e6c2f998d01072c446759562edb20431bd323c6219baf5c650109
-  data.tar.gz: 915073908f3294a0ca4b315c182dfb71c53d12b0d21276ac65004cddd6159d0e
+  metadata.gz: 2d87bcd4f4a605609fa81a94eba9ca07eaf48d975798ec98ece2bd8d65bbf502
+  data.tar.gz: fe921298587fcfa02bae98fc4ddef4480981ec4fe8d4b2263401e906153d211c
 SHA512:
-  metadata.gz: 75e63c7b8a4c5a24e71adb5bd3b45c35e05914eefe4f549a3cf479771303f630c6ee266ad9d7ef6814dbe2834aa45b6860db9d8f3d07223de02b261620471f03
-  data.tar.gz: 80fefa370f1ac3329f739cd23549a108c0c7fbfcec0c3748527f86478b1d08af7a9cede21ab830008d1d83900711da626eae8d85f94c7fb00aef1f33f6a31b66
+  metadata.gz: 0f074758ac67625662bf7d420b64c314dc07d7a75d19fb2eb3d135f89582023f562929eefe813cf491f575e722c88ff75e571bcf43e0fd4d6092fae7d882886f
+  data.tar.gz: '09910623ccb46a5b49224835c2d4baaadc5e40b278c2d4c4502c0c9e2668a2504a4eae1ec55a2128201b2173cecbfcb44fd5677eb40edc472c3e3d841fdf245b'

data/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.
 
+## [v3.21.0] - eSignature API v2.1-22.4.02.00 - 2023-02-02
+### Changed
+- Added support for version v2.1-22.4.02.00 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
 ## [v3.20.0] - eSignature API v2.1-22.3.01.00 - 2022-11-18
 ### Changed
 - Added support for version v2.1-22.3.01.00 of the DocuSign ESignature API.

data/lib/docusign_esign/api/connect_api.rb

@@ -1147,6 +1147,57 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Updates the existing Connect OAuth Config for the account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param connect_o_auth_config  (optional parameter)
+    # @return [ConnectOAuthConfig]
+    def update_connect_o_auth_config(account_id, connect_o_auth_config)
+      data, _status_code, _headers = update_connect_o_auth_config_with_http_info(account_id,  connect_o_auth_config)
+      return data
+    end
+
+    # Updates the existing Connect OAuth Config for the account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param connect_o_auth_config  (optional parameter)
+    # @return [Array<(ConnectOAuthConfig, Fixnum, Hash)>] ConnectOAuthConfig data, response status code and response headers
+    def update_connect_o_auth_config_with_http_info(account_id, connect_o_auth_config)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConnectApi.update_connect_o_auth_config ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling ConnectApi.update_connect_o_auth_config" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/connect/oauth".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 = @api_client.object_to_http_body(connect_o_auth_config)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConnectOAuthConfig')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConnectApi#update_connect_o_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Reserved
     # Reserved:
     # @param account_id The external account number (int) or account ID Guid.

data/lib/docusign_esign/api/envelopes_api.rb

@@ -80,7 +80,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), 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), 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
@@ -6223,9 +6223,10 @@ module DocuSign_eSign
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @param document_file_bytes Updated document content. 
     # @return [EnvelopeDocument]
-    def update_document(account_id, document_id, envelope_id)
-      data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id)
+    def update_document(account_id, document_id, envelope_id, document_file_bytes)
+      data, _status_code, _headers = update_document_with_http_info(account_id, document_id, envelope_id,  document_file_bytes)
       return data
     end
 
@@ -6234,8 +6235,9 @@ module DocuSign_eSign
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @param document_file_bytes Updated document content. 
     # @return [Array<(EnvelopeDocument, Fixnum, Hash)>] EnvelopeDocument data, response status code and response headers
-    def update_document_with_http_info(account_id, document_id, envelope_id)
+    def update_document_with_http_info(account_id, document_id, envelope_id, document_file_bytes)
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: EnvelopesApi.update_document ..."
       end
@@ -6245,6 +6247,8 @@ module DocuSign_eSign
       fail ArgumentError, "Missing the required parameter 'document_id' when calling EnvelopesApi.update_document" if document_id.nil?
       # verify the required parameter 'envelope_id' is set
       fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_document" if envelope_id.nil?
+      # verify the required parameter 'document_file_bytes' is set
+      fail ArgumentError, "Missing the required parameter 'document_file_bytes' when calling EnvelopesApi.update_document" if document_file_bytes.nil?
       # resource path
       local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'documentId' + '}', document_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
 
@@ -6255,12 +6259,14 @@ module DocuSign_eSign
       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(['application/pdf'])
 
       # form parameters
       form_params = {}
 
       # http body (model)
-      post_body = nil
+      post_body = @api_client.object_to_http_body(document_file_bytes)
       auth_names = []
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,
@@ -7237,65 +7243,6 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Retrieves a PDF document from the envelope with no CoC.
-    # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param regen_document_id 
-    # @param document  (optional parameter)
-    # @return [File]
-    def update_regen_document(account_id, envelope_id, regen_document_id, document)
-      data, _status_code, _headers = update_regen_document_with_http_info(account_id, envelope_id, regen_document_id,  document)
-      return data
-    end
-
-    # Retrieves a PDF document from the envelope with no CoC.
-    # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param regen_document_id 
-    # @param document  (optional parameter)
-    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
-    def update_regen_document_with_http_info(account_id, envelope_id, regen_document_id, document)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: EnvelopesApi.update_regen_document ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_regen_document" if account_id.nil?
-      # verify the required parameter 'envelope_id' is set
-      fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_regen_document" if envelope_id.nil?
-      # verify the required parameter 'regen_document_id' is set
-      fail ArgumentError, "Missing the required parameter 'regen_document_id' when calling EnvelopesApi.update_regen_document" if regen_document_id.nil?
-      # resource path
-      local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{regenDocumentId}/regen".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'regenDocumentId' + '}', regen_document_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/pdf'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(document)
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'File')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EnvelopesApi#update_regen_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Updates the tabs for a recipient.  
     # Updates one or more tabs for a recipient in a draft envelope.
     # @param account_id The external account number (int) or account ID Guid.

data/lib/docusign_esign/api/folders_api.rb

@@ -14,6 +14,9 @@ require "uri"
 module DocuSign_eSign
 
   class ListOptions
+    # 
+    attr_accessor :count
+
     # 
     attr_accessor :include
 
@@ -23,6 +26,9 @@ module DocuSign_eSign
     # 
     attr_accessor :start_position
 
+    # 
+    attr_accessor :sub_folder_depth
+
     # Specifies the items that are returned. Valid values are:   * include - The folder list will return normal folders plus template folders.  * only - Only the list of template folders are returned.
     attr_accessor :template
 
@@ -128,9 +134,11 @@ module DocuSign_eSign
 
       # query parameters
       query_params = {}
+      query_params[:'count'] = options.count if !options.count.nil?
       query_params[:'include'] = options.include if !options.include.nil?
       query_params[:'include_items'] = options.include_items if !options.include_items.nil?
       query_params[:'start_position'] = options.start_position if !options.start_position.nil?
+      query_params[:'sub_folder_depth'] = options.sub_folder_depth if !options.sub_folder_depth.nil?
       query_params[:'template'] = options.template if !options.template.nil?
       query_params[:'user_filter'] = options.user_filter if !options.user_filter.nil?
 

data/lib/docusign_esign/api/templates_api.rb

@@ -97,18 +97,6 @@ module DocuSign_eSign
     end
   end
 
-  class ListBulkRecipientsOptions
-    # 
-    attr_accessor :include_tabs
-
-    # 
-    attr_accessor :start_position
-
-    def self.default
-      @@default ||= ListBulkRecipientsOptions.new
-    end
-  end
-
   class ListDocumentsOptions
     # 
     attr_accessor :include_tabs
@@ -2087,67 +2075,6 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Gets the bulk recipient file from a template.
-    # Retrieves the bulk recipient file information from a template that has a bulk recipient.
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param recipient_id The ID of the recipient being accessed.
-    # @param template_id The ID of the template being accessed.
-    # @param DocuSign_eSign::ListBulkRecipientsOptions Options for modifying the behavior of the function.
-    # @return [BulkRecipientsResponse]
-    def list_bulk_recipients(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default)
-      data, _status_code, _headers = list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, options)
-      return data
-    end
-
-    # Gets the bulk recipient file from a template.
-    # Retrieves the bulk recipient file information from a template that has a bulk recipient.
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param recipient_id The ID of the recipient being accessed.
-    # @param template_id The ID of the template being accessed.
-    # @param DocuSign_eSign::ListBulkRecipientsOptions Options for modifying the behavior of the function.
-    # @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
-    def list_bulk_recipients_with_http_info(account_id, recipient_id, template_id, options = DocuSign_eSign::ListBulkRecipientsOptions.default)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TemplatesApi.list_bulk_recipients ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.list_bulk_recipients" if account_id.nil?
-      # verify the required parameter 'recipient_id' is set
-      fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.list_bulk_recipients" if recipient_id.nil?
-      # verify the required parameter 'template_id' is set
-      fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.list_bulk_recipients" if template_id.nil?
-      # resource path
-      local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
-
-      # query parameters
-      query_params = {}
-      query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
-      query_params[:'start_position'] = options.start_position if !options.start_position.nil?
-
-      # 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 => 'BulkRecipientsResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TemplatesApi#list_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Gets the custom document fields from a template.
     # Retrieves the custom document field information from an existing template.
     # @param account_id The external account number (int) or account ID Guid.

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/3.20.0/ruby"
+      @user_agent = "Swagger-Codegen/3.21.0/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent