Version 3.14.0-v2.1-21.4.02.00 release (#140)

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

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.14.0] - eSignature API v2.1-21.4.02.00 - 2022-02-11
+### Changed
+- Added support for version v2.1-21.4.02.00 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
 ## [v3.14.0rc1] - eSignature API v2.1-21.4.01.00 - 2022-01-06
 ### Changed
 - Added support for version v2.1-21.4.01.00 of the DocuSign ESignature API.

docusign_esign/__init__.py

@@ -145,6 +145,7 @@
 from docusign_esign.models.bulk_recipients_response import BulkRecipientsResponse
 from docusign_esign.models.bulk_recipients_summary_response import BulkRecipientsSummaryResponse
 from docusign_esign.models.bulk_recipients_update_response import BulkRecipientsUpdateResponse
+from docusign_esign.models.bulk_send_batch_action_request import BulkSendBatchActionRequest
 from docusign_esign.models.bulk_send_batch_error import BulkSendBatchError
 from docusign_esign.models.bulk_send_batch_request import BulkSendBatchRequest
 from docusign_esign.models.bulk_send_batch_status import BulkSendBatchStatus

docusign_esign/apis/bulk_envelopes_api.py

@@ -1055,6 +1055,125 @@ def get_bulk_send_lists_with_http_info(self, account_id, **kwargs):
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
+    def update_bulk_send_batch_action(self, account_id, bulk_action, bulk_send_batch_id, **kwargs):
+        """
+        Initiate a specific bulk send batch action
+        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_bulk_send_batch_action(account_id, bulk_action, bulk_send_batch_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 str bulk_action: (required)
+        :param str bulk_send_batch_id: (required)
+        :param BulkSendBatchActionRequest bulk_send_batch_action_request:
+        :return: BulkSendBatchStatus
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('callback'):
+            return self.update_bulk_send_batch_action_with_http_info(account_id, bulk_action, bulk_send_batch_id, **kwargs)
+        else:
+            (data) = self.update_bulk_send_batch_action_with_http_info(account_id, bulk_action, bulk_send_batch_id, **kwargs)
+            return data
+
+    def update_bulk_send_batch_action_with_http_info(self, account_id, bulk_action, bulk_send_batch_id, **kwargs):
+        """
+        Initiate a specific bulk send batch action
+        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_bulk_send_batch_action_with_http_info(account_id, bulk_action, bulk_send_batch_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 str bulk_action: (required)
+        :param str bulk_send_batch_id: (required)
+        :param BulkSendBatchActionRequest bulk_send_batch_action_request:
+        :return: BulkSendBatchStatus
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['account_id', 'bulk_action', 'bulk_send_batch_id', 'bulk_send_batch_action_request']
+        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_bulk_send_batch_action" % 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_bulk_send_batch_action`")
+        # verify the required parameter 'bulk_action' is set
+        if ('bulk_action' not in params) or (params['bulk_action'] is None):
+            raise ValueError("Missing the required parameter `bulk_action` when calling `update_bulk_send_batch_action`")
+        # verify the required parameter 'bulk_send_batch_id' is set
+        if ('bulk_send_batch_id' not in params) or (params['bulk_send_batch_id'] is None):
+            raise ValueError("Missing the required parameter `bulk_send_batch_id` when calling `update_bulk_send_batch_action`")
+
+
+        collection_formats = {}
+
+        resource_path = '/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}'.replace('{format}', 'json')
+        path_params = {}
+        if 'account_id' in params:
+            path_params['accountId'] = params['account_id']
+        if 'bulk_action' in params:
+            path_params['bulkAction'] = params['bulk_action']
+        if 'bulk_send_batch_id' in params:
+            path_params['bulkSendBatchId'] = params['bulk_send_batch_id']
+
+        query_params = {}
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'bulk_send_batch_action_request' in params:
+            body_params = params['bulk_send_batch_action_request']
+        # 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='BulkSendBatchStatus',
+                                        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_bulk_send_batch_status(self, account_id, bulk_send_batch_id, **kwargs):
         """
         Put/Update a specific bulk send batch status

docusign_esign/models/__init__.py

@@ -109,6 +109,7 @@
 from docusign_esign.models.bulk_recipients_response import BulkRecipientsResponse
 from docusign_esign.models.bulk_recipients_summary_response import BulkRecipientsSummaryResponse
 from docusign_esign.models.bulk_recipients_update_response import BulkRecipientsUpdateResponse
+from docusign_esign.models.bulk_send_batch_action_request import BulkSendBatchActionRequest
 from docusign_esign.models.bulk_send_batch_error import BulkSendBatchError
 from docusign_esign.models.bulk_send_batch_request import BulkSendBatchRequest
 from docusign_esign.models.bulk_send_batch_status import BulkSendBatchStatus

docusign_esign/models/account_settings_information.py

@@ -3304,7 +3304,7 @@ def allow_data_download_metadata(self, allow_data_download_metadata):
     def allow_delayed_routing(self):
         """Gets the allow_delayed_routing of this AccountSettingsInformation.  # noqa: E501
 
