Version 5.0.0rc3 release

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.0.0rc3] - eSignature API v2.1-25.1.00.00 - 2025-03-10
+### Changed
+- Added support for version v2.1-25.1.00.00 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
 ## [v5.0.0rc2] - eSignature API v2.1-24.2.00.00 - 2024-08-22
 ### Breaking Changes
 - Updated datatype for `get_document` method from `envelopes_api`.

README.md

@@ -33,7 +33,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.0rc2
+- **Latest SDK version**: 5.0.0rc3
 
 <a id="requirements"></a>
 ## Requirements

docusign_esign/__init__.py

@@ -199,6 +199,7 @@
 from docusign_esign.models.connect_salesforce_object import ConnectSalesforceObject
 from docusign_esign.models.connect_user_info import ConnectUserInfo
 from docusign_esign.models.connect_user_object import ConnectUserObject
+from docusign_esign.models.connected_object_details import ConnectedObjectDetails
 from docusign_esign.models.consent_details import ConsentDetails
 from docusign_esign.models.console_view_request import ConsoleViewRequest
 from docusign_esign.models.consumer_disclosure import ConsumerDisclosure
@@ -493,6 +494,8 @@
 from docusign_esign.models.tab_metadata import TabMetadata
 from docusign_esign.models.tab_metadata_list import TabMetadataList
 from docusign_esign.models.tabs import Tabs
+from docusign_esign.models.template_auto_match import TemplateAutoMatch
+from docusign_esign.models.template_auto_match_list import TemplateAutoMatchList
 from docusign_esign.models.template_custom_fields import TemplateCustomFields
 from docusign_esign.models.template_document_visibility_list import TemplateDocumentVisibilityList
 from docusign_esign.models.template_documents_result import TemplateDocumentsResult

docusign_esign/apis/cloud_storage_api.py

@@ -530,6 +530,7 @@ def list(self, account_id, folder_id, service_id, user_id, **kwargs):
         :param str order: An optional value that sets the direction order used to sort the item list.   Valid values are:   * asc = ascending sort order * desc = descending sort order 
         :param str order_by: An optional value that sets the file attribute used to sort the item list.   Valid values are:   * modified * name  
         :param str search_text:
+        :param str sky_drive_skip_token:
         :param str start_position: Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.  
         :return: ExternalFolder
                  If the method is called asynchronously,
