2.1.0rc1 Major Release (#38)

Author: harsharahul

CHANGELOG.md

@@ -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.
 
+## [2.1.0rc1] - eSignature API v2-19.2.02 - 2019-08-28
+### Changed
+* Updated the way the models and classes are initialized. Now using constructor parameters to initialize the classes. Updates to unit tests.
+### Fixed
+* A bug in model mapping where instead of mapping to custom DocuSign `Date` class, was mapping to python `date` class. Causing the functions such as `envelope_api.list_tabs()` to raise exception. (DCM-1788)
+
 ## [2.0.1] - 2019-06-24
 ### Removed
 * Removed harcoded test config values from the test cases. Now getting test config values from the environment variables.

docusign_esign/apis/bulk_envelopes_api.py

@@ -519,7 +519,7 @@ def list_with_http_info(self, account_id, **kwargs):
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
-    def update_recipients(self, account_id, envelope_id, recipient_id, **kwargs):
+    def update_recipients(self, account_id, envelope_id, recipient_id, bulk_recipients_request, **kwargs):
         """
         Adds or replaces envelope bulk recipients.
         Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).  The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
@@ -529,26 +529,26 @@ def update_recipients(self, account_id, envelope_id, recipient_id, **kwargs):
         >>> def callback_function(response):
         >>>     pprint(response)
         >>>
-        >>> thread = api.update_recipients(account_id, envelope_id, recipient_id, callback=callback_function)
+        >>> thread = api.update_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request, 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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
-        :param str recipient_id: The ID of the recipient being accessed. (required)
-        :param BulkRecipientsRequest bulk_recipients_request:
+        :param str envelope_id: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec  (required)
+        :param str recipient_id: The `recipientId` used when the envelope or template was created. (required)
+        :param str bulk_recipients_request:  (required)
         :return: BulkRecipientsSummaryResponse
                  If the method is called asynchronously,
                  returns the request thread.
         """
         kwargs['_return_http_data_only'] = True
         if kwargs.get('callback'):
-            return self.update_recipients_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+            return self.update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request, **kwargs)
         else:
-            (data) = self.update_recipients_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+            (data) = self.update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request, **kwargs)
             return data
 