-          # noqa: E501
+        \"true\" if the account has permission to use the delayed routing feature to insert delays before routing an envelope to a recipient, \"false\" otherwise.  # noqa: E501
 
         :return: The allow_delayed_routing of this AccountSettingsInformation.  # noqa: E501
         :rtype: str
@@ -3315,7 +3315,7 @@ def allow_delayed_routing(self):
     def allow_delayed_routing(self, allow_delayed_routing):
         """Sets the allow_delayed_routing of this AccountSettingsInformation.
 
-          # noqa: E501
+        \"true\" if the account has permission to use the delayed routing feature to insert delays before routing an envelope to a recipient, \"false\" otherwise.  # noqa: E501
 
         :param allow_delayed_routing: The allow_delayed_routing of this AccountSettingsInformation.  # noqa: E501
         :type: str
@@ -5372,7 +5372,7 @@ def allow_safe_bio_pharma_signer_certificate_metadata(self, allow_safe_bio_pharm
     def allow_scheduled_sending(self):
         """Gets the allow_scheduled_sending of this AccountSettingsInformation.  # noqa: E501
 
-          # noqa: E501
+        \"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise.  # noqa: E501
 
         :return: The allow_scheduled_sending of this AccountSettingsInformation.  # noqa: E501
         :rtype: str
@@ -5383,7 +5383,7 @@ def allow_scheduled_sending(self):
     def allow_scheduled_sending(self, allow_scheduled_sending):
         """Sets the allow_scheduled_sending of this AccountSettingsInformation.
 
-          # noqa: E501
+        \"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise.  # noqa: E501
 
         :param allow_scheduled_sending: The allow_scheduled_sending of this AccountSettingsInformation.  # noqa: E501
         :type: str

docusign_esign/models/agent.py

@@ -53,6 +53,7 @@ class Agent(object):
         'email': 'str',
         'email_metadata': 'PropertyMetadata',
         'email_notification': 'RecipientEmailNotification',
+        'email_recipient_post_signing_url': 'str',
         'embedded_recipient_start_url': 'str',
         'error_details': 'ErrorDetails',
         'excluded_documents': 'list[str]',
@@ -127,6 +128,7 @@ class Agent(object):
         'email': 'email',
         'email_metadata': 'emailMetadata',
         'email_notification': 'emailNotification',
+        'email_recipient_post_signing_url': 'emailRecipientPostSigningURL',
         'embedded_recipient_start_url': 'embeddedRecipientStartURL',
         'error_details': 'errorDetails',
         'excluded_documents': 'excludedDocuments',
@@ -206,6 +208,7 @@ def __init__(self, _configuration=None, **kwargs):  # noqa: E501
         self._email = None
         self._email_metadata = None
         self._email_notification = None
+        self._email_recipient_post_signing_url = None
         self._embedded_recipient_start_url = None
         self._error_details = None
         self._excluded_documents = None
@@ -279,6 +282,7 @@ def __init__(self, _configuration=None, **kwargs):  # noqa: E501
         setattr(self, "_{}".format('email'), kwargs.get('email', None))
         setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None))
         setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None))
+        setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None))
         setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None))
         setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
         setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None))
@@ -783,6 +787,29 @@ def email_notification(self, email_notification):
 
         self._email_notification = email_notification
 
+    @property
+    def email_recipient_post_signing_url(self):
+        """Gets the email_recipient_post_signing_url of this Agent.  # noqa: E501
+
+          # noqa: E501
+
+        :return: The email_recipient_post_signing_url of this Agent.  # noqa: E501
+        :rtype: str
+        """
+        return self._email_recipient_post_signing_url
+
+    @email_recipient_post_signing_url.setter
+    def email_recipient_post_signing_url(self, email_recipient_post_signing_url):
+        """Sets the email_recipient_post_signing_url of this Agent.
+
+          # noqa: E501
+
+        :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this Agent.  # noqa: E501
+        :type: str
+        """
+
+        self._email_recipient_post_signing_url = email_recipient_post_signing_url
+
     @property
     def embedded_recipient_start_url(self):
         """Gets the embedded_recipient_start_url of this Agent.  # noqa: E501