@@ -566,13 +567,14 @@ def list_with_http_info(self, account_id, folder_id, service_id, user_id, **kwar
         :param str order: An optional value that sets the direction order used to sort the item list.   Valid values are:   * asc = ascending sort order * desc = descending sort order 
         :param str order_by: An optional value that sets the file attribute used to sort the item list.   Valid values are:   * modified * name  
         :param str search_text:
+        :param str sky_drive_skip_token:
         :param str start_position: Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.  
         :return: ExternalFolder
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['account_id', 'folder_id', 'service_id', 'user_id', 'cloud_storage_folder_path', 'cloud_storage_folderid_plain', 'count', 'order', 'order_by', 'search_text', 'start_position']
+        all_params = ['account_id', 'folder_id', 'service_id', 'user_id', 'cloud_storage_folder_path', 'cloud_storage_folderid_plain', 'count', 'order', 'order_by', 'search_text', 'sky_drive_skip_token', 'start_position']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -627,6 +629,8 @@ def list_with_http_info(self, account_id, folder_id, service_id, user_id, **kwar
             query_params['order_by'] = params['order_by']
         if 'search_text' in params:
             query_params['search_text'] = params['search_text']
+        if 'sky_drive_skip_token' in params:
+            query_params['sky_drive_skip_token'] = params['sky_drive_skip_token']
         if 'start_position' in params:
             query_params['start_position'] = params['start_position']
 

docusign_esign/apis/power_forms_api.py

@@ -718,11 +718,13 @@ def list_power_forms(self, account_id, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str account_id: The external account number (int) or account ID Guid. (required)
+        :param str count:
         :param str from_date:
         :param str order:
         :param str order_by:
         :param str search_fields:
         :param str search_text:
+        :param str start_position:
         :param str to_date:
         :return: PowerFormsResponse
                  If the method is called asynchronously,
@@ -750,18 +752,20 @@ def list_power_forms_with_http_info(self, account_id, **kwargs):
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str account_id: The external account number (int) or account ID Guid. (required)
+        :param str count:
         :param str from_date:
         :param str order:
         :param str order_by:
         :param str search_fields:
         :param str search_text:
+        :param str start_position:
         :param str to_date:
         :return: PowerFormsResponse
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['account_id', 'from_date', 'order', 'order_by', 'search_fields', 'search_text', 'to_date']
+        all_params = ['account_id', 'count', 'from_date', 'order', 'order_by', 'search_fields', 'search_text', 'start_position', 'to_date']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -789,6 +793,8 @@ def list_power_forms_with_http_info(self, account_id, **kwargs):
             path_params['accountId'] = params['account_id']
 
         query_params = {}
+        if 'count' in params:
+            query_params['count'] = params['count']
         if 'from_date' in params:
             query_params['from_date'] = params['from_date']
         if 'order' in params:
@@ -799,6 +805,8 @@ def list_power_forms_with_http_info(self, account_id, **kwargs):
             query_params['search_fields'] = params['search_fields']
         if 'search_text' in params:
             query_params['search_text'] = params['search_text']
+        if 'start_position' in params:
+            query_params['start_position'] = params['start_position']
         if 'to_date' in params:
             query_params['to_date'] = params['to_date']
 

docusign_esign/apis/templates_api.py

@@ -5935,3 +5935,213 @@ def update_template_document_tabs_with_http_info(self, account_id, document_id,
                                         _preload_content=params.get('_preload_content', True),
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
+
+    def update_templates(self, account_id, **kwargs):
+        """
+        Update template autoMatch setting.
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.update_templates(account_id, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str account_id: The external account number (int) or account ID Guid. (required)
+        :param TemplateAutoMatchList template_auto_match_list:
+        :return: TemplateAutoMatchList
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.update_templates_with_http_info(account_id, **kwargs)
+        else:
+            (data) = self.update_templates_with_http_info(account_id, **kwargs)
+            return data
+
+    def update_templates_with_http_info(self, account_id, **kwargs):
+        """
+        Update template autoMatch setting.
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.update_templates_with_http_info(account_id, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str account_id: The external account number (int) or account ID Guid. (required)
+        :param TemplateAutoMatchList template_auto_match_list:
+        :return: TemplateAutoMatchList
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['account_id', 'template_auto_match_list']
+        all_params.append('callback')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method update_templates" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'account_id' is set
+        if ('account_id' not in params) or (params['account_id'] is None):
+            raise ValueError("Missing the required parameter `account_id` when calling `update_templates`")
+
+
+        collection_formats = {}
+
+        resource_path = '/v2.1/accounts/{accountId}/templates'.replace('{format}', 'json')
+        path_params = {}
+        if 'account_id' in params:
+            path_params['accountId'] = params['account_id']
+
+        query_params = {}
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'template_auto_match_list' in params:
+            body_params = params['template_auto_match_list']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/json'])
+
+        # Authentication setting
+        auth_settings = []
+
+        return self.api_client.call_api(resource_path, 'PUT',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type='TemplateAutoMatchList',
+                                        auth_settings=auth_settings,
+                                        callback=params.get('callback'),
+                                        _return_http_data_only=params.get('_return_http_data_only'),
+                                        _preload_content=params.get('_preload_content', True),
+                                        _request_timeout=params.get('_request_timeout'),
+                                        collection_formats=collection_formats)
+
+    def update_templates_auto_match(self, account_id, **kwargs):
+        """
+        Update template autoMatch setting.
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.update_templates_auto_match(account_id, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str account_id: The external account number (int) or account ID Guid. (required)
+        :param TemplateAutoMatchList template_auto_match_list:
+        :return: TemplateAutoMatchList
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.update_templates_auto_match_with_http_info(account_id, **kwargs)
+        else:
+            (data) = self.update_templates_auto_match_with_http_info(account_id, **kwargs)
+            return data
+
+    def update_templates_auto_match_with_http_info(self, account_id, **kwargs):
+        """
+        Update template autoMatch setting.
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please define a `callback` function
+        to be invoked when receiving the response.
+        >>> def callback_function(response):
+        >>>     pprint(response)
+        >>>
+        >>> thread = api.update_templates_auto_match_with_http_info(account_id, callback=callback_function)
+
+        :param callback function: The callback function
+            for asynchronous request. (optional)
+        :param str account_id: The external account number (int) or account ID Guid. (required)
+        :param TemplateAutoMatchList template_auto_match_list:
+        :return: TemplateAutoMatchList
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['account_id', 'template_auto_match_list']
+        all_params.append('callback')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method update_templates_auto_match" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'account_id' is set
+        if ('account_id' not in params) or (params['account_id'] is None):
+            raise ValueError("Missing the required parameter `account_id` when calling `update_templates_auto_match`")
+
+
+        collection_formats = {}
+
+        resource_path = '/v2.1/accounts/{accountId}/templates/auto_match'.replace('{format}', 'json')
+        path_params = {}
+        if 'account_id' in params:
+            path_params['accountId'] = params['account_id']
+
+        query_params = {}
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'template_auto_match_list' in params:
+            body_params = params['template_auto_match_list']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.\
+            select_header_accept(['application/json'])
+
+        # Authentication setting
+        auth_settings = []
+
+        return self.api_client.call_api(resource_path, 'PUT',
+                                        path_params,
+                                        query_params,
+                                        header_params,
+                                        body=body_params,
+                                        post_params=form_params,
+                                        files=local_var_files,
+                                        response_type='TemplateAutoMatchList',
+                                        auth_settings=auth_settings,
+                                        callback=params.get('callback'),
+                                        _return_http_data_only=params.get('_return_http_data_only'),
+                                        _preload_content=params.get('_preload_content', True),
+                                        _request_timeout=params.get('_request_timeout'),
+                                        collection_formats=collection_formats)