-    def update_recipients_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs):
+    def update_recipients_with_http_info(self, account_id, envelope_id, recipient_id, bulk_recipients_request, **kwargs):
         """
         Adds or replaces envelope bulk recipients.
         Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).  The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
@@ -558,14 +558,14 @@ def update_recipients_with_http_info(self, account_id, envelope_id, recipient_id
         >>> def callback_function(response):
         >>>     pprint(response)
         >>>
-        >>> thread = api.update_recipients_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function)
+        >>> thread = api.update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request, 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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
-        :param str recipient_id: The ID of the recipient being accessed. (required)
-        :param BulkRecipientsRequest bulk_recipients_request:
+        :param str envelope_id: The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec  (required)
+        :param str recipient_id: The `recipientId` used when the envelope or template was created. (required)
+        :param str bulk_recipients_request:  (required)
         :return: BulkRecipientsSummaryResponse
                  If the method is called asynchronously,
                  returns the request thread.
@@ -595,6 +595,9 @@ def update_recipients_with_http_info(self, account_id, envelope_id, recipient_id
         # verify the required parameter 'recipient_id' is set
         if ('recipient_id' not in params) or (params['recipient_id'] is None):
             raise ValueError("Missing the required parameter `recipient_id` when calling `update_recipients`")
+        # verify the required parameter 'bulk_recipients_request' is set
+        if ('bulk_recipients_request' not in params) or (params['bulk_recipients_request'] is None):
+            raise ValueError("Missing the required parameter `bulk_recipients_request` when calling `update_recipients`")
 
 
         collection_formats = {}

docusign_esign/apis/envelopes_api.py

@@ -102,7 +102,6 @@
 from .cloud_storage_providers import CloudStorageProviders
 from .company import Company
 from .complete_sign_hash_response import CompleteSignHashResponse
-from .complete_sign_request import CompleteSignRequest
 from .composite_template import CompositeTemplate
 from .connect_config_results import ConnectConfigResults
 from .connect_custom_configuration import ConnectCustomConfiguration
@@ -121,7 +120,6 @@
 from .contact_update_response import ContactUpdateResponse
 from .correct_view_request import CorrectViewRequest
 from .country import Country
-from .credential import Credential
 from .credit_card_information import CreditCardInformation
 from .credit_card_types import CreditCardTypes
 from .currency_feature_set_price import CurrencyFeatureSetPrice
@@ -146,10 +144,8 @@
 from .document_html_definitions import DocumentHtmlDefinitions
 from .document_html_display_anchor import DocumentHtmlDisplayAnchor
 from .document_html_display_settings import DocumentHtmlDisplaySettings
-from .document_security_store import DocumentSecurityStore
 from .document_template import DocumentTemplate
 from .document_template_list import DocumentTemplateList
-from .document_update_info import DocumentUpdateInfo
 from .document_visibility import DocumentVisibility
 from .document_visibility_list import DocumentVisibilityList
 from .e_note_configuration import ENoteConfiguration
@@ -271,6 +267,7 @@
 from .recipient_email_notification import RecipientEmailNotification
 from .recipient_event import RecipientEvent
 from .recipient_form_data import RecipientFormData
+from .recipient_identity_verification import RecipientIdentityVerification
 from .recipient_names_response import RecipientNamesResponse
 from .recipient_phone_authentication import RecipientPhoneAuthentication
 from .recipient_saml_authentication import RecipientSAMLAuthentication
@@ -286,24 +283,18 @@
 from .reminders import Reminders
 from .resource_information import ResourceInformation
 from .return_url_request import ReturnUrlRequest
-from .revision import Revision
 from .saml_assertion_attribute import SamlAssertionAttribute
 from .seal import Seal
 from .seal_identifier import SealIdentifier
 from .seal_sign import SealSign
 from .seat_discount import SeatDiscount
-from .sender import Sender
 from .sender_email_notifications import SenderEmailNotifications
 from .server_template import ServerTemplate
 from .service_information import ServiceInformation
 from .service_version import ServiceVersion
 from .settings_metadata import SettingsMetadata
 from .shared_item import SharedItem
-from .sign_hash_document import SignHashDocument
-from .sign_hash_session_info_response import SignHashSessionInfoResponse
 from .sign_here import SignHere
-from .sign_session_info_request import SignSessionInfoRequest
-from .signature_data_info import SignatureDataInfo
 from .signature_provider_required_option import SignatureProviderRequiredOption
 from .signature_type import SignatureType
 from .signer import Signer
@@ -341,18 +332,11 @@
 from .template_update_summary import TemplateUpdateSummary
 from .text import Text
 from .text_custom_field import TextCustomField
-from .time_stamp_field import TimeStampField
 from .title import Title
-from .tsp_health_check_request import TspHealthCheckRequest
-from .tsp_health_check_status_description import TspHealthCheckStatusDescription
-from .update_transaction_request import UpdateTransactionRequest
-from .update_transaction_response import UpdateTransactionResponse
 from .usage_history import UsageHistory
-from .user import User
 from .user_account_management_granular_information import UserAccountManagementGranularInformation
 from .user_info import UserInfo
 from .user_info_list import UserInfoList
-from .user_info_response import UserInfoResponse
 from .user_information import UserInformation
 from .user_information_list import UserInformationList
 from .user_password_information import UserPasswordInformation

docusign_esign/models/__init__.py

@@ -21,7 +21,7 @@ class AccountRoleSettings(object):
     NOTE: This class is auto generated by the swagger code generator program.
     Do not edit the class manually.
     """
-    def __init__(self, allow_account_management=None, allow_account_management_metadata=None, allow_api_access=None, allow_api_access_metadata=None, allow_api_access_to_account=None, allow_api_access_to_account_metadata=None, allow_api_sending_on_behalf_of_others=None, allow_api_sending_on_behalf_of_others_metadata=None, allow_api_sequential_signing=None, allow_api_sequential_signing_metadata=None, allow_bulk_sending=None, allow_bulk_sending_metadata=None, allow_docu_sign_desktop_client=None, allow_docu_sign_desktop_client_metadata=None, allowed_address_book_access=None, allowed_address_book_access_metadata=None, allowed_template_access=None, allowed_template_access_metadata=None, allowed_to_be_envelope_transfer_recipient=None, allowed_to_be_envelope_transfer_recipient_metadata=None, allow_envelope_sending=None, allow_envelope_sending_metadata=None, allow_e_seal_recipients=None, allow_e_seal_recipients_metadata=None, allow_power_forms_admin_to_access_all_power_form_envelopes=None, allow_power_forms_admin_to_access_all_power_form_envelopes_metadata=None, allow_senders_to_set_recipient_email_language=None, allow_senders_to_set_recipient_email_language_metadata=None, allow_signer_attachments=None, allow_signer_attachments_metadata=None, allow_supplemental_documents=None, allow_supplemental_documents_metadata=None, allow_tagging_in_send_and_correct=None, allow_tagging_in_send_and_correct_metadata=None, allow_vaulting=None, allow_vaulting_metadata=None, allow_wet_signing_override=None, allow_wet_signing_override_metadata=None, can_create_workspaces=None, can_create_workspaces_metadata=None, disable_document_upload=None, disable_document_upload_metadata=None, disable_other_actions=None, disable_other_actions_metadata=None, enable_api_request_logging=None, enable_api_request_logging_metadata=None, enable_recipient_viewing_notifications=None, enable_recipient_viewing_notifications_metadata=None, enable_sequential_signing_interface=None, enable_sequential_signing_interface_metadata=None, enable_transaction_point_integration=None, enable_transaction_point_integration_metadata=None, power_form_role=None, power_form_role_metadata=None, receive_completed_self_signed_documents_as_email_links=None, receive_completed_self_signed_documents_as_email_links_metadata=None, supplemental_documents_must_accept=None, supplemental_documents_must_accept_metadata=None, supplemental_documents_must_read=None, supplemental_documents_must_read_metadata=None, supplemental_documents_must_view=None, supplemental_documents_must_view_metadata=None, use_new_docu_sign_experience_interface=None, use_new_docu_sign_experience_interface_metadata=None, use_new_sending_interface=None, use_new_sending_interface_metadata=None, vaulting_mode=None, vaulting_mode_metadata=None):
+    def __init__(self, allow_account_management=None, allow_account_management_metadata=None, allow_api_access=None, allow_api_access_metadata=None, allow_api_access_to_account=None, allow_api_access_to_account_metadata=None, allow_api_sending_on_behalf_of_others=None, allow_api_sending_on_behalf_of_others_metadata=None, allow_api_sequential_signing=None, allow_api_sequential_signing_metadata=None, allow_auto_tagging=None, allow_auto_tagging_metadata=None, allow_bulk_sending=None, allow_bulk_sending_metadata=None, allow_docu_sign_desktop_client=None, allow_docu_sign_desktop_client_metadata=None, allowed_address_book_access=None, allowed_address_book_access_metadata=None, allowed_template_access=None, allowed_template_access_metadata=None, allowed_to_be_envelope_transfer_recipient=None, allowed_to_be_envelope_transfer_recipient_metadata=None, allow_envelope_sending=None, allow_envelope_sending_metadata=None, allow_e_seal_recipients=None, allow_e_seal_recipients_metadata=None, allow_power_forms_admin_to_access_all_power_form_envelopes=None, allow_power_forms_admin_to_access_all_power_form_envelopes_metadata=None, allow_senders_to_set_recipient_email_language=None, allow_senders_to_set_recipient_email_language_metadata=None, allow_signer_attachments=None, allow_signer_attachments_metadata=None, allow_supplemental_documents=None, allow_supplemental_documents_metadata=None, allow_tagging_in_send_and_correct=None, allow_tagging_in_send_and_correct_metadata=None, allow_vaulting=None, allow_vaulting_metadata=None, allow_wet_signing_override=None, allow_wet_signing_override_metadata=None, can_create_workspaces=None, can_create_workspaces_metadata=None, disable_document_upload=None, disable_document_upload_metadata=None, disable_other_actions=None, disable_other_actions_metadata=None, enable_api_request_logging=None, enable_api_request_logging_metadata=None, enable_recipient_viewing_notifications=None, enable_recipient_viewing_notifications_metadata=None, enable_sequential_signing_interface=None, enable_sequential_signing_interface_metadata=None, enable_transaction_point_integration=None, enable_transaction_point_integration_metadata=None, power_form_role=None, power_form_role_metadata=None, receive_completed_self_signed_documents_as_email_links=None, receive_completed_self_signed_documents_as_email_links_metadata=None, supplemental_documents_must_accept=None, supplemental_documents_must_accept_metadata=None, supplemental_documents_must_read=None, supplemental_documents_must_read_metadata=None, supplemental_documents_must_view=None, supplemental_documents_must_view_metadata=None, use_new_docu_sign_experience_interface=None, use_new_docu_sign_experience_interface_metadata=None, use_new_sending_interface=None, use_new_sending_interface_metadata=None, vaulting_mode=None, vaulting_mode_metadata=None):
         """
         AccountRoleSettings - a model defined in Swagger
 
@@ -41,6 +41,8 @@ def __init__(self, allow_account_management=None, allow_account_management_metad
             'allow_api_sending_on_behalf_of_others_metadata': 'SettingsMetadata',
             'allow_api_sequential_signing': 'str',
             'allow_api_sequential_signing_metadata': 'SettingsMetadata',
+            'allow_auto_tagging': 'str',
+            'allow_auto_tagging_metadata': 'SettingsMetadata',
             'allow_bulk_sending': 'str',
             'allow_bulk_sending_metadata': 'SettingsMetadata',
             'allow_docu_sign_desktop_client': 'str',
@@ -112,6 +114,8 @@ def __init__(self, allow_account_management=None, allow_account_management_metad
             'allow_api_sending_on_behalf_of_others_metadata': 'allowApiSendingOnBehalfOfOthersMetadata',
             'allow_api_sequential_signing': 'allowApiSequentialSigning',
             'allow_api_sequential_signing_metadata': 'allowApiSequentialSigningMetadata',
+            'allow_auto_tagging': 'allowAutoTagging',
+            'allow_auto_tagging_metadata': 'allowAutoTaggingMetadata',
             'allow_bulk_sending': 'allowBulkSending',
             'allow_bulk_sending_metadata': 'allowBulkSendingMetadata',
             'allow_docu_sign_desktop_client': 'allowDocuSignDesktopClient',
@@ -182,6 +186,8 @@ def __init__(self, allow_account_management=None, allow_account_management_metad
         self._allow_api_sending_on_behalf_of_others_metadata = allow_api_sending_on_behalf_of_others_metadata
         self._allow_api_sequential_signing = allow_api_sequential_signing
         self._allow_api_sequential_signing_metadata = allow_api_sequential_signing_metadata
+        self._allow_auto_tagging = allow_auto_tagging
+        self._allow_auto_tagging_metadata = allow_auto_tagging_metadata
         self._allow_bulk_sending = allow_bulk_sending
         self._allow_bulk_sending_metadata = allow_bulk_sending_metadata
         self._allow_docu_sign_desktop_client = allow_docu_sign_desktop_client
@@ -461,6 +467,50 @@ def allow_api_sequential_signing_metadata(self, allow_api_sequential_signing_met
 
         self._allow_api_sequential_signing_metadata = allow_api_sequential_signing_metadata
 
+    @property
+    def allow_auto_tagging(self):
+        """
+        Gets the allow_auto_tagging of this AccountRoleSettings.
+        
+
+        :return: The allow_auto_tagging of this AccountRoleSettings.
+        :rtype: str
+        """
+        return self._allow_auto_tagging
+
+    @allow_auto_tagging.setter
+    def allow_auto_tagging(self, allow_auto_tagging):
+        """
+        Sets the allow_auto_tagging of this AccountRoleSettings.
+        
+
+        :param allow_auto_tagging: The allow_auto_tagging of this AccountRoleSettings.
+        :type: str
+        """
+
+        self._allow_auto_tagging = allow_auto_tagging
+
+    @property
+    def allow_auto_tagging_metadata(self):
+        """
+        Gets the allow_auto_tagging_metadata of this AccountRoleSettings.
+
+        :return: The allow_auto_tagging_metadata of this AccountRoleSettings.
+        :rtype: SettingsMetadata
+        """
+        return self._allow_auto_tagging_metadata
+
+    @allow_auto_tagging_metadata.setter
+    def allow_auto_tagging_metadata(self, allow_auto_tagging_metadata):
+        """
+        Sets the allow_auto_tagging_metadata of this AccountRoleSettings.
+
+        :param allow_auto_tagging_metadata: The allow_auto_tagging_metadata of this AccountRoleSettings.
+        :type: SettingsMetadata
+        """
+
+        self._allow_auto_tagging_metadata = allow_auto_tagging_metadata
+
     @property
     def allow_bulk_sending(self):
         """