diff --git a/CHANGELOG.md b/CHANGELOG.md
index 12a5b2b..ebab797 100644
--- a/CHANGELOG.md
+++ b/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.
+## [v8.0.0] - eSignature API v2.1-26.3.01.02 - 2026-10-16
+### Changed
+- Added support for version v2.1-26.3.01.02 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
## [v8.0.0rc1] - eSignature API v2.1-26.2.00.00 - 2026-06-04
### Breaking Changes
- Groups API: ListGroupUsers, ListGroupUsersAsync, and their WithHttpInfo variants now return GroupUsersResponse
diff --git a/README.md b/README.md
index 88309d6..b4236ef 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ This client SDK is provided as open source, which enables you to customize its f
### Version Information
- **API version**: v2.1
-- **Latest SDK version**: 8.0.0rc1
+- **Latest SDK version**: 8.0.0
## Requirements
diff --git a/docusign_esign/__init__.py b/docusign_esign/__init__.py
index aabacb2..4ae9311 100644
--- a/docusign_esign/__init__.py
+++ b/docusign_esign/__init__.py
@@ -30,6 +30,7 @@
from .apis.envelopes_api import EnvelopesApi
from .apis.folders_api import FoldersApi
from .apis.groups_api import GroupsApi
+from .apis.insights_api import InsightsApi
from .apis.notary_api import NotaryApi
from .apis.organizations_api import OrganizationsApi
from .apis.power_forms_api import PowerFormsApi
@@ -98,6 +99,7 @@
from docusign_esign.models.authentication_method import AuthenticationMethod
from docusign_esign.models.authentication_status import AuthenticationStatus
from docusign_esign.models.authorization_user import AuthorizationUser
+from docusign_esign.models.authorized_signatory import AuthorizedSignatory
from docusign_esign.models.bcc_email_address import BccEmailAddress
from docusign_esign.models.bcc_email_archive import BccEmailArchive
from docusign_esign.models.bcc_email_archive_history import BccEmailArchiveHistory
@@ -233,6 +235,8 @@
from docusign_esign.models.diagnostics_settings_information import DiagnosticsSettingsInformation
from docusign_esign.models.direct_debit_processor_information import DirectDebitProcessorInformation
from docusign_esign.models.dob_information_input import DobInformationInput
+from docusign_esign.models.doc_gen_conditional_operation_base import DocGenConditionalOperationBase
+from docusign_esign.models.doc_gen_conditional_rule import DocGenConditionalRule
from docusign_esign.models.doc_gen_form_field import DocGenFormField
from docusign_esign.models.doc_gen_form_field_option import DocGenFormFieldOption
from docusign_esign.models.doc_gen_form_field_request import DocGenFormFieldRequest
@@ -266,6 +270,7 @@
from docusign_esign.models.email_address import EmailAddress
from docusign_esign.models.email_settings import EmailSettings
from docusign_esign.models.envelope import Envelope
+from docusign_esign.models.envelope_archive_summary import EnvelopeArchiveSummary
from docusign_esign.models.envelope_attachment import EnvelopeAttachment
from docusign_esign.models.envelope_attachments_request import EnvelopeAttachmentsRequest
from docusign_esign.models.envelope_attachments_result import EnvelopeAttachmentsResult
@@ -278,6 +283,8 @@
from docusign_esign.models.envelope_documents_result import EnvelopeDocumentsResult
from docusign_esign.models.envelope_event import EnvelopeEvent
from docusign_esign.models.envelope_form_data import EnvelopeFormData
+from docusign_esign.models.envelope_gen_and_send import EnvelopeGenAndSend
+from docusign_esign.models.envelope_gen_and_send_properties import EnvelopeGenAndSendProperties
from docusign_esign.models.envelope_id import EnvelopeId
from docusign_esign.models.envelope_ids_request import EnvelopeIdsRequest
from docusign_esign.models.envelope_metadata import EnvelopeMetadata
@@ -302,6 +309,7 @@
from docusign_esign.models.envelope_view_template_settings import EnvelopeViewTemplateSettings
from docusign_esign.models.envelopes_information import EnvelopesInformation
from docusign_esign.models.envelopes_share_permission_request import EnvelopesSharePermissionRequest
+from docusign_esign.models.envelopes_share_permission_response import EnvelopesSharePermissionResponse
from docusign_esign.models.envelopes_share_request import EnvelopesShareRequest
from docusign_esign.models.envelopes_share_response import EnvelopesShareResponse
from docusign_esign.models.envelopes_shares_request import EnvelopesSharesRequest
@@ -310,6 +318,8 @@
from docusign_esign.models.event_notification import EventNotification
from docusign_esign.models.event_result import EventResult
from docusign_esign.models.expirations import Expirations
+from docusign_esign.models.extend_payment_configuration import ExtendPaymentConfiguration
+from docusign_esign.models.extend_payment_line_item import ExtendPaymentLineItem
from docusign_esign.models.extension_data import ExtensionData
from docusign_esign.models.external_doc_service_error_details import ExternalDocServiceErrorDetails
from docusign_esign.models.external_document_sources import ExternalDocumentSources
@@ -335,6 +345,8 @@
from docusign_esign.models.form_data_item import FormDataItem
from docusign_esign.models.formula_tab import FormulaTab
from docusign_esign.models.full_name import FullName
+from docusign_esign.models.generated_document import GeneratedDocument
+from docusign_esign.models.generated_documents_result import GeneratedDocumentsResult
from docusign_esign.models.graphics_context import GraphicsContext
from docusign_esign.models.group import Group
from docusign_esign.models.group_information import GroupInformation
@@ -407,6 +419,7 @@
from docusign_esign.models.participant import Participant
from docusign_esign.models.path_extended_element import PathExtendedElement
from docusign_esign.models.pay_pal_legacy_settings import PayPalLegacySettings
+from docusign_esign.models.payment_audit_event import PaymentAuditEvent
from docusign_esign.models.payment_details import PaymentDetails
from docusign_esign.models.payment_gateway_account import PaymentGatewayAccount
from docusign_esign.models.payment_gateway_account_setting import PaymentGatewayAccountSetting
@@ -463,6 +476,9 @@
from docusign_esign.models.recipient_view_request import RecipientViewRequest
from docusign_esign.models.recipients import Recipients
from docusign_esign.models.recipients_update_summary import RecipientsUpdateSummary
+from docusign_esign.models.recommendation_info import RecommendationInfo
+from docusign_esign.models.recommendations_list_request import RecommendationsListRequest
+from docusign_esign.models.recommendations_list_response import RecommendationsListResponse
from docusign_esign.models.referral_information import ReferralInformation
from docusign_esign.models.reminders import Reminders
from docusign_esign.models.resource_information import ResourceInformation
diff --git a/docusign_esign/apis/__init__.py b/docusign_esign/apis/__init__.py
index 53585e5..c29bf19 100644
--- a/docusign_esign/apis/__init__.py
+++ b/docusign_esign/apis/__init__.py
@@ -17,6 +17,7 @@
from .envelopes_api import EnvelopesApi
from .folders_api import FoldersApi
from .groups_api import GroupsApi
+from .insights_api import InsightsApi
from .notary_api import NotaryApi
from .organizations_api import OrganizationsApi
from .power_forms_api import PowerFormsApi
diff --git a/docusign_esign/apis/accounts_api.py b/docusign_esign/apis/accounts_api.py
index 5a5fadc..cb154f5 100644
--- a/docusign_esign/apis/accounts_api.py
+++ b/docusign_esign/apis/accounts_api.py
@@ -698,7 +698,7 @@ def create_user_authorization_with_http_info(self, account_id, user_id, **kwargs
def create_user_authorizations(self, account_id, user_id, **kwargs):
"""
- Creates ot updates user authorizations
+ Creates or updates user authorizations
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.
@@ -725,7 +725,7 @@ def create_user_authorizations(self, account_id, user_id, **kwargs):
def create_user_authorizations_with_http_info(self, account_id, user_id, **kwargs):
"""
- Creates ot updates user authorizations
+ Creates or updates user authorizations
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.
@@ -2038,7 +2038,7 @@ def delete_user_authorization_with_http_info(self, account_id, authorization_id,
def delete_user_authorizations(self, account_id, user_id, **kwargs):
"""
- Creates ot updates user authorizations
+ Deletes user authorizations
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.
@@ -2065,7 +2065,7 @@ def delete_user_authorizations(self, account_id, user_id, **kwargs):
def delete_user_authorizations_with_http_info(self, account_id, user_id, **kwargs):
"""
- Creates ot updates user authorizations
+ Deletes user authorizations
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.
@@ -2836,6 +2836,8 @@ def get_agent_user_authorizations(self, account_id, user_id, **kwargs):
:param str include_closed_users:
:param str permissions:
:param str start_position:
+ :param str task_source:
+ :param str task_type:
:param str user_name_substring:
:return: UserAuthorizations
If the method is called asynchronously,
@@ -2869,13 +2871,15 @@ def get_agent_user_authorizations_with_http_info(self, account_id, user_id, **kw
:param str include_closed_users:
:param str permissions:
:param str start_position:
+ :param str task_source:
+ :param str task_type:
:param str user_name_substring:
:return: UserAuthorizations
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'user_id', 'active_only', 'count', 'email_substring', 'include_closed_users', 'permissions', 'start_position', 'user_name_substring']
+ all_params = ['account_id', 'user_id', 'active_only', 'count', 'email_substring', 'include_closed_users', 'permissions', 'start_position', 'task_source', 'task_type', 'user_name_substring']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2920,6 +2924,10 @@ def get_agent_user_authorizations_with_http_info(self, account_id, user_id, **kw
query_params['permissions'] = params['permissions']
if 'start_position' in params:
query_params['start_position'] = params['start_position']
+ if 'task_source' in params:
+ query_params['task_source'] = params['task_source']
+ if 'task_type' in params:
+ query_params['task_type'] = params['task_type']
if 'user_name_substring' in params:
query_params['user_name_substring'] = params['user_name_substring']
@@ -3741,215 +3749,6 @@ def get_brand_resources_by_content_type_with_http_info(self, account_id, brand_i
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_completion_rate_for_template(self, account_id, template_id, **kwargs):
- """
- Gets completion rate for the template
- 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.get_completion_rate_for_template(account_id, template_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 template_id: The ID of the template being accessed. (required)
- :return: TemplateCompletionRateResponse
- If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- if kwargs.get('callback'):
- return self.get_completion_rate_for_template_with_http_info(account_id, template_id, **kwargs)
- else:
- (data) = self.get_completion_rate_for_template_with_http_info(account_id, template_id, **kwargs)
- return data
-
- def get_completion_rate_for_template_with_http_info(self, account_id, template_id, **kwargs):
- """
- Gets completion rate for the template
- 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.get_completion_rate_for_template_with_http_info(account_id, template_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 template_id: The ID of the template being accessed. (required)
- :return: TemplateCompletionRateResponse
- If the method is called asynchronously,
- returns the request thread.
- """
-
- all_params = ['account_id', 'template_id']
- 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 get_completion_rate_for_template" % 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 `get_completion_rate_for_template`")
- # verify the required parameter 'template_id' is set
- if ('template_id' not in params) or (params['template_id'] is None):
- raise ValueError("Missing the required parameter `template_id` when calling `get_completion_rate_for_template`")
-
-
- collection_formats = {}
-
- resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/insights/completionRate'.replace('{format}', 'json')
- path_params = {}
- if 'account_id' in params:
- path_params['accountId'] = params['account_id']
- if 'template_id' in params:
- path_params['templateId'] = params['template_id']
-
- query_params = {}
-
- header_params = {}
-
- form_params = []
- local_var_files = {}
-
- body_params = None
- # 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, 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='TemplateCompletionRateResponse',
- 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 get_completion_rate_for_template_owner(self, account_id, **kwargs):
- """
- Gets completion rate for the user
- 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.get_completion_rate_for_template_owner(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)
- :return: UserCompletionRateResponse
- If the method is called asynchronously,
- returns the request thread.
- """
- kwargs['_return_http_data_only'] = True
- if kwargs.get('callback'):
- return self.get_completion_rate_for_template_owner_with_http_info(account_id, **kwargs)
- else:
- (data) = self.get_completion_rate_for_template_owner_with_http_info(account_id, **kwargs)
- return data
-
- def get_completion_rate_for_template_owner_with_http_info(self, account_id, **kwargs):
- """
- Gets completion rate for the user
- 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.get_completion_rate_for_template_owner_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)
- :return: UserCompletionRateResponse
- If the method is called asynchronously,
- returns the request thread.
- """
-
- all_params = ['account_id']
- 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 get_completion_rate_for_template_owner" % 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 `get_completion_rate_for_template_owner`")
-
-
- collection_formats = {}
-
- resource_path = '/v2.1/accounts/{accountId}/templates/insights/completionRate'.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
- # 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, 'GET',
- path_params,
- query_params,
- header_params,
- body=body_params,
- post_params=form_params,
- files=local_var_files,
- response_type='UserCompletionRateResponse',
- 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 get_consumer_disclosure(self, account_id, lang_code, **kwargs):
"""
Gets the Electronic Record and Signature Disclosure.
@@ -4912,6 +4711,8 @@ def get_principal_user_authorizations(self, account_id, user_id, **kwargs):
:param str include_closed_users:
:param str permissions:
:param str start_position:
+ :param str task_source:
+ :param str task_type:
:param str user_name_substring:
:return: UserAuthorizations
If the method is called asynchronously,
@@ -4945,13 +4746,15 @@ def get_principal_user_authorizations_with_http_info(self, account_id, user_id,
:param str include_closed_users:
:param str permissions:
:param str start_position:
+ :param str task_source:
+ :param str task_type:
:param str user_name_substring:
:return: UserAuthorizations
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'user_id', 'active_only', 'count', 'email_substring', 'include_closed_users', 'permissions', 'start_position', 'user_name_substring']
+ all_params = ['account_id', 'user_id', 'active_only', 'count', 'email_substring', 'include_closed_users', 'permissions', 'start_position', 'task_source', 'task_type', 'user_name_substring']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -4996,6 +4799,10 @@ def get_principal_user_authorizations_with_http_info(self, account_id, user_id,
query_params['permissions'] = params['permissions']
if 'start_position' in params:
query_params['start_position'] = params['start_position']
+ if 'task_source' in params:
+ query_params['task_source'] = params['task_source']
+ if 'task_type' in params:
+ query_params['task_type'] = params['task_type']
if 'user_name_substring' in params:
query_params['user_name_substring'] = params['user_name_substring']
diff --git a/docusign_esign/apis/envelopes_api.py b/docusign_esign/apis/envelopes_api.py
index 1093f6e..0deace9 100644
--- a/docusign_esign/apis/envelopes_api.py
+++ b/docusign_esign/apis/envelopes_api.py
@@ -283,6 +283,111 @@ def apply_template_to_document_with_http_info(self, account_id, document_id, env
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
+ def create_archive_metadata_envelopes(self, account_id, **kwargs):
+ """
+ Add metadata in the form of GenAndSend to existing envelopes in docusign.
+ 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.create_archive_metadata_envelopes(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 EnvelopeGenAndSend envelope_gen_and_send:
+ :return: EnvelopeArchiveSummary
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.create_archive_metadata_envelopes_with_http_info(account_id, **kwargs)
+ else:
+ (data) = self.create_archive_metadata_envelopes_with_http_info(account_id, **kwargs)
+ return data
+
+ def create_archive_metadata_envelopes_with_http_info(self, account_id, **kwargs):
+ """
+ Add metadata in the form of GenAndSend to existing envelopes in docusign.
+ 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.create_archive_metadata_envelopes_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 EnvelopeGenAndSend envelope_gen_and_send:
+ :return: EnvelopeArchiveSummary
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_gen_and_send']
+ 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 create_archive_metadata_envelopes" % 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 `create_archive_metadata_envelopes`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/archive_metadata'.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 'envelope_gen_and_send' in params:
+ body_params = params['envelope_gen_and_send']
+ # 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, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='EnvelopeArchiveSummary',
+ 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 create_chunked_upload(self, account_id, **kwargs):
"""
Initiate a new ChunkedUpload.
@@ -372,10 +477,6 @@ def create_chunked_upload_with_http_info(self, account_id, **kwargs):
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
- # HTTP header `Content-Type`
- header_params['Content-Type'] = self.api_client.\
- select_header_content_type(['multipart/form-data'])
-
# Authentication setting
auth_settings = []
@@ -2120,53 +2221,53 @@ def create_envelopes_shares_with_http_info(self, account_id, envelope_id, **kwar
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def create_historical_envelope_publish_transaction(self, account_id, **kwargs):
+ def create_gen_and_archive_envelopes(self, account_id, **kwargs):
"""
- Submits a batch of historical envelopes for republish to an adhoc config.
+ Generates the document using DocuSign Spring CM template then returns the html content of the document.
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.create_historical_envelope_publish_transaction(account_id, callback=callback_function)
+ >>> thread = api.create_gen_and_archive_envelopes(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 ConnectHistoricalEnvelopeRepublish connect_historical_envelope_republish:
- :return: EnvelopePublishTransaction
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: file
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.create_historical_envelope_publish_transaction_with_http_info(account_id, **kwargs)
+ return self.create_gen_and_archive_envelopes_with_http_info(account_id, **kwargs)
else:
- (data) = self.create_historical_envelope_publish_transaction_with_http_info(account_id, **kwargs)
+ (data) = self.create_gen_and_archive_envelopes_with_http_info(account_id, **kwargs)
return data
- def create_historical_envelope_publish_transaction_with_http_info(self, account_id, **kwargs):
+ def create_gen_and_archive_envelopes_with_http_info(self, account_id, **kwargs):
"""
- Submits a batch of historical envelopes for republish to an adhoc config.
+ Generates the document using DocuSign Spring CM template then returns the html content of the document.
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.create_historical_envelope_publish_transaction_with_http_info(account_id, callback=callback_function)
+ >>> thread = api.create_gen_and_archive_envelopes_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 ConnectHistoricalEnvelopeRepublish connect_historical_envelope_republish:
- :return: EnvelopePublishTransaction
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: file
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'connect_historical_envelope_republish']
+ all_params = ['account_id', 'envelope_gen_and_send']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2177,18 +2278,18 @@ def create_historical_envelope_publish_transaction_with_http_info(self, account_
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method create_historical_envelope_publish_transaction" % key
+ " to method create_gen_and_archive_envelopes" % 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 `create_historical_envelope_publish_transaction`")
+ raise ValueError("Missing the required parameter `account_id` when calling `create_gen_and_archive_envelopes`")
collection_formats = {}
- resource_path = '/v2.1/accounts/{accountId}/connect/envelopes/publish/historical'.replace('{format}', 'json')
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/generate_and_archive'.replace('{format}', 'json')
path_params = {}
if 'account_id' in params:
path_params['accountId'] = params['account_id']
@@ -2201,11 +2302,11 @@ def create_historical_envelope_publish_transaction_with_http_info(self, account_
local_var_files = {}
body_params = None
- if 'connect_historical_envelope_republish' in params:
- body_params = params['connect_historical_envelope_republish']
+ if 'envelope_gen_and_send' in params:
+ body_params = params['envelope_gen_and_send']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
- select_header_accept(['application/json'])
+ select_header_accept(['text/plain'])
# Authentication setting
auth_settings = []
@@ -2217,7 +2318,7 @@ def create_historical_envelope_publish_transaction_with_http_info(self, account_
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='EnvelopePublishTransaction',
+ response_type='file',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -2225,57 +2326,53 @@ def create_historical_envelope_publish_transaction_with_http_info(self, account_
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def create_lock(self, account_id, envelope_id, **kwargs):
+ def create_gen_and_convert_envelopes(self, account_id, **kwargs):
"""
- Lock an envelope.
- Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
+ Generates the document using DocuSign Spring CM template then returns the content of the document based on the return document type.
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.create_lock(account_id, envelope_id, callback=callback_function)
+ >>> thread = api.create_gen_and_convert_envelopes(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 str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :param LockRequest lock_request:
- :return: LockInformation
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: file
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.create_lock_with_http_info(account_id, envelope_id, **kwargs)
+ return self.create_gen_and_convert_envelopes_with_http_info(account_id, **kwargs)
else:
- (data) = self.create_lock_with_http_info(account_id, envelope_id, **kwargs)
+ (data) = self.create_gen_and_convert_envelopes_with_http_info(account_id, **kwargs)
return data
- def create_lock_with_http_info(self, account_id, envelope_id, **kwargs):
+ def create_gen_and_convert_envelopes_with_http_info(self, account_id, **kwargs):
"""
- Lock an envelope.
- Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
+ Generates the document using DocuSign Spring CM template then returns the content of the document based on the return document type.
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.create_lock_with_http_info(account_id, envelope_id, callback=callback_function)
+ >>> thread = api.create_gen_and_convert_envelopes_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 str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :param LockRequest lock_request:
- :return: LockInformation
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: file
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'envelope_id', 'lock_request']
+ all_params = ['account_id', 'envelope_gen_and_send']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2286,26 +2383,21 @@ def create_lock_with_http_info(self, account_id, envelope_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method create_lock" % key
+ " to method create_gen_and_convert_envelopes" % 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 `create_lock`")
- # verify the required parameter 'envelope_id' is set
- if ('envelope_id' not in params) or (params['envelope_id'] is None):
- raise ValueError("Missing the required parameter `envelope_id` when calling `create_lock`")
+ raise ValueError("Missing the required parameter `account_id` when calling `create_gen_and_convert_envelopes`")
collection_formats = {}
- resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json')
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/generate_and_convert'.replace('{format}', 'json')
path_params = {}
if 'account_id' in params:
path_params['accountId'] = params['account_id']
- if 'envelope_id' in params:
- path_params['envelopeId'] = params['envelope_id']
query_params = {}
@@ -2315,11 +2407,11 @@ def create_lock_with_http_info(self, account_id, envelope_id, **kwargs):
local_var_files = {}
body_params = None
- if 'lock_request' in params:
- body_params = params['lock_request']
+ if 'envelope_gen_and_send' in params:
+ body_params = params['envelope_gen_and_send']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
- select_header_accept(['application/json'])
+ select_header_accept(['text/plain'])
# Authentication setting
auth_settings = []
@@ -2331,7 +2423,7 @@ def create_lock_with_http_info(self, account_id, envelope_id, **kwargs):
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='LockInformation',
+ response_type='file',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -2339,59 +2431,53 @@ def create_lock_with_http_info(self, account_id, envelope_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def create_recipient(self, account_id, envelope_id, **kwargs):
+ def create_gen_and_convert_multi_envelopes(self, account_id, **kwargs):
"""
- Adds one or more recipients to an envelope.
- Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
+ Generates multiple document using DocuSign Spring CM template then returns the content of the document based on the return document type.
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.create_recipient(account_id, envelope_id, callback=callback_function)
+ >>> thread = api.create_gen_and_convert_multi_envelopes(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 str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :param str resend_envelope: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.
- :param Recipients recipients:
- :return: Recipients
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: GeneratedDocumentsResult
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.create_recipient_with_http_info(account_id, envelope_id, **kwargs)
+ return self.create_gen_and_convert_multi_envelopes_with_http_info(account_id, **kwargs)
else:
- (data) = self.create_recipient_with_http_info(account_id, envelope_id, **kwargs)
+ (data) = self.create_gen_and_convert_multi_envelopes_with_http_info(account_id, **kwargs)
return data
- def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs):
+ def create_gen_and_convert_multi_envelopes_with_http_info(self, account_id, **kwargs):
"""
- Adds one or more recipients to an envelope.
- Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
+ Generates multiple document using DocuSign Spring CM template then returns the content of the document based on the return document type.
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.create_recipient_with_http_info(account_id, envelope_id, callback=callback_function)
+ >>> thread = api.create_gen_and_convert_multi_envelopes_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 str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :param str resend_envelope: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.
- :param Recipients recipients:
- :return: Recipients
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: GeneratedDocumentsResult
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'envelope_id', 'resend_envelope', 'recipients']
+ all_params = ['account_id', 'envelope_gen_and_send']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2402,30 +2488,23 @@ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method create_recipient" % key
+ " to method create_gen_and_convert_multi_envelopes" % 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 `create_recipient`")
- # verify the required parameter 'envelope_id' is set
- if ('envelope_id' not in params) or (params['envelope_id'] is None):
- raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient`")
+ raise ValueError("Missing the required parameter `account_id` when calling `create_gen_and_convert_multi_envelopes`")
collection_formats = {}
- resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.replace('{format}', 'json')
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/generate_and_convert_multi'.replace('{format}', 'json')
path_params = {}
if 'account_id' in params:
path_params['accountId'] = params['account_id']
- if 'envelope_id' in params:
- path_params['envelopeId'] = params['envelope_id']
query_params = {}
- if 'resend_envelope' in params:
- query_params['resend_envelope'] = params['resend_envelope']
header_params = {}
@@ -2433,8 +2512,8 @@ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs):
local_var_files = {}
body_params = None
- if 'recipients' in params:
- body_params = params['recipients']
+ if 'envelope_gen_and_send' in params:
+ body_params = params['envelope_gen_and_send']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
@@ -2449,7 +2528,7 @@ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs):
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='Recipients',
+ response_type='GeneratedDocumentsResult',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -2457,57 +2536,53 @@ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def create_recipient_manual_review_view(self, account_id, envelope_id, recipient_id, **kwargs):
+ def create_gen_and_send_envelopes(self, account_id, **kwargs):
"""
- Provides a link to access the Identity manual review related to a recipient.
- This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
+ Generates the documents for an envelope using DocuSign Spring CM then creates the envelope.
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.create_recipient_manual_review_view(account_id, envelope_id, recipient_id, callback=callback_function)
+ >>> thread = api.create_gen_and_send_envelopes(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 str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :param str recipient_id: The ID of the recipient being accessed. (required)
- :return: ViewUrl
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: EnvelopeSummary
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+ return self.create_gen_and_send_envelopes_with_http_info(account_id, **kwargs)
else:
- (data) = self.create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+ (data) = self.create_gen_and_send_envelopes_with_http_info(account_id, **kwargs)
return data
- def create_recipient_manual_review_view_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs):
+ def create_gen_and_send_envelopes_with_http_info(self, account_id, **kwargs):
"""
- Provides a link to access the Identity manual review related to a recipient.
- This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
+ Generates the documents for an envelope using DocuSign Spring CM then creates the envelope.
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.create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function)
+ >>> thread = api.create_gen_and_send_envelopes_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 str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :param str recipient_id: The ID of the recipient being accessed. (required)
- :return: ViewUrl
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: EnvelopeSummary
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'envelope_id', 'recipient_id']
+ all_params = ['account_id', 'envelope_gen_and_send']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2518,31 +2593,21 @@ def create_recipient_manual_review_view_with_http_info(self, account_id, envelop
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method create_recipient_manual_review_view" % key
+ " to method create_gen_and_send_envelopes" % 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 `create_recipient_manual_review_view`")
- # verify the required parameter 'envelope_id' is set
- if ('envelope_id' not in params) or (params['envelope_id'] is None):
- raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient_manual_review_view`")
- # 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 `create_recipient_manual_review_view`")
+ raise ValueError("Missing the required parameter `account_id` when calling `create_gen_and_send_envelopes`")
collection_formats = {}
- resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review'.replace('{format}', 'json')
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/generate_and_send'.replace('{format}', 'json')
path_params = {}
if 'account_id' in params:
path_params['accountId'] = params['account_id']
- if 'envelope_id' in params:
- path_params['envelopeId'] = params['envelope_id']
- if 'recipient_id' in params:
- path_params['recipientId'] = params['recipient_id']
query_params = {}
@@ -2552,6 +2617,8 @@ def create_recipient_manual_review_view_with_http_info(self, account_id, envelop
local_var_files = {}
body_params = None
+ if 'envelope_gen_and_send' in params:
+ body_params = params['envelope_gen_and_send']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.\
select_header_accept(['application/json'])
@@ -2566,7 +2633,7 @@ def create_recipient_manual_review_view_with_http_info(self, account_id, envelop
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='ViewUrl',
+ response_type='EnvelopeSummary',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -2574,57 +2641,53 @@ def create_recipient_manual_review_view_with_http_info(self, account_id, envelop
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def create_recipient_proof_file_link(self, account_id, envelope_id, recipient_id, **kwargs):
+ def create_historical_envelope_publish_transaction(self, account_id, **kwargs):
"""
- Returns a link to access to the identity events stored in the proof service related to this recipient.
-
+ Submits a batch of historical envelopes for republish to an adhoc config.
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.create_recipient_proof_file_link(account_id, envelope_id, recipient_id, callback=callback_function)
+ >>> thread = api.create_historical_envelope_publish_transaction(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 str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :param str recipient_id: The ID of the recipient being accessed. (required)
- :return: IdEvidenceViewLink
+ :param ConnectHistoricalEnvelopeRepublish connect_historical_envelope_republish:
+ :return: EnvelopePublishTransaction
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+ return self.create_historical_envelope_publish_transaction_with_http_info(account_id, **kwargs)
else:
- (data) = self.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+ (data) = self.create_historical_envelope_publish_transaction_with_http_info(account_id, **kwargs)
return data
- def create_recipient_proof_file_link_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs):
+ def create_historical_envelope_publish_transaction_with_http_info(self, account_id, **kwargs):
"""
- Returns a link to access to the identity events stored in the proof service related to this recipient.
-
+ Submits a batch of historical envelopes for republish to an adhoc config.
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.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, callback=callback_function)
+ >>> thread = api.create_historical_envelope_publish_transaction_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 str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :param str recipient_id: The ID of the recipient being accessed. (required)
- :return: IdEvidenceViewLink
+ :param ConnectHistoricalEnvelopeRepublish connect_historical_envelope_republish:
+ :return: EnvelopePublishTransaction
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'envelope_id', 'recipient_id']
+ all_params = ['account_id', 'connect_historical_envelope_republish']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2635,31 +2698,601 @@ def create_recipient_proof_file_link_with_http_info(self, account_id, envelope_i
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method create_recipient_proof_file_link" % key
+ " to method create_historical_envelope_publish_transaction" % 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 `create_recipient_proof_file_link`")
- # verify the required parameter 'envelope_id' is set
- if ('envelope_id' not in params) or (params['envelope_id'] is None):
- raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient_proof_file_link`")
- # 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 `create_recipient_proof_file_link`")
+ raise ValueError("Missing the required parameter `account_id` when calling `create_historical_envelope_publish_transaction`")
collection_formats = {}
- resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof'.replace('{format}', 'json')
+ resource_path = '/v2.1/accounts/{accountId}/connect/envelopes/publish/historical'.replace('{format}', 'json')
path_params = {}
if 'account_id' in params:
path_params['accountId'] = params['account_id']
- if 'envelope_id' in params:
- path_params['envelopeId'] = params['envelope_id']
- if 'recipient_id' in params:
- path_params['recipientId'] = params['recipient_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'connect_historical_envelope_republish' in params:
+ body_params = params['connect_historical_envelope_republish']
+ # 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, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='EnvelopePublishTransaction',
+ 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 create_link_metadata_envelopes(self, account_id, envelope_id, **kwargs):
+ """
+ Add metadata in the form of GenAndSend to existing envelopes in docusign.
+ 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.create_link_metadata_envelopes(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: EnvelopeSummary
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.create_link_metadata_envelopes_with_http_info(account_id, envelope_id, **kwargs)
+ else:
+ (data) = self.create_link_metadata_envelopes_with_http_info(account_id, envelope_id, **kwargs)
+ return data
+
+ def create_link_metadata_envelopes_with_http_info(self, account_id, envelope_id, **kwargs):
+ """
+ Add metadata in the form of GenAndSend to existing envelopes in docusign.
+ 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.create_link_metadata_envelopes_with_http_info(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param EnvelopeGenAndSend envelope_gen_and_send:
+ :return: EnvelopeSummary
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id', 'envelope_gen_and_send']
+ 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 create_link_metadata_envelopes" % 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 `create_link_metadata_envelopes`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `create_link_metadata_envelopes`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/archive_metadata'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'envelope_gen_and_send' in params:
+ body_params = params['envelope_gen_and_send']
+ # 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, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='EnvelopeSummary',
+ 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 create_lock(self, account_id, envelope_id, **kwargs):
+ """
+ Lock an envelope.
+ Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
+ 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.create_lock(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param LockRequest lock_request:
+ :return: LockInformation
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.create_lock_with_http_info(account_id, envelope_id, **kwargs)
+ else:
+ (data) = self.create_lock_with_http_info(account_id, envelope_id, **kwargs)
+ return data
+
+ def create_lock_with_http_info(self, account_id, envelope_id, **kwargs):
+ """
+ Lock an envelope.
+ Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
+ 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.create_lock_with_http_info(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param LockRequest lock_request:
+ :return: LockInformation
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id', 'lock_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 create_lock" % 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 `create_lock`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `create_lock`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'lock_request' in params:
+ body_params = params['lock_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, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='LockInformation',
+ 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 create_recipient(self, account_id, envelope_id, **kwargs):
+ """
+ Adds one or more recipients to an envelope.
+ Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
+ 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.create_recipient(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param str resend_envelope: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.
+ :param Recipients recipients:
+ :return: Recipients
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.create_recipient_with_http_info(account_id, envelope_id, **kwargs)
+ else:
+ (data) = self.create_recipient_with_http_info(account_id, envelope_id, **kwargs)
+ return data
+
+ def create_recipient_with_http_info(self, account_id, envelope_id, **kwargs):
+ """
+ Adds one or more recipients to an envelope.
+ Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to **true**.
+ 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.create_recipient_with_http_info(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param str resend_envelope: When set to **true**, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.
+ :param Recipients recipients:
+ :return: Recipients
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id', 'resend_envelope', 'recipients']
+ 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 create_recipient" % 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 `create_recipient`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+
+ query_params = {}
+ if 'resend_envelope' in params:
+ query_params['resend_envelope'] = params['resend_envelope']
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'recipients' in params:
+ body_params = params['recipients']
+ # 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, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='Recipients',
+ 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 create_recipient_manual_review_view(self, account_id, envelope_id, recipient_id, **kwargs):
+ """
+ Provides a link to access the Identity manual review related to a recipient.
+ This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
+ 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.create_recipient_manual_review_view(account_id, envelope_id, recipient_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param str recipient_id: The ID of the recipient being accessed. (required)
+ :return: ViewUrl
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+ else:
+ (data) = self.create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+ return data
+
+ def create_recipient_manual_review_view_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs):
+ """
+ Provides a link to access the Identity manual review related to a recipient.
+ This method returns the URL of the page that allows a sender to [manually review](https://support.docusign.com/en/guides/ndse-user-guide-send-documents-with-id-verification) the ID of a recipient.
+ 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.create_recipient_manual_review_view_with_http_info(account_id, envelope_id, recipient_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param str recipient_id: The ID of the recipient being accessed. (required)
+ :return: ViewUrl
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id', 'recipient_id']
+ 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 create_recipient_manual_review_view" % 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 `create_recipient_manual_review_view`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient_manual_review_view`")
+ # 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 `create_recipient_manual_review_view`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+ if 'recipient_id' in params:
+ path_params['recipientId'] = params['recipient_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # 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, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='ViewUrl',
+ 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 create_recipient_proof_file_link(self, account_id, envelope_id, recipient_id, **kwargs):
+ """
+ Returns a link to access to the identity events stored in the proof service related to this recipient.
+
+ 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.create_recipient_proof_file_link(account_id, envelope_id, recipient_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param str recipient_id: The ID of the recipient being accessed. (required)
+ :return: IdEvidenceViewLink
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+ else:
+ (data) = self.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_id, **kwargs)
+ return data
+
+ def create_recipient_proof_file_link_with_http_info(self, account_id, envelope_id, recipient_id, **kwargs):
+ """
+ Returns a link to access to the identity events stored in the proof service related to this recipient.
+
+ 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.create_recipient_proof_file_link_with_http_info(account_id, envelope_id, recipient_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param str recipient_id: The ID of the recipient being accessed. (required)
+ :return: IdEvidenceViewLink
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id', 'recipient_id']
+ 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 create_recipient_proof_file_link" % 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 `create_recipient_proof_file_link`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `create_recipient_proof_file_link`")
+ # 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 `create_recipient_proof_file_link`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+ if 'recipient_id' in params:
+ path_params['recipientId'] = params['recipient_id']
query_params = {}
@@ -6248,6 +6881,114 @@ def delete_templates_from_document_with_http_info(self, account_id, document_id,
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
+ def get_archive_document(self, account_id, document_id, **kwargs):
+ """
+ Return generated html document from archive.
+ 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.get_archive_document(account_id, document_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 document_id: The ID of the document being accessed. (required)
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_archive_document_with_http_info(account_id, document_id, **kwargs)
+ else:
+ (data) = self.get_archive_document_with_http_info(account_id, document_id, **kwargs)
+ return data
+
+ def get_archive_document_with_http_info(self, account_id, document_id, **kwargs):
+ """
+ Return generated html document from archive.
+ 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.get_archive_document_with_http_info(account_id, document_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 document_id: The ID of the document being accessed. (required)
+ :return: file
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'document_id']
+ 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 get_archive_document" % 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 `get_archive_document`")
+ # verify the required parameter 'document_id' is set
+ if ('document_id' not in params) or (params['document_id'] is None):
+ raise ValueError("Missing the required parameter `document_id` when calling `get_archive_document`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/archivedocuments/{documentId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'document_id' in params:
+ path_params['documentId'] = params['document_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # HTTP header `Accept`
+ header_params['Accept'] = self.api_client.\
+ select_header_accept(['text/plain'])
+
+ # Authentication setting
+ auth_settings = []
+
+ return self.api_client.call_api(resource_path, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='file',
+ 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 get_attachment(self, account_id, attachment_id, envelope_id, **kwargs):
"""
Retrieves an attachment from the envelope.
@@ -7792,10 +8533,127 @@ def get_envelope_doc_gen_form_fields_with_http_info(self, account_id, envelope_i
collection_formats = {}
- resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields'.replace('{format}', 'json')
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # 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, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='DocGenFormFieldResponse',
+ 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 get_envelope_document_html_definitions(self, account_id, document_id, envelope_id, **kwargs):
+ """
+ Get the Original HTML Definition used to generate the Responsive HTML for a given document.
+
+ 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.get_envelope_document_html_definitions(account_id, document_id, envelope_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 document_id: The ID of the document being accessed. (required)
+ :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :return: DocumentHtmlDefinitionOriginals
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs)
+ else:
+ (data) = self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs)
+ return data
+
+ def get_envelope_document_html_definitions_with_http_info(self, account_id, document_id, envelope_id, **kwargs):
+ """
+ Get the Original HTML Definition used to generate the Responsive HTML for a given document.
+
+ 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.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_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 document_id: The ID of the document being accessed. (required)
+ :param str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :return: DocumentHtmlDefinitionOriginals
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'document_id', 'envelope_id']
+ 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 get_envelope_document_html_definitions" % 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 `get_envelope_document_html_definitions`")
+ # verify the required parameter 'document_id' is set
+ if ('document_id' not in params) or (params['document_id'] is None):
+ raise ValueError("Missing the required parameter `document_id` when calling `get_envelope_document_html_definitions`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_document_html_definitions`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions'.replace('{format}', 'json')
path_params = {}
if 'account_id' in params:
path_params['accountId'] = params['account_id']
+ if 'document_id' in params:
+ path_params['documentId'] = params['document_id']
if 'envelope_id' in params:
path_params['envelopeId'] = params['envelope_id']
@@ -7821,7 +8679,7 @@ def get_envelope_doc_gen_form_fields_with_http_info(self, account_id, envelope_i
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='DocGenFormFieldResponse',
+ response_type='DocumentHtmlDefinitionOriginals',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -7829,9 +8687,9 @@ def get_envelope_doc_gen_form_fields_with_http_info(self, account_id, envelope_i
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_envelope_document_html_definitions(self, account_id, document_id, envelope_id, **kwargs):
+ def get_envelope_html_definitions(self, account_id, envelope_id, **kwargs):
"""
- Get the Original HTML Definition used to generate the Responsive HTML for a given document.
+ Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -7839,12 +8697,11 @@ def get_envelope_document_html_definitions(self, account_id, document_id, envelo
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_envelope_document_html_definitions(account_id, document_id, envelope_id, callback=callback_function)
+ >>> thread = api.get_envelope_html_definitions(account_id, envelope_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 document_id: The ID of the document being accessed. (required)
:param str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
:return: DocumentHtmlDefinitionOriginals
If the method is called asynchronously,
@@ -7852,14 +8709,14 @@ def get_envelope_document_html_definitions(self, account_id, document_id, envelo
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs)
+ return self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs)
else:
- (data) = self.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, **kwargs)
+ (data) = self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs)
return data
- def get_envelope_document_html_definitions_with_http_info(self, account_id, document_id, envelope_id, **kwargs):
+ def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, **kwargs):
"""
- Get the Original HTML Definition used to generate the Responsive HTML for a given document.
+ Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please define a `callback` function
@@ -7867,19 +8724,18 @@ def get_envelope_document_html_definitions_with_http_info(self, account_id, docu
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.get_envelope_document_html_definitions_with_http_info(account_id, document_id, envelope_id, callback=callback_function)
+ >>> thread = api.get_envelope_html_definitions_with_http_info(account_id, envelope_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 document_id: The ID of the document being accessed. (required)
:param str envelope_id: The envelopeId Guid of the envelope being accessed. (required)
:return: DocumentHtmlDefinitionOriginals
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'document_id', 'envelope_id']
+ all_params = ['account_id', 'envelope_id']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -7890,29 +8746,24 @@ def get_envelope_document_html_definitions_with_http_info(self, account_id, docu
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_envelope_document_html_definitions" % key
+ " to method get_envelope_html_definitions" % 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 `get_envelope_document_html_definitions`")
- # verify the required parameter 'document_id' is set
- if ('document_id' not in params) or (params['document_id'] is None):
- raise ValueError("Missing the required parameter `document_id` when calling `get_envelope_document_html_definitions`")
+ raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_html_definitions`")
# verify the required parameter 'envelope_id' is set
if ('envelope_id' not in params) or (params['envelope_id'] is None):
- raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_document_html_definitions`")
+ raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_html_definitions`")
collection_formats = {}
- resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions'.replace('{format}', 'json')
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions'.replace('{format}', 'json')
path_params = {}
if 'account_id' in params:
path_params['accountId'] = params['account_id']
- if 'document_id' in params:
- path_params['documentId'] = params['document_id']
if 'envelope_id' in params:
path_params['envelopeId'] = params['envelope_id']
@@ -7946,50 +8797,48 @@ def get_envelope_document_html_definitions_with_http_info(self, account_id, docu
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def get_envelope_html_definitions(self, account_id, envelope_id, **kwargs):
+ def get_envelope_permission(self, account_id, envelope_id, **kwargs):
"""
- Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
-
+ Gets the permission level the calling user has for an envelope
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.get_envelope_html_definitions(account_id, envelope_id, callback=callback_function)
+ >>> thread = api.get_envelope_permission(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :return: DocumentHtmlDefinitionOriginals
+ :return: EnvelopesSharePermissionResponse
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs)
+ return self.get_envelope_permission_with_http_info(account_id, envelope_id, **kwargs)
else:
- (data) = self.get_envelope_html_definitions_with_http_info(account_id, envelope_id, **kwargs)
+ (data) = self.get_envelope_permission_with_http_info(account_id, envelope_id, **kwargs)
return data
- def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id, **kwargs):
+ def get_envelope_permission_with_http_info(self, account_id, envelope_id, **kwargs):
"""
- Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
-
+ Gets the permission level the calling user has for an envelope
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.get_envelope_html_definitions_with_http_info(account_id, envelope_id, callback=callback_function)
+ >>> thread = api.get_envelope_permission_with_http_info(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
- :return: DocumentHtmlDefinitionOriginals
+ :return: EnvelopesSharePermissionResponse
If the method is called asynchronously,
returns the request thread.
"""
@@ -8005,21 +8854,21 @@ def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id,
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method get_envelope_html_definitions" % key
+ " to method get_envelope_permission" % 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 `get_envelope_html_definitions`")
+ raise ValueError("Missing the required parameter `account_id` when calling `get_envelope_permission`")
# verify the required parameter 'envelope_id' is set
if ('envelope_id' not in params) or (params['envelope_id'] is None):
- raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_html_definitions`")
+ raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelope_permission`")
collection_formats = {}
- resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions'.replace('{format}', 'json')
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/permission'.replace('{format}', 'json')
path_params = {}
if 'account_id' in params:
path_params['accountId'] = params['account_id']
@@ -8048,7 +8897,7 @@ def get_envelope_html_definitions_with_http_info(self, account_id, envelope_id,
body=body_params,
post_params=form_params,
files=local_var_files,
- response_type='DocumentHtmlDefinitionOriginals',
+ response_type='EnvelopesSharePermissionResponse',
auth_settings=auth_settings,
callback=params.get('callback'),
_return_http_data_only=params.get('_return_http_data_only'),
@@ -8500,6 +9349,229 @@ def get_envelope_workflow_step_definition_with_http_info(self, account_id, envel
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
+ def get_envelopes_share(self, account_id, envelope_id, share_id, **kwargs):
+ """
+ Gets a single envelope share by shareId
+ 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.get_envelopes_share(account_id, envelope_id, share_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param str share_id: (required)
+ :return: EnvelopesShareResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_envelopes_share_with_http_info(account_id, envelope_id, share_id, **kwargs)
+ else:
+ (data) = self.get_envelopes_share_with_http_info(account_id, envelope_id, share_id, **kwargs)
+ return data
+
+ def get_envelopes_share_with_http_info(self, account_id, envelope_id, share_id, **kwargs):
+ """
+ Gets a single envelope share by shareId
+ 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.get_envelopes_share_with_http_info(account_id, envelope_id, share_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :param str share_id: (required)
+ :return: EnvelopesShareResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id', 'share_id']
+ 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 get_envelopes_share" % 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 `get_envelopes_share`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelopes_share`")
+ # verify the required parameter 'share_id' is set
+ if ('share_id' not in params) or (params['share_id'] is None):
+ raise ValueError("Missing the required parameter `share_id` when calling `get_envelopes_share`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+ if 'share_id' in params:
+ path_params['shareId'] = params['share_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # 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, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='EnvelopesShareResponse',
+ 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 get_envelopes_shares(self, account_id, envelope_id, **kwargs):
+ """
+ Gets all shares for an envelope
+ 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.get_envelopes_shares(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :return: EnvelopesSharesResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_envelopes_shares_with_http_info(account_id, envelope_id, **kwargs)
+ else:
+ (data) = self.get_envelopes_shares_with_http_info(account_id, envelope_id, **kwargs)
+ return data
+
+ def get_envelopes_shares_with_http_info(self, account_id, envelope_id, **kwargs):
+ """
+ Gets all shares for an envelope
+ 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.get_envelopes_shares_with_http_info(account_id, envelope_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 envelope_id: The envelopeId Guid of the envelope being accessed. (required)
+ :return: EnvelopesSharesResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id']
+ 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 get_envelopes_shares" % 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 `get_envelopes_shares`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `get_envelopes_shares`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # 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, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='EnvelopesSharesResponse',
+ 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 get_form_data(self, account_id, envelope_id, **kwargs):
"""
Returns envelope form data for an existing envelope.
diff --git a/docusign_esign/apis/insights_api.py b/docusign_esign/apis/insights_api.py
new file mode 100644
index 0000000..ae2bd90
--- /dev/null
+++ b/docusign_esign/apis/insights_api.py
@@ -0,0 +1,383 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+from __future__ import absolute_import
+
+import sys
+import os
+import re
+
+# python 2 and python 3 compatibility library
+from six import iteritems
+
+from ..client.configuration import Configuration
+from ..client.api_client import ApiClient
+
+
+class InsightsApi(object):
+ """
+ NOTE: This class is auto generated by the swagger code generator program.
+ Do not edit the class manually.
+ Ref: https://github.com/swagger-api/swagger-codegen
+ """
+
+ def __init__(self, api_client=None):
+ config = Configuration()
+ if api_client:
+ self.api_client = api_client
+ else:
+ if not config.api_client:
+ config.api_client = ApiClient()
+ self.api_client = config.api_client
+
+ def create_recommendations_intent(self, account_id, envelope_id, type, **kwargs):
+ """
+ Sets recommendations for an envelope
+ 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.create_recommendations_intent(account_id, envelope_id, type, 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 type: (required)
+ :param RecommendationsListRequest recommendations_list_request:
+ :return: RecommendationsListResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.create_recommendations_intent_with_http_info(account_id, envelope_id, type, **kwargs)
+ else:
+ (data) = self.create_recommendations_intent_with_http_info(account_id, envelope_id, type, **kwargs)
+ return data
+
+ def create_recommendations_intent_with_http_info(self, account_id, envelope_id, type, **kwargs):
+ """
+ Sets recommendations for an envelope
+ 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.create_recommendations_intent_with_http_info(account_id, envelope_id, type, 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 type: (required)
+ :param RecommendationsListRequest recommendations_list_request:
+ :return: RecommendationsListResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id', 'type', 'recommendations_list_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 create_recommendations_intent" % 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 `create_recommendations_intent`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `create_recommendations_intent`")
+ # verify the required parameter 'type' is set
+ if ('type' not in params) or (params['type'] is None):
+ raise ValueError("Missing the required parameter `type` when calling `create_recommendations_intent`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/recommendations/{type}/{envelopeId}/intent'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+ if 'type' in params:
+ path_params['type'] = params['type']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ if 'recommendations_list_request' in params:
+ body_params = params['recommendations_list_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, 'POST',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='RecommendationsListResponse',
+ 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 get_recommendations_intent(self, account_id, envelope_id, type, **kwargs):
+ """
+ Gets Recommendations associated with an envelope
+ 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.get_recommendations_intent(account_id, envelope_id, type, 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 type: (required)
+ :return: RecommendationsListResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_recommendations_intent_with_http_info(account_id, envelope_id, type, **kwargs)
+ else:
+ (data) = self.get_recommendations_intent_with_http_info(account_id, envelope_id, type, **kwargs)
+ return data
+
+ def get_recommendations_intent_with_http_info(self, account_id, envelope_id, type, **kwargs):
+ """
+ Gets Recommendations associated with an envelope
+ 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.get_recommendations_intent_with_http_info(account_id, envelope_id, type, 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 type: (required)
+ :return: RecommendationsListResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'envelope_id', 'type']
+ 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 get_recommendations_intent" % 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 `get_recommendations_intent`")
+ # verify the required parameter 'envelope_id' is set
+ if ('envelope_id' not in params) or (params['envelope_id'] is None):
+ raise ValueError("Missing the required parameter `envelope_id` when calling `get_recommendations_intent`")
+ # verify the required parameter 'type' is set
+ if ('type' not in params) or (params['type'] is None):
+ raise ValueError("Missing the required parameter `type` when calling `get_recommendations_intent`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/recommendations/{type}/{envelopeId}/intent'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'envelope_id' in params:
+ path_params['envelopeId'] = params['envelope_id']
+ if 'type' in params:
+ path_params['type'] = params['type']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # 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, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='RecommendationsListResponse',
+ 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 get_recommendations_list(self, account_id, type, **kwargs):
+ """
+ Gets available Recommendations
+ 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.get_recommendations_list(account_id, type, 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 type: (required)
+ :return: RecommendationsListResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_recommendations_list_with_http_info(account_id, type, **kwargs)
+ else:
+ (data) = self.get_recommendations_list_with_http_info(account_id, type, **kwargs)
+ return data
+
+ def get_recommendations_list_with_http_info(self, account_id, type, **kwargs):
+ """
+ Gets available Recommendations
+ 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.get_recommendations_list_with_http_info(account_id, type, 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 type: (required)
+ :return: RecommendationsListResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'type']
+ 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 get_recommendations_list" % 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 `get_recommendations_list`")
+ # verify the required parameter 'type' is set
+ if ('type' not in params) or (params['type'] is None):
+ raise ValueError("Missing the required parameter `type` when calling `get_recommendations_list`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/recommendations/{type}'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'type' in params:
+ path_params['type'] = params['type']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # 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, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='RecommendationsListResponse',
+ 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)
diff --git a/docusign_esign/apis/templates_api.py b/docusign_esign/apis/templates_api.py
index c1ea16c..9a3c9be 100644
--- a/docusign_esign/apis/templates_api.py
+++ b/docusign_esign/apis/templates_api.py
@@ -2525,6 +2525,7 @@ def get(self, account_id, template_id, **kwargs):
:param str account_id: The external account number (int) or account ID Guid. (required)
:param str template_id: The ID of the template being accessed. (required)
:param str include:
+ :param str link_configuration_id:
:return: EnvelopeTemplate
If the method is called asynchronously,
returns the request thread.
@@ -2553,12 +2554,13 @@ def get_with_http_info(self, account_id, template_id, **kwargs):
:param str account_id: The external account number (int) or account ID Guid. (required)
:param str template_id: The ID of the template being accessed. (required)
:param str include:
+ :param str link_configuration_id:
:return: EnvelopeTemplate
If the method is called asynchronously,
returns the request thread.
"""
- all_params = ['account_id', 'template_id', 'include']
+ all_params = ['account_id', 'template_id', 'include', 'link_configuration_id']
all_params.append('callback')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
@@ -2593,6 +2595,8 @@ def get_with_http_info(self, account_id, template_id, **kwargs):
query_params = {}
if 'include' in params:
query_params['include'] = params['include']
+ if 'link_configuration_id' in params:
+ query_params['link_configuration_id'] = params['link_configuration_id']
header_params = {}
@@ -2622,6 +2626,215 @@ def get_with_http_info(self, account_id, template_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
+ def get_completion_rate_for_template(self, account_id, template_id, **kwargs):
+ """
+ Gets completion rate for the template
+ 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.get_completion_rate_for_template(account_id, template_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 template_id: The ID of the template being accessed. (required)
+ :return: TemplateCompletionRateResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_completion_rate_for_template_with_http_info(account_id, template_id, **kwargs)
+ else:
+ (data) = self.get_completion_rate_for_template_with_http_info(account_id, template_id, **kwargs)
+ return data
+
+ def get_completion_rate_for_template_with_http_info(self, account_id, template_id, **kwargs):
+ """
+ Gets completion rate for the template
+ 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.get_completion_rate_for_template_with_http_info(account_id, template_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 template_id: The ID of the template being accessed. (required)
+ :return: TemplateCompletionRateResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id', 'template_id']
+ 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 get_completion_rate_for_template" % 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 `get_completion_rate_for_template`")
+ # verify the required parameter 'template_id' is set
+ if ('template_id' not in params) or (params['template_id'] is None):
+ raise ValueError("Missing the required parameter `template_id` when calling `get_completion_rate_for_template`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/templates/{templateId}/insights/completionRate'.replace('{format}', 'json')
+ path_params = {}
+ if 'account_id' in params:
+ path_params['accountId'] = params['account_id']
+ if 'template_id' in params:
+ path_params['templateId'] = params['template_id']
+
+ query_params = {}
+
+ header_params = {}
+
+ form_params = []
+ local_var_files = {}
+
+ body_params = None
+ # 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, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='TemplateCompletionRateResponse',
+ 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 get_completion_rate_for_template_owner(self, account_id, **kwargs):
+ """
+ Gets completion rate for the user
+ 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.get_completion_rate_for_template_owner(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)
+ :return: UserCompletionRateResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+ kwargs['_return_http_data_only'] = True
+ if kwargs.get('callback'):
+ return self.get_completion_rate_for_template_owner_with_http_info(account_id, **kwargs)
+ else:
+ (data) = self.get_completion_rate_for_template_owner_with_http_info(account_id, **kwargs)
+ return data
+
+ def get_completion_rate_for_template_owner_with_http_info(self, account_id, **kwargs):
+ """
+ Gets completion rate for the user
+ 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.get_completion_rate_for_template_owner_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)
+ :return: UserCompletionRateResponse
+ If the method is called asynchronously,
+ returns the request thread.
+ """
+
+ all_params = ['account_id']
+ 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 get_completion_rate_for_template_owner" % 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 `get_completion_rate_for_template_owner`")
+
+
+ collection_formats = {}
+
+ resource_path = '/v2.1/accounts/{accountId}/templates/insights/completionRate'.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
+ # 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, 'GET',
+ path_params,
+ query_params,
+ header_params,
+ body=body_params,
+ post_params=form_params,
+ files=local_var_files,
+ response_type='UserCompletionRateResponse',
+ 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 get_document(self, account_id, document_id, template_id, **kwargs):
"""
Gets PDF documents from a template.
@@ -5948,7 +6161,7 @@ def update_template_document_tabs_with_http_info(self, account_id, document_id,
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def update_templates(self, account_id, **kwargs):
+ 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
@@ -5957,7 +6170,7 @@ def update_templates(self, account_id, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.update_templates(account_id, callback=callback_function)
+ >>> thread = api.update_templates_auto_match(account_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
@@ -5969,12 +6182,12 @@ def update_templates(self, account_id, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.update_templates_with_http_info(account_id, **kwargs)
+ return self.update_templates_auto_match_with_http_info(account_id, **kwargs)
else:
- (data) = self.update_templates_with_http_info(account_id, **kwargs)
+ (data) = self.update_templates_auto_match_with_http_info(account_id, **kwargs)
return data
- def update_templates_with_http_info(self, account_id, **kwargs):
+ 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
@@ -5983,7 +6196,7 @@ def update_templates_with_http_info(self, account_id, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.update_templates_with_http_info(account_id, callback=callback_function)
+ >>> thread = api.update_templates_auto_match_with_http_info(account_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
@@ -6005,13 +6218,13 @@ def update_templates_with_http_info(self, account_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method update_templates" % key
+ " 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`")
+ raise ValueError("Missing the required parameter `account_id` when calling `update_templates_auto_match`")
collection_formats = {}
@@ -6053,7 +6266,7 @@ def update_templates_with_http_info(self, account_id, **kwargs):
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
- def update_templates_auto_match(self, account_id, **kwargs):
+ def update_templates_auto_match_0(self, account_id, **kwargs):
"""
Update template autoMatch setting.
This method makes a synchronous HTTP request by default. To make an
@@ -6062,7 +6275,7 @@ def update_templates_auto_match(self, account_id, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.update_templates_auto_match(account_id, callback=callback_function)
+ >>> thread = api.update_templates_auto_match_0(account_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
@@ -6074,12 +6287,12 @@ def update_templates_auto_match(self, account_id, **kwargs):
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('callback'):
- return self.update_templates_auto_match_with_http_info(account_id, **kwargs)
+ return self.update_templates_auto_match_0_with_http_info(account_id, **kwargs)
else:
- (data) = self.update_templates_auto_match_with_http_info(account_id, **kwargs)
+ (data) = self.update_templates_auto_match_0_with_http_info(account_id, **kwargs)
return data
- def update_templates_auto_match_with_http_info(self, account_id, **kwargs):
+ def update_templates_auto_match_0_with_http_info(self, account_id, **kwargs):
"""
Update template autoMatch setting.
This method makes a synchronous HTTP request by default. To make an
@@ -6088,7 +6301,7 @@ def update_templates_auto_match_with_http_info(self, account_id, **kwargs):
>>> def callback_function(response):
>>> pprint(response)
>>>
- >>> thread = api.update_templates_auto_match_with_http_info(account_id, callback=callback_function)
+ >>> thread = api.update_templates_auto_match_0_with_http_info(account_id, callback=callback_function)
:param callback function: The callback function
for asynchronous request. (optional)
@@ -6110,13 +6323,13 @@ def update_templates_auto_match_with_http_info(self, account_id, **kwargs):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
- " to method update_templates_auto_match" % key
+ " to method update_templates_auto_match_0" % 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`")
+ raise ValueError("Missing the required parameter `account_id` when calling `update_templates_auto_match_0`")
collection_formats = {}
diff --git a/docusign_esign/client/configuration.py b/docusign_esign/client/configuration.py
index 7b2f5f1..4c65484 100644
--- a/docusign_esign/client/configuration.py
+++ b/docusign_esign/client/configuration.py
@@ -116,9 +116,9 @@ def __init__(self):
python_version = platform.python_version()
if six.PY3:
- self.user_agent = "Swagger-Codegen/v2.1/8.0.0rc1/python3/" + f"{python_version}"
+ self.user_agent = "Swagger-Codegen/v2.1/8.0.0/python3/" + f"{python_version}"
else:
- self.user_agent = "Swagger-Codegen/v2.1/8.0.0rc1/python2/" + f"{python_version}"
+ self.user_agent = "Swagger-Codegen/v2.1/8.0.0/python2/" + f"{python_version}"
@classmethod
@@ -274,5 +274,5 @@ def to_debug_report(self):
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: v2.1\n"\
- "SDK Package Version: 8.0.0rc1".\
+ "SDK Package Version: 8.0.0".\
format(env=sys.platform, pyversion=sys.version)
diff --git a/docusign_esign/models/__init__.py b/docusign_esign/models/__init__.py
index 574f53e..7b0dd84 100644
--- a/docusign_esign/models/__init__.py
+++ b/docusign_esign/models/__init__.py
@@ -62,6 +62,7 @@
from docusign_esign.models.authentication_method import AuthenticationMethod
from docusign_esign.models.authentication_status import AuthenticationStatus
from docusign_esign.models.authorization_user import AuthorizationUser
+from docusign_esign.models.authorized_signatory import AuthorizedSignatory
from docusign_esign.models.bcc_email_address import BccEmailAddress
from docusign_esign.models.bcc_email_archive import BccEmailArchive
from docusign_esign.models.bcc_email_archive_history import BccEmailArchiveHistory
@@ -197,6 +198,8 @@
from docusign_esign.models.diagnostics_settings_information import DiagnosticsSettingsInformation
from docusign_esign.models.direct_debit_processor_information import DirectDebitProcessorInformation
from docusign_esign.models.dob_information_input import DobInformationInput
+from docusign_esign.models.doc_gen_conditional_operation_base import DocGenConditionalOperationBase
+from docusign_esign.models.doc_gen_conditional_rule import DocGenConditionalRule
from docusign_esign.models.doc_gen_form_field import DocGenFormField
from docusign_esign.models.doc_gen_form_field_option import DocGenFormFieldOption
from docusign_esign.models.doc_gen_form_field_request import DocGenFormFieldRequest
@@ -230,6 +233,7 @@
from docusign_esign.models.email_address import EmailAddress
from docusign_esign.models.email_settings import EmailSettings
from docusign_esign.models.envelope import Envelope
+from docusign_esign.models.envelope_archive_summary import EnvelopeArchiveSummary
from docusign_esign.models.envelope_attachment import EnvelopeAttachment
from docusign_esign.models.envelope_attachments_request import EnvelopeAttachmentsRequest
from docusign_esign.models.envelope_attachments_result import EnvelopeAttachmentsResult
@@ -242,6 +246,8 @@
from docusign_esign.models.envelope_documents_result import EnvelopeDocumentsResult
from docusign_esign.models.envelope_event import EnvelopeEvent
from docusign_esign.models.envelope_form_data import EnvelopeFormData
+from docusign_esign.models.envelope_gen_and_send import EnvelopeGenAndSend
+from docusign_esign.models.envelope_gen_and_send_properties import EnvelopeGenAndSendProperties
from docusign_esign.models.envelope_id import EnvelopeId
from docusign_esign.models.envelope_ids_request import EnvelopeIdsRequest
from docusign_esign.models.envelope_metadata import EnvelopeMetadata
@@ -266,6 +272,7 @@
from docusign_esign.models.envelope_view_template_settings import EnvelopeViewTemplateSettings
from docusign_esign.models.envelopes_information import EnvelopesInformation
from docusign_esign.models.envelopes_share_permission_request import EnvelopesSharePermissionRequest
+from docusign_esign.models.envelopes_share_permission_response import EnvelopesSharePermissionResponse
from docusign_esign.models.envelopes_share_request import EnvelopesShareRequest
from docusign_esign.models.envelopes_share_response import EnvelopesShareResponse
from docusign_esign.models.envelopes_shares_request import EnvelopesSharesRequest
@@ -274,6 +281,8 @@
from docusign_esign.models.event_notification import EventNotification
from docusign_esign.models.event_result import EventResult
from docusign_esign.models.expirations import Expirations
+from docusign_esign.models.extend_payment_configuration import ExtendPaymentConfiguration
+from docusign_esign.models.extend_payment_line_item import ExtendPaymentLineItem
from docusign_esign.models.extension_data import ExtensionData
from docusign_esign.models.external_doc_service_error_details import ExternalDocServiceErrorDetails
from docusign_esign.models.external_document_sources import ExternalDocumentSources
@@ -299,6 +308,8 @@
from docusign_esign.models.form_data_item import FormDataItem
from docusign_esign.models.formula_tab import FormulaTab
from docusign_esign.models.full_name import FullName
+from docusign_esign.models.generated_document import GeneratedDocument
+from docusign_esign.models.generated_documents_result import GeneratedDocumentsResult
from docusign_esign.models.graphics_context import GraphicsContext
from docusign_esign.models.group import Group
from docusign_esign.models.group_information import GroupInformation
@@ -371,6 +382,7 @@
from docusign_esign.models.participant import Participant
from docusign_esign.models.path_extended_element import PathExtendedElement
from docusign_esign.models.pay_pal_legacy_settings import PayPalLegacySettings
+from docusign_esign.models.payment_audit_event import PaymentAuditEvent
from docusign_esign.models.payment_details import PaymentDetails
from docusign_esign.models.payment_gateway_account import PaymentGatewayAccount
from docusign_esign.models.payment_gateway_account_setting import PaymentGatewayAccountSetting
@@ -427,6 +439,9 @@
from docusign_esign.models.recipient_view_request import RecipientViewRequest
from docusign_esign.models.recipients import Recipients
from docusign_esign.models.recipients_update_summary import RecipientsUpdateSummary
+from docusign_esign.models.recommendation_info import RecommendationInfo
+from docusign_esign.models.recommendations_list_request import RecommendationsListRequest
+from docusign_esign.models.recommendations_list_response import RecommendationsListResponse
from docusign_esign.models.referral_information import ReferralInformation
from docusign_esign.models.reminders import Reminders
from docusign_esign.models.resource_information import ResourceInformation
diff --git a/docusign_esign/models/account_management_granular.py b/docusign_esign/models/account_management_granular.py
index d818c16..7a665b1 100644
--- a/docusign_esign/models/account_management_granular.py
+++ b/docusign_esign/models/account_management_granular.py
@@ -59,7 +59,8 @@ class AccountManagementGranular(object):
'allow_manage_stamps_metadata': 'SettingsMetadata',
'allow_manage_users': 'str',
'allow_manage_users_metadata': 'SettingsMetadata',
- 'allow_view_users': 'str'
+ 'allow_view_users': 'str',
+ 'view_only_account_admin_pages': 'str'
}
attribute_map = {
@@ -89,7 +90,8 @@ class AccountManagementGranular(object):
'allow_manage_stamps_metadata': 'allowManageStampsMetadata',
'allow_manage_users': 'allowManageUsers',
'allow_manage_users_metadata': 'allowManageUsersMetadata',
- 'allow_view_users': 'allowViewUsers'
+ 'allow_view_users': 'allowViewUsers',
+ 'view_only_account_admin_pages': 'viewOnlyAccountAdminPages'
}
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -125,6 +127,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._allow_manage_users = None
self._allow_manage_users_metadata = None
self._allow_view_users = None
+ self._view_only_account_admin_pages = None
self.discriminator = None
setattr(self, "_{}".format('allow_manage_account_security_settings'), kwargs.get('allow_manage_account_security_settings', None))
@@ -154,6 +157,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('allow_manage_users'), kwargs.get('allow_manage_users', None))
setattr(self, "_{}".format('allow_manage_users_metadata'), kwargs.get('allow_manage_users_metadata', None))
setattr(self, "_{}".format('allow_view_users'), kwargs.get('allow_view_users', None))
+ setattr(self, "_{}".format('view_only_account_admin_pages'), kwargs.get('view_only_account_admin_pages', None))
@property
def allow_manage_account_security_settings(self):
@@ -776,6 +780,29 @@ def allow_view_users(self, allow_view_users):
self._allow_view_users = allow_view_users
+ @property
+ def view_only_account_admin_pages(self):
+ """Gets the view_only_account_admin_pages of this AccountManagementGranular. # noqa: E501
+
+ # noqa: E501
+
+ :return: The view_only_account_admin_pages of this AccountManagementGranular. # noqa: E501
+ :rtype: str
+ """
+ return self._view_only_account_admin_pages
+
+ @view_only_account_admin_pages.setter
+ def view_only_account_admin_pages(self, view_only_account_admin_pages):
+ """Sets the view_only_account_admin_pages of this AccountManagementGranular.
+
+ # noqa: E501
+
+ :param view_only_account_admin_pages: The view_only_account_admin_pages of this AccountManagementGranular. # noqa: E501
+ :type: str
+ """
+
+ self._view_only_account_admin_pages = view_only_account_admin_pages
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/docusign_esign/models/account_settings_information.py b/docusign_esign/models/account_settings_information.py
index 54fe163..7659180 100644
--- a/docusign_esign/models/account_settings_information.py
+++ b/docusign_esign/models/account_settings_information.py
@@ -93,6 +93,7 @@ class AccountSettingsInformation(object):
'allow_connect_send_finish_later': 'str',
'allow_connect_send_finish_later_metadata': 'SettingsMetadata',
'allow_connect_unified_payload_ui': 'str',
+ 'allow_connect_workspace_upload_request_ui': 'str',
'allow_consumer_disclosure_override': 'str',
'allow_consumer_disclosure_override_metadata': 'SettingsMetadata',
'allow_data_download': 'str',
@@ -371,6 +372,8 @@ class AccountSettingsInformation(object):
'document_retention_purge_tabs': 'str',
'document_visibility': 'str',
'document_visibility_metadata': 'SettingsMetadata',
+ 'docusign_pdf': 'str',
+ 'docusign_pdf_metadata': 'SettingsMetadata',
'draft_envelope_retention': 'str',
'draft_envelope_retention_metadata': 'SettingsMetadata',
'dss_sign_28411_enable_leave_page_prompt_radmin_option': 'str',
@@ -399,6 +402,8 @@ class AccountSettingsInformation(object):
'enable_agreement_actions_for_e_sign_metadata': 'SettingsMetadata',
'enable_agreement_desk_advanced': 'str',
'enable_agreement_desk_advanced_meta_data': 'SettingsMetadata',
+ 'enable_ai_agents': 'str',
+ 'enable_ai_agents_metadata': 'SettingsMetadata',
'enable_ai_contract_review': 'str',
'enable_ai_contract_review_metadata': 'SettingsMetadata',
'enable_ai_sender_message': 'str',
@@ -481,6 +486,8 @@ class AccountSettingsInformation(object):
'enable_esign_communities_metadata': 'SettingsMetadata',
'enable_esign_task_list': 'str',
'enable_esign_task_list_metadata': 'SettingsMetadata',
+ 'enable_gen_and_api': 'str',
+ 'enable_gen_and_api_metadata': 'SettingsMetadata',
'enable_generation_with3_p_integration': 'str',
'enable_generation_with3_p_integration_meta_data': 'SettingsMetadata',
'enable_greenhouse_app': 'str',
@@ -489,6 +496,8 @@ class AccountSettingsInformation(object):
'enable_i9_on_demand_metadata': 'SettingsMetadata',
'enable_iam_clause_library': 'str',
'enable_iam_clause_library_metadata': 'SettingsMetadata',
+ 'enable_iam_data_connector': 'str',
+ 'enable_iam_data_connector_metadata': 'SettingsMetadata',
'enable_ia_mfor_x_embedded_ux': 'str',
'enable_ia_mfor_x_embedded_ux_metadata': 'SettingsMetadata',
'enable_id_fx_accountless_sms_auth_for_part11': 'str',
@@ -535,6 +544,7 @@ class AccountSettingsInformation(object):
'enable_notary_on_demand_witness_metadata': 'SettingsMetadata',
'enable_obligation_management': 'str',
'enable_obligation_management_metadata': 'SettingsMetadata',
+ 'enable_owner_insights_and_recommendations_setting_metadata': 'SettingsMetadata',
'enable_participant_recipient_setting_metadata': 'SettingsMetadata',
'enable_payment_processing': 'str',
'enable_payment_processing_metadata': 'SettingsMetadata',
@@ -568,6 +578,7 @@ class AccountSettingsInformation(object):
'enable_search_service_azure_uri_metadata': 'SettingsMetadata',
'enable_search_site_specific_api': 'str',
'enable_search_site_specific_api_metadata': 'SettingsMetadata',
+ 'enable_sender_insights_and_recommendations_setting_metadata': 'SettingsMetadata',
'enable_sending_tags_font_settings': 'str',
'enable_sending_tags_font_settings_metadata': 'SettingsMetadata',
'enable_send_to_agent': 'str',
@@ -958,6 +969,7 @@ class AccountSettingsInformation(object):
'allow_connect_send_finish_later': 'allowConnectSendFinishLater',
'allow_connect_send_finish_later_metadata': 'allowConnectSendFinishLaterMetadata',
'allow_connect_unified_payload_ui': 'allowConnectUnifiedPayloadUI',
+ 'allow_connect_workspace_upload_request_ui': 'allowConnectWorkspaceUploadRequestUI',
'allow_consumer_disclosure_override': 'allowConsumerDisclosureOverride',
'allow_consumer_disclosure_override_metadata': 'allowConsumerDisclosureOverrideMetadata',
'allow_data_download': 'allowDataDownload',
@@ -1236,6 +1248,8 @@ class AccountSettingsInformation(object):
'document_retention_purge_tabs': 'documentRetentionPurgeTabs',
'document_visibility': 'documentVisibility',
'document_visibility_metadata': 'documentVisibilityMetadata',
+ 'docusign_pdf': 'docusignPDF',
+ 'docusign_pdf_metadata': 'docusignPDFMetadata',
'draft_envelope_retention': 'draftEnvelopeRetention',
'draft_envelope_retention_metadata': 'draftEnvelopeRetentionMetadata',
'dss_sign_28411_enable_leave_page_prompt_radmin_option': 'dss_SIGN_28411_EnableLeavePagePrompt_RadminOption',
@@ -1264,6 +1278,8 @@ class AccountSettingsInformation(object):
'enable_agreement_actions_for_e_sign_metadata': 'enableAgreementActionsForESignMetadata',
'enable_agreement_desk_advanced': 'enableAgreementDeskAdvanced',
'enable_agreement_desk_advanced_meta_data': 'enableAgreementDeskAdvancedMetaData',
+ 'enable_ai_agents': 'enableAIAgents',
+ 'enable_ai_agents_metadata': 'enableAIAgentsMetadata',
'enable_ai_contract_review': 'enableAIContractReview',
'enable_ai_contract_review_metadata': 'enableAIContractReviewMetadata',
'enable_ai_sender_message': 'enableAISenderMessage',
@@ -1346,6 +1362,8 @@ class AccountSettingsInformation(object):
'enable_esign_communities_metadata': 'enableEsignCommunitiesMetadata',
'enable_esign_task_list': 'enableEsignTaskList',
'enable_esign_task_list_metadata': 'enableEsignTaskListMetadata',
+ 'enable_gen_and_api': 'enableGenAndAPI',
+ 'enable_gen_and_api_metadata': 'enableGenAndAPIMetadata',
'enable_generation_with3_p_integration': 'enableGenerationWith3PIntegration',
'enable_generation_with3_p_integration_meta_data': 'enableGenerationWith3PIntegrationMetaData',
'enable_greenhouse_app': 'enableGreenhouseApp',
@@ -1354,6 +1372,8 @@ class AccountSettingsInformation(object):
'enable_i9_on_demand_metadata': 'enableI9OnDemandMetadata',
'enable_iam_clause_library': 'enableIAMClauseLibrary',
'enable_iam_clause_library_metadata': 'enableIAMClauseLibraryMetadata',
+ 'enable_iam_data_connector': 'enableIAMDataConnector',
+ 'enable_iam_data_connector_metadata': 'enableIAMDataConnectorMetadata',
'enable_ia_mfor_x_embedded_ux': 'enableIAMforXEmbeddedUX',
'enable_ia_mfor_x_embedded_ux_metadata': 'enableIAMforXEmbeddedUXMetadata',
'enable_id_fx_accountless_sms_auth_for_part11': 'enableIDFxAccountlessSMSAuthForPart11',
@@ -1400,6 +1420,7 @@ class AccountSettingsInformation(object):
'enable_notary_on_demand_witness_metadata': 'enableNotaryOnDemandWitnessMetadata',
'enable_obligation_management': 'enableObligationManagement',
'enable_obligation_management_metadata': 'enableObligationManagementMetadata',
+ 'enable_owner_insights_and_recommendations_setting_metadata': 'enableOwnerInsightsAndRecommendationsSettingMetadata',
'enable_participant_recipient_setting_metadata': 'enableParticipantRecipientSettingMetadata',
'enable_payment_processing': 'enablePaymentProcessing',
'enable_payment_processing_metadata': 'enablePaymentProcessingMetadata',
@@ -1433,6 +1454,7 @@ class AccountSettingsInformation(object):
'enable_search_service_azure_uri_metadata': 'enableSearchServiceAzureUriMetadata',
'enable_search_site_specific_api': 'enableSearchSiteSpecificApi',
'enable_search_site_specific_api_metadata': 'enableSearchSiteSpecificApiMetadata',
+ 'enable_sender_insights_and_recommendations_setting_metadata': 'enableSenderInsightsAndRecommendationsSettingMetadata',
'enable_sending_tags_font_settings': 'enableSendingTagsFontSettings',
'enable_sending_tags_font_settings_metadata': 'enableSendingTagsFontSettingsMetadata',
'enable_send_to_agent': 'enableSendToAgent',
@@ -1828,6 +1850,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._allow_connect_send_finish_later = None
self._allow_connect_send_finish_later_metadata = None
self._allow_connect_unified_payload_ui = None
+ self._allow_connect_workspace_upload_request_ui = None
self._allow_consumer_disclosure_override = None
self._allow_consumer_disclosure_override_metadata = None
self._allow_data_download = None
@@ -2106,6 +2129,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._document_retention_purge_tabs = None
self._document_visibility = None
self._document_visibility_metadata = None
+ self._docusign_pdf = None
+ self._docusign_pdf_metadata = None
self._draft_envelope_retention = None
self._draft_envelope_retention_metadata = None
self._dss_sign_28411_enable_leave_page_prompt_radmin_option = None
@@ -2134,6 +2159,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._enable_agreement_actions_for_e_sign_metadata = None
self._enable_agreement_desk_advanced = None
self._enable_agreement_desk_advanced_meta_data = None
+ self._enable_ai_agents = None
+ self._enable_ai_agents_metadata = None
self._enable_ai_contract_review = None
self._enable_ai_contract_review_metadata = None
self._enable_ai_sender_message = None
@@ -2216,6 +2243,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._enable_esign_communities_metadata = None
self._enable_esign_task_list = None
self._enable_esign_task_list_metadata = None
+ self._enable_gen_and_api = None
+ self._enable_gen_and_api_metadata = None
self._enable_generation_with3_p_integration = None
self._enable_generation_with3_p_integration_meta_data = None
self._enable_greenhouse_app = None
@@ -2224,6 +2253,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._enable_i9_on_demand_metadata = None
self._enable_iam_clause_library = None
self._enable_iam_clause_library_metadata = None
+ self._enable_iam_data_connector = None
+ self._enable_iam_data_connector_metadata = None
self._enable_ia_mfor_x_embedded_ux = None
self._enable_ia_mfor_x_embedded_ux_metadata = None
self._enable_id_fx_accountless_sms_auth_for_part11 = None
@@ -2270,6 +2301,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._enable_notary_on_demand_witness_metadata = None
self._enable_obligation_management = None
self._enable_obligation_management_metadata = None
+ self._enable_owner_insights_and_recommendations_setting_metadata = None
self._enable_participant_recipient_setting_metadata = None
self._enable_payment_processing = None
self._enable_payment_processing_metadata = None
@@ -2303,6 +2335,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._enable_search_service_azure_uri_metadata = None
self._enable_search_site_specific_api = None
self._enable_search_site_specific_api_metadata = None
+ self._enable_sender_insights_and_recommendations_setting_metadata = None
self._enable_sending_tags_font_settings = None
self._enable_sending_tags_font_settings_metadata = None
self._enable_send_to_agent = None
@@ -2692,6 +2725,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('allow_connect_send_finish_later'), kwargs.get('allow_connect_send_finish_later', None))
setattr(self, "_{}".format('allow_connect_send_finish_later_metadata'), kwargs.get('allow_connect_send_finish_later_metadata', None))
setattr(self, "_{}".format('allow_connect_unified_payload_ui'), kwargs.get('allow_connect_unified_payload_ui', None))
+ setattr(self, "_{}".format('allow_connect_workspace_upload_request_ui'), kwargs.get('allow_connect_workspace_upload_request_ui', None))
setattr(self, "_{}".format('allow_consumer_disclosure_override'), kwargs.get('allow_consumer_disclosure_override', None))
setattr(self, "_{}".format('allow_consumer_disclosure_override_metadata'), kwargs.get('allow_consumer_disclosure_override_metadata', None))
setattr(self, "_{}".format('allow_data_download'), kwargs.get('allow_data_download', None))
@@ -2970,6 +3004,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('document_retention_purge_tabs'), kwargs.get('document_retention_purge_tabs', None))
setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None))
setattr(self, "_{}".format('document_visibility_metadata'), kwargs.get('document_visibility_metadata', None))
+ setattr(self, "_{}".format('docusign_pdf'), kwargs.get('docusign_pdf', None))
+ setattr(self, "_{}".format('docusign_pdf_metadata'), kwargs.get('docusign_pdf_metadata', None))
setattr(self, "_{}".format('draft_envelope_retention'), kwargs.get('draft_envelope_retention', None))
setattr(self, "_{}".format('draft_envelope_retention_metadata'), kwargs.get('draft_envelope_retention_metadata', None))
setattr(self, "_{}".format('dss_sign_28411_enable_leave_page_prompt_radmin_option'), kwargs.get('dss_sign_28411_enable_leave_page_prompt_radmin_option', None))
@@ -2998,6 +3034,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('enable_agreement_actions_for_e_sign_metadata'), kwargs.get('enable_agreement_actions_for_e_sign_metadata', None))
setattr(self, "_{}".format('enable_agreement_desk_advanced'), kwargs.get('enable_agreement_desk_advanced', None))
setattr(self, "_{}".format('enable_agreement_desk_advanced_meta_data'), kwargs.get('enable_agreement_desk_advanced_meta_data', None))
+ setattr(self, "_{}".format('enable_ai_agents'), kwargs.get('enable_ai_agents', None))
+ setattr(self, "_{}".format('enable_ai_agents_metadata'), kwargs.get('enable_ai_agents_metadata', None))
setattr(self, "_{}".format('enable_ai_contract_review'), kwargs.get('enable_ai_contract_review', None))
setattr(self, "_{}".format('enable_ai_contract_review_metadata'), kwargs.get('enable_ai_contract_review_metadata', None))
setattr(self, "_{}".format('enable_ai_sender_message'), kwargs.get('enable_ai_sender_message', None))
@@ -3080,6 +3118,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('enable_esign_communities_metadata'), kwargs.get('enable_esign_communities_metadata', None))
setattr(self, "_{}".format('enable_esign_task_list'), kwargs.get('enable_esign_task_list', None))
setattr(self, "_{}".format('enable_esign_task_list_metadata'), kwargs.get('enable_esign_task_list_metadata', None))
+ setattr(self, "_{}".format('enable_gen_and_api'), kwargs.get('enable_gen_and_api', None))
+ setattr(self, "_{}".format('enable_gen_and_api_metadata'), kwargs.get('enable_gen_and_api_metadata', None))
setattr(self, "_{}".format('enable_generation_with3_p_integration'), kwargs.get('enable_generation_with3_p_integration', None))
setattr(self, "_{}".format('enable_generation_with3_p_integration_meta_data'), kwargs.get('enable_generation_with3_p_integration_meta_data', None))
setattr(self, "_{}".format('enable_greenhouse_app'), kwargs.get('enable_greenhouse_app', None))
@@ -3088,6 +3128,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('enable_i9_on_demand_metadata'), kwargs.get('enable_i9_on_demand_metadata', None))
setattr(self, "_{}".format('enable_iam_clause_library'), kwargs.get('enable_iam_clause_library', None))
setattr(self, "_{}".format('enable_iam_clause_library_metadata'), kwargs.get('enable_iam_clause_library_metadata', None))
+ setattr(self, "_{}".format('enable_iam_data_connector'), kwargs.get('enable_iam_data_connector', None))
+ setattr(self, "_{}".format('enable_iam_data_connector_metadata'), kwargs.get('enable_iam_data_connector_metadata', None))
setattr(self, "_{}".format('enable_ia_mfor_x_embedded_ux'), kwargs.get('enable_ia_mfor_x_embedded_ux', None))
setattr(self, "_{}".format('enable_ia_mfor_x_embedded_ux_metadata'), kwargs.get('enable_ia_mfor_x_embedded_ux_metadata', None))
setattr(self, "_{}".format('enable_id_fx_accountless_sms_auth_for_part11'), kwargs.get('enable_id_fx_accountless_sms_auth_for_part11', None))
@@ -3134,6 +3176,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('enable_notary_on_demand_witness_metadata'), kwargs.get('enable_notary_on_demand_witness_metadata', None))
setattr(self, "_{}".format('enable_obligation_management'), kwargs.get('enable_obligation_management', None))
setattr(self, "_{}".format('enable_obligation_management_metadata'), kwargs.get('enable_obligation_management_metadata', None))
+ setattr(self, "_{}".format('enable_owner_insights_and_recommendations_setting_metadata'), kwargs.get('enable_owner_insights_and_recommendations_setting_metadata', None))
setattr(self, "_{}".format('enable_participant_recipient_setting_metadata'), kwargs.get('enable_participant_recipient_setting_metadata', None))
setattr(self, "_{}".format('enable_payment_processing'), kwargs.get('enable_payment_processing', None))
setattr(self, "_{}".format('enable_payment_processing_metadata'), kwargs.get('enable_payment_processing_metadata', None))
@@ -3167,6 +3210,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('enable_search_service_azure_uri_metadata'), kwargs.get('enable_search_service_azure_uri_metadata', None))
setattr(self, "_{}".format('enable_search_site_specific_api'), kwargs.get('enable_search_site_specific_api', None))
setattr(self, "_{}".format('enable_search_site_specific_api_metadata'), kwargs.get('enable_search_site_specific_api_metadata', None))
+ setattr(self, "_{}".format('enable_sender_insights_and_recommendations_setting_metadata'), kwargs.get('enable_sender_insights_and_recommendations_setting_metadata', None))
setattr(self, "_{}".format('enable_sending_tags_font_settings'), kwargs.get('enable_sending_tags_font_settings', None))
setattr(self, "_{}".format('enable_sending_tags_font_settings_metadata'), kwargs.get('enable_sending_tags_font_settings_metadata', None))
setattr(self, "_{}".format('enable_send_to_agent'), kwargs.get('enable_send_to_agent', None))
@@ -4875,6 +4919,29 @@ def allow_connect_unified_payload_ui(self, allow_connect_unified_payload_ui):
self._allow_connect_unified_payload_ui = allow_connect_unified_payload_ui
+ @property
+ def allow_connect_workspace_upload_request_ui(self):
+ """Gets the allow_connect_workspace_upload_request_ui of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The allow_connect_workspace_upload_request_ui of this AccountSettingsInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._allow_connect_workspace_upload_request_ui
+
+ @allow_connect_workspace_upload_request_ui.setter
+ def allow_connect_workspace_upload_request_ui(self, allow_connect_workspace_upload_request_ui):
+ """Sets the allow_connect_workspace_upload_request_ui of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param allow_connect_workspace_upload_request_ui: The allow_connect_workspace_upload_request_ui of this AccountSettingsInformation. # noqa: E501
+ :type: str
+ """
+
+ self._allow_connect_workspace_upload_request_ui = allow_connect_workspace_upload_request_ui
+
@property
def allow_consumer_disclosure_override(self):
"""Gets the allow_consumer_disclosure_override of this AccountSettingsInformation. # noqa: E501
@@ -11269,6 +11336,52 @@ def document_visibility_metadata(self, document_visibility_metadata):
self._document_visibility_metadata = document_visibility_metadata
+ @property
+ def docusign_pdf(self):
+ """Gets the docusign_pdf of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The docusign_pdf of this AccountSettingsInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._docusign_pdf
+
+ @docusign_pdf.setter
+ def docusign_pdf(self, docusign_pdf):
+ """Sets the docusign_pdf of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param docusign_pdf: The docusign_pdf of this AccountSettingsInformation. # noqa: E501
+ :type: str
+ """
+
+ self._docusign_pdf = docusign_pdf
+
+ @property
+ def docusign_pdf_metadata(self):
+ """Gets the docusign_pdf_metadata of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The docusign_pdf_metadata of this AccountSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._docusign_pdf_metadata
+
+ @docusign_pdf_metadata.setter
+ def docusign_pdf_metadata(self, docusign_pdf_metadata):
+ """Sets the docusign_pdf_metadata of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param docusign_pdf_metadata: The docusign_pdf_metadata of this AccountSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._docusign_pdf_metadata = docusign_pdf_metadata
+
@property
def draft_envelope_retention(self):
"""Gets the draft_envelope_retention of this AccountSettingsInformation. # noqa: E501
@@ -11913,6 +12026,52 @@ def enable_agreement_desk_advanced_meta_data(self, enable_agreement_desk_advance
self._enable_agreement_desk_advanced_meta_data = enable_agreement_desk_advanced_meta_data
+ @property
+ def enable_ai_agents(self):
+ """Gets the enable_ai_agents of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The enable_ai_agents of this AccountSettingsInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._enable_ai_agents
+
+ @enable_ai_agents.setter
+ def enable_ai_agents(self, enable_ai_agents):
+ """Sets the enable_ai_agents of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param enable_ai_agents: The enable_ai_agents of this AccountSettingsInformation. # noqa: E501
+ :type: str
+ """
+
+ self._enable_ai_agents = enable_ai_agents
+
+ @property
+ def enable_ai_agents_metadata(self):
+ """Gets the enable_ai_agents_metadata of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The enable_ai_agents_metadata of this AccountSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._enable_ai_agents_metadata
+
+ @enable_ai_agents_metadata.setter
+ def enable_ai_agents_metadata(self, enable_ai_agents_metadata):
+ """Sets the enable_ai_agents_metadata of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param enable_ai_agents_metadata: The enable_ai_agents_metadata of this AccountSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._enable_ai_agents_metadata = enable_ai_agents_metadata
+
@property
def enable_ai_contract_review(self):
"""Gets the enable_ai_contract_review of this AccountSettingsInformation. # noqa: E501
@@ -13799,6 +13958,52 @@ def enable_esign_task_list_metadata(self, enable_esign_task_list_metadata):
self._enable_esign_task_list_metadata = enable_esign_task_list_metadata
+ @property
+ def enable_gen_and_api(self):
+ """Gets the enable_gen_and_api of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The enable_gen_and_api of this AccountSettingsInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._enable_gen_and_api
+
+ @enable_gen_and_api.setter
+ def enable_gen_and_api(self, enable_gen_and_api):
+ """Sets the enable_gen_and_api of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param enable_gen_and_api: The enable_gen_and_api of this AccountSettingsInformation. # noqa: E501
+ :type: str
+ """
+
+ self._enable_gen_and_api = enable_gen_and_api
+
+ @property
+ def enable_gen_and_api_metadata(self):
+ """Gets the enable_gen_and_api_metadata of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The enable_gen_and_api_metadata of this AccountSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._enable_gen_and_api_metadata
+
+ @enable_gen_and_api_metadata.setter
+ def enable_gen_and_api_metadata(self, enable_gen_and_api_metadata):
+ """Sets the enable_gen_and_api_metadata of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param enable_gen_and_api_metadata: The enable_gen_and_api_metadata of this AccountSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._enable_gen_and_api_metadata = enable_gen_and_api_metadata
+
@property
def enable_generation_with3_p_integration(self):
"""Gets the enable_generation_with3_p_integration of this AccountSettingsInformation. # noqa: E501
@@ -13983,6 +14188,52 @@ def enable_iam_clause_library_metadata(self, enable_iam_clause_library_metadata)
self._enable_iam_clause_library_metadata = enable_iam_clause_library_metadata
+ @property
+ def enable_iam_data_connector(self):
+ """Gets the enable_iam_data_connector of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The enable_iam_data_connector of this AccountSettingsInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._enable_iam_data_connector
+
+ @enable_iam_data_connector.setter
+ def enable_iam_data_connector(self, enable_iam_data_connector):
+ """Sets the enable_iam_data_connector of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param enable_iam_data_connector: The enable_iam_data_connector of this AccountSettingsInformation. # noqa: E501
+ :type: str
+ """
+
+ self._enable_iam_data_connector = enable_iam_data_connector
+
+ @property
+ def enable_iam_data_connector_metadata(self):
+ """Gets the enable_iam_data_connector_metadata of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The enable_iam_data_connector_metadata of this AccountSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._enable_iam_data_connector_metadata
+
+ @enable_iam_data_connector_metadata.setter
+ def enable_iam_data_connector_metadata(self, enable_iam_data_connector_metadata):
+ """Sets the enable_iam_data_connector_metadata of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param enable_iam_data_connector_metadata: The enable_iam_data_connector_metadata of this AccountSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._enable_iam_data_connector_metadata = enable_iam_data_connector_metadata
+
@property
def enable_ia_mfor_x_embedded_ux(self):
"""Gets the enable_ia_mfor_x_embedded_ux of this AccountSettingsInformation. # noqa: E501
@@ -15041,6 +15292,29 @@ def enable_obligation_management_metadata(self, enable_obligation_management_met
self._enable_obligation_management_metadata = enable_obligation_management_metadata
+ @property
+ def enable_owner_insights_and_recommendations_setting_metadata(self):
+ """Gets the enable_owner_insights_and_recommendations_setting_metadata of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The enable_owner_insights_and_recommendations_setting_metadata of this AccountSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._enable_owner_insights_and_recommendations_setting_metadata
+
+ @enable_owner_insights_and_recommendations_setting_metadata.setter
+ def enable_owner_insights_and_recommendations_setting_metadata(self, enable_owner_insights_and_recommendations_setting_metadata):
+ """Sets the enable_owner_insights_and_recommendations_setting_metadata of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param enable_owner_insights_and_recommendations_setting_metadata: The enable_owner_insights_and_recommendations_setting_metadata of this AccountSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._enable_owner_insights_and_recommendations_setting_metadata = enable_owner_insights_and_recommendations_setting_metadata
+
@property
def enable_participant_recipient_setting_metadata(self):
"""Gets the enable_participant_recipient_setting_metadata of this AccountSettingsInformation. # noqa: E501
@@ -15800,6 +16074,29 @@ def enable_search_site_specific_api_metadata(self, enable_search_site_specific_a
self._enable_search_site_specific_api_metadata = enable_search_site_specific_api_metadata
+ @property
+ def enable_sender_insights_and_recommendations_setting_metadata(self):
+ """Gets the enable_sender_insights_and_recommendations_setting_metadata of this AccountSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The enable_sender_insights_and_recommendations_setting_metadata of this AccountSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._enable_sender_insights_and_recommendations_setting_metadata
+
+ @enable_sender_insights_and_recommendations_setting_metadata.setter
+ def enable_sender_insights_and_recommendations_setting_metadata(self, enable_sender_insights_and_recommendations_setting_metadata):
+ """Sets the enable_sender_insights_and_recommendations_setting_metadata of this AccountSettingsInformation.
+
+ # noqa: E501
+
+ :param enable_sender_insights_and_recommendations_setting_metadata: The enable_sender_insights_and_recommendations_setting_metadata of this AccountSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._enable_sender_insights_and_recommendations_setting_metadata = enable_sender_insights_and_recommendations_setting_metadata
+
@property
def enable_sending_tags_font_settings(self):
"""Gets the enable_sending_tags_font_settings of this AccountSettingsInformation. # noqa: E501
diff --git a/docusign_esign/models/authorized_signatory.py b/docusign_esign/models/authorized_signatory.py
new file mode 100644
index 0000000..2a4f882
--- /dev/null
+++ b/docusign_esign/models/authorized_signatory.py
@@ -0,0 +1,2824 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class AuthorizedSignatory(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'access_code': 'str',
+ 'access_code_metadata': 'PropertyMetadata',
+ 'add_access_code_to_email': 'str',
+ 'additional_notifications': 'list[RecipientAdditionalNotification]',
+ 'agent_can_edit_email': 'str',
+ 'agent_can_edit_name': 'str',
+ 'allow_system_override_for_locked_recipient': 'str',
+ 'auto_navigation': 'str',
+ 'auto_responded_reason': 'str',
+ 'bulk_recipients_uri': 'str',
+ 'bulk_send_v2_recipient': 'str',
+ 'can_sign_offline': 'str',
+ 'client_user_id': 'str',
+ 'completed_count': 'str',
+ 'consent_details_list': 'list[ConsentDetails]',
+ 'creation_reason': 'str',
+ 'custom_fields': 'list[str]',
+ 'declined_date_time': 'str',
+ 'declined_reason': 'str',
+ 'default_recipient': 'str',
+ 'delegated_by': 'DelegationInfo',
+ 'delegated_to': 'list[DelegationInfo]',
+ 'delivered_date_time': 'str',
+ 'delivery_method': 'str',
+ 'delivery_method_metadata': 'PropertyMetadata',
+ 'designator_id': 'str',
+ 'designator_id_guid': 'str',
+ 'document_template_id': 'str',
+ 'document_visibility': 'list[DocumentVisibility]',
+ '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]',
+ 'fax_number': 'str',
+ 'fax_number_metadata': 'PropertyMetadata',
+ 'first_name': 'str',
+ 'first_name_metadata': 'PropertyMetadata',
+ 'full_name': 'str',
+ 'full_name_metadata': 'PropertyMetadata',
+ 'id_check_configuration_name': 'str',
+ 'id_check_configuration_name_metadata': 'PropertyMetadata',
+ 'id_check_information_input': 'IdCheckInformationInput',
+ 'identity_verification': 'RecipientIdentityVerification',
+ 'inherit_email_notification_configuration': 'str',
+ 'is_bulk_recipient': 'str',
+ 'is_bulk_recipient_metadata': 'PropertyMetadata',
+ 'last_name': 'str',
+ 'last_name_metadata': 'PropertyMetadata',
+ 'locked_recipient_phone_auth_editable': 'str',
+ 'locked_recipient_sms_editable': 'str',
+ 'name': 'str',
+ 'name_metadata': 'PropertyMetadata',
+ 'notary_id': 'str',
+ 'notary_signer_email_sent': 'str',
+ 'note': 'str',
+ 'note_metadata': 'PropertyMetadata',
+ 'offline_attributes': 'OfflineAttributes',
+ 'phone_authentication': 'RecipientPhoneAuthentication',
+ 'phone_number': 'RecipientPhoneNumber',
+ 'proof_file': 'RecipientProofFile',
+ 'recipient_attachments': 'list[RecipientAttachment]',
+ 'recipient_authentication_status': 'AuthenticationStatus',
+ 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]',
+ 'recipient_id': 'str',
+ 'recipient_id_guid': 'str',
+ 'recipient_signature_providers': 'list[RecipientSignatureProvider]',
+ 'recipient_supplies_tabs': 'str',
+ 'recipient_type': 'str',
+ 'recipient_type_metadata': 'PropertyMetadata',
+ 'require_id_lookup': 'str',
+ 'require_id_lookup_metadata': 'PropertyMetadata',
+ 'require_signer_certificate': 'str',
+ 'require_sign_on_paper': 'str',
+ 'require_upload_signature': 'str',
+ 'role_name': 'str',
+ 'routing_order': 'str',
+ 'routing_order_metadata': 'PropertyMetadata',
+ 'sent_date_time': 'str',
+ 'signature_info': 'RecipientSignatureInformation',
+ 'signed_date_time': 'str',
+ 'sign_in_each_location': 'str',
+ 'sign_in_each_location_metadata': 'PropertyMetadata',
+ 'signing_group_id': 'str',
+ 'signing_group_id_metadata': 'PropertyMetadata',
+ 'signing_group_name': 'str',
+ 'signing_group_type': 'str',
+ 'signing_group_users': 'list[UserInfo]',
+ 'sms_authentication': 'RecipientSMSAuthentication',
+ 'social_authentications': 'list[SocialAuthentication]',
+ 'status': 'str',
+ 'status_code': 'str',
+ 'suppress_emails': 'str',
+ 'tabs': 'Tabs',
+ 'template_locked': 'str',
+ 'template_required': 'str',
+ 'total_tab_count': 'str',
+ 'user_id': 'str',
+ 'web_form_recipient_view_id': 'str'
+ }
+
+ attribute_map = {
+ 'access_code': 'accessCode',
+ 'access_code_metadata': 'accessCodeMetadata',
+ 'add_access_code_to_email': 'addAccessCodeToEmail',
+ 'additional_notifications': 'additionalNotifications',
+ 'agent_can_edit_email': 'agentCanEditEmail',
+ 'agent_can_edit_name': 'agentCanEditName',
+ 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient',
+ 'auto_navigation': 'autoNavigation',
+ 'auto_responded_reason': 'autoRespondedReason',
+ 'bulk_recipients_uri': 'bulkRecipientsUri',
+ 'bulk_send_v2_recipient': 'bulkSendV2Recipient',
+ 'can_sign_offline': 'canSignOffline',
+ 'client_user_id': 'clientUserId',
+ 'completed_count': 'completedCount',
+ 'consent_details_list': 'consentDetailsList',
+ 'creation_reason': 'creationReason',
+ 'custom_fields': 'customFields',
+ 'declined_date_time': 'declinedDateTime',
+ 'declined_reason': 'declinedReason',
+ 'default_recipient': 'defaultRecipient',
+ 'delegated_by': 'delegatedBy',
+ 'delegated_to': 'delegatedTo',
+ 'delivered_date_time': 'deliveredDateTime',
+ 'delivery_method': 'deliveryMethod',
+ 'delivery_method_metadata': 'deliveryMethodMetadata',
+ 'designator_id': 'designatorId',
+ 'designator_id_guid': 'designatorIdGuid',
+ 'document_template_id': 'documentTemplateId',
+ 'document_visibility': 'documentVisibility',
+ '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',
+ 'fax_number': 'faxNumber',
+ 'fax_number_metadata': 'faxNumberMetadata',
+ 'first_name': 'firstName',
+ 'first_name_metadata': 'firstNameMetadata',
+ 'full_name': 'fullName',
+ 'full_name_metadata': 'fullNameMetadata',
+ 'id_check_configuration_name': 'idCheckConfigurationName',
+ 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata',
+ 'id_check_information_input': 'idCheckInformationInput',
+ 'identity_verification': 'identityVerification',
+ 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration',
+ 'is_bulk_recipient': 'isBulkRecipient',
+ 'is_bulk_recipient_metadata': 'isBulkRecipientMetadata',
+ 'last_name': 'lastName',
+ 'last_name_metadata': 'lastNameMetadata',
+ 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable',
+ 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable',
+ 'name': 'name',
+ 'name_metadata': 'nameMetadata',
+ 'notary_id': 'notaryId',
+ 'notary_signer_email_sent': 'notarySignerEmailSent',
+ 'note': 'note',
+ 'note_metadata': 'noteMetadata',
+ 'offline_attributes': 'offlineAttributes',
+ 'phone_authentication': 'phoneAuthentication',
+ 'phone_number': 'phoneNumber',
+ 'proof_file': 'proofFile',
+ 'recipient_attachments': 'recipientAttachments',
+ 'recipient_authentication_status': 'recipientAuthenticationStatus',
+ 'recipient_feature_metadata': 'recipientFeatureMetadata',
+ 'recipient_id': 'recipientId',
+ 'recipient_id_guid': 'recipientIdGuid',
+ 'recipient_signature_providers': 'recipientSignatureProviders',
+ 'recipient_supplies_tabs': 'recipientSuppliesTabs',
+ 'recipient_type': 'recipientType',
+ 'recipient_type_metadata': 'recipientTypeMetadata',
+ 'require_id_lookup': 'requireIdLookup',
+ 'require_id_lookup_metadata': 'requireIdLookupMetadata',
+ 'require_signer_certificate': 'requireSignerCertificate',
+ 'require_sign_on_paper': 'requireSignOnPaper',
+ 'require_upload_signature': 'requireUploadSignature',
+ 'role_name': 'roleName',
+ 'routing_order': 'routingOrder',
+ 'routing_order_metadata': 'routingOrderMetadata',
+ 'sent_date_time': 'sentDateTime',
+ 'signature_info': 'signatureInfo',
+ 'signed_date_time': 'signedDateTime',
+ 'sign_in_each_location': 'signInEachLocation',
+ 'sign_in_each_location_metadata': 'signInEachLocationMetadata',
+ 'signing_group_id': 'signingGroupId',
+ 'signing_group_id_metadata': 'signingGroupIdMetadata',
+ 'signing_group_name': 'signingGroupName',
+ 'signing_group_type': 'signingGroupType',
+ 'signing_group_users': 'signingGroupUsers',
+ 'sms_authentication': 'smsAuthentication',
+ 'social_authentications': 'socialAuthentications',
+ 'status': 'status',
+ 'status_code': 'statusCode',
+ 'suppress_emails': 'suppressEmails',
+ 'tabs': 'tabs',
+ 'template_locked': 'templateLocked',
+ 'template_required': 'templateRequired',
+ 'total_tab_count': 'totalTabCount',
+ 'user_id': 'userId',
+ 'web_form_recipient_view_id': 'webFormRecipientViewId'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """AuthorizedSignatory - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._access_code = None
+ self._access_code_metadata = None
+ self._add_access_code_to_email = None
+ self._additional_notifications = None
+ self._agent_can_edit_email = None
+ self._agent_can_edit_name = None
+ self._allow_system_override_for_locked_recipient = None
+ self._auto_navigation = None
+ self._auto_responded_reason = None
+ self._bulk_recipients_uri = None
+ self._bulk_send_v2_recipient = None
+ self._can_sign_offline = None
+ self._client_user_id = None
+ self._completed_count = None
+ self._consent_details_list = None
+ self._creation_reason = None
+ self._custom_fields = None
+ self._declined_date_time = None
+ self._declined_reason = None
+ self._default_recipient = None
+ self._delegated_by = None
+ self._delegated_to = None
+ self._delivered_date_time = None
+ self._delivery_method = None
+ self._delivery_method_metadata = None
+ self._designator_id = None
+ self._designator_id_guid = None
+ self._document_template_id = None
+ self._document_visibility = None
+ 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
+ self._fax_number = None
+ self._fax_number_metadata = None
+ self._first_name = None
+ self._first_name_metadata = None
+ self._full_name = None
+ self._full_name_metadata = None
+ self._id_check_configuration_name = None
+ self._id_check_configuration_name_metadata = None
+ self._id_check_information_input = None
+ self._identity_verification = None
+ self._inherit_email_notification_configuration = None
+ self._is_bulk_recipient = None
+ self._is_bulk_recipient_metadata = None
+ self._last_name = None
+ self._last_name_metadata = None
+ self._locked_recipient_phone_auth_editable = None
+ self._locked_recipient_sms_editable = None
+ self._name = None
+ self._name_metadata = None
+ self._notary_id = None
+ self._notary_signer_email_sent = None
+ self._note = None
+ self._note_metadata = None
+ self._offline_attributes = None
+ self._phone_authentication = None
+ self._phone_number = None
+ self._proof_file = None
+ self._recipient_attachments = None
+ self._recipient_authentication_status = None
+ self._recipient_feature_metadata = None
+ self._recipient_id = None
+ self._recipient_id_guid = None
+ self._recipient_signature_providers = None
+ self._recipient_supplies_tabs = None
+ self._recipient_type = None
+ self._recipient_type_metadata = None
+ self._require_id_lookup = None
+ self._require_id_lookup_metadata = None
+ self._require_signer_certificate = None
+ self._require_sign_on_paper = None
+ self._require_upload_signature = None
+ self._role_name = None
+ self._routing_order = None
+ self._routing_order_metadata = None
+ self._sent_date_time = None
+ self._signature_info = None
+ self._signed_date_time = None
+ self._sign_in_each_location = None
+ self._sign_in_each_location_metadata = None
+ self._signing_group_id = None
+ self._signing_group_id_metadata = None
+ self._signing_group_name = None
+ self._signing_group_type = None
+ self._signing_group_users = None
+ self._sms_authentication = None
+ self._social_authentications = None
+ self._status = None
+ self._status_code = None
+ self._suppress_emails = None
+ self._tabs = None
+ self._template_locked = None
+ self._template_required = None
+ self._total_tab_count = None
+ self._user_id = None
+ self._web_form_recipient_view_id = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None))
+ setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None))
+ setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None))
+ setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None))
+ setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None))
+ setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None))
+ setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None))
+ setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None))
+ setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None))
+ setattr(self, "_{}".format('bulk_recipients_uri'), kwargs.get('bulk_recipients_uri', None))
+ setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None))
+ setattr(self, "_{}".format('can_sign_offline'), kwargs.get('can_sign_offline', None))
+ setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None))
+ setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None))
+ setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None))
+ setattr(self, "_{}".format('creation_reason'), kwargs.get('creation_reason', None))
+ setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None))
+ setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None))
+ setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None))
+ setattr(self, "_{}".format('default_recipient'), kwargs.get('default_recipient', None))
+ setattr(self, "_{}".format('delegated_by'), kwargs.get('delegated_by', None))
+ setattr(self, "_{}".format('delegated_to'), kwargs.get('delegated_to', None))
+ setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None))
+ setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None))
+ setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None))
+ setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None))
+ setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None))
+ setattr(self, "_{}".format('document_template_id'), kwargs.get('document_template_id', None))
+ setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None))
+ 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))
+ setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None))
+ setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None))
+ setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None))
+ setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None))
+ setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None))
+ setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None))
+ setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None))
+ setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None))
+ setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None))
+ setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None))
+ setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None))
+ setattr(self, "_{}".format('is_bulk_recipient'), kwargs.get('is_bulk_recipient', None))
+ setattr(self, "_{}".format('is_bulk_recipient_metadata'), kwargs.get('is_bulk_recipient_metadata', None))
+ setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None))
+ setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None))
+ setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None))
+ setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None))
+ setattr(self, "_{}".format('name'), kwargs.get('name', None))
+ setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None))
+ setattr(self, "_{}".format('notary_id'), kwargs.get('notary_id', None))
+ setattr(self, "_{}".format('notary_signer_email_sent'), kwargs.get('notary_signer_email_sent', None))
+ setattr(self, "_{}".format('note'), kwargs.get('note', None))
+ setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None))
+ setattr(self, "_{}".format('offline_attributes'), kwargs.get('offline_attributes', None))
+ setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None))
+ setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None))
+ setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None))
+ setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None))
+ setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None))
+ setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None))
+ setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None))
+ setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None))
+ setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None))
+ setattr(self, "_{}".format('recipient_supplies_tabs'), kwargs.get('recipient_supplies_tabs', None))
+ setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None))
+ setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None))
+ setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None))
+ setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None))
+ setattr(self, "_{}".format('require_signer_certificate'), kwargs.get('require_signer_certificate', None))
+ setattr(self, "_{}".format('require_sign_on_paper'), kwargs.get('require_sign_on_paper', None))
+ setattr(self, "_{}".format('require_upload_signature'), kwargs.get('require_upload_signature', None))
+ setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None))
+ setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None))
+ setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None))
+ setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None))
+ setattr(self, "_{}".format('signature_info'), kwargs.get('signature_info', None))
+ setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None))
+ setattr(self, "_{}".format('sign_in_each_location'), kwargs.get('sign_in_each_location', None))
+ setattr(self, "_{}".format('sign_in_each_location_metadata'), kwargs.get('sign_in_each_location_metadata', None))
+ setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None))
+ setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None))
+ setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None))
+ setattr(self, "_{}".format('signing_group_type'), kwargs.get('signing_group_type', None))
+ setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None))
+ setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None))
+ setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None))
+ setattr(self, "_{}".format('status'), kwargs.get('status', None))
+ setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None))
+ setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None))
+ setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None))
+ setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None))
+ setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None))
+ setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None))
+ setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None))
+ setattr(self, "_{}".format('web_form_recipient_view_id'), kwargs.get('web_form_recipient_view_id', None))
+
+ @property
+ def access_code(self):
+ """Gets the access_code of this AuthorizedSignatory. # noqa: E501
+
+ If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501
+
+ :return: The access_code of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._access_code
+
+ @access_code.setter
+ def access_code(self, access_code):
+ """Sets the access_code of this AuthorizedSignatory.
+
+ If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501
+
+ :param access_code: The access_code of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._access_code = access_code
+
+ @property
+ def access_code_metadata(self):
+ """Gets the access_code_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The access_code_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._access_code_metadata
+
+ @access_code_metadata.setter
+ def access_code_metadata(self, access_code_metadata):
+ """Sets the access_code_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param access_code_metadata: The access_code_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._access_code_metadata = access_code_metadata
+
+ @property
+ def add_access_code_to_email(self):
+ """Gets the add_access_code_to_email of this AuthorizedSignatory. # noqa: E501
+
+ This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501
+
+ :return: The add_access_code_to_email of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._add_access_code_to_email
+
+ @add_access_code_to_email.setter
+ def add_access_code_to_email(self, add_access_code_to_email):
+ """Sets the add_access_code_to_email of this AuthorizedSignatory.
+
+ This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501
+
+ :param add_access_code_to_email: The add_access_code_to_email of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._add_access_code_to_email = add_access_code_to_email
+
+ @property
+ def additional_notifications(self):
+ """Gets the additional_notifications of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The additional_notifications of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[RecipientAdditionalNotification]
+ """
+ return self._additional_notifications
+
+ @additional_notifications.setter
+ def additional_notifications(self, additional_notifications):
+ """Sets the additional_notifications of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param additional_notifications: The additional_notifications of this AuthorizedSignatory. # noqa: E501
+ :type: list[RecipientAdditionalNotification]
+ """
+
+ self._additional_notifications = additional_notifications
+
+ @property
+ def agent_can_edit_email(self):
+ """Gets the agent_can_edit_email of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The agent_can_edit_email of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._agent_can_edit_email
+
+ @agent_can_edit_email.setter
+ def agent_can_edit_email(self, agent_can_edit_email):
+ """Sets the agent_can_edit_email of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param agent_can_edit_email: The agent_can_edit_email of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._agent_can_edit_email = agent_can_edit_email
+
+ @property
+ def agent_can_edit_name(self):
+ """Gets the agent_can_edit_name of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The agent_can_edit_name of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._agent_can_edit_name
+
+ @agent_can_edit_name.setter
+ def agent_can_edit_name(self, agent_can_edit_name):
+ """Sets the agent_can_edit_name of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param agent_can_edit_name: The agent_can_edit_name of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._agent_can_edit_name = agent_can_edit_name
+
+ @property
+ def allow_system_override_for_locked_recipient(self):
+ """Gets the allow_system_override_for_locked_recipient of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The allow_system_override_for_locked_recipient of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._allow_system_override_for_locked_recipient
+
+ @allow_system_override_for_locked_recipient.setter
+ def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient):
+ """Sets the allow_system_override_for_locked_recipient of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient
+
+ @property
+ def auto_navigation(self):
+ """Gets the auto_navigation of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The auto_navigation of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._auto_navigation
+
+ @auto_navigation.setter
+ def auto_navigation(self, auto_navigation):
+ """Sets the auto_navigation of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param auto_navigation: The auto_navigation of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._auto_navigation = auto_navigation
+
+ @property
+ def auto_responded_reason(self):
+ """Gets the auto_responded_reason of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The auto_responded_reason of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._auto_responded_reason
+
+ @auto_responded_reason.setter
+ def auto_responded_reason(self, auto_responded_reason):
+ """Sets the auto_responded_reason of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param auto_responded_reason: The auto_responded_reason of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._auto_responded_reason = auto_responded_reason
+
+ @property
+ def bulk_recipients_uri(self):
+ """Gets the bulk_recipients_uri of this AuthorizedSignatory. # noqa: E501
+
+ Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501
+
+ :return: The bulk_recipients_uri of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._bulk_recipients_uri
+
+ @bulk_recipients_uri.setter
+ def bulk_recipients_uri(self, bulk_recipients_uri):
+ """Sets the bulk_recipients_uri of this AuthorizedSignatory.
+
+ Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501
+
+ :param bulk_recipients_uri: The bulk_recipients_uri of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._bulk_recipients_uri = bulk_recipients_uri
+
+ @property
+ def bulk_send_v2_recipient(self):
+ """Gets the bulk_send_v2_recipient of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The bulk_send_v2_recipient of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._bulk_send_v2_recipient
+
+ @bulk_send_v2_recipient.setter
+ def bulk_send_v2_recipient(self, bulk_send_v2_recipient):
+ """Sets the bulk_send_v2_recipient of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._bulk_send_v2_recipient = bulk_send_v2_recipient
+
+ @property
+ def can_sign_offline(self):
+ """Gets the can_sign_offline of this AuthorizedSignatory. # noqa: E501
+
+ When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501
+
+ :return: The can_sign_offline of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._can_sign_offline
+
+ @can_sign_offline.setter
+ def can_sign_offline(self, can_sign_offline):
+ """Sets the can_sign_offline of this AuthorizedSignatory.
+
+ When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501
+
+ :param can_sign_offline: The can_sign_offline of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._can_sign_offline = can_sign_offline
+
+ @property
+ def client_user_id(self):
+ """Gets the client_user_id of this AuthorizedSignatory. # noqa: E501
+
+ Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501
+
+ :return: The client_user_id of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._client_user_id
+
+ @client_user_id.setter
+ def client_user_id(self, client_user_id):
+ """Sets the client_user_id of this AuthorizedSignatory.
+
+ Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501
+
+ :param client_user_id: The client_user_id of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._client_user_id = client_user_id
+
+ @property
+ def completed_count(self):
+ """Gets the completed_count of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The completed_count of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._completed_count
+
+ @completed_count.setter
+ def completed_count(self, completed_count):
+ """Sets the completed_count of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param completed_count: The completed_count of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._completed_count = completed_count
+
+ @property
+ def consent_details_list(self):
+ """Gets the consent_details_list of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The consent_details_list of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[ConsentDetails]
+ """
+ return self._consent_details_list
+
+ @consent_details_list.setter
+ def consent_details_list(self, consent_details_list):
+ """Sets the consent_details_list of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param consent_details_list: The consent_details_list of this AuthorizedSignatory. # noqa: E501
+ :type: list[ConsentDetails]
+ """
+
+ self._consent_details_list = consent_details_list
+
+ @property
+ def creation_reason(self):
+ """Gets the creation_reason of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The creation_reason of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._creation_reason
+
+ @creation_reason.setter
+ def creation_reason(self, creation_reason):
+ """Sets the creation_reason of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param creation_reason: The creation_reason of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._creation_reason = creation_reason
+
+ @property
+ def custom_fields(self):
+ """Gets the custom_fields of this AuthorizedSignatory. # noqa: E501
+
+ An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501
+
+ :return: The custom_fields of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._custom_fields
+
+ @custom_fields.setter
+ def custom_fields(self, custom_fields):
+ """Sets the custom_fields of this AuthorizedSignatory.
+
+ An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501
+
+ :param custom_fields: The custom_fields of this AuthorizedSignatory. # noqa: E501
+ :type: list[str]
+ """
+
+ self._custom_fields = custom_fields
+
+ @property
+ def declined_date_time(self):
+ """Gets the declined_date_time of this AuthorizedSignatory. # noqa: E501
+
+ The date and time the recipient declined the document. # noqa: E501
+
+ :return: The declined_date_time of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._declined_date_time
+
+ @declined_date_time.setter
+ def declined_date_time(self, declined_date_time):
+ """Sets the declined_date_time of this AuthorizedSignatory.
+
+ The date and time the recipient declined the document. # noqa: E501
+
+ :param declined_date_time: The declined_date_time of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._declined_date_time = declined_date_time
+
+ @property
+ def declined_reason(self):
+ """Gets the declined_reason of this AuthorizedSignatory. # noqa: E501
+
+ The reason the recipient declined the document. # noqa: E501
+
+ :return: The declined_reason of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._declined_reason
+
+ @declined_reason.setter
+ def declined_reason(self, declined_reason):
+ """Sets the declined_reason of this AuthorizedSignatory.
+
+ The reason the recipient declined the document. # noqa: E501
+
+ :param declined_reason: The declined_reason of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._declined_reason = declined_reason
+
+ @property
+ def default_recipient(self):
+ """Gets the default_recipient of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The default_recipient of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._default_recipient
+
+ @default_recipient.setter
+ def default_recipient(self, default_recipient):
+ """Sets the default_recipient of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param default_recipient: The default_recipient of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._default_recipient = default_recipient
+
+ @property
+ def delegated_by(self):
+ """Gets the delegated_by of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The delegated_by of this AuthorizedSignatory. # noqa: E501
+ :rtype: DelegationInfo
+ """
+ return self._delegated_by
+
+ @delegated_by.setter
+ def delegated_by(self, delegated_by):
+ """Sets the delegated_by of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param delegated_by: The delegated_by of this AuthorizedSignatory. # noqa: E501
+ :type: DelegationInfo
+ """
+
+ self._delegated_by = delegated_by
+
+ @property
+ def delegated_to(self):
+ """Gets the delegated_to of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The delegated_to of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[DelegationInfo]
+ """
+ return self._delegated_to
+
+ @delegated_to.setter
+ def delegated_to(self, delegated_to):
+ """Sets the delegated_to of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param delegated_to: The delegated_to of this AuthorizedSignatory. # noqa: E501
+ :type: list[DelegationInfo]
+ """
+
+ self._delegated_to = delegated_to
+
+ @property
+ def delivered_date_time(self):
+ """Gets the delivered_date_time of this AuthorizedSignatory. # noqa: E501
+
+ Reserved: For DocuSign use only. # noqa: E501
+
+ :return: The delivered_date_time of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._delivered_date_time
+
+ @delivered_date_time.setter
+ def delivered_date_time(self, delivered_date_time):
+ """Sets the delivered_date_time of this AuthorizedSignatory.
+
+ Reserved: For DocuSign use only. # noqa: E501
+
+ :param delivered_date_time: The delivered_date_time of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._delivered_date_time = delivered_date_time
+
+ @property
+ def delivery_method(self):
+ """Gets the delivery_method of this AuthorizedSignatory. # noqa: E501
+
+ Reserved: For DocuSign use only. # noqa: E501
+
+ :return: The delivery_method of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._delivery_method
+
+ @delivery_method.setter
+ def delivery_method(self, delivery_method):
+ """Sets the delivery_method of this AuthorizedSignatory.
+
+ Reserved: For DocuSign use only. # noqa: E501
+
+ :param delivery_method: The delivery_method of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._delivery_method = delivery_method
+
+ @property
+ def delivery_method_metadata(self):
+ """Gets the delivery_method_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The delivery_method_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._delivery_method_metadata
+
+ @delivery_method_metadata.setter
+ def delivery_method_metadata(self, delivery_method_metadata):
+ """Sets the delivery_method_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param delivery_method_metadata: The delivery_method_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._delivery_method_metadata = delivery_method_metadata
+
+ @property
+ def designator_id(self):
+ """Gets the designator_id of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The designator_id of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._designator_id
+
+ @designator_id.setter
+ def designator_id(self, designator_id):
+ """Sets the designator_id of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param designator_id: The designator_id of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._designator_id = designator_id
+
+ @property
+ def designator_id_guid(self):
+ """Gets the designator_id_guid of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The designator_id_guid of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._designator_id_guid
+
+ @designator_id_guid.setter
+ def designator_id_guid(self, designator_id_guid):
+ """Sets the designator_id_guid of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param designator_id_guid: The designator_id_guid of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._designator_id_guid = designator_id_guid
+
+ @property
+ def document_template_id(self):
+ """Gets the document_template_id of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_template_id of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._document_template_id
+
+ @document_template_id.setter
+ def document_template_id(self, document_template_id):
+ """Sets the document_template_id of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param document_template_id: The document_template_id of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._document_template_id = document_template_id
+
+ @property
+ def document_visibility(self):
+ """Gets the document_visibility of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_visibility of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[DocumentVisibility]
+ """
+ return self._document_visibility
+
+ @document_visibility.setter
+ def document_visibility(self, document_visibility):
+ """Sets the document_visibility of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param document_visibility: The document_visibility of this AuthorizedSignatory. # noqa: E501
+ :type: list[DocumentVisibility]
+ """
+
+ self._document_visibility = document_visibility
+
+ @property
+ def email(self):
+ """Gets the email of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The email of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._email
+
+ @email.setter
+ def email(self, email):
+ """Sets the email of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param email: The email of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._email = email
+
+ @property
+ def email_metadata(self):
+ """Gets the email_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The email_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._email_metadata
+
+ @email_metadata.setter
+ def email_metadata(self, email_metadata):
+ """Sets the email_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param email_metadata: The email_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._email_metadata = email_metadata
+
+ @property
+ def email_notification(self):
+ """Gets the email_notification of this AuthorizedSignatory. # noqa: E501
+
+ A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. # noqa: E501
+
+ :return: The email_notification of this AuthorizedSignatory. # noqa: E501
+ :rtype: RecipientEmailNotification
+ """
+ return self._email_notification
+
+ @email_notification.setter
+ def email_notification(self, email_notification):
+ """Sets the email_notification of this AuthorizedSignatory.
+
+ A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. # noqa: E501
+
+ :param email_notification: The email_notification of this AuthorizedSignatory. # noqa: E501
+ :type: RecipientEmailNotification
+ """
+
+ self._email_notification = email_notification
+
+ @property
+ def email_recipient_post_signing_url(self):
+ """Gets the email_recipient_post_signing_url of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The email_recipient_post_signing_url of this AuthorizedSignatory. # 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 AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this AuthorizedSignatory. # 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 AuthorizedSignatory. # noqa: E501
+
+ Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` # noqa: E501
+
+ :return: The embedded_recipient_start_url of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._embedded_recipient_start_url
+
+ @embedded_recipient_start_url.setter
+ def embedded_recipient_start_url(self, embedded_recipient_start_url):
+ """Sets the embedded_recipient_start_url of this AuthorizedSignatory.
+
+ Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` # noqa: E501
+
+ :param embedded_recipient_start_url: The embedded_recipient_start_url of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._embedded_recipient_start_url = embedded_recipient_start_url
+
+ @property
+ def error_details(self):
+ """Gets the error_details of this AuthorizedSignatory. # noqa: E501
+
+ Array or errors. # noqa: E501
+
+ :return: The error_details of this AuthorizedSignatory. # noqa: E501
+ :rtype: ErrorDetails
+ """
+ return self._error_details
+
+ @error_details.setter
+ def error_details(self, error_details):
+ """Sets the error_details of this AuthorizedSignatory.
+
+ Array or errors. # noqa: E501
+
+ :param error_details: The error_details of this AuthorizedSignatory. # noqa: E501
+ :type: ErrorDetails
+ """
+
+ self._error_details = error_details
+
+ @property
+ def excluded_documents(self):
+ """Gets the excluded_documents of this AuthorizedSignatory. # noqa: E501
+
+ Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. # noqa: E501
+
+ :return: The excluded_documents of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._excluded_documents
+
+ @excluded_documents.setter
+ def excluded_documents(self, excluded_documents):
+ """Sets the excluded_documents of this AuthorizedSignatory.
+
+ Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. # noqa: E501
+
+ :param excluded_documents: The excluded_documents of this AuthorizedSignatory. # noqa: E501
+ :type: list[str]
+ """
+
+ self._excluded_documents = excluded_documents
+
+ @property
+ def fax_number(self):
+ """Gets the fax_number of this AuthorizedSignatory. # noqa: E501
+
+ Reserved: # noqa: E501
+
+ :return: The fax_number of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._fax_number
+
+ @fax_number.setter
+ def fax_number(self, fax_number):
+ """Sets the fax_number of this AuthorizedSignatory.
+
+ Reserved: # noqa: E501
+
+ :param fax_number: The fax_number of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._fax_number = fax_number
+
+ @property
+ def fax_number_metadata(self):
+ """Gets the fax_number_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The fax_number_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._fax_number_metadata
+
+ @fax_number_metadata.setter
+ def fax_number_metadata(self, fax_number_metadata):
+ """Sets the fax_number_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param fax_number_metadata: The fax_number_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._fax_number_metadata = fax_number_metadata
+
+ @property
+ def first_name(self):
+ """Gets the first_name of this AuthorizedSignatory. # noqa: E501
+
+ The user's first name. Maximum Length: 50 characters. # noqa: E501
+
+ :return: The first_name of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._first_name
+
+ @first_name.setter
+ def first_name(self, first_name):
+ """Sets the first_name of this AuthorizedSignatory.
+
+ The user's first name. Maximum Length: 50 characters. # noqa: E501
+
+ :param first_name: The first_name of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._first_name = first_name
+
+ @property
+ def first_name_metadata(self):
+ """Gets the first_name_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The first_name_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._first_name_metadata
+
+ @first_name_metadata.setter
+ def first_name_metadata(self, first_name_metadata):
+ """Sets the first_name_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param first_name_metadata: The first_name_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._first_name_metadata = first_name_metadata
+
+ @property
+ def full_name(self):
+ """Gets the full_name of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The full_name of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._full_name
+
+ @full_name.setter
+ def full_name(self, full_name):
+ """Sets the full_name of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param full_name: The full_name of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._full_name = full_name
+
+ @property
+ def full_name_metadata(self):
+ """Gets the full_name_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The full_name_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._full_name_metadata
+
+ @full_name_metadata.setter
+ def full_name_metadata(self, full_name_metadata):
+ """Sets the full_name_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param full_name_metadata: The full_name_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._full_name_metadata = full_name_metadata
+
+ @property
+ def id_check_configuration_name(self):
+ """Gets the id_check_configuration_name of this AuthorizedSignatory. # noqa: E501
+
+ Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501
+
+ :return: The id_check_configuration_name of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._id_check_configuration_name
+
+ @id_check_configuration_name.setter
+ def id_check_configuration_name(self, id_check_configuration_name):
+ """Sets the id_check_configuration_name of this AuthorizedSignatory.
+
+ Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501
+
+ :param id_check_configuration_name: The id_check_configuration_name of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._id_check_configuration_name = id_check_configuration_name
+
+ @property
+ def id_check_configuration_name_metadata(self):
+ """Gets the id_check_configuration_name_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The id_check_configuration_name_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._id_check_configuration_name_metadata
+
+ @id_check_configuration_name_metadata.setter
+ def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata):
+ """Sets the id_check_configuration_name_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._id_check_configuration_name_metadata = id_check_configuration_name_metadata
+
+ @property
+ def id_check_information_input(self):
+ """Gets the id_check_information_input of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The id_check_information_input of this AuthorizedSignatory. # noqa: E501
+ :rtype: IdCheckInformationInput
+ """
+ return self._id_check_information_input
+
+ @id_check_information_input.setter
+ def id_check_information_input(self, id_check_information_input):
+ """Sets the id_check_information_input of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param id_check_information_input: The id_check_information_input of this AuthorizedSignatory. # noqa: E501
+ :type: IdCheckInformationInput
+ """
+
+ self._id_check_information_input = id_check_information_input
+
+ @property
+ def identity_verification(self):
+ """Gets the identity_verification of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The identity_verification of this AuthorizedSignatory. # noqa: E501
+ :rtype: RecipientIdentityVerification
+ """
+ return self._identity_verification
+
+ @identity_verification.setter
+ def identity_verification(self, identity_verification):
+ """Sets the identity_verification of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param identity_verification: The identity_verification of this AuthorizedSignatory. # noqa: E501
+ :type: RecipientIdentityVerification
+ """
+
+ self._identity_verification = identity_verification
+
+ @property
+ def inherit_email_notification_configuration(self):
+ """Gets the inherit_email_notification_configuration of this AuthorizedSignatory. # noqa: E501
+
+ When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501
+
+ :return: The inherit_email_notification_configuration of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._inherit_email_notification_configuration
+
+ @inherit_email_notification_configuration.setter
+ def inherit_email_notification_configuration(self, inherit_email_notification_configuration):
+ """Sets the inherit_email_notification_configuration of this AuthorizedSignatory.
+
+ When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501
+
+ :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._inherit_email_notification_configuration = inherit_email_notification_configuration
+
+ @property
+ def is_bulk_recipient(self):
+ """Gets the is_bulk_recipient of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_bulk_recipient of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._is_bulk_recipient
+
+ @is_bulk_recipient.setter
+ def is_bulk_recipient(self, is_bulk_recipient):
+ """Sets the is_bulk_recipient of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param is_bulk_recipient: The is_bulk_recipient of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._is_bulk_recipient = is_bulk_recipient
+
+ @property
+ def is_bulk_recipient_metadata(self):
+ """Gets the is_bulk_recipient_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_bulk_recipient_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._is_bulk_recipient_metadata
+
+ @is_bulk_recipient_metadata.setter
+ def is_bulk_recipient_metadata(self, is_bulk_recipient_metadata):
+ """Sets the is_bulk_recipient_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param is_bulk_recipient_metadata: The is_bulk_recipient_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._is_bulk_recipient_metadata = is_bulk_recipient_metadata
+
+ @property
+ def last_name(self):
+ """Gets the last_name of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The last_name of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._last_name
+
+ @last_name.setter
+ def last_name(self, last_name):
+ """Sets the last_name of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param last_name: The last_name of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._last_name = last_name
+
+ @property
+ def last_name_metadata(self):
+ """Gets the last_name_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The last_name_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._last_name_metadata
+
+ @last_name_metadata.setter
+ def last_name_metadata(self, last_name_metadata):
+ """Sets the last_name_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param last_name_metadata: The last_name_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._last_name_metadata = last_name_metadata
+
+ @property
+ def locked_recipient_phone_auth_editable(self):
+ """Gets the locked_recipient_phone_auth_editable of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The locked_recipient_phone_auth_editable of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._locked_recipient_phone_auth_editable
+
+ @locked_recipient_phone_auth_editable.setter
+ def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable):
+ """Sets the locked_recipient_phone_auth_editable of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable
+
+ @property
+ def locked_recipient_sms_editable(self):
+ """Gets the locked_recipient_sms_editable of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The locked_recipient_sms_editable of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._locked_recipient_sms_editable
+
+ @locked_recipient_sms_editable.setter
+ def locked_recipient_sms_editable(self, locked_recipient_sms_editable):
+ """Sets the locked_recipient_sms_editable of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._locked_recipient_sms_editable = locked_recipient_sms_editable
+
+ @property
+ def name(self):
+ """Gets the name of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The name of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name):
+ """Sets the name of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param name: The name of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._name = name
+
+ @property
+ def name_metadata(self):
+ """Gets the name_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The name_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._name_metadata
+
+ @name_metadata.setter
+ def name_metadata(self, name_metadata):
+ """Sets the name_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param name_metadata: The name_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._name_metadata = name_metadata
+
+ @property
+ def notary_id(self):
+ """Gets the notary_id of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The notary_id of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._notary_id
+
+ @notary_id.setter
+ def notary_id(self, notary_id):
+ """Sets the notary_id of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param notary_id: The notary_id of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._notary_id = notary_id
+
+ @property
+ def notary_signer_email_sent(self):
+ """Gets the notary_signer_email_sent of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The notary_signer_email_sent of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._notary_signer_email_sent
+
+ @notary_signer_email_sent.setter
+ def notary_signer_email_sent(self, notary_signer_email_sent):
+ """Sets the notary_signer_email_sent of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param notary_signer_email_sent: The notary_signer_email_sent of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._notary_signer_email_sent = notary_signer_email_sent
+
+ @property
+ def note(self):
+ """Gets the note of this AuthorizedSignatory. # noqa: E501
+
+ Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501
+
+ :return: The note of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._note
+
+ @note.setter
+ def note(self, note):
+ """Sets the note of this AuthorizedSignatory.
+
+ Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501
+
+ :param note: The note of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._note = note
+
+ @property
+ def note_metadata(self):
+ """Gets the note_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The note_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._note_metadata
+
+ @note_metadata.setter
+ def note_metadata(self, note_metadata):
+ """Sets the note_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param note_metadata: The note_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._note_metadata = note_metadata
+
+ @property
+ def offline_attributes(self):
+ """Gets the offline_attributes of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The offline_attributes of this AuthorizedSignatory. # noqa: E501
+ :rtype: OfflineAttributes
+ """
+ return self._offline_attributes
+
+ @offline_attributes.setter
+ def offline_attributes(self, offline_attributes):
+ """Sets the offline_attributes of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param offline_attributes: The offline_attributes of this AuthorizedSignatory. # noqa: E501
+ :type: OfflineAttributes
+ """
+
+ self._offline_attributes = offline_attributes
+
+ @property
+ def phone_authentication(self):
+ """Gets the phone_authentication of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The phone_authentication of this AuthorizedSignatory. # noqa: E501
+ :rtype: RecipientPhoneAuthentication
+ """
+ return self._phone_authentication
+
+ @phone_authentication.setter
+ def phone_authentication(self, phone_authentication):
+ """Sets the phone_authentication of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param phone_authentication: The phone_authentication of this AuthorizedSignatory. # noqa: E501
+ :type: RecipientPhoneAuthentication
+ """
+
+ self._phone_authentication = phone_authentication
+
+ @property
+ def phone_number(self):
+ """Gets the phone_number of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The phone_number of this AuthorizedSignatory. # noqa: E501
+ :rtype: RecipientPhoneNumber
+ """
+ return self._phone_number
+
+ @phone_number.setter
+ def phone_number(self, phone_number):
+ """Sets the phone_number of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param phone_number: The phone_number of this AuthorizedSignatory. # noqa: E501
+ :type: RecipientPhoneNumber
+ """
+
+ self._phone_number = phone_number
+
+ @property
+ def proof_file(self):
+ """Gets the proof_file of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The proof_file of this AuthorizedSignatory. # noqa: E501
+ :rtype: RecipientProofFile
+ """
+ return self._proof_file
+
+ @proof_file.setter
+ def proof_file(self, proof_file):
+ """Sets the proof_file of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param proof_file: The proof_file of this AuthorizedSignatory. # noqa: E501
+ :type: RecipientProofFile
+ """
+
+ self._proof_file = proof_file
+
+ @property
+ def recipient_attachments(self):
+ """Gets the recipient_attachments of this AuthorizedSignatory. # noqa: E501
+
+ Reserved: # noqa: E501
+
+ :return: The recipient_attachments of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[RecipientAttachment]
+ """
+ return self._recipient_attachments
+
+ @recipient_attachments.setter
+ def recipient_attachments(self, recipient_attachments):
+ """Sets the recipient_attachments of this AuthorizedSignatory.
+
+ Reserved: # noqa: E501
+
+ :param recipient_attachments: The recipient_attachments of this AuthorizedSignatory. # noqa: E501
+ :type: list[RecipientAttachment]
+ """
+
+ self._recipient_attachments = recipient_attachments
+
+ @property
+ def recipient_authentication_status(self):
+ """Gets the recipient_authentication_status of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_authentication_status of this AuthorizedSignatory. # noqa: E501
+ :rtype: AuthenticationStatus
+ """
+ return self._recipient_authentication_status
+
+ @recipient_authentication_status.setter
+ def recipient_authentication_status(self, recipient_authentication_status):
+ """Sets the recipient_authentication_status of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param recipient_authentication_status: The recipient_authentication_status of this AuthorizedSignatory. # noqa: E501
+ :type: AuthenticationStatus
+ """
+
+ self._recipient_authentication_status = recipient_authentication_status
+
+ @property
+ def recipient_feature_metadata(self):
+ """Gets the recipient_feature_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_feature_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[FeatureAvailableMetadata]
+ """
+ return self._recipient_feature_metadata
+
+ @recipient_feature_metadata.setter
+ def recipient_feature_metadata(self, recipient_feature_metadata):
+ """Sets the recipient_feature_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param recipient_feature_metadata: The recipient_feature_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: list[FeatureAvailableMetadata]
+ """
+
+ self._recipient_feature_metadata = recipient_feature_metadata
+
+ @property
+ def recipient_id(self):
+ """Gets the recipient_id of this AuthorizedSignatory. # noqa: E501
+
+ Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501
+
+ :return: The recipient_id of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._recipient_id
+
+ @recipient_id.setter
+ def recipient_id(self, recipient_id):
+ """Sets the recipient_id of this AuthorizedSignatory.
+
+ Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501
+
+ :param recipient_id: The recipient_id of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._recipient_id = recipient_id
+
+ @property
+ def recipient_id_guid(self):
+ """Gets the recipient_id_guid of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_id_guid of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._recipient_id_guid
+
+ @recipient_id_guid.setter
+ def recipient_id_guid(self, recipient_id_guid):
+ """Sets the recipient_id_guid of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param recipient_id_guid: The recipient_id_guid of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._recipient_id_guid = recipient_id_guid
+
+ @property
+ def recipient_signature_providers(self):
+ """Gets the recipient_signature_providers of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_signature_providers of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[RecipientSignatureProvider]
+ """
+ return self._recipient_signature_providers
+
+ @recipient_signature_providers.setter
+ def recipient_signature_providers(self, recipient_signature_providers):
+ """Sets the recipient_signature_providers of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param recipient_signature_providers: The recipient_signature_providers of this AuthorizedSignatory. # noqa: E501
+ :type: list[RecipientSignatureProvider]
+ """
+
+ self._recipient_signature_providers = recipient_signature_providers
+
+ @property
+ def recipient_supplies_tabs(self):
+ """Gets the recipient_supplies_tabs of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_supplies_tabs of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._recipient_supplies_tabs
+
+ @recipient_supplies_tabs.setter
+ def recipient_supplies_tabs(self, recipient_supplies_tabs):
+ """Sets the recipient_supplies_tabs of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param recipient_supplies_tabs: The recipient_supplies_tabs of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._recipient_supplies_tabs = recipient_supplies_tabs
+
+ @property
+ def recipient_type(self):
+ """Gets the recipient_type of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_type of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._recipient_type
+
+ @recipient_type.setter
+ def recipient_type(self, recipient_type):
+ """Sets the recipient_type of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param recipient_type: The recipient_type of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._recipient_type = recipient_type
+
+ @property
+ def recipient_type_metadata(self):
+ """Gets the recipient_type_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_type_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._recipient_type_metadata
+
+ @recipient_type_metadata.setter
+ def recipient_type_metadata(self, recipient_type_metadata):
+ """Sets the recipient_type_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param recipient_type_metadata: The recipient_type_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._recipient_type_metadata = recipient_type_metadata
+
+ @property
+ def require_id_lookup(self):
+ """Gets the require_id_lookup of this AuthorizedSignatory. # noqa: E501
+
+ When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501
+
+ :return: The require_id_lookup of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._require_id_lookup
+
+ @require_id_lookup.setter
+ def require_id_lookup(self, require_id_lookup):
+ """Sets the require_id_lookup of this AuthorizedSignatory.
+
+ When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501
+
+ :param require_id_lookup: The require_id_lookup of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._require_id_lookup = require_id_lookup
+
+ @property
+ def require_id_lookup_metadata(self):
+ """Gets the require_id_lookup_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The require_id_lookup_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._require_id_lookup_metadata
+
+ @require_id_lookup_metadata.setter
+ def require_id_lookup_metadata(self, require_id_lookup_metadata):
+ """Sets the require_id_lookup_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param require_id_lookup_metadata: The require_id_lookup_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._require_id_lookup_metadata = require_id_lookup_metadata
+
+ @property
+ def require_signer_certificate(self):
+ """Gets the require_signer_certificate of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The require_signer_certificate of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._require_signer_certificate
+
+ @require_signer_certificate.setter
+ def require_signer_certificate(self, require_signer_certificate):
+ """Sets the require_signer_certificate of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param require_signer_certificate: The require_signer_certificate of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._require_signer_certificate = require_signer_certificate
+
+ @property
+ def require_sign_on_paper(self):
+ """Gets the require_sign_on_paper of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The require_sign_on_paper of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._require_sign_on_paper
+
+ @require_sign_on_paper.setter
+ def require_sign_on_paper(self, require_sign_on_paper):
+ """Sets the require_sign_on_paper of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param require_sign_on_paper: The require_sign_on_paper of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._require_sign_on_paper = require_sign_on_paper
+
+ @property
+ def require_upload_signature(self):
+ """Gets the require_upload_signature of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The require_upload_signature of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._require_upload_signature
+
+ @require_upload_signature.setter
+ def require_upload_signature(self, require_upload_signature):
+ """Sets the require_upload_signature of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param require_upload_signature: The require_upload_signature of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._require_upload_signature = require_upload_signature
+
+ @property
+ def role_name(self):
+ """Gets the role_name of this AuthorizedSignatory. # noqa: E501
+
+ Optional element. Specifies the role name associated with the recipient.
This is required when working with template recipients. # noqa: E501
+
+ :return: The role_name of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._role_name
+
+ @role_name.setter
+ def role_name(self, role_name):
+ """Sets the role_name of this AuthorizedSignatory.
+
+ Optional element. Specifies the role name associated with the recipient.
This is required when working with template recipients. # noqa: E501
+
+ :param role_name: The role_name of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._role_name = role_name
+
+ @property
+ def routing_order(self):
+ """Gets the routing_order of this AuthorizedSignatory. # noqa: E501
+
+ Specifies the routing order of the recipient in the envelope. # noqa: E501
+
+ :return: The routing_order of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._routing_order
+
+ @routing_order.setter
+ def routing_order(self, routing_order):
+ """Sets the routing_order of this AuthorizedSignatory.
+
+ Specifies the routing order of the recipient in the envelope. # noqa: E501
+
+ :param routing_order: The routing_order of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._routing_order = routing_order
+
+ @property
+ def routing_order_metadata(self):
+ """Gets the routing_order_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The routing_order_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._routing_order_metadata
+
+ @routing_order_metadata.setter
+ def routing_order_metadata(self, routing_order_metadata):
+ """Sets the routing_order_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param routing_order_metadata: The routing_order_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._routing_order_metadata = routing_order_metadata
+
+ @property
+ def sent_date_time(self):
+ """Gets the sent_date_time of this AuthorizedSignatory. # noqa: E501
+
+ The date and time the envelope was sent. # noqa: E501
+
+ :return: The sent_date_time of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._sent_date_time
+
+ @sent_date_time.setter
+ def sent_date_time(self, sent_date_time):
+ """Sets the sent_date_time of this AuthorizedSignatory.
+
+ The date and time the envelope was sent. # noqa: E501
+
+ :param sent_date_time: The sent_date_time of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._sent_date_time = sent_date_time
+
+ @property
+ def signature_info(self):
+ """Gets the signature_info of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The signature_info of this AuthorizedSignatory. # noqa: E501
+ :rtype: RecipientSignatureInformation
+ """
+ return self._signature_info
+
+ @signature_info.setter
+ def signature_info(self, signature_info):
+ """Sets the signature_info of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param signature_info: The signature_info of this AuthorizedSignatory. # noqa: E501
+ :type: RecipientSignatureInformation
+ """
+
+ self._signature_info = signature_info
+
+ @property
+ def signed_date_time(self):
+ """Gets the signed_date_time of this AuthorizedSignatory. # noqa: E501
+
+ Reserved: For DocuSign use only. # noqa: E501
+
+ :return: The signed_date_time of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._signed_date_time
+
+ @signed_date_time.setter
+ def signed_date_time(self, signed_date_time):
+ """Sets the signed_date_time of this AuthorizedSignatory.
+
+ Reserved: For DocuSign use only. # noqa: E501
+
+ :param signed_date_time: The signed_date_time of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._signed_date_time = signed_date_time
+
+ @property
+ def sign_in_each_location(self):
+ """Gets the sign_in_each_location of this AuthorizedSignatory. # noqa: E501
+
+ When set to **true**, specifies that the signer must sign in all locations. # noqa: E501
+
+ :return: The sign_in_each_location of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._sign_in_each_location
+
+ @sign_in_each_location.setter
+ def sign_in_each_location(self, sign_in_each_location):
+ """Sets the sign_in_each_location of this AuthorizedSignatory.
+
+ When set to **true**, specifies that the signer must sign in all locations. # noqa: E501
+
+ :param sign_in_each_location: The sign_in_each_location of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._sign_in_each_location = sign_in_each_location
+
+ @property
+ def sign_in_each_location_metadata(self):
+ """Gets the sign_in_each_location_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The sign_in_each_location_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._sign_in_each_location_metadata
+
+ @sign_in_each_location_metadata.setter
+ def sign_in_each_location_metadata(self, sign_in_each_location_metadata):
+ """Sets the sign_in_each_location_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param sign_in_each_location_metadata: The sign_in_each_location_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._sign_in_each_location_metadata = sign_in_each_location_metadata
+
+ @property
+ def signing_group_id(self):
+ """Gets the signing_group_id of this AuthorizedSignatory. # noqa: E501
+
+ When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501
+
+ :return: The signing_group_id of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._signing_group_id
+
+ @signing_group_id.setter
+ def signing_group_id(self, signing_group_id):
+ """Sets the signing_group_id of this AuthorizedSignatory.
+
+ When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501
+
+ :param signing_group_id: The signing_group_id of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._signing_group_id = signing_group_id
+
+ @property
+ def signing_group_id_metadata(self):
+ """Gets the signing_group_id_metadata of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The signing_group_id_metadata of this AuthorizedSignatory. # noqa: E501
+ :rtype: PropertyMetadata
+ """
+ return self._signing_group_id_metadata
+
+ @signing_group_id_metadata.setter
+ def signing_group_id_metadata(self, signing_group_id_metadata):
+ """Sets the signing_group_id_metadata of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param signing_group_id_metadata: The signing_group_id_metadata of this AuthorizedSignatory. # noqa: E501
+ :type: PropertyMetadata
+ """
+
+ self._signing_group_id_metadata = signing_group_id_metadata
+
+ @property
+ def signing_group_name(self):
+ """Gets the signing_group_name of this AuthorizedSignatory. # noqa: E501
+
+ The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
+
+ :return: The signing_group_name of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._signing_group_name
+
+ @signing_group_name.setter
+ def signing_group_name(self, signing_group_name):
+ """Sets the signing_group_name of this AuthorizedSignatory.
+
+ The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
+
+ :param signing_group_name: The signing_group_name of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._signing_group_name = signing_group_name
+
+ @property
+ def signing_group_type(self):
+ """Gets the signing_group_type of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The signing_group_type of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._signing_group_type
+
+ @signing_group_type.setter
+ def signing_group_type(self, signing_group_type):
+ """Sets the signing_group_type of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param signing_group_type: The signing_group_type of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._signing_group_type = signing_group_type
+
+ @property
+ def signing_group_users(self):
+ """Gets the signing_group_users of this AuthorizedSignatory. # noqa: E501
+
+ A complex type that contains information about users in the signing group. # noqa: E501
+
+ :return: The signing_group_users of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[UserInfo]
+ """
+ return self._signing_group_users
+
+ @signing_group_users.setter
+ def signing_group_users(self, signing_group_users):
+ """Sets the signing_group_users of this AuthorizedSignatory.
+
+ A complex type that contains information about users in the signing group. # noqa: E501
+
+ :param signing_group_users: The signing_group_users of this AuthorizedSignatory. # noqa: E501
+ :type: list[UserInfo]
+ """
+
+ self._signing_group_users = signing_group_users
+
+ @property
+ def sms_authentication(self):
+ """Gets the sms_authentication of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The sms_authentication of this AuthorizedSignatory. # noqa: E501
+ :rtype: RecipientSMSAuthentication
+ """
+ return self._sms_authentication
+
+ @sms_authentication.setter
+ def sms_authentication(self, sms_authentication):
+ """Sets the sms_authentication of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param sms_authentication: The sms_authentication of this AuthorizedSignatory. # noqa: E501
+ :type: RecipientSMSAuthentication
+ """
+
+ self._sms_authentication = sms_authentication
+
+ @property
+ def social_authentications(self):
+ """Gets the social_authentications of this AuthorizedSignatory. # noqa: E501
+
+ Lists the social ID type that can be used for recipient authentication. # noqa: E501
+
+ :return: The social_authentications of this AuthorizedSignatory. # noqa: E501
+ :rtype: list[SocialAuthentication]
+ """
+ return self._social_authentications
+
+ @social_authentications.setter
+ def social_authentications(self, social_authentications):
+ """Sets the social_authentications of this AuthorizedSignatory.
+
+ Lists the social ID type that can be used for recipient authentication. # noqa: E501
+
+ :param social_authentications: The social_authentications of this AuthorizedSignatory. # noqa: E501
+ :type: list[SocialAuthentication]
+ """
+
+ self._social_authentications = social_authentications
+
+ @property
+ def status(self):
+ """Gets the status of this AuthorizedSignatory. # noqa: E501
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :return: The status of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this AuthorizedSignatory.
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :param status: The status of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def status_code(self):
+ """Gets the status_code of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The status_code of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._status_code
+
+ @status_code.setter
+ def status_code(self, status_code):
+ """Sets the status_code of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param status_code: The status_code of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._status_code = status_code
+
+ @property
+ def suppress_emails(self):
+ """Gets the suppress_emails of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The suppress_emails of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._suppress_emails
+
+ @suppress_emails.setter
+ def suppress_emails(self, suppress_emails):
+ """Sets the suppress_emails of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param suppress_emails: The suppress_emails of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._suppress_emails = suppress_emails
+
+ @property
+ def tabs(self):
+ """Gets the tabs of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The tabs of this AuthorizedSignatory. # noqa: E501
+ :rtype: Tabs
+ """
+ return self._tabs
+
+ @tabs.setter
+ def tabs(self, tabs):
+ """Sets the tabs of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param tabs: The tabs of this AuthorizedSignatory. # noqa: E501
+ :type: Tabs
+ """
+
+ self._tabs = tabs
+
+ @property
+ def template_locked(self):
+ """Gets the template_locked of this AuthorizedSignatory. # noqa: E501
+
+ When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
+
+ :return: The template_locked of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._template_locked
+
+ @template_locked.setter
+ def template_locked(self, template_locked):
+ """Sets the template_locked of this AuthorizedSignatory.
+
+ When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
+
+ :param template_locked: The template_locked of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._template_locked = template_locked
+
+ @property
+ def template_required(self):
+ """Gets the template_required of this AuthorizedSignatory. # noqa: E501
+
+ When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
+
+ :return: The template_required of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._template_required
+
+ @template_required.setter
+ def template_required(self, template_required):
+ """Sets the template_required of this AuthorizedSignatory.
+
+ When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
+
+ :param template_required: The template_required of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._template_required = template_required
+
+ @property
+ def total_tab_count(self):
+ """Gets the total_tab_count of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The total_tab_count of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._total_tab_count
+
+ @total_tab_count.setter
+ def total_tab_count(self, total_tab_count):
+ """Sets the total_tab_count of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param total_tab_count: The total_tab_count of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._total_tab_count = total_tab_count
+
+ @property
+ def user_id(self):
+ """Gets the user_id of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The user_id of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._user_id
+
+ @user_id.setter
+ def user_id(self, user_id):
+ """Sets the user_id of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param user_id: The user_id of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._user_id = user_id
+
+ @property
+ def web_form_recipient_view_id(self):
+ """Gets the web_form_recipient_view_id of this AuthorizedSignatory. # noqa: E501
+
+ # noqa: E501
+
+ :return: The web_form_recipient_view_id of this AuthorizedSignatory. # noqa: E501
+ :rtype: str
+ """
+ return self._web_form_recipient_view_id
+
+ @web_form_recipient_view_id.setter
+ def web_form_recipient_view_id(self, web_form_recipient_view_id):
+ """Sets the web_form_recipient_view_id of this AuthorizedSignatory.
+
+ # noqa: E501
+
+ :param web_form_recipient_view_id: The web_form_recipient_view_id of this AuthorizedSignatory. # noqa: E501
+ :type: str
+ """
+
+ self._web_form_recipient_view_id = web_form_recipient_view_id
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(AuthorizedSignatory, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, AuthorizedSignatory):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, AuthorizedSignatory):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/connect_custom_configuration.py b/docusign_esign/models/connect_custom_configuration.py
index e860464..26efd86 100644
--- a/docusign_esign/models/connect_custom_configuration.py
+++ b/docusign_esign/models/connect_custom_configuration.py
@@ -69,6 +69,7 @@ class ConnectCustomConfiguration(object):
'salesforce_api_version': 'str',
'salesforce_authcode': 'str',
'salesforce_call_back_url': 'str',
+ 'salesforce_code_verifier': 'str',
'salesforce_documents_as_content_files': 'str',
'sender_override': 'str',
'sender_selectable_items': 'list[str]',
@@ -118,6 +119,7 @@ class ConnectCustomConfiguration(object):
'salesforce_api_version': 'salesforceApiVersion',
'salesforce_authcode': 'salesforceAuthcode',
'salesforce_call_back_url': 'salesforceCallBackUrl',
+ 'salesforce_code_verifier': 'salesforceCodeVerifier',
'salesforce_documents_as_content_files': 'salesforceDocumentsAsContentFiles',
'sender_override': 'senderOverride',
'sender_selectable_items': 'senderSelectableItems',
@@ -172,6 +174,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._salesforce_api_version = None
self._salesforce_authcode = None
self._salesforce_call_back_url = None
+ self._salesforce_code_verifier = None
self._salesforce_documents_as_content_files = None
self._sender_override = None
self._sender_selectable_items = None
@@ -220,6 +223,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('salesforce_api_version'), kwargs.get('salesforce_api_version', None))
setattr(self, "_{}".format('salesforce_authcode'), kwargs.get('salesforce_authcode', None))
setattr(self, "_{}".format('salesforce_call_back_url'), kwargs.get('salesforce_call_back_url', None))
+ setattr(self, "_{}".format('salesforce_code_verifier'), kwargs.get('salesforce_code_verifier', None))
setattr(self, "_{}".format('salesforce_documents_as_content_files'), kwargs.get('salesforce_documents_as_content_files', None))
setattr(self, "_{}".format('sender_override'), kwargs.get('sender_override', None))
setattr(self, "_{}".format('sender_selectable_items'), kwargs.get('sender_selectable_items', None))
@@ -1059,6 +1063,29 @@ def salesforce_call_back_url(self, salesforce_call_back_url):
self._salesforce_call_back_url = salesforce_call_back_url
+ @property
+ def salesforce_code_verifier(self):
+ """Gets the salesforce_code_verifier of this ConnectCustomConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The salesforce_code_verifier of this ConnectCustomConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._salesforce_code_verifier
+
+ @salesforce_code_verifier.setter
+ def salesforce_code_verifier(self, salesforce_code_verifier):
+ """Sets the salesforce_code_verifier of this ConnectCustomConfiguration.
+
+ # noqa: E501
+
+ :param salesforce_code_verifier: The salesforce_code_verifier of this ConnectCustomConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._salesforce_code_verifier = salesforce_code_verifier
+
@property
def salesforce_documents_as_content_files(self):
"""Gets the salesforce_documents_as_content_files of this ConnectCustomConfiguration. # noqa: E501
diff --git a/docusign_esign/models/doc_gen_conditional_operation_base.py b/docusign_esign/models/doc_gen_conditional_operation_base.py
new file mode 100644
index 0000000..a8c4360
--- /dev/null
+++ b/docusign_esign/models/doc_gen_conditional_operation_base.py
@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class DocGenConditionalOperationBase(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ }
+
+ attribute_map = {
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """DocGenConditionalOperationBase - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+ self.discriminator = None
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(DocGenConditionalOperationBase, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, DocGenConditionalOperationBase):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, DocGenConditionalOperationBase):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/doc_gen_conditional_rule.py b/docusign_esign/models/doc_gen_conditional_rule.py
new file mode 100644
index 0000000..f5c29d9
--- /dev/null
+++ b/docusign_esign/models/doc_gen_conditional_rule.py
@@ -0,0 +1,205 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class DocGenConditionalRule(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'conditional_operations': 'list[DocGenConditionalOperationBase]',
+ 'conditional_rule_effect': 'str',
+ 'conditional_rule_effect_fields': 'list[str]',
+ 'conditional_rule_operator': 'str'
+ }
+
+ attribute_map = {
+ 'conditional_operations': 'conditionalOperations',
+ 'conditional_rule_effect': 'conditionalRuleEffect',
+ 'conditional_rule_effect_fields': 'conditionalRuleEffectFields',
+ 'conditional_rule_operator': 'conditionalRuleOperator'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """DocGenConditionalRule - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._conditional_operations = None
+ self._conditional_rule_effect = None
+ self._conditional_rule_effect_fields = None
+ self._conditional_rule_operator = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('conditional_operations'), kwargs.get('conditional_operations', None))
+ setattr(self, "_{}".format('conditional_rule_effect'), kwargs.get('conditional_rule_effect', None))
+ setattr(self, "_{}".format('conditional_rule_effect_fields'), kwargs.get('conditional_rule_effect_fields', None))
+ setattr(self, "_{}".format('conditional_rule_operator'), kwargs.get('conditional_rule_operator', None))
+
+ @property
+ def conditional_operations(self):
+ """Gets the conditional_operations of this DocGenConditionalRule. # noqa: E501
+
+ # noqa: E501
+
+ :return: The conditional_operations of this DocGenConditionalRule. # noqa: E501
+ :rtype: list[DocGenConditionalOperationBase]
+ """
+ return self._conditional_operations
+
+ @conditional_operations.setter
+ def conditional_operations(self, conditional_operations):
+ """Sets the conditional_operations of this DocGenConditionalRule.
+
+ # noqa: E501
+
+ :param conditional_operations: The conditional_operations of this DocGenConditionalRule. # noqa: E501
+ :type: list[DocGenConditionalOperationBase]
+ """
+
+ self._conditional_operations = conditional_operations
+
+ @property
+ def conditional_rule_effect(self):
+ """Gets the conditional_rule_effect of this DocGenConditionalRule. # noqa: E501
+
+ # noqa: E501
+
+ :return: The conditional_rule_effect of this DocGenConditionalRule. # noqa: E501
+ :rtype: str
+ """
+ return self._conditional_rule_effect
+
+ @conditional_rule_effect.setter
+ def conditional_rule_effect(self, conditional_rule_effect):
+ """Sets the conditional_rule_effect of this DocGenConditionalRule.
+
+ # noqa: E501
+
+ :param conditional_rule_effect: The conditional_rule_effect of this DocGenConditionalRule. # noqa: E501
+ :type: str
+ """
+
+ self._conditional_rule_effect = conditional_rule_effect
+
+ @property
+ def conditional_rule_effect_fields(self):
+ """Gets the conditional_rule_effect_fields of this DocGenConditionalRule. # noqa: E501
+
+ # noqa: E501
+
+ :return: The conditional_rule_effect_fields of this DocGenConditionalRule. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._conditional_rule_effect_fields
+
+ @conditional_rule_effect_fields.setter
+ def conditional_rule_effect_fields(self, conditional_rule_effect_fields):
+ """Sets the conditional_rule_effect_fields of this DocGenConditionalRule.
+
+ # noqa: E501
+
+ :param conditional_rule_effect_fields: The conditional_rule_effect_fields of this DocGenConditionalRule. # noqa: E501
+ :type: list[str]
+ """
+
+ self._conditional_rule_effect_fields = conditional_rule_effect_fields
+
+ @property
+ def conditional_rule_operator(self):
+ """Gets the conditional_rule_operator of this DocGenConditionalRule. # noqa: E501
+
+ # noqa: E501
+
+ :return: The conditional_rule_operator of this DocGenConditionalRule. # noqa: E501
+ :rtype: str
+ """
+ return self._conditional_rule_operator
+
+ @conditional_rule_operator.setter
+ def conditional_rule_operator(self, conditional_rule_operator):
+ """Sets the conditional_rule_operator of this DocGenConditionalRule.
+
+ # noqa: E501
+
+ :param conditional_rule_operator: The conditional_rule_operator of this DocGenConditionalRule. # noqa: E501
+ :type: str
+ """
+
+ self._conditional_rule_operator = conditional_rule_operator
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(DocGenConditionalRule, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, DocGenConditionalRule):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, DocGenConditionalRule):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/doc_gen_form_field.py b/docusign_esign/models/doc_gen_form_field.py
index 9f7beab..4d1a751 100644
--- a/docusign_esign/models/doc_gen_form_field.py
+++ b/docusign_esign/models/doc_gen_form_field.py
@@ -33,18 +33,20 @@ class DocGenFormField(object):
and the value is json key in definition.
"""
swagger_types = {
+ 'children': 'list[DocGenFormField]',
'connected_object_details': 'ConnectedObjectDetails',
'default_value': 'str',
'description': 'str',
+ 'filter': 'object',
'format': 'DocGenFormat',
'fully_qualified_path': 'str',
- 'hidden': 'str',
+ 'hidden': 'bool',
'label': 'str',
'name': 'str',
'options': 'list[DocGenFormFieldOption]',
'order': 'str',
'predefined_validation': 'str',
- 'read_only': 'str',
+ 'read_only': 'bool',
'required': 'str',
'row_values': 'list[DocGenFormFieldRowValue]',
'type': 'str',
@@ -53,9 +55,11 @@ class DocGenFormField(object):
}
attribute_map = {
+ 'children': 'children',
'connected_object_details': 'connectedObjectDetails',
'default_value': 'defaultValue',
'description': 'description',
+ 'filter': 'filter',
'format': 'format',
'fully_qualified_path': 'fullyQualifiedPath',
'hidden': 'hidden',
@@ -78,9 +82,11 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
_configuration = Configuration()
self._configuration = _configuration
+ self._children = None
self._connected_object_details = None
self._default_value = None
self._description = None
+ self._filter = None
self._format = None
self._fully_qualified_path = None
self._hidden = None
@@ -97,9 +103,11 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._value = None
self.discriminator = None
+ setattr(self, "_{}".format('children'), kwargs.get('children', None))
setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None))
setattr(self, "_{}".format('default_value'), kwargs.get('default_value', None))
setattr(self, "_{}".format('description'), kwargs.get('description', None))
+ setattr(self, "_{}".format('filter'), kwargs.get('filter', None))
setattr(self, "_{}".format('format'), kwargs.get('format', None))
setattr(self, "_{}".format('fully_qualified_path'), kwargs.get('fully_qualified_path', None))
setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None))
@@ -115,6 +123,29 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('validation'), kwargs.get('validation', None))
setattr(self, "_{}".format('value'), kwargs.get('value', None))
+ @property
+ def children(self):
+ """Gets the children of this DocGenFormField. # noqa: E501
+
+ # noqa: E501
+
+ :return: The children of this DocGenFormField. # noqa: E501
+ :rtype: list[DocGenFormField]
+ """
+ return self._children
+
+ @children.setter
+ def children(self, children):
+ """Sets the children of this DocGenFormField.
+
+ # noqa: E501
+
+ :param children: The children of this DocGenFormField. # noqa: E501
+ :type: list[DocGenFormField]
+ """
+
+ self._children = children
+
@property
def connected_object_details(self):
"""Gets the connected_object_details of this DocGenFormField. # noqa: E501
@@ -184,6 +215,29 @@ def description(self, description):
self._description = description
+ @property
+ def filter(self):
+ """Gets the filter of this DocGenFormField. # noqa: E501
+
+ # noqa: E501
+
+ :return: The filter of this DocGenFormField. # noqa: E501
+ :rtype: object
+ """
+ return self._filter
+
+ @filter.setter
+ def filter(self, filter):
+ """Sets the filter of this DocGenFormField.
+
+ # noqa: E501
+
+ :param filter: The filter of this DocGenFormField. # noqa: E501
+ :type: object
+ """
+
+ self._filter = filter
+
@property
def format(self):
"""Gets the format of this DocGenFormField. # noqa: E501
@@ -237,7 +291,7 @@ def hidden(self):
# noqa: E501
:return: The hidden of this DocGenFormField. # noqa: E501
- :rtype: str
+ :rtype: bool
"""
return self._hidden
@@ -248,7 +302,7 @@ def hidden(self, hidden):
# noqa: E501
:param hidden: The hidden of this DocGenFormField. # noqa: E501
- :type: str
+ :type: bool
"""
self._hidden = hidden
@@ -375,7 +429,7 @@ def read_only(self):
# noqa: E501
:return: The read_only of this DocGenFormField. # noqa: E501
- :rtype: str
+ :rtype: bool
"""
return self._read_only
@@ -386,7 +440,7 @@ def read_only(self, read_only):
# noqa: E501
:param read_only: The read_only of this DocGenFormField. # noqa: E501
- :type: str
+ :type: bool
"""
self._read_only = read_only
diff --git a/docusign_esign/models/doc_gen_form_fields.py b/docusign_esign/models/doc_gen_form_fields.py
index 7235d48..de555c0 100644
--- a/docusign_esign/models/doc_gen_form_fields.py
+++ b/docusign_esign/models/doc_gen_form_fields.py
@@ -33,6 +33,7 @@ class DocGenFormFields(object):
and the value is json key in definition.
"""
swagger_types = {
+ 'doc_gen_conditional_rules': 'list[DocGenConditionalRule]',
'doc_gen_document_status': 'str',
'doc_gen_errors': 'list[DocGenSyntaxError]',
'doc_gen_form_field_list': 'list[DocGenFormField]',
@@ -40,6 +41,7 @@ class DocGenFormFields(object):
}
attribute_map = {
+ 'doc_gen_conditional_rules': 'docGenConditionalRules',
'doc_gen_document_status': 'docGenDocumentStatus',
'doc_gen_errors': 'docGenErrors',
'doc_gen_form_field_list': 'docGenFormFieldList',
@@ -52,17 +54,42 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
_configuration = Configuration()
self._configuration = _configuration
+ self._doc_gen_conditional_rules = None
self._doc_gen_document_status = None
self._doc_gen_errors = None
self._doc_gen_form_field_list = None
self._document_id = None
self.discriminator = None
+ setattr(self, "_{}".format('doc_gen_conditional_rules'), kwargs.get('doc_gen_conditional_rules', None))
setattr(self, "_{}".format('doc_gen_document_status'), kwargs.get('doc_gen_document_status', None))
setattr(self, "_{}".format('doc_gen_errors'), kwargs.get('doc_gen_errors', None))
setattr(self, "_{}".format('doc_gen_form_field_list'), kwargs.get('doc_gen_form_field_list', None))
setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None))
+ @property
+ def doc_gen_conditional_rules(self):
+ """Gets the doc_gen_conditional_rules of this DocGenFormFields. # noqa: E501
+
+ # noqa: E501
+
+ :return: The doc_gen_conditional_rules of this DocGenFormFields. # noqa: E501
+ :rtype: list[DocGenConditionalRule]
+ """
+ return self._doc_gen_conditional_rules
+
+ @doc_gen_conditional_rules.setter
+ def doc_gen_conditional_rules(self, doc_gen_conditional_rules):
+ """Sets the doc_gen_conditional_rules of this DocGenFormFields.
+
+ # noqa: E501
+
+ :param doc_gen_conditional_rules: The doc_gen_conditional_rules of this DocGenFormFields. # noqa: E501
+ :type: list[DocGenConditionalRule]
+ """
+
+ self._doc_gen_conditional_rules = doc_gen_conditional_rules
+
@property
def doc_gen_document_status(self):
"""Gets the doc_gen_document_status of this DocGenFormFields. # noqa: E501
diff --git a/docusign_esign/models/envelope.py b/docusign_esign/models/envelope.py
index 0d78d9d..780576b 100644
--- a/docusign_esign/models/envelope.py
+++ b/docusign_esign/models/envelope.py
@@ -66,6 +66,7 @@ class Envelope(object):
'enable_wet_sign': 'str',
'enforce_signer_visibility': 'str',
'envelope_attachments': 'list[Attachment]',
+ 'envelope_classification': 'str',
'envelope_custom_metadata': 'EnvelopeCustomMetadata',
'envelope_documents': 'list[EnvelopeDocument]',
'envelope_id': 'str',
@@ -112,6 +113,7 @@ class Envelope(object):
'u_sig_state': 'str',
'voided_date_time': 'str',
'voided_reason': 'str',
+ 'watermark_language': 'str',
'workflow': 'Workflow'
}
@@ -149,6 +151,7 @@ class Envelope(object):
'enable_wet_sign': 'enableWetSign',
'enforce_signer_visibility': 'enforceSignerVisibility',
'envelope_attachments': 'envelopeAttachments',
+ 'envelope_classification': 'envelopeClassification',
'envelope_custom_metadata': 'envelopeCustomMetadata',
'envelope_documents': 'envelopeDocuments',
'envelope_id': 'envelopeId',
@@ -195,6 +198,7 @@ class Envelope(object):
'u_sig_state': 'uSigState',
'voided_date_time': 'voidedDateTime',
'voided_reason': 'voidedReason',
+ 'watermark_language': 'watermarkLanguage',
'workflow': 'workflow'
}
@@ -237,6 +241,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._enable_wet_sign = None
self._enforce_signer_visibility = None
self._envelope_attachments = None
+ self._envelope_classification = None
self._envelope_custom_metadata = None
self._envelope_documents = None
self._envelope_id = None
@@ -283,6 +288,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._u_sig_state = None
self._voided_date_time = None
self._voided_reason = None
+ self._watermark_language = None
self._workflow = None
self.discriminator = None
@@ -319,6 +325,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('enable_wet_sign'), kwargs.get('enable_wet_sign', None))
setattr(self, "_{}".format('enforce_signer_visibility'), kwargs.get('enforce_signer_visibility', None))
setattr(self, "_{}".format('envelope_attachments'), kwargs.get('envelope_attachments', None))
+ setattr(self, "_{}".format('envelope_classification'), kwargs.get('envelope_classification', None))
setattr(self, "_{}".format('envelope_custom_metadata'), kwargs.get('envelope_custom_metadata', None))
setattr(self, "_{}".format('envelope_documents'), kwargs.get('envelope_documents', None))
setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
@@ -365,6 +372,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('u_sig_state'), kwargs.get('u_sig_state', None))
setattr(self, "_{}".format('voided_date_time'), kwargs.get('voided_date_time', None))
setattr(self, "_{}".format('voided_reason'), kwargs.get('voided_reason', None))
+ setattr(self, "_{}".format('watermark_language'), kwargs.get('watermark_language', None))
setattr(self, "_{}".format('workflow'), kwargs.get('workflow', None))
@property
@@ -1126,6 +1134,29 @@ def envelope_attachments(self, envelope_attachments):
self._envelope_attachments = envelope_attachments
+ @property
+ def envelope_classification(self):
+ """Gets the envelope_classification of this Envelope. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_classification of this Envelope. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_classification
+
+ @envelope_classification.setter
+ def envelope_classification(self, envelope_classification):
+ """Sets the envelope_classification of this Envelope.
+
+ # noqa: E501
+
+ :param envelope_classification: The envelope_classification of this Envelope. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_classification = envelope_classification
+
@property
def envelope_custom_metadata(self):
"""Gets the envelope_custom_metadata of this Envelope. # noqa: E501
@@ -2184,6 +2215,29 @@ def voided_reason(self, voided_reason):
self._voided_reason = voided_reason
+ @property
+ def watermark_language(self):
+ """Gets the watermark_language of this Envelope. # noqa: E501
+
+ # noqa: E501
+
+ :return: The watermark_language of this Envelope. # noqa: E501
+ :rtype: str
+ """
+ return self._watermark_language
+
+ @watermark_language.setter
+ def watermark_language(self, watermark_language):
+ """Sets the watermark_language of this Envelope.
+
+ # noqa: E501
+
+ :param watermark_language: The watermark_language of this Envelope. # noqa: E501
+ :type: str
+ """
+
+ self._watermark_language = watermark_language
+
@property
def workflow(self):
"""Gets the workflow of this Envelope. # noqa: E501
diff --git a/docusign_esign/models/envelope_archive_summary.py b/docusign_esign/models/envelope_archive_summary.py
new file mode 100644
index 0000000..99b5f8b
--- /dev/null
+++ b/docusign_esign/models/envelope_archive_summary.py
@@ -0,0 +1,313 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class EnvelopeArchiveSummary(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'bulk_envelope_status': 'BulkEnvelopeStatus',
+ 'envelope_id': 'str',
+ 'error_details': 'ErrorDetails',
+ 'recipient_signing_uri': 'str',
+ 'recipient_signing_uri_error': 'str',
+ 'status': 'str',
+ 'status_date_time': 'str',
+ 'uri': 'str'
+ }
+
+ attribute_map = {
+ 'bulk_envelope_status': 'bulkEnvelopeStatus',
+ 'envelope_id': 'envelopeId',
+ 'error_details': 'errorDetails',
+ 'recipient_signing_uri': 'recipientSigningUri',
+ 'recipient_signing_uri_error': 'recipientSigningUriError',
+ 'status': 'status',
+ 'status_date_time': 'statusDateTime',
+ 'uri': 'uri'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """EnvelopeArchiveSummary - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._bulk_envelope_status = None
+ self._envelope_id = None
+ self._error_details = None
+ self._recipient_signing_uri = None
+ self._recipient_signing_uri_error = None
+ self._status = None
+ self._status_date_time = None
+ self._uri = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('bulk_envelope_status'), kwargs.get('bulk_envelope_status', None))
+ setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
+ setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
+ setattr(self, "_{}".format('recipient_signing_uri'), kwargs.get('recipient_signing_uri', None))
+ setattr(self, "_{}".format('recipient_signing_uri_error'), kwargs.get('recipient_signing_uri_error', None))
+ setattr(self, "_{}".format('status'), kwargs.get('status', None))
+ setattr(self, "_{}".format('status_date_time'), kwargs.get('status_date_time', None))
+ setattr(self, "_{}".format('uri'), kwargs.get('uri', None))
+
+ @property
+ def bulk_envelope_status(self):
+ """Gets the bulk_envelope_status of this EnvelopeArchiveSummary. # noqa: E501
+
+ # noqa: E501
+
+ :return: The bulk_envelope_status of this EnvelopeArchiveSummary. # noqa: E501
+ :rtype: BulkEnvelopeStatus
+ """
+ return self._bulk_envelope_status
+
+ @bulk_envelope_status.setter
+ def bulk_envelope_status(self, bulk_envelope_status):
+ """Sets the bulk_envelope_status of this EnvelopeArchiveSummary.
+
+ # noqa: E501
+
+ :param bulk_envelope_status: The bulk_envelope_status of this EnvelopeArchiveSummary. # noqa: E501
+ :type: BulkEnvelopeStatus
+ """
+
+ self._bulk_envelope_status = bulk_envelope_status
+
+ @property
+ def envelope_id(self):
+ """Gets the envelope_id of this EnvelopeArchiveSummary. # noqa: E501
+
+ The envelope ID of the envelope status that failed to post. # noqa: E501
+
+ :return: The envelope_id of this EnvelopeArchiveSummary. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_id
+
+ @envelope_id.setter
+ def envelope_id(self, envelope_id):
+ """Sets the envelope_id of this EnvelopeArchiveSummary.
+
+ The envelope ID of the envelope status that failed to post. # noqa: E501
+
+ :param envelope_id: The envelope_id of this EnvelopeArchiveSummary. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_id = envelope_id
+
+ @property
+ def error_details(self):
+ """Gets the error_details of this EnvelopeArchiveSummary. # noqa: E501
+
+ Array or errors. # noqa: E501
+
+ :return: The error_details of this EnvelopeArchiveSummary. # noqa: E501
+ :rtype: ErrorDetails
+ """
+ return self._error_details
+
+ @error_details.setter
+ def error_details(self, error_details):
+ """Sets the error_details of this EnvelopeArchiveSummary.
+
+ Array or errors. # noqa: E501
+
+ :param error_details: The error_details of this EnvelopeArchiveSummary. # noqa: E501
+ :type: ErrorDetails
+ """
+
+ self._error_details = error_details
+
+ @property
+ def recipient_signing_uri(self):
+ """Gets the recipient_signing_uri of this EnvelopeArchiveSummary. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_signing_uri of this EnvelopeArchiveSummary. # noqa: E501
+ :rtype: str
+ """
+ return self._recipient_signing_uri
+
+ @recipient_signing_uri.setter
+ def recipient_signing_uri(self, recipient_signing_uri):
+ """Sets the recipient_signing_uri of this EnvelopeArchiveSummary.
+
+ # noqa: E501
+
+ :param recipient_signing_uri: The recipient_signing_uri of this EnvelopeArchiveSummary. # noqa: E501
+ :type: str
+ """
+
+ self._recipient_signing_uri = recipient_signing_uri
+
+ @property
+ def recipient_signing_uri_error(self):
+ """Gets the recipient_signing_uri_error of this EnvelopeArchiveSummary. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_signing_uri_error of this EnvelopeArchiveSummary. # noqa: E501
+ :rtype: str
+ """
+ return self._recipient_signing_uri_error
+
+ @recipient_signing_uri_error.setter
+ def recipient_signing_uri_error(self, recipient_signing_uri_error):
+ """Sets the recipient_signing_uri_error of this EnvelopeArchiveSummary.
+
+ # noqa: E501
+
+ :param recipient_signing_uri_error: The recipient_signing_uri_error of this EnvelopeArchiveSummary. # noqa: E501
+ :type: str
+ """
+
+ self._recipient_signing_uri_error = recipient_signing_uri_error
+
+ @property
+ def status(self):
+ """Gets the status of this EnvelopeArchiveSummary. # noqa: E501
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :return: The status of this EnvelopeArchiveSummary. # noqa: E501
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this EnvelopeArchiveSummary.
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :param status: The status of this EnvelopeArchiveSummary. # noqa: E501
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def status_date_time(self):
+ """Gets the status_date_time of this EnvelopeArchiveSummary. # noqa: E501
+
+ # noqa: E501
+
+ :return: The status_date_time of this EnvelopeArchiveSummary. # noqa: E501
+ :rtype: str
+ """
+ return self._status_date_time
+
+ @status_date_time.setter
+ def status_date_time(self, status_date_time):
+ """Sets the status_date_time of this EnvelopeArchiveSummary.
+
+ # noqa: E501
+
+ :param status_date_time: The status_date_time of this EnvelopeArchiveSummary. # noqa: E501
+ :type: str
+ """
+
+ self._status_date_time = status_date_time
+
+ @property
+ def uri(self):
+ """Gets the uri of this EnvelopeArchiveSummary. # noqa: E501
+
+ # noqa: E501
+
+ :return: The uri of this EnvelopeArchiveSummary. # noqa: E501
+ :rtype: str
+ """
+ return self._uri
+
+ @uri.setter
+ def uri(self, uri):
+ """Sets the uri of this EnvelopeArchiveSummary.
+
+ # noqa: E501
+
+ :param uri: The uri of this EnvelopeArchiveSummary. # noqa: E501
+ :type: str
+ """
+
+ self._uri = uri
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(EnvelopeArchiveSummary, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, EnvelopeArchiveSummary):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, EnvelopeArchiveSummary):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/envelope_audit_event_response.py b/docusign_esign/models/envelope_audit_event_response.py
index 62ba549..d0f1914 100644
--- a/docusign_esign/models/envelope_audit_event_response.py
+++ b/docusign_esign/models/envelope_audit_event_response.py
@@ -33,11 +33,13 @@ class EnvelopeAuditEventResponse(object):
and the value is json key in definition.
"""
swagger_types = {
- 'audit_events': 'list[EnvelopeAuditEvent]'
+ 'audit_events': 'list[EnvelopeAuditEvent]',
+ 'payment_events': 'list[PaymentAuditEvent]'
}
attribute_map = {
- 'audit_events': 'auditEvents'
+ 'audit_events': 'auditEvents',
+ 'payment_events': 'paymentEvents'
}
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -47,9 +49,11 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._configuration = _configuration
self._audit_events = None
+ self._payment_events = None
self.discriminator = None
setattr(self, "_{}".format('audit_events'), kwargs.get('audit_events', None))
+ setattr(self, "_{}".format('payment_events'), kwargs.get('payment_events', None))
@property
def audit_events(self):
@@ -74,6 +78,29 @@ def audit_events(self, audit_events):
self._audit_events = audit_events
+ @property
+ def payment_events(self):
+ """Gets the payment_events of this EnvelopeAuditEventResponse. # noqa: E501
+
+ # noqa: E501
+
+ :return: The payment_events of this EnvelopeAuditEventResponse. # noqa: E501
+ :rtype: list[PaymentAuditEvent]
+ """
+ return self._payment_events
+
+ @payment_events.setter
+ def payment_events(self, payment_events):
+ """Sets the payment_events of this EnvelopeAuditEventResponse.
+
+ # noqa: E501
+
+ :param payment_events: The payment_events of this EnvelopeAuditEventResponse. # noqa: E501
+ :type: list[PaymentAuditEvent]
+ """
+
+ self._payment_events = payment_events
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/docusign_esign/models/envelope_definition.py b/docusign_esign/models/envelope_definition.py
index a2e6818..ed55c70 100644
--- a/docusign_esign/models/envelope_definition.py
+++ b/docusign_esign/models/envelope_definition.py
@@ -71,6 +71,7 @@ class EnvelopeDefinition(object):
'enable_wet_sign': 'str',
'enforce_signer_visibility': 'str',
'envelope_attachments': 'list[Attachment]',
+ 'envelope_classification': 'str',
'envelope_custom_metadata': 'EnvelopeCustomMetadata',
'envelope_documents': 'list[EnvelopeDocument]',
'envelope_id': 'str',
@@ -123,6 +124,7 @@ class EnvelopeDefinition(object):
'u_sig_state': 'str',
'voided_date_time': 'str',
'voided_reason': 'str',
+ 'watermark_language': 'str',
'workflow': 'Workflow'
}
@@ -165,6 +167,7 @@ class EnvelopeDefinition(object):
'enable_wet_sign': 'enableWetSign',
'enforce_signer_visibility': 'enforceSignerVisibility',
'envelope_attachments': 'envelopeAttachments',
+ 'envelope_classification': 'envelopeClassification',
'envelope_custom_metadata': 'envelopeCustomMetadata',
'envelope_documents': 'envelopeDocuments',
'envelope_id': 'envelopeId',
@@ -217,6 +220,7 @@ class EnvelopeDefinition(object):
'u_sig_state': 'uSigState',
'voided_date_time': 'voidedDateTime',
'voided_reason': 'voidedReason',
+ 'watermark_language': 'watermarkLanguage',
'workflow': 'workflow'
}
@@ -264,6 +268,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._enable_wet_sign = None
self._enforce_signer_visibility = None
self._envelope_attachments = None
+ self._envelope_classification = None
self._envelope_custom_metadata = None
self._envelope_documents = None
self._envelope_id = None
@@ -316,6 +321,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._u_sig_state = None
self._voided_date_time = None
self._voided_reason = None
+ self._watermark_language = None
self._workflow = None
self.discriminator = None
@@ -357,6 +363,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('enable_wet_sign'), kwargs.get('enable_wet_sign', None))
setattr(self, "_{}".format('enforce_signer_visibility'), kwargs.get('enforce_signer_visibility', None))
setattr(self, "_{}".format('envelope_attachments'), kwargs.get('envelope_attachments', None))
+ setattr(self, "_{}".format('envelope_classification'), kwargs.get('envelope_classification', None))
setattr(self, "_{}".format('envelope_custom_metadata'), kwargs.get('envelope_custom_metadata', None))
setattr(self, "_{}".format('envelope_documents'), kwargs.get('envelope_documents', None))
setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
@@ -409,6 +416,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('u_sig_state'), kwargs.get('u_sig_state', None))
setattr(self, "_{}".format('voided_date_time'), kwargs.get('voided_date_time', None))
setattr(self, "_{}".format('voided_reason'), kwargs.get('voided_reason', None))
+ setattr(self, "_{}".format('watermark_language'), kwargs.get('watermark_language', None))
setattr(self, "_{}".format('workflow'), kwargs.get('workflow', None))
@property
@@ -1285,6 +1293,29 @@ def envelope_attachments(self, envelope_attachments):
self._envelope_attachments = envelope_attachments
+ @property
+ def envelope_classification(self):
+ """Gets the envelope_classification of this EnvelopeDefinition. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_classification of this EnvelopeDefinition. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_classification
+
+ @envelope_classification.setter
+ def envelope_classification(self, envelope_classification):
+ """Sets the envelope_classification of this EnvelopeDefinition.
+
+ # noqa: E501
+
+ :param envelope_classification: The envelope_classification of this EnvelopeDefinition. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_classification = envelope_classification
+
@property
def envelope_custom_metadata(self):
"""Gets the envelope_custom_metadata of this EnvelopeDefinition. # noqa: E501
@@ -2481,6 +2512,29 @@ def voided_reason(self, voided_reason):
self._voided_reason = voided_reason
+ @property
+ def watermark_language(self):
+ """Gets the watermark_language of this EnvelopeDefinition. # noqa: E501
+
+ # noqa: E501
+
+ :return: The watermark_language of this EnvelopeDefinition. # noqa: E501
+ :rtype: str
+ """
+ return self._watermark_language
+
+ @watermark_language.setter
+ def watermark_language(self, watermark_language):
+ """Sets the watermark_language of this EnvelopeDefinition.
+
+ # noqa: E501
+
+ :param watermark_language: The watermark_language of this EnvelopeDefinition. # noqa: E501
+ :type: str
+ """
+
+ self._watermark_language = watermark_language
+
@property
def workflow(self):
"""Gets the workflow of this EnvelopeDefinition. # noqa: E501
diff --git a/docusign_esign/models/envelope_gen_and_send.py b/docusign_esign/models/envelope_gen_and_send.py
new file mode 100644
index 0000000..d50a925
--- /dev/null
+++ b/docusign_esign/models/envelope_gen_and_send.py
@@ -0,0 +1,2770 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class EnvelopeGenAndSend(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'access_control_list_base64': 'str',
+ 'accessibility': 'str',
+ 'allow_comments': 'str',
+ 'allow_markup': 'str',
+ 'allow_reassign': 'str',
+ 'allow_recipient_recursion': 'str',
+ 'allow_view_history': 'str',
+ 'any_signer': 'str',
+ 'archive_action': 'str',
+ 'asynchronous': 'str',
+ 'attachments': 'list[Attachment]',
+ 'attachments_uri': 'str',
+ 'authoritative_copy': 'str',
+ 'authoritative_copy_default': 'str',
+ 'auto_navigation': 'str',
+ 'brand_id': 'str',
+ 'brand_lock': 'str',
+ 'burn_default_tab_data': 'str',
+ 'certificate_uri': 'str',
+ 'completed_date_time': 'str',
+ 'composite_templates': 'list[CompositeTemplate]',
+ 'copy_recipient_data': 'str',
+ 'created_date_time': 'str',
+ 'custom_fields': 'CustomFields',
+ 'custom_fields_uri': 'str',
+ 'declined_date_time': 'str',
+ 'deleted_date_time': 'str',
+ 'delivered_date_time': 'str',
+ 'disable_responsive_document': 'str',
+ 'document_base64': 'str',
+ 'documents': 'list[Document]',
+ 'documents_combined_uri': 'str',
+ 'documents_uri': 'str',
+ 'email_blurb': 'str',
+ 'email_settings': 'EmailSettings',
+ 'email_subject': 'str',
+ 'enable_wet_sign': 'str',
+ 'enforce_signer_visibility': 'str',
+ 'envelope_attachments': 'list[Attachment]',
+ 'envelope_classification': 'str',
+ 'envelope_custom_metadata': 'EnvelopeCustomMetadata',
+ 'envelope_documents': 'list[EnvelopeDocument]',
+ 'envelope_id': 'str',
+ 'envelope_id_stamping': 'str',
+ 'envelope_location': 'str',
+ 'envelope_metadata': 'EnvelopeMetadata',
+ 'envelope_uri': 'str',
+ 'event_notification': 'EventNotification',
+ 'event_notifications': 'list[EventNotification]',
+ 'expire_after': 'str',
+ 'expire_date_time': 'str',
+ 'expire_enabled': 'str',
+ 'external_envelope_id': 'str',
+ 'folders': 'list[Folder]',
+ 'generate_data_source': 'str',
+ 'generate_properties': 'list[EnvelopeGenAndSendProperties]',
+ 'generate_schema_id': 'str',
+ 'has_comments': 'str',
+ 'has_form_data_changed': 'str',
+ 'has_wav_file': 'str',
+ 'holder': 'str',
+ 'image_handling': 'str',
+ 'initial_sent_date_time': 'str',
+ 'is21_cfr_part11': 'str',
+ 'is_dynamic_envelope': 'str',
+ 'is_signature_provider_envelope': 'str',
+ 'is_ticket_related_envelope': 'str',
+ 'last_modified_date_time': 'str',
+ 'location': 'str',
+ 'lock_information': 'LockInformation',
+ 'message_lock': 'str',
+ 'notification': 'Notification',
+ 'notification_uri': 'str',
+ 'password': 'str',
+ 'power_form': 'PowerForm',
+ 'purge_completed_date': 'str',
+ 'purge_request_date': 'str',
+ 'purge_state': 'str',
+ 'recipients': 'Recipients',
+ 'recipients_lock': 'str',
+ 'recipients_uri': 'str',
+ 'recipient_view_request': 'RecipientViewRequest',
+ 'save_documents_to_archive': 'str',
+ 'sender': 'UserInfo',
+ 'sent_date_time': 'str',
+ 'signer_can_sign_on_mobile': 'str',
+ 'signing_location': 'str',
+ 'status': 'str',
+ 'status_changed_date_time': 'str',
+ 'template_id': 'str',
+ 'template_roles': 'list[TemplateRole]',
+ 'templates_uri': 'str',
+ 'transaction_id': 'str',
+ 'use_disclosure': 'str',
+ 'u_sig_state': 'str',
+ 'voided_date_time': 'str',
+ 'voided_reason': 'str',
+ 'watermark_language': 'str',
+ 'workflow': 'Workflow'
+ }
+
+ attribute_map = {
+ 'access_control_list_base64': 'accessControlListBase64',
+ 'accessibility': 'accessibility',
+ 'allow_comments': 'allowComments',
+ 'allow_markup': 'allowMarkup',
+ 'allow_reassign': 'allowReassign',
+ 'allow_recipient_recursion': 'allowRecipientRecursion',
+ 'allow_view_history': 'allowViewHistory',
+ 'any_signer': 'anySigner',
+ 'archive_action': 'archiveAction',
+ 'asynchronous': 'asynchronous',
+ 'attachments': 'attachments',
+ 'attachments_uri': 'attachmentsUri',
+ 'authoritative_copy': 'authoritativeCopy',
+ 'authoritative_copy_default': 'authoritativeCopyDefault',
+ 'auto_navigation': 'autoNavigation',
+ 'brand_id': 'brandId',
+ 'brand_lock': 'brandLock',
+ 'burn_default_tab_data': 'burnDefaultTabData',
+ 'certificate_uri': 'certificateUri',
+ 'completed_date_time': 'completedDateTime',
+ 'composite_templates': 'compositeTemplates',
+ 'copy_recipient_data': 'copyRecipientData',
+ 'created_date_time': 'createdDateTime',
+ 'custom_fields': 'customFields',
+ 'custom_fields_uri': 'customFieldsUri',
+ 'declined_date_time': 'declinedDateTime',
+ 'deleted_date_time': 'deletedDateTime',
+ 'delivered_date_time': 'deliveredDateTime',
+ 'disable_responsive_document': 'disableResponsiveDocument',
+ 'document_base64': 'documentBase64',
+ 'documents': 'documents',
+ 'documents_combined_uri': 'documentsCombinedUri',
+ 'documents_uri': 'documentsUri',
+ 'email_blurb': 'emailBlurb',
+ 'email_settings': 'emailSettings',
+ 'email_subject': 'emailSubject',
+ 'enable_wet_sign': 'enableWetSign',
+ 'enforce_signer_visibility': 'enforceSignerVisibility',
+ 'envelope_attachments': 'envelopeAttachments',
+ 'envelope_classification': 'envelopeClassification',
+ 'envelope_custom_metadata': 'envelopeCustomMetadata',
+ 'envelope_documents': 'envelopeDocuments',
+ 'envelope_id': 'envelopeId',
+ 'envelope_id_stamping': 'envelopeIdStamping',
+ 'envelope_location': 'envelopeLocation',
+ 'envelope_metadata': 'envelopeMetadata',
+ 'envelope_uri': 'envelopeUri',
+ 'event_notification': 'eventNotification',
+ 'event_notifications': 'eventNotifications',
+ 'expire_after': 'expireAfter',
+ 'expire_date_time': 'expireDateTime',
+ 'expire_enabled': 'expireEnabled',
+ 'external_envelope_id': 'externalEnvelopeId',
+ 'folders': 'folders',
+ 'generate_data_source': 'generateDataSource',
+ 'generate_properties': 'generateProperties',
+ 'generate_schema_id': 'generateSchemaId',
+ 'has_comments': 'hasComments',
+ 'has_form_data_changed': 'hasFormDataChanged',
+ 'has_wav_file': 'hasWavFile',
+ 'holder': 'holder',
+ 'image_handling': 'imageHandling',
+ 'initial_sent_date_time': 'initialSentDateTime',
+ 'is21_cfr_part11': 'is21CFRPart11',
+ 'is_dynamic_envelope': 'isDynamicEnvelope',
+ 'is_signature_provider_envelope': 'isSignatureProviderEnvelope',
+ 'is_ticket_related_envelope': 'isTicketRelatedEnvelope',
+ 'last_modified_date_time': 'lastModifiedDateTime',
+ 'location': 'location',
+ 'lock_information': 'lockInformation',
+ 'message_lock': 'messageLock',
+ 'notification': 'notification',
+ 'notification_uri': 'notificationUri',
+ 'password': 'password',
+ 'power_form': 'powerForm',
+ 'purge_completed_date': 'purgeCompletedDate',
+ 'purge_request_date': 'purgeRequestDate',
+ 'purge_state': 'purgeState',
+ 'recipients': 'recipients',
+ 'recipients_lock': 'recipientsLock',
+ 'recipients_uri': 'recipientsUri',
+ 'recipient_view_request': 'recipientViewRequest',
+ 'save_documents_to_archive': 'saveDocumentsToArchive',
+ 'sender': 'sender',
+ 'sent_date_time': 'sentDateTime',
+ 'signer_can_sign_on_mobile': 'signerCanSignOnMobile',
+ 'signing_location': 'signingLocation',
+ 'status': 'status',
+ 'status_changed_date_time': 'statusChangedDateTime',
+ 'template_id': 'templateId',
+ 'template_roles': 'templateRoles',
+ 'templates_uri': 'templatesUri',
+ 'transaction_id': 'transactionId',
+ 'use_disclosure': 'useDisclosure',
+ 'u_sig_state': 'uSigState',
+ 'voided_date_time': 'voidedDateTime',
+ 'voided_reason': 'voidedReason',
+ 'watermark_language': 'watermarkLanguage',
+ 'workflow': 'workflow'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """EnvelopeGenAndSend - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._access_control_list_base64 = None
+ self._accessibility = None
+ self._allow_comments = None
+ self._allow_markup = None
+ self._allow_reassign = None
+ self._allow_recipient_recursion = None
+ self._allow_view_history = None
+ self._any_signer = None
+ self._archive_action = None
+ self._asynchronous = None
+ self._attachments = None
+ self._attachments_uri = None
+ self._authoritative_copy = None
+ self._authoritative_copy_default = None
+ self._auto_navigation = None
+ self._brand_id = None
+ self._brand_lock = None
+ self._burn_default_tab_data = None
+ self._certificate_uri = None
+ self._completed_date_time = None
+ self._composite_templates = None
+ self._copy_recipient_data = None
+ self._created_date_time = None
+ self._custom_fields = None
+ self._custom_fields_uri = None
+ self._declined_date_time = None
+ self._deleted_date_time = None
+ self._delivered_date_time = None
+ self._disable_responsive_document = None
+ self._document_base64 = None
+ self._documents = None
+ self._documents_combined_uri = None
+ self._documents_uri = None
+ self._email_blurb = None
+ self._email_settings = None
+ self._email_subject = None
+ self._enable_wet_sign = None
+ self._enforce_signer_visibility = None
+ self._envelope_attachments = None
+ self._envelope_classification = None
+ self._envelope_custom_metadata = None
+ self._envelope_documents = None
+ self._envelope_id = None
+ self._envelope_id_stamping = None
+ self._envelope_location = None
+ self._envelope_metadata = None
+ self._envelope_uri = None
+ self._event_notification = None
+ self._event_notifications = None
+ self._expire_after = None
+ self._expire_date_time = None
+ self._expire_enabled = None
+ self._external_envelope_id = None
+ self._folders = None
+ self._generate_data_source = None
+ self._generate_properties = None
+ self._generate_schema_id = None
+ self._has_comments = None
+ self._has_form_data_changed = None
+ self._has_wav_file = None
+ self._holder = None
+ self._image_handling = None
+ self._initial_sent_date_time = None
+ self._is21_cfr_part11 = None
+ self._is_dynamic_envelope = None
+ self._is_signature_provider_envelope = None
+ self._is_ticket_related_envelope = None
+ self._last_modified_date_time = None
+ self._location = None
+ self._lock_information = None
+ self._message_lock = None
+ self._notification = None
+ self._notification_uri = None
+ self._password = None
+ self._power_form = None
+ self._purge_completed_date = None
+ self._purge_request_date = None
+ self._purge_state = None
+ self._recipients = None
+ self._recipients_lock = None
+ self._recipients_uri = None
+ self._recipient_view_request = None
+ self._save_documents_to_archive = None
+ self._sender = None
+ self._sent_date_time = None
+ self._signer_can_sign_on_mobile = None
+ self._signing_location = None
+ self._status = None
+ self._status_changed_date_time = None
+ self._template_id = None
+ self._template_roles = None
+ self._templates_uri = None
+ self._transaction_id = None
+ self._use_disclosure = None
+ self._u_sig_state = None
+ self._voided_date_time = None
+ self._voided_reason = None
+ self._watermark_language = None
+ self._workflow = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('access_control_list_base64'), kwargs.get('access_control_list_base64', None))
+ setattr(self, "_{}".format('accessibility'), kwargs.get('accessibility', None))
+ setattr(self, "_{}".format('allow_comments'), kwargs.get('allow_comments', None))
+ setattr(self, "_{}".format('allow_markup'), kwargs.get('allow_markup', None))
+ setattr(self, "_{}".format('allow_reassign'), kwargs.get('allow_reassign', None))
+ setattr(self, "_{}".format('allow_recipient_recursion'), kwargs.get('allow_recipient_recursion', None))
+ setattr(self, "_{}".format('allow_view_history'), kwargs.get('allow_view_history', None))
+ setattr(self, "_{}".format('any_signer'), kwargs.get('any_signer', None))
+ setattr(self, "_{}".format('archive_action'), kwargs.get('archive_action', None))
+ setattr(self, "_{}".format('asynchronous'), kwargs.get('asynchronous', None))
+ setattr(self, "_{}".format('attachments'), kwargs.get('attachments', None))
+ setattr(self, "_{}".format('attachments_uri'), kwargs.get('attachments_uri', None))
+ setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None))
+ setattr(self, "_{}".format('authoritative_copy_default'), kwargs.get('authoritative_copy_default', None))
+ setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None))
+ setattr(self, "_{}".format('brand_id'), kwargs.get('brand_id', None))
+ setattr(self, "_{}".format('brand_lock'), kwargs.get('brand_lock', None))
+ setattr(self, "_{}".format('burn_default_tab_data'), kwargs.get('burn_default_tab_data', None))
+ setattr(self, "_{}".format('certificate_uri'), kwargs.get('certificate_uri', None))
+ setattr(self, "_{}".format('completed_date_time'), kwargs.get('completed_date_time', None))
+ setattr(self, "_{}".format('composite_templates'), kwargs.get('composite_templates', None))
+ setattr(self, "_{}".format('copy_recipient_data'), kwargs.get('copy_recipient_data', None))
+ setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None))
+ setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None))
+ setattr(self, "_{}".format('custom_fields_uri'), kwargs.get('custom_fields_uri', None))
+ setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None))
+ setattr(self, "_{}".format('deleted_date_time'), kwargs.get('deleted_date_time', None))
+ setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None))
+ setattr(self, "_{}".format('disable_responsive_document'), kwargs.get('disable_responsive_document', None))
+ setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None))
+ setattr(self, "_{}".format('documents'), kwargs.get('documents', None))
+ setattr(self, "_{}".format('documents_combined_uri'), kwargs.get('documents_combined_uri', None))
+ setattr(self, "_{}".format('documents_uri'), kwargs.get('documents_uri', None))
+ setattr(self, "_{}".format('email_blurb'), kwargs.get('email_blurb', None))
+ setattr(self, "_{}".format('email_settings'), kwargs.get('email_settings', None))
+ setattr(self, "_{}".format('email_subject'), kwargs.get('email_subject', None))
+ setattr(self, "_{}".format('enable_wet_sign'), kwargs.get('enable_wet_sign', None))
+ setattr(self, "_{}".format('enforce_signer_visibility'), kwargs.get('enforce_signer_visibility', None))
+ setattr(self, "_{}".format('envelope_attachments'), kwargs.get('envelope_attachments', None))
+ setattr(self, "_{}".format('envelope_classification'), kwargs.get('envelope_classification', None))
+ setattr(self, "_{}".format('envelope_custom_metadata'), kwargs.get('envelope_custom_metadata', None))
+ setattr(self, "_{}".format('envelope_documents'), kwargs.get('envelope_documents', None))
+ setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
+ setattr(self, "_{}".format('envelope_id_stamping'), kwargs.get('envelope_id_stamping', None))
+ setattr(self, "_{}".format('envelope_location'), kwargs.get('envelope_location', None))
+ setattr(self, "_{}".format('envelope_metadata'), kwargs.get('envelope_metadata', None))
+ setattr(self, "_{}".format('envelope_uri'), kwargs.get('envelope_uri', None))
+ setattr(self, "_{}".format('event_notification'), kwargs.get('event_notification', None))
+ setattr(self, "_{}".format('event_notifications'), kwargs.get('event_notifications', None))
+ setattr(self, "_{}".format('expire_after'), kwargs.get('expire_after', None))
+ setattr(self, "_{}".format('expire_date_time'), kwargs.get('expire_date_time', None))
+ setattr(self, "_{}".format('expire_enabled'), kwargs.get('expire_enabled', None))
+ setattr(self, "_{}".format('external_envelope_id'), kwargs.get('external_envelope_id', None))
+ setattr(self, "_{}".format('folders'), kwargs.get('folders', None))
+ setattr(self, "_{}".format('generate_data_source'), kwargs.get('generate_data_source', None))
+ setattr(self, "_{}".format('generate_properties'), kwargs.get('generate_properties', None))
+ setattr(self, "_{}".format('generate_schema_id'), kwargs.get('generate_schema_id', None))
+ setattr(self, "_{}".format('has_comments'), kwargs.get('has_comments', None))
+ setattr(self, "_{}".format('has_form_data_changed'), kwargs.get('has_form_data_changed', None))
+ setattr(self, "_{}".format('has_wav_file'), kwargs.get('has_wav_file', None))
+ setattr(self, "_{}".format('holder'), kwargs.get('holder', None))
+ setattr(self, "_{}".format('image_handling'), kwargs.get('image_handling', None))
+ setattr(self, "_{}".format('initial_sent_date_time'), kwargs.get('initial_sent_date_time', None))
+ setattr(self, "_{}".format('is21_cfr_part11'), kwargs.get('is21_cfr_part11', None))
+ setattr(self, "_{}".format('is_dynamic_envelope'), kwargs.get('is_dynamic_envelope', None))
+ setattr(self, "_{}".format('is_signature_provider_envelope'), kwargs.get('is_signature_provider_envelope', None))
+ setattr(self, "_{}".format('is_ticket_related_envelope'), kwargs.get('is_ticket_related_envelope', None))
+ setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None))
+ setattr(self, "_{}".format('location'), kwargs.get('location', None))
+ setattr(self, "_{}".format('lock_information'), kwargs.get('lock_information', None))
+ setattr(self, "_{}".format('message_lock'), kwargs.get('message_lock', None))
+ setattr(self, "_{}".format('notification'), kwargs.get('notification', None))
+ setattr(self, "_{}".format('notification_uri'), kwargs.get('notification_uri', None))
+ setattr(self, "_{}".format('password'), kwargs.get('password', None))
+ setattr(self, "_{}".format('power_form'), kwargs.get('power_form', None))
+ setattr(self, "_{}".format('purge_completed_date'), kwargs.get('purge_completed_date', None))
+ setattr(self, "_{}".format('purge_request_date'), kwargs.get('purge_request_date', None))
+ setattr(self, "_{}".format('purge_state'), kwargs.get('purge_state', None))
+ setattr(self, "_{}".format('recipients'), kwargs.get('recipients', None))
+ setattr(self, "_{}".format('recipients_lock'), kwargs.get('recipients_lock', None))
+ setattr(self, "_{}".format('recipients_uri'), kwargs.get('recipients_uri', None))
+ setattr(self, "_{}".format('recipient_view_request'), kwargs.get('recipient_view_request', None))
+ setattr(self, "_{}".format('save_documents_to_archive'), kwargs.get('save_documents_to_archive', None))
+ setattr(self, "_{}".format('sender'), kwargs.get('sender', None))
+ setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None))
+ setattr(self, "_{}".format('signer_can_sign_on_mobile'), kwargs.get('signer_can_sign_on_mobile', None))
+ setattr(self, "_{}".format('signing_location'), kwargs.get('signing_location', None))
+ setattr(self, "_{}".format('status'), kwargs.get('status', None))
+ setattr(self, "_{}".format('status_changed_date_time'), kwargs.get('status_changed_date_time', None))
+ setattr(self, "_{}".format('template_id'), kwargs.get('template_id', None))
+ setattr(self, "_{}".format('template_roles'), kwargs.get('template_roles', None))
+ setattr(self, "_{}".format('templates_uri'), kwargs.get('templates_uri', None))
+ setattr(self, "_{}".format('transaction_id'), kwargs.get('transaction_id', None))
+ setattr(self, "_{}".format('use_disclosure'), kwargs.get('use_disclosure', None))
+ setattr(self, "_{}".format('u_sig_state'), kwargs.get('u_sig_state', None))
+ setattr(self, "_{}".format('voided_date_time'), kwargs.get('voided_date_time', None))
+ setattr(self, "_{}".format('voided_reason'), kwargs.get('voided_reason', None))
+ setattr(self, "_{}".format('watermark_language'), kwargs.get('watermark_language', None))
+ setattr(self, "_{}".format('workflow'), kwargs.get('workflow', None))
+
+ @property
+ def access_control_list_base64(self):
+ """Gets the access_control_list_base64 of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The access_control_list_base64 of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._access_control_list_base64
+
+ @access_control_list_base64.setter
+ def access_control_list_base64(self, access_control_list_base64):
+ """Sets the access_control_list_base64 of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param access_control_list_base64: The access_control_list_base64 of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._access_control_list_base64 = access_control_list_base64
+
+ @property
+ def accessibility(self):
+ """Gets the accessibility of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The accessibility of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._accessibility
+
+ @accessibility.setter
+ def accessibility(self, accessibility):
+ """Sets the accessibility of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param accessibility: The accessibility of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._accessibility = accessibility
+
+ @property
+ def allow_comments(self):
+ """Gets the allow_comments of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The allow_comments of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._allow_comments
+
+ @allow_comments.setter
+ def allow_comments(self, allow_comments):
+ """Sets the allow_comments of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param allow_comments: The allow_comments of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._allow_comments = allow_comments
+
+ @property
+ def allow_markup(self):
+ """Gets the allow_markup of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this # noqa: E501
+
+ :return: The allow_markup of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._allow_markup
+
+ @allow_markup.setter
+ def allow_markup(self, allow_markup):
+ """Sets the allow_markup of this EnvelopeGenAndSend.
+
+ When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this # noqa: E501
+
+ :param allow_markup: The allow_markup of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._allow_markup = allow_markup
+
+ @property
+ def allow_reassign(self):
+ """Gets the allow_reassign of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. # noqa: E501
+
+ :return: The allow_reassign of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._allow_reassign
+
+ @allow_reassign.setter
+ def allow_reassign(self, allow_reassign):
+ """Sets the allow_reassign of this EnvelopeGenAndSend.
+
+ When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. # noqa: E501
+
+ :param allow_reassign: The allow_reassign of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._allow_reassign = allow_reassign
+
+ @property
+ def allow_recipient_recursion(self):
+ """Gets the allow_recipient_recursion of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The allow_recipient_recursion of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._allow_recipient_recursion
+
+ @allow_recipient_recursion.setter
+ def allow_recipient_recursion(self, allow_recipient_recursion):
+ """Sets the allow_recipient_recursion of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param allow_recipient_recursion: The allow_recipient_recursion of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._allow_recipient_recursion = allow_recipient_recursion
+
+ @property
+ def allow_view_history(self):
+ """Gets the allow_view_history of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The allow_view_history of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._allow_view_history
+
+ @allow_view_history.setter
+ def allow_view_history(self, allow_view_history):
+ """Sets the allow_view_history of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param allow_view_history: The allow_view_history of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._allow_view_history = allow_view_history
+
+ @property
+ def any_signer(self):
+ """Gets the any_signer of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The any_signer of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._any_signer
+
+ @any_signer.setter
+ def any_signer(self, any_signer):
+ """Sets the any_signer of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param any_signer: The any_signer of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._any_signer = any_signer
+
+ @property
+ def archive_action(self):
+ """Gets the archive_action of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The archive_action of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._archive_action
+
+ @archive_action.setter
+ def archive_action(self, archive_action):
+ """Sets the archive_action of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param archive_action: The archive_action of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._archive_action = archive_action
+
+ @property
+ def asynchronous(self):
+ """Gets the asynchronous of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. # noqa: E501
+
+ :return: The asynchronous of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._asynchronous
+
+ @asynchronous.setter
+ def asynchronous(self, asynchronous):
+ """Sets the asynchronous of this EnvelopeGenAndSend.
+
+ When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed. # noqa: E501
+
+ :param asynchronous: The asynchronous of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._asynchronous = asynchronous
+
+ @property
+ def attachments(self):
+ """Gets the attachments of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The attachments of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[Attachment]
+ """
+ return self._attachments
+
+ @attachments.setter
+ def attachments(self, attachments):
+ """Sets the attachments of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param attachments: The attachments of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[Attachment]
+ """
+
+ self._attachments = attachments
+
+ @property
+ def attachments_uri(self):
+ """Gets the attachments_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The attachments_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._attachments_uri
+
+ @attachments_uri.setter
+ def attachments_uri(self, attachments_uri):
+ """Sets the attachments_uri of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param attachments_uri: The attachments_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._attachments_uri = attachments_uri
+
+ @property
+ def authoritative_copy(self):
+ """Gets the authoritative_copy of this EnvelopeGenAndSend. # noqa: E501
+
+ Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501
+
+ :return: The authoritative_copy of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._authoritative_copy
+
+ @authoritative_copy.setter
+ def authoritative_copy(self, authoritative_copy):
+ """Sets the authoritative_copy of this EnvelopeGenAndSend.
+
+ Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501
+
+ :param authoritative_copy: The authoritative_copy of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._authoritative_copy = authoritative_copy
+
+ @property
+ def authoritative_copy_default(self):
+ """Gets the authoritative_copy_default of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The authoritative_copy_default of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._authoritative_copy_default
+
+ @authoritative_copy_default.setter
+ def authoritative_copy_default(self, authoritative_copy_default):
+ """Sets the authoritative_copy_default of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param authoritative_copy_default: The authoritative_copy_default of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._authoritative_copy_default = authoritative_copy_default
+
+ @property
+ def auto_navigation(self):
+ """Gets the auto_navigation of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The auto_navigation of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._auto_navigation
+
+ @auto_navigation.setter
+ def auto_navigation(self, auto_navigation):
+ """Sets the auto_navigation of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param auto_navigation: The auto_navigation of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._auto_navigation = auto_navigation
+
+ @property
+ def brand_id(self):
+ """Gets the brand_id of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The brand_id of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._brand_id
+
+ @brand_id.setter
+ def brand_id(self, brand_id):
+ """Sets the brand_id of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param brand_id: The brand_id of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._brand_id = brand_id
+
+ @property
+ def brand_lock(self):
+ """Gets the brand_lock of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The brand_lock of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._brand_lock
+
+ @brand_lock.setter
+ def brand_lock(self, brand_lock):
+ """Sets the brand_lock of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param brand_lock: The brand_lock of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._brand_lock = brand_lock
+
+ @property
+ def burn_default_tab_data(self):
+ """Gets the burn_default_tab_data of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The burn_default_tab_data of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._burn_default_tab_data
+
+ @burn_default_tab_data.setter
+ def burn_default_tab_data(self, burn_default_tab_data):
+ """Sets the burn_default_tab_data of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param burn_default_tab_data: The burn_default_tab_data of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._burn_default_tab_data = burn_default_tab_data
+
+ @property
+ def certificate_uri(self):
+ """Gets the certificate_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. # noqa: E501
+
+ :return: The certificate_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._certificate_uri
+
+ @certificate_uri.setter
+ def certificate_uri(self, certificate_uri):
+ """Sets the certificate_uri of this EnvelopeGenAndSend.
+
+ Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. # noqa: E501
+
+ :param certificate_uri: The certificate_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._certificate_uri = certificate_uri
+
+ @property
+ def completed_date_time(self):
+ """Gets the completed_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ Specifies the date and time this item was completed. # noqa: E501
+
+ :return: The completed_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._completed_date_time
+
+ @completed_date_time.setter
+ def completed_date_time(self, completed_date_time):
+ """Sets the completed_date_time of this EnvelopeGenAndSend.
+
+ Specifies the date and time this item was completed. # noqa: E501
+
+ :param completed_date_time: The completed_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._completed_date_time = completed_date_time
+
+ @property
+ def composite_templates(self):
+ """Gets the composite_templates of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The composite_templates of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[CompositeTemplate]
+ """
+ return self._composite_templates
+
+ @composite_templates.setter
+ def composite_templates(self, composite_templates):
+ """Sets the composite_templates of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param composite_templates: The composite_templates of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[CompositeTemplate]
+ """
+
+ self._composite_templates = composite_templates
+
+ @property
+ def copy_recipient_data(self):
+ """Gets the copy_recipient_data of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The copy_recipient_data of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._copy_recipient_data
+
+ @copy_recipient_data.setter
+ def copy_recipient_data(self, copy_recipient_data):
+ """Sets the copy_recipient_data of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param copy_recipient_data: The copy_recipient_data of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._copy_recipient_data = copy_recipient_data
+
+ @property
+ def created_date_time(self):
+ """Gets the created_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ Indicates the date and time the item was created. # noqa: E501
+
+ :return: The created_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._created_date_time
+
+ @created_date_time.setter
+ def created_date_time(self, created_date_time):
+ """Sets the created_date_time of this EnvelopeGenAndSend.
+
+ Indicates the date and time the item was created. # noqa: E501
+
+ :param created_date_time: The created_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._created_date_time = created_date_time
+
+ @property
+ def custom_fields(self):
+ """Gets the custom_fields of this EnvelopeGenAndSend. # noqa: E501
+
+ An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501
+
+ :return: The custom_fields of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: CustomFields
+ """
+ return self._custom_fields
+
+ @custom_fields.setter
+ def custom_fields(self, custom_fields):
+ """Sets the custom_fields of this EnvelopeGenAndSend.
+
+ An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501
+
+ :param custom_fields: The custom_fields of this EnvelopeGenAndSend. # noqa: E501
+ :type: CustomFields
+ """
+
+ self._custom_fields = custom_fields
+
+ @property
+ def custom_fields_uri(self):
+ """Gets the custom_fields_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ Contains a URI for an endpoint that you can use to retrieve the custom fields. # noqa: E501
+
+ :return: The custom_fields_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._custom_fields_uri
+
+ @custom_fields_uri.setter
+ def custom_fields_uri(self, custom_fields_uri):
+ """Sets the custom_fields_uri of this EnvelopeGenAndSend.
+
+ Contains a URI for an endpoint that you can use to retrieve the custom fields. # noqa: E501
+
+ :param custom_fields_uri: The custom_fields_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._custom_fields_uri = custom_fields_uri
+
+ @property
+ def declined_date_time(self):
+ """Gets the declined_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ The date and time the recipient declined the document. # noqa: E501
+
+ :return: The declined_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._declined_date_time
+
+ @declined_date_time.setter
+ def declined_date_time(self, declined_date_time):
+ """Sets the declined_date_time of this EnvelopeGenAndSend.
+
+ The date and time the recipient declined the document. # noqa: E501
+
+ :param declined_date_time: The declined_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._declined_date_time = declined_date_time
+
+ @property
+ def deleted_date_time(self):
+ """Gets the deleted_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ Specifies the data and time the item was deleted. # noqa: E501
+
+ :return: The deleted_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._deleted_date_time
+
+ @deleted_date_time.setter
+ def deleted_date_time(self, deleted_date_time):
+ """Sets the deleted_date_time of this EnvelopeGenAndSend.
+
+ Specifies the data and time the item was deleted. # noqa: E501
+
+ :param deleted_date_time: The deleted_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._deleted_date_time = deleted_date_time
+
+ @property
+ def delivered_date_time(self):
+ """Gets the delivered_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ Reserved: For DocuSign use only. # noqa: E501
+
+ :return: The delivered_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._delivered_date_time
+
+ @delivered_date_time.setter
+ def delivered_date_time(self, delivered_date_time):
+ """Sets the delivered_date_time of this EnvelopeGenAndSend.
+
+ Reserved: For DocuSign use only. # noqa: E501
+
+ :param delivered_date_time: The delivered_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._delivered_date_time = delivered_date_time
+
+ @property
+ def disable_responsive_document(self):
+ """Gets the disable_responsive_document of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The disable_responsive_document of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._disable_responsive_document
+
+ @disable_responsive_document.setter
+ def disable_responsive_document(self, disable_responsive_document):
+ """Sets the disable_responsive_document of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param disable_responsive_document: The disable_responsive_document of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._disable_responsive_document = disable_responsive_document
+
+ @property
+ def document_base64(self):
+ """Gets the document_base64 of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_base64 of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._document_base64
+
+ @document_base64.setter
+ def document_base64(self, document_base64):
+ """Sets the document_base64 of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param document_base64: The document_base64 of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._document_base64 = document_base64
+
+ @property
+ def documents(self):
+ """Gets the documents of this EnvelopeGenAndSend. # noqa: E501
+
+ Complex element contains the details on the documents in the envelope. # noqa: E501
+
+ :return: The documents of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[Document]
+ """
+ return self._documents
+
+ @documents.setter
+ def documents(self, documents):
+ """Sets the documents of this EnvelopeGenAndSend.
+
+ Complex element contains the details on the documents in the envelope. # noqa: E501
+
+ :param documents: The documents of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[Document]
+ """
+
+ self._documents = documents
+
+ @property
+ def documents_combined_uri(self):
+ """Gets the documents_combined_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The documents_combined_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._documents_combined_uri
+
+ @documents_combined_uri.setter
+ def documents_combined_uri(self, documents_combined_uri):
+ """Sets the documents_combined_uri of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param documents_combined_uri: The documents_combined_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._documents_combined_uri = documents_combined_uri
+
+ @property
+ def documents_uri(self):
+ """Gets the documents_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ Contains a URI for an endpoint that you can use to retrieve the documents. # noqa: E501
+
+ :return: The documents_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._documents_uri
+
+ @documents_uri.setter
+ def documents_uri(self, documents_uri):
+ """Sets the documents_uri of this EnvelopeGenAndSend.
+
+ Contains a URI for an endpoint that you can use to retrieve the documents. # noqa: E501
+
+ :param documents_uri: The documents_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._documents_uri = documents_uri
+
+ @property
+ def email_blurb(self):
+ """Gets the email_blurb of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The email_blurb of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._email_blurb
+
+ @email_blurb.setter
+ def email_blurb(self, email_blurb):
+ """Sets the email_blurb of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param email_blurb: The email_blurb of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._email_blurb = email_blurb
+
+ @property
+ def email_settings(self):
+ """Gets the email_settings of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The email_settings of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: EmailSettings
+ """
+ return self._email_settings
+
+ @email_settings.setter
+ def email_settings(self, email_settings):
+ """Sets the email_settings of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param email_settings: The email_settings of this EnvelopeGenAndSend. # noqa: E501
+ :type: EmailSettings
+ """
+
+ self._email_settings = email_settings
+
+ @property
+ def email_subject(self):
+ """Gets the email_subject of this EnvelopeGenAndSend. # noqa: E501
+
+ Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. # noqa: E501
+
+ :return: The email_subject of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._email_subject
+
+ @email_subject.setter
+ def email_subject(self, email_subject):
+ """Sets the email_subject of this EnvelopeGenAndSend.
+
+ Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject. # noqa: E501
+
+ :param email_subject: The email_subject of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._email_subject = email_subject
+
+ @property
+ def enable_wet_sign(self):
+ """Gets the enable_wet_sign of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, the signer is allowed to print the document and sign it on paper. # noqa: E501
+
+ :return: The enable_wet_sign of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._enable_wet_sign
+
+ @enable_wet_sign.setter
+ def enable_wet_sign(self, enable_wet_sign):
+ """Sets the enable_wet_sign of this EnvelopeGenAndSend.
+
+ When set to **true**, the signer is allowed to print the document and sign it on paper. # noqa: E501
+
+ :param enable_wet_sign: The enable_wet_sign of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._enable_wet_sign = enable_wet_sign
+
+ @property
+ def enforce_signer_visibility(self):
+ """Gets the enforce_signer_visibility of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this. # noqa: E501
+
+ :return: The enforce_signer_visibility of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._enforce_signer_visibility
+
+ @enforce_signer_visibility.setter
+ def enforce_signer_visibility(self, enforce_signer_visibility):
+ """Sets the enforce_signer_visibility of this EnvelopeGenAndSend.
+
+ When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this. # noqa: E501
+
+ :param enforce_signer_visibility: The enforce_signer_visibility of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._enforce_signer_visibility = enforce_signer_visibility
+
+ @property
+ def envelope_attachments(self):
+ """Gets the envelope_attachments of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_attachments of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[Attachment]
+ """
+ return self._envelope_attachments
+
+ @envelope_attachments.setter
+ def envelope_attachments(self, envelope_attachments):
+ """Sets the envelope_attachments of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param envelope_attachments: The envelope_attachments of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[Attachment]
+ """
+
+ self._envelope_attachments = envelope_attachments
+
+ @property
+ def envelope_classification(self):
+ """Gets the envelope_classification of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_classification of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_classification
+
+ @envelope_classification.setter
+ def envelope_classification(self, envelope_classification):
+ """Sets the envelope_classification of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param envelope_classification: The envelope_classification of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_classification = envelope_classification
+
+ @property
+ def envelope_custom_metadata(self):
+ """Gets the envelope_custom_metadata of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_custom_metadata of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: EnvelopeCustomMetadata
+ """
+ return self._envelope_custom_metadata
+
+ @envelope_custom_metadata.setter
+ def envelope_custom_metadata(self, envelope_custom_metadata):
+ """Sets the envelope_custom_metadata of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param envelope_custom_metadata: The envelope_custom_metadata of this EnvelopeGenAndSend. # noqa: E501
+ :type: EnvelopeCustomMetadata
+ """
+
+ self._envelope_custom_metadata = envelope_custom_metadata
+
+ @property
+ def envelope_documents(self):
+ """Gets the envelope_documents of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_documents of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[EnvelopeDocument]
+ """
+ return self._envelope_documents
+
+ @envelope_documents.setter
+ def envelope_documents(self, envelope_documents):
+ """Sets the envelope_documents of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param envelope_documents: The envelope_documents of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[EnvelopeDocument]
+ """
+
+ self._envelope_documents = envelope_documents
+
+ @property
+ def envelope_id(self):
+ """Gets the envelope_id of this EnvelopeGenAndSend. # noqa: E501
+
+ The envelope ID of the envelope status that failed to post. # noqa: E501
+
+ :return: The envelope_id of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_id
+
+ @envelope_id.setter
+ def envelope_id(self, envelope_id):
+ """Sets the envelope_id of this EnvelopeGenAndSend.
+
+ The envelope ID of the envelope status that failed to post. # noqa: E501
+
+ :param envelope_id: The envelope_id of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_id = envelope_id
+
+ @property
+ def envelope_id_stamping(self):
+ """Gets the envelope_id_stamping of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, Envelope ID Stamping is enabled. # noqa: E501
+
+ :return: The envelope_id_stamping of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_id_stamping
+
+ @envelope_id_stamping.setter
+ def envelope_id_stamping(self, envelope_id_stamping):
+ """Sets the envelope_id_stamping of this EnvelopeGenAndSend.
+
+ When set to **true**, Envelope ID Stamping is enabled. # noqa: E501
+
+ :param envelope_id_stamping: The envelope_id_stamping of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_id_stamping = envelope_id_stamping
+
+ @property
+ def envelope_location(self):
+ """Gets the envelope_location of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_location of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_location
+
+ @envelope_location.setter
+ def envelope_location(self, envelope_location):
+ """Sets the envelope_location of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param envelope_location: The envelope_location of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_location = envelope_location
+
+ @property
+ def envelope_metadata(self):
+ """Gets the envelope_metadata of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_metadata of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: EnvelopeMetadata
+ """
+ return self._envelope_metadata
+
+ @envelope_metadata.setter
+ def envelope_metadata(self, envelope_metadata):
+ """Sets the envelope_metadata of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param envelope_metadata: The envelope_metadata of this EnvelopeGenAndSend. # noqa: E501
+ :type: EnvelopeMetadata
+ """
+
+ self._envelope_metadata = envelope_metadata
+
+ @property
+ def envelope_uri(self):
+ """Gets the envelope_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. # noqa: E501
+
+ :return: The envelope_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_uri
+
+ @envelope_uri.setter
+ def envelope_uri(self, envelope_uri):
+ """Sets the envelope_uri of this EnvelopeGenAndSend.
+
+ Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. # noqa: E501
+
+ :param envelope_uri: The envelope_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_uri = envelope_uri
+
+ @property
+ def event_notification(self):
+ """Gets the event_notification of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The event_notification of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: EventNotification
+ """
+ return self._event_notification
+
+ @event_notification.setter
+ def event_notification(self, event_notification):
+ """Sets the event_notification of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param event_notification: The event_notification of this EnvelopeGenAndSend. # noqa: E501
+ :type: EventNotification
+ """
+
+ self._event_notification = event_notification
+
+ @property
+ def event_notifications(self):
+ """Gets the event_notifications of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The event_notifications of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[EventNotification]
+ """
+ return self._event_notifications
+
+ @event_notifications.setter
+ def event_notifications(self, event_notifications):
+ """Sets the event_notifications of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param event_notifications: The event_notifications of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[EventNotification]
+ """
+
+ self._event_notifications = event_notifications
+
+ @property
+ def expire_after(self):
+ """Gets the expire_after of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The expire_after of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._expire_after
+
+ @expire_after.setter
+ def expire_after(self, expire_after):
+ """Sets the expire_after of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param expire_after: The expire_after of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._expire_after = expire_after
+
+ @property
+ def expire_date_time(self):
+ """Gets the expire_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The expire_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._expire_date_time
+
+ @expire_date_time.setter
+ def expire_date_time(self, expire_date_time):
+ """Sets the expire_date_time of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param expire_date_time: The expire_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._expire_date_time = expire_date_time
+
+ @property
+ def expire_enabled(self):
+ """Gets the expire_enabled of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The expire_enabled of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._expire_enabled
+
+ @expire_enabled.setter
+ def expire_enabled(self, expire_enabled):
+ """Sets the expire_enabled of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param expire_enabled: The expire_enabled of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._expire_enabled = expire_enabled
+
+ @property
+ def external_envelope_id(self):
+ """Gets the external_envelope_id of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The external_envelope_id of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._external_envelope_id
+
+ @external_envelope_id.setter
+ def external_envelope_id(self, external_envelope_id):
+ """Sets the external_envelope_id of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param external_envelope_id: The external_envelope_id of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._external_envelope_id = external_envelope_id
+
+ @property
+ def folders(self):
+ """Gets the folders of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The folders of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[Folder]
+ """
+ return self._folders
+
+ @folders.setter
+ def folders(self, folders):
+ """Sets the folders of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param folders: The folders of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[Folder]
+ """
+
+ self._folders = folders
+
+ @property
+ def generate_data_source(self):
+ """Gets the generate_data_source of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The generate_data_source of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._generate_data_source
+
+ @generate_data_source.setter
+ def generate_data_source(self, generate_data_source):
+ """Sets the generate_data_source of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param generate_data_source: The generate_data_source of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._generate_data_source = generate_data_source
+
+ @property
+ def generate_properties(self):
+ """Gets the generate_properties of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The generate_properties of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[EnvelopeGenAndSendProperties]
+ """
+ return self._generate_properties
+
+ @generate_properties.setter
+ def generate_properties(self, generate_properties):
+ """Sets the generate_properties of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param generate_properties: The generate_properties of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[EnvelopeGenAndSendProperties]
+ """
+
+ self._generate_properties = generate_properties
+
+ @property
+ def generate_schema_id(self):
+ """Gets the generate_schema_id of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The generate_schema_id of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._generate_schema_id
+
+ @generate_schema_id.setter
+ def generate_schema_id(self, generate_schema_id):
+ """Sets the generate_schema_id of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param generate_schema_id: The generate_schema_id of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._generate_schema_id = generate_schema_id
+
+ @property
+ def has_comments(self):
+ """Gets the has_comments of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The has_comments of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._has_comments
+
+ @has_comments.setter
+ def has_comments(self, has_comments):
+ """Sets the has_comments of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param has_comments: The has_comments of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._has_comments = has_comments
+
+ @property
+ def has_form_data_changed(self):
+ """Gets the has_form_data_changed of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The has_form_data_changed of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._has_form_data_changed
+
+ @has_form_data_changed.setter
+ def has_form_data_changed(self, has_form_data_changed):
+ """Sets the has_form_data_changed of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param has_form_data_changed: The has_form_data_changed of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._has_form_data_changed = has_form_data_changed
+
+ @property
+ def has_wav_file(self):
+ """Gets the has_wav_file of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The has_wav_file of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._has_wav_file
+
+ @has_wav_file.setter
+ def has_wav_file(self, has_wav_file):
+ """Sets the has_wav_file of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param has_wav_file: The has_wav_file of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._has_wav_file = has_wav_file
+
+ @property
+ def holder(self):
+ """Gets the holder of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The holder of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._holder
+
+ @holder.setter
+ def holder(self, holder):
+ """Sets the holder of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param holder: The holder of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._holder = holder
+
+ @property
+ def image_handling(self):
+ """Gets the image_handling of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The image_handling of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._image_handling
+
+ @image_handling.setter
+ def image_handling(self, image_handling):
+ """Sets the image_handling of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param image_handling: The image_handling of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._image_handling = image_handling
+
+ @property
+ def initial_sent_date_time(self):
+ """Gets the initial_sent_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The initial_sent_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._initial_sent_date_time
+
+ @initial_sent_date_time.setter
+ def initial_sent_date_time(self, initial_sent_date_time):
+ """Sets the initial_sent_date_time of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param initial_sent_date_time: The initial_sent_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._initial_sent_date_time = initial_sent_date_time
+
+ @property
+ def is21_cfr_part11(self):
+ """Gets the is21_cfr_part11 of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, indicates that this module is enabled on the account. # noqa: E501
+
+ :return: The is21_cfr_part11 of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._is21_cfr_part11
+
+ @is21_cfr_part11.setter
+ def is21_cfr_part11(self, is21_cfr_part11):
+ """Sets the is21_cfr_part11 of this EnvelopeGenAndSend.
+
+ When set to **true**, indicates that this module is enabled on the account. # noqa: E501
+
+ :param is21_cfr_part11: The is21_cfr_part11 of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._is21_cfr_part11 = is21_cfr_part11
+
+ @property
+ def is_dynamic_envelope(self):
+ """Gets the is_dynamic_envelope of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_dynamic_envelope of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._is_dynamic_envelope
+
+ @is_dynamic_envelope.setter
+ def is_dynamic_envelope(self, is_dynamic_envelope):
+ """Sets the is_dynamic_envelope of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param is_dynamic_envelope: The is_dynamic_envelope of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._is_dynamic_envelope = is_dynamic_envelope
+
+ @property
+ def is_signature_provider_envelope(self):
+ """Gets the is_signature_provider_envelope of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_signature_provider_envelope of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._is_signature_provider_envelope
+
+ @is_signature_provider_envelope.setter
+ def is_signature_provider_envelope(self, is_signature_provider_envelope):
+ """Sets the is_signature_provider_envelope of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param is_signature_provider_envelope: The is_signature_provider_envelope of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._is_signature_provider_envelope = is_signature_provider_envelope
+
+ @property
+ def is_ticket_related_envelope(self):
+ """Gets the is_ticket_related_envelope of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_ticket_related_envelope of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._is_ticket_related_envelope
+
+ @is_ticket_related_envelope.setter
+ def is_ticket_related_envelope(self, is_ticket_related_envelope):
+ """Sets the is_ticket_related_envelope of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param is_ticket_related_envelope: The is_ticket_related_envelope of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._is_ticket_related_envelope = is_ticket_related_envelope
+
+ @property
+ def last_modified_date_time(self):
+ """Gets the last_modified_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ The date and time the item was last modified. # noqa: E501
+
+ :return: The last_modified_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._last_modified_date_time
+
+ @last_modified_date_time.setter
+ def last_modified_date_time(self, last_modified_date_time):
+ """Sets the last_modified_date_time of this EnvelopeGenAndSend.
+
+ The date and time the item was last modified. # noqa: E501
+
+ :param last_modified_date_time: The last_modified_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._last_modified_date_time = last_modified_date_time
+
+ @property
+ def location(self):
+ """Gets the location of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The location of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._location
+
+ @location.setter
+ def location(self, location):
+ """Sets the location of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param location: The location of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._location = location
+
+ @property
+ def lock_information(self):
+ """Gets the lock_information of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The lock_information of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: LockInformation
+ """
+ return self._lock_information
+
+ @lock_information.setter
+ def lock_information(self, lock_information):
+ """Sets the lock_information of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param lock_information: The lock_information of this EnvelopeGenAndSend. # noqa: E501
+ :type: LockInformation
+ """
+
+ self._lock_information = lock_information
+
+ @property
+ def message_lock(self):
+ """Gets the message_lock of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. # noqa: E501
+
+ :return: The message_lock of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._message_lock
+
+ @message_lock.setter
+ def message_lock(self, message_lock):
+ """Sets the message_lock of this EnvelopeGenAndSend.
+
+ When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope. # noqa: E501
+
+ :param message_lock: The message_lock of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._message_lock = message_lock
+
+ @property
+ def notification(self):
+ """Gets the notification of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The notification of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: Notification
+ """
+ return self._notification
+
+ @notification.setter
+ def notification(self, notification):
+ """Sets the notification of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param notification: The notification of this EnvelopeGenAndSend. # noqa: E501
+ :type: Notification
+ """
+
+ self._notification = notification
+
+ @property
+ def notification_uri(self):
+ """Gets the notification_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ Contains a URI for an endpoint that you can use to retrieve the notifications. # noqa: E501
+
+ :return: The notification_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._notification_uri
+
+ @notification_uri.setter
+ def notification_uri(self, notification_uri):
+ """Sets the notification_uri of this EnvelopeGenAndSend.
+
+ Contains a URI for an endpoint that you can use to retrieve the notifications. # noqa: E501
+
+ :param notification_uri: The notification_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._notification_uri = notification_uri
+
+ @property
+ def password(self):
+ """Gets the password of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The password of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._password
+
+ @password.setter
+ def password(self, password):
+ """Sets the password of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param password: The password of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._password = password
+
+ @property
+ def power_form(self):
+ """Gets the power_form of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The power_form of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: PowerForm
+ """
+ return self._power_form
+
+ @power_form.setter
+ def power_form(self, power_form):
+ """Sets the power_form of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param power_form: The power_form of this EnvelopeGenAndSend. # noqa: E501
+ :type: PowerForm
+ """
+
+ self._power_form = power_form
+
+ @property
+ def purge_completed_date(self):
+ """Gets the purge_completed_date of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The purge_completed_date of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._purge_completed_date
+
+ @purge_completed_date.setter
+ def purge_completed_date(self, purge_completed_date):
+ """Sets the purge_completed_date of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param purge_completed_date: The purge_completed_date of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._purge_completed_date = purge_completed_date
+
+ @property
+ def purge_request_date(self):
+ """Gets the purge_request_date of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The purge_request_date of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._purge_request_date
+
+ @purge_request_date.setter
+ def purge_request_date(self, purge_request_date):
+ """Sets the purge_request_date of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param purge_request_date: The purge_request_date of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._purge_request_date = purge_request_date
+
+ @property
+ def purge_state(self):
+ """Gets the purge_state of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The purge_state of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._purge_state
+
+ @purge_state.setter
+ def purge_state(self, purge_state):
+ """Sets the purge_state of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param purge_state: The purge_state of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._purge_state = purge_state
+
+ @property
+ def recipients(self):
+ """Gets the recipients of this EnvelopeGenAndSend. # noqa: E501
+
+ An array of powerform recipients. # noqa: E501
+
+ :return: The recipients of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: Recipients
+ """
+ return self._recipients
+
+ @recipients.setter
+ def recipients(self, recipients):
+ """Sets the recipients of this EnvelopeGenAndSend.
+
+ An array of powerform recipients. # noqa: E501
+
+ :param recipients: The recipients of this EnvelopeGenAndSend. # noqa: E501
+ :type: Recipients
+ """
+
+ self._recipients = recipients
+
+ @property
+ def recipients_lock(self):
+ """Gets the recipients_lock of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. # noqa: E501
+
+ :return: The recipients_lock of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._recipients_lock
+
+ @recipients_lock.setter
+ def recipients_lock(self, recipients_lock):
+ """Sets the recipients_lock of this EnvelopeGenAndSend.
+
+ When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. # noqa: E501
+
+ :param recipients_lock: The recipients_lock of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._recipients_lock = recipients_lock
+
+ @property
+ def recipients_uri(self):
+ """Gets the recipients_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ Contains a URI for an endpoint that you can use to retrieve the recipients. # noqa: E501
+
+ :return: The recipients_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._recipients_uri
+
+ @recipients_uri.setter
+ def recipients_uri(self, recipients_uri):
+ """Sets the recipients_uri of this EnvelopeGenAndSend.
+
+ Contains a URI for an endpoint that you can use to retrieve the recipients. # noqa: E501
+
+ :param recipients_uri: The recipients_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._recipients_uri = recipients_uri
+
+ @property
+ def recipient_view_request(self):
+ """Gets the recipient_view_request of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recipient_view_request of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: RecipientViewRequest
+ """
+ return self._recipient_view_request
+
+ @recipient_view_request.setter
+ def recipient_view_request(self, recipient_view_request):
+ """Sets the recipient_view_request of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param recipient_view_request: The recipient_view_request of this EnvelopeGenAndSend. # noqa: E501
+ :type: RecipientViewRequest
+ """
+
+ self._recipient_view_request = recipient_view_request
+
+ @property
+ def save_documents_to_archive(self):
+ """Gets the save_documents_to_archive of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The save_documents_to_archive of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._save_documents_to_archive
+
+ @save_documents_to_archive.setter
+ def save_documents_to_archive(self, save_documents_to_archive):
+ """Sets the save_documents_to_archive of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param save_documents_to_archive: The save_documents_to_archive of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._save_documents_to_archive = save_documents_to_archive
+
+ @property
+ def sender(self):
+ """Gets the sender of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The sender of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: UserInfo
+ """
+ return self._sender
+
+ @sender.setter
+ def sender(self, sender):
+ """Sets the sender of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param sender: The sender of this EnvelopeGenAndSend. # noqa: E501
+ :type: UserInfo
+ """
+
+ self._sender = sender
+
+ @property
+ def sent_date_time(self):
+ """Gets the sent_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ The date and time the envelope was sent. # noqa: E501
+
+ :return: The sent_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._sent_date_time
+
+ @sent_date_time.setter
+ def sent_date_time(self, sent_date_time):
+ """Sets the sent_date_time of this EnvelopeGenAndSend.
+
+ The date and time the envelope was sent. # noqa: E501
+
+ :param sent_date_time: The sent_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._sent_date_time = sent_date_time
+
+ @property
+ def signer_can_sign_on_mobile(self):
+ """Gets the signer_can_sign_on_mobile of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The signer_can_sign_on_mobile of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._signer_can_sign_on_mobile
+
+ @signer_can_sign_on_mobile.setter
+ def signer_can_sign_on_mobile(self, signer_can_sign_on_mobile):
+ """Sets the signer_can_sign_on_mobile of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param signer_can_sign_on_mobile: The signer_can_sign_on_mobile of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._signer_can_sign_on_mobile = signer_can_sign_on_mobile
+
+ @property
+ def signing_location(self):
+ """Gets the signing_location of this EnvelopeGenAndSend. # noqa: E501
+
+ Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501
+
+ :return: The signing_location of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._signing_location
+
+ @signing_location.setter
+ def signing_location(self, signing_location):
+ """Sets the signing_location of this EnvelopeGenAndSend.
+
+ Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501
+
+ :param signing_location: The signing_location of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._signing_location = signing_location
+
+ @property
+ def status(self):
+ """Gets the status of this EnvelopeGenAndSend. # noqa: E501
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :return: The status of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this EnvelopeGenAndSend.
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :param status: The status of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def status_changed_date_time(self):
+ """Gets the status_changed_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ The data and time the status changed. # noqa: E501
+
+ :return: The status_changed_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._status_changed_date_time
+
+ @status_changed_date_time.setter
+ def status_changed_date_time(self, status_changed_date_time):
+ """Sets the status_changed_date_time of this EnvelopeGenAndSend.
+
+ The data and time the status changed. # noqa: E501
+
+ :param status_changed_date_time: The status_changed_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._status_changed_date_time = status_changed_date_time
+
+ @property
+ def template_id(self):
+ """Gets the template_id of this EnvelopeGenAndSend. # noqa: E501
+
+ The unique identifier of the template. If this is not provided, DocuSign will generate a value. # noqa: E501
+
+ :return: The template_id of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._template_id
+
+ @template_id.setter
+ def template_id(self, template_id):
+ """Sets the template_id of this EnvelopeGenAndSend.
+
+ The unique identifier of the template. If this is not provided, DocuSign will generate a value. # noqa: E501
+
+ :param template_id: The template_id of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._template_id = template_id
+
+ @property
+ def template_roles(self):
+ """Gets the template_roles of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The template_roles of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: list[TemplateRole]
+ """
+ return self._template_roles
+
+ @template_roles.setter
+ def template_roles(self, template_roles):
+ """Sets the template_roles of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param template_roles: The template_roles of this EnvelopeGenAndSend. # noqa: E501
+ :type: list[TemplateRole]
+ """
+
+ self._template_roles = template_roles
+
+ @property
+ def templates_uri(self):
+ """Gets the templates_uri of this EnvelopeGenAndSend. # noqa: E501
+
+ Contains a URI for an endpoint which you can use to retrieve the templates. # noqa: E501
+
+ :return: The templates_uri of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._templates_uri
+
+ @templates_uri.setter
+ def templates_uri(self, templates_uri):
+ """Sets the templates_uri of this EnvelopeGenAndSend.
+
+ Contains a URI for an endpoint which you can use to retrieve the templates. # noqa: E501
+
+ :param templates_uri: The templates_uri of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._templates_uri = templates_uri
+
+ @property
+ def transaction_id(self):
+ """Gets the transaction_id of this EnvelopeGenAndSend. # noqa: E501
+
+ Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. # noqa: E501
+
+ :return: The transaction_id of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._transaction_id
+
+ @transaction_id.setter
+ def transaction_id(self, transaction_id):
+ """Sets the transaction_id of this EnvelopeGenAndSend.
+
+ Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned. # noqa: E501
+
+ :param transaction_id: The transaction_id of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._transaction_id = transaction_id
+
+ @property
+ def use_disclosure(self):
+ """Gets the use_disclosure of this EnvelopeGenAndSend. # noqa: E501
+
+ When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. # noqa: E501
+
+ :return: The use_disclosure of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._use_disclosure
+
+ @use_disclosure.setter
+ def use_disclosure(self, use_disclosure):
+ """Sets the use_disclosure of this EnvelopeGenAndSend.
+
+ When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information. # noqa: E501
+
+ :param use_disclosure: The use_disclosure of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._use_disclosure = use_disclosure
+
+ @property
+ def u_sig_state(self):
+ """Gets the u_sig_state of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The u_sig_state of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._u_sig_state
+
+ @u_sig_state.setter
+ def u_sig_state(self, u_sig_state):
+ """Sets the u_sig_state of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param u_sig_state: The u_sig_state of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._u_sig_state = u_sig_state
+
+ @property
+ def voided_date_time(self):
+ """Gets the voided_date_time of this EnvelopeGenAndSend. # noqa: E501
+
+ The date and time the envelope or template was voided. # noqa: E501
+
+ :return: The voided_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._voided_date_time
+
+ @voided_date_time.setter
+ def voided_date_time(self, voided_date_time):
+ """Sets the voided_date_time of this EnvelopeGenAndSend.
+
+ The date and time the envelope or template was voided. # noqa: E501
+
+ :param voided_date_time: The voided_date_time of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._voided_date_time = voided_date_time
+
+ @property
+ def voided_reason(self):
+ """Gets the voided_reason of this EnvelopeGenAndSend. # noqa: E501
+
+ The reason the envelope or template was voided. # noqa: E501
+
+ :return: The voided_reason of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._voided_reason
+
+ @voided_reason.setter
+ def voided_reason(self, voided_reason):
+ """Sets the voided_reason of this EnvelopeGenAndSend.
+
+ The reason the envelope or template was voided. # noqa: E501
+
+ :param voided_reason: The voided_reason of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._voided_reason = voided_reason
+
+ @property
+ def watermark_language(self):
+ """Gets the watermark_language of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The watermark_language of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: str
+ """
+ return self._watermark_language
+
+ @watermark_language.setter
+ def watermark_language(self, watermark_language):
+ """Sets the watermark_language of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param watermark_language: The watermark_language of this EnvelopeGenAndSend. # noqa: E501
+ :type: str
+ """
+
+ self._watermark_language = watermark_language
+
+ @property
+ def workflow(self):
+ """Gets the workflow of this EnvelopeGenAndSend. # noqa: E501
+
+ # noqa: E501
+
+ :return: The workflow of this EnvelopeGenAndSend. # noqa: E501
+ :rtype: Workflow
+ """
+ return self._workflow
+
+ @workflow.setter
+ def workflow(self, workflow):
+ """Sets the workflow of this EnvelopeGenAndSend.
+
+ # noqa: E501
+
+ :param workflow: The workflow of this EnvelopeGenAndSend. # noqa: E501
+ :type: Workflow
+ """
+
+ self._workflow = workflow
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(EnvelopeGenAndSend, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, EnvelopeGenAndSend):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, EnvelopeGenAndSend):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/envelope_gen_and_send_properties.py b/docusign_esign/models/envelope_gen_and_send_properties.py
new file mode 100644
index 0000000..b6f1eae
--- /dev/null
+++ b/docusign_esign/models/envelope_gen_and_send_properties.py
@@ -0,0 +1,1150 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class EnvelopeGenAndSendProperties(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'apply_anchor_tabs': 'str',
+ 'archive_document_type': 'str',
+ 'assign_tabs_to_recipient_id': 'str',
+ 'authoritative_copy': 'str',
+ 'base64_data_json': 'str',
+ 'base64_generate_template_document': 'str',
+ 'data_json': 'str',
+ 'display': 'str',
+ 'doc_gen_document_status': 'str',
+ 'doc_gen_form_fields': 'list[DocGenFormField]',
+ 'document_base64': 'str',
+ 'document_fields': 'list[NameValue]',
+ 'document_id': 'str',
+ 'document_name': 'str',
+ 'document_sequence': 'str',
+ 'document_template_id': 'str',
+ 'encrypted_with_key_manager': 'str',
+ 'file_extension': 'str',
+ 'file_format_hint': 'str',
+ 'generate_document_template_kind': 'str',
+ 'generate_document_template_source': 'str',
+ 'generate_template_document_id': 'str',
+ 'html_definition': 'DocumentHtmlDefinition',
+ 'include_in_download': 'str',
+ 'is_doc_gen_document': 'str',
+ 'match_boxes': 'list[MatchBox]',
+ 'name': 'str',
+ 'order': 'str',
+ 'pages': 'str',
+ 'password': 'str',
+ 'pdf_form_field_option': 'str',
+ 'remote_url': 'str',
+ 'signer_must_acknowledge': 'str',
+ 'signer_must_acknowledge_use_account_default': 'bool',
+ 'tabs': 'Tabs',
+ 'template_locked': 'str',
+ 'template_required': 'str',
+ 'transform_pdf_fields': 'str',
+ 'uri': 'str'
+ }
+
+ attribute_map = {
+ 'apply_anchor_tabs': 'applyAnchorTabs',
+ 'archive_document_type': 'archiveDocumentType',
+ 'assign_tabs_to_recipient_id': 'assignTabsToRecipientId',
+ 'authoritative_copy': 'authoritativeCopy',
+ 'base64_data_json': 'base64DataJson',
+ 'base64_generate_template_document': 'base64GenerateTemplateDocument',
+ 'data_json': 'dataJson',
+ 'display': 'display',
+ 'doc_gen_document_status': 'docGenDocumentStatus',
+ 'doc_gen_form_fields': 'docGenFormFields',
+ 'document_base64': 'documentBase64',
+ 'document_fields': 'documentFields',
+ 'document_id': 'documentId',
+ 'document_name': 'documentName',
+ 'document_sequence': 'documentSequence',
+ 'document_template_id': 'documentTemplateId',
+ 'encrypted_with_key_manager': 'encryptedWithKeyManager',
+ 'file_extension': 'fileExtension',
+ 'file_format_hint': 'fileFormatHint',
+ 'generate_document_template_kind': 'generateDocumentTemplateKind',
+ 'generate_document_template_source': 'generateDocumentTemplateSource',
+ 'generate_template_document_id': 'generateTemplateDocumentId',
+ 'html_definition': 'htmlDefinition',
+ 'include_in_download': 'includeInDownload',
+ 'is_doc_gen_document': 'isDocGenDocument',
+ 'match_boxes': 'matchBoxes',
+ 'name': 'name',
+ 'order': 'order',
+ 'pages': 'pages',
+ 'password': 'password',
+ 'pdf_form_field_option': 'pdfFormFieldOption',
+ 'remote_url': 'remoteUrl',
+ 'signer_must_acknowledge': 'signerMustAcknowledge',
+ 'signer_must_acknowledge_use_account_default': 'signerMustAcknowledgeUseAccountDefault',
+ 'tabs': 'tabs',
+ 'template_locked': 'templateLocked',
+ 'template_required': 'templateRequired',
+ 'transform_pdf_fields': 'transformPdfFields',
+ 'uri': 'uri'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """EnvelopeGenAndSendProperties - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._apply_anchor_tabs = None
+ self._archive_document_type = None
+ self._assign_tabs_to_recipient_id = None
+ self._authoritative_copy = None
+ self._base64_data_json = None
+ self._base64_generate_template_document = None
+ self._data_json = None
+ self._display = None
+ self._doc_gen_document_status = None
+ self._doc_gen_form_fields = None
+ self._document_base64 = None
+ self._document_fields = None
+ self._document_id = None
+ self._document_name = None
+ self._document_sequence = None
+ self._document_template_id = None
+ self._encrypted_with_key_manager = None
+ self._file_extension = None
+ self._file_format_hint = None
+ self._generate_document_template_kind = None
+ self._generate_document_template_source = None
+ self._generate_template_document_id = None
+ self._html_definition = None
+ self._include_in_download = None
+ self._is_doc_gen_document = None
+ self._match_boxes = None
+ self._name = None
+ self._order = None
+ self._pages = None
+ self._password = None
+ self._pdf_form_field_option = None
+ self._remote_url = None
+ self._signer_must_acknowledge = None
+ self._signer_must_acknowledge_use_account_default = None
+ self._tabs = None
+ self._template_locked = None
+ self._template_required = None
+ self._transform_pdf_fields = None
+ self._uri = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('apply_anchor_tabs'), kwargs.get('apply_anchor_tabs', None))
+ setattr(self, "_{}".format('archive_document_type'), kwargs.get('archive_document_type', None))
+ setattr(self, "_{}".format('assign_tabs_to_recipient_id'), kwargs.get('assign_tabs_to_recipient_id', None))
+ setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None))
+ setattr(self, "_{}".format('base64_data_json'), kwargs.get('base64_data_json', None))
+ setattr(self, "_{}".format('base64_generate_template_document'), kwargs.get('base64_generate_template_document', None))
+ setattr(self, "_{}".format('data_json'), kwargs.get('data_json', None))
+ setattr(self, "_{}".format('display'), kwargs.get('display', None))
+ setattr(self, "_{}".format('doc_gen_document_status'), kwargs.get('doc_gen_document_status', None))
+ setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None))
+ setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None))
+ setattr(self, "_{}".format('document_fields'), kwargs.get('document_fields', None))
+ setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None))
+ setattr(self, "_{}".format('document_name'), kwargs.get('document_name', None))
+ setattr(self, "_{}".format('document_sequence'), kwargs.get('document_sequence', None))
+ setattr(self, "_{}".format('document_template_id'), kwargs.get('document_template_id', None))
+ setattr(self, "_{}".format('encrypted_with_key_manager'), kwargs.get('encrypted_with_key_manager', None))
+ setattr(self, "_{}".format('file_extension'), kwargs.get('file_extension', None))
+ setattr(self, "_{}".format('file_format_hint'), kwargs.get('file_format_hint', None))
+ setattr(self, "_{}".format('generate_document_template_kind'), kwargs.get('generate_document_template_kind', None))
+ setattr(self, "_{}".format('generate_document_template_source'), kwargs.get('generate_document_template_source', None))
+ setattr(self, "_{}".format('generate_template_document_id'), kwargs.get('generate_template_document_id', None))
+ setattr(self, "_{}".format('html_definition'), kwargs.get('html_definition', None))
+ setattr(self, "_{}".format('include_in_download'), kwargs.get('include_in_download', None))
+ setattr(self, "_{}".format('is_doc_gen_document'), kwargs.get('is_doc_gen_document', None))
+ setattr(self, "_{}".format('match_boxes'), kwargs.get('match_boxes', None))
+ setattr(self, "_{}".format('name'), kwargs.get('name', None))
+ setattr(self, "_{}".format('order'), kwargs.get('order', None))
+ setattr(self, "_{}".format('pages'), kwargs.get('pages', None))
+ setattr(self, "_{}".format('password'), kwargs.get('password', None))
+ setattr(self, "_{}".format('pdf_form_field_option'), kwargs.get('pdf_form_field_option', None))
+ setattr(self, "_{}".format('remote_url'), kwargs.get('remote_url', None))
+ setattr(self, "_{}".format('signer_must_acknowledge'), kwargs.get('signer_must_acknowledge', None))
+ setattr(self, "_{}".format('signer_must_acknowledge_use_account_default'), kwargs.get('signer_must_acknowledge_use_account_default', None))
+ setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None))
+ setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None))
+ setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None))
+ setattr(self, "_{}".format('transform_pdf_fields'), kwargs.get('transform_pdf_fields', None))
+ setattr(self, "_{}".format('uri'), kwargs.get('uri', None))
+
+ @property
+ def apply_anchor_tabs(self):
+ """Gets the apply_anchor_tabs of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The apply_anchor_tabs of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._apply_anchor_tabs
+
+ @apply_anchor_tabs.setter
+ def apply_anchor_tabs(self, apply_anchor_tabs):
+ """Sets the apply_anchor_tabs of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param apply_anchor_tabs: The apply_anchor_tabs of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._apply_anchor_tabs = apply_anchor_tabs
+
+ @property
+ def archive_document_type(self):
+ """Gets the archive_document_type of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The archive_document_type of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._archive_document_type
+
+ @archive_document_type.setter
+ def archive_document_type(self, archive_document_type):
+ """Sets the archive_document_type of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param archive_document_type: The archive_document_type of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._archive_document_type = archive_document_type
+
+ @property
+ def assign_tabs_to_recipient_id(self):
+ """Gets the assign_tabs_to_recipient_id of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The assign_tabs_to_recipient_id of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._assign_tabs_to_recipient_id
+
+ @assign_tabs_to_recipient_id.setter
+ def assign_tabs_to_recipient_id(self, assign_tabs_to_recipient_id):
+ """Sets the assign_tabs_to_recipient_id of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param assign_tabs_to_recipient_id: The assign_tabs_to_recipient_id of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._assign_tabs_to_recipient_id = assign_tabs_to_recipient_id
+
+ @property
+ def authoritative_copy(self):
+ """Gets the authoritative_copy of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501
+
+ :return: The authoritative_copy of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._authoritative_copy
+
+ @authoritative_copy.setter
+ def authoritative_copy(self, authoritative_copy):
+ """Sets the authoritative_copy of this EnvelopeGenAndSendProperties.
+
+ Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501
+
+ :param authoritative_copy: The authoritative_copy of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._authoritative_copy = authoritative_copy
+
+ @property
+ def base64_data_json(self):
+ """Gets the base64_data_json of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The base64_data_json of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._base64_data_json
+
+ @base64_data_json.setter
+ def base64_data_json(self, base64_data_json):
+ """Sets the base64_data_json of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param base64_data_json: The base64_data_json of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._base64_data_json = base64_data_json
+
+ @property
+ def base64_generate_template_document(self):
+ """Gets the base64_generate_template_document of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The base64_generate_template_document of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._base64_generate_template_document
+
+ @base64_generate_template_document.setter
+ def base64_generate_template_document(self, base64_generate_template_document):
+ """Sets the base64_generate_template_document of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param base64_generate_template_document: The base64_generate_template_document of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._base64_generate_template_document = base64_generate_template_document
+
+ @property
+ def data_json(self):
+ """Gets the data_json of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The data_json of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._data_json
+
+ @data_json.setter
+ def data_json(self, data_json):
+ """Sets the data_json of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param data_json: The data_json of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._data_json = data_json
+
+ @property
+ def display(self):
+ """Gets the display of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The display of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._display
+
+ @display.setter
+ def display(self, display):
+ """Sets the display of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param display: The display of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._display = display
+
+ @property
+ def doc_gen_document_status(self):
+ """Gets the doc_gen_document_status of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The doc_gen_document_status of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._doc_gen_document_status
+
+ @doc_gen_document_status.setter
+ def doc_gen_document_status(self, doc_gen_document_status):
+ """Sets the doc_gen_document_status of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param doc_gen_document_status: The doc_gen_document_status of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._doc_gen_document_status = doc_gen_document_status
+
+ @property
+ def doc_gen_form_fields(self):
+ """Gets the doc_gen_form_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The doc_gen_form_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: list[DocGenFormField]
+ """
+ return self._doc_gen_form_fields
+
+ @doc_gen_form_fields.setter
+ def doc_gen_form_fields(self, doc_gen_form_fields):
+ """Sets the doc_gen_form_fields of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param doc_gen_form_fields: The doc_gen_form_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: list[DocGenFormField]
+ """
+
+ self._doc_gen_form_fields = doc_gen_form_fields
+
+ @property
+ def document_base64(self):
+ """Gets the document_base64 of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_base64 of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._document_base64
+
+ @document_base64.setter
+ def document_base64(self, document_base64):
+ """Sets the document_base64 of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param document_base64: The document_base64 of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._document_base64 = document_base64
+
+ @property
+ def document_fields(self):
+ """Gets the document_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: list[NameValue]
+ """
+ return self._document_fields
+
+ @document_fields.setter
+ def document_fields(self, document_fields):
+ """Sets the document_fields of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param document_fields: The document_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: list[NameValue]
+ """
+
+ self._document_fields = document_fields
+
+ @property
+ def document_id(self):
+ """Gets the document_id of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501
+
+ :return: The document_id of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._document_id
+
+ @document_id.setter
+ def document_id(self, document_id):
+ """Sets the document_id of this EnvelopeGenAndSendProperties.
+
+ Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501
+
+ :param document_id: The document_id of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._document_id = document_id
+
+ @property
+ def document_name(self):
+ """Gets the document_name of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_name of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._document_name
+
+ @document_name.setter
+ def document_name(self, document_name):
+ """Sets the document_name of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param document_name: The document_name of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._document_name = document_name
+
+ @property
+ def document_sequence(self):
+ """Gets the document_sequence of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_sequence of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._document_sequence
+
+ @document_sequence.setter
+ def document_sequence(self, document_sequence):
+ """Sets the document_sequence of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param document_sequence: The document_sequence of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._document_sequence = document_sequence
+
+ @property
+ def document_template_id(self):
+ """Gets the document_template_id of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_template_id of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._document_template_id
+
+ @document_template_id.setter
+ def document_template_id(self, document_template_id):
+ """Sets the document_template_id of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param document_template_id: The document_template_id of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._document_template_id = document_template_id
+
+ @property
+ def encrypted_with_key_manager(self):
+ """Gets the encrypted_with_key_manager of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The encrypted_with_key_manager of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._encrypted_with_key_manager
+
+ @encrypted_with_key_manager.setter
+ def encrypted_with_key_manager(self, encrypted_with_key_manager):
+ """Sets the encrypted_with_key_manager of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param encrypted_with_key_manager: The encrypted_with_key_manager of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._encrypted_with_key_manager = encrypted_with_key_manager
+
+ @property
+ def file_extension(self):
+ """Gets the file_extension of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The file_extension of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._file_extension
+
+ @file_extension.setter
+ def file_extension(self, file_extension):
+ """Sets the file_extension of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param file_extension: The file_extension of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._file_extension = file_extension
+
+ @property
+ def file_format_hint(self):
+ """Gets the file_format_hint of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The file_format_hint of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._file_format_hint
+
+ @file_format_hint.setter
+ def file_format_hint(self, file_format_hint):
+ """Sets the file_format_hint of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param file_format_hint: The file_format_hint of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._file_format_hint = file_format_hint
+
+ @property
+ def generate_document_template_kind(self):
+ """Gets the generate_document_template_kind of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The generate_document_template_kind of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._generate_document_template_kind
+
+ @generate_document_template_kind.setter
+ def generate_document_template_kind(self, generate_document_template_kind):
+ """Sets the generate_document_template_kind of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param generate_document_template_kind: The generate_document_template_kind of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._generate_document_template_kind = generate_document_template_kind
+
+ @property
+ def generate_document_template_source(self):
+ """Gets the generate_document_template_source of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The generate_document_template_source of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._generate_document_template_source
+
+ @generate_document_template_source.setter
+ def generate_document_template_source(self, generate_document_template_source):
+ """Sets the generate_document_template_source of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param generate_document_template_source: The generate_document_template_source of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._generate_document_template_source = generate_document_template_source
+
+ @property
+ def generate_template_document_id(self):
+ """Gets the generate_template_document_id of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The generate_template_document_id of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._generate_template_document_id
+
+ @generate_template_document_id.setter
+ def generate_template_document_id(self, generate_template_document_id):
+ """Sets the generate_template_document_id of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param generate_template_document_id: The generate_template_document_id of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._generate_template_document_id = generate_template_document_id
+
+ @property
+ def html_definition(self):
+ """Gets the html_definition of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The html_definition of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: DocumentHtmlDefinition
+ """
+ return self._html_definition
+
+ @html_definition.setter
+ def html_definition(self, html_definition):
+ """Sets the html_definition of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param html_definition: The html_definition of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: DocumentHtmlDefinition
+ """
+
+ self._html_definition = html_definition
+
+ @property
+ def include_in_download(self):
+ """Gets the include_in_download of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The include_in_download of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._include_in_download
+
+ @include_in_download.setter
+ def include_in_download(self, include_in_download):
+ """Sets the include_in_download of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param include_in_download: The include_in_download of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._include_in_download = include_in_download
+
+ @property
+ def is_doc_gen_document(self):
+ """Gets the is_doc_gen_document of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_doc_gen_document of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._is_doc_gen_document
+
+ @is_doc_gen_document.setter
+ def is_doc_gen_document(self, is_doc_gen_document):
+ """Sets the is_doc_gen_document of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param is_doc_gen_document: The is_doc_gen_document of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._is_doc_gen_document = is_doc_gen_document
+
+ @property
+ def match_boxes(self):
+ """Gets the match_boxes of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The match_boxes of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: list[MatchBox]
+ """
+ return self._match_boxes
+
+ @match_boxes.setter
+ def match_boxes(self, match_boxes):
+ """Sets the match_boxes of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param match_boxes: The match_boxes of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: list[MatchBox]
+ """
+
+ self._match_boxes = match_boxes
+
+ @property
+ def name(self):
+ """Gets the name of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The name of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name):
+ """Sets the name of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param name: The name of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._name = name
+
+ @property
+ def order(self):
+ """Gets the order of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The order of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._order
+
+ @order.setter
+ def order(self, order):
+ """Sets the order of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param order: The order of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._order = order
+
+ @property
+ def pages(self):
+ """Gets the pages of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The pages of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._pages
+
+ @pages.setter
+ def pages(self, pages):
+ """Sets the pages of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param pages: The pages of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._pages = pages
+
+ @property
+ def password(self):
+ """Gets the password of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The password of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._password
+
+ @password.setter
+ def password(self, password):
+ """Sets the password of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param password: The password of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._password = password
+
+ @property
+ def pdf_form_field_option(self):
+ """Gets the pdf_form_field_option of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The pdf_form_field_option of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._pdf_form_field_option
+
+ @pdf_form_field_option.setter
+ def pdf_form_field_option(self, pdf_form_field_option):
+ """Sets the pdf_form_field_option of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param pdf_form_field_option: The pdf_form_field_option of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._pdf_form_field_option = pdf_form_field_option
+
+ @property
+ def remote_url(self):
+ """Gets the remote_url of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The remote_url of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._remote_url
+
+ @remote_url.setter
+ def remote_url(self, remote_url):
+ """Sets the remote_url of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param remote_url: The remote_url of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._remote_url = remote_url
+
+ @property
+ def signer_must_acknowledge(self):
+ """Gets the signer_must_acknowledge of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The signer_must_acknowledge of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._signer_must_acknowledge
+
+ @signer_must_acknowledge.setter
+ def signer_must_acknowledge(self, signer_must_acknowledge):
+ """Sets the signer_must_acknowledge of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param signer_must_acknowledge: The signer_must_acknowledge of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._signer_must_acknowledge = signer_must_acknowledge
+
+ @property
+ def signer_must_acknowledge_use_account_default(self):
+ """Gets the signer_must_acknowledge_use_account_default of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The signer_must_acknowledge_use_account_default of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: bool
+ """
+ return self._signer_must_acknowledge_use_account_default
+
+ @signer_must_acknowledge_use_account_default.setter
+ def signer_must_acknowledge_use_account_default(self, signer_must_acknowledge_use_account_default):
+ """Sets the signer_must_acknowledge_use_account_default of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param signer_must_acknowledge_use_account_default: The signer_must_acknowledge_use_account_default of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: bool
+ """
+
+ self._signer_must_acknowledge_use_account_default = signer_must_acknowledge_use_account_default
+
+ @property
+ def tabs(self):
+ """Gets the tabs of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The tabs of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: Tabs
+ """
+ return self._tabs
+
+ @tabs.setter
+ def tabs(self, tabs):
+ """Sets the tabs of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param tabs: The tabs of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: Tabs
+ """
+
+ self._tabs = tabs
+
+ @property
+ def template_locked(self):
+ """Gets the template_locked of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
+
+ :return: The template_locked of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._template_locked
+
+ @template_locked.setter
+ def template_locked(self, template_locked):
+ """Sets the template_locked of this EnvelopeGenAndSendProperties.
+
+ When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
+
+ :param template_locked: The template_locked of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._template_locked = template_locked
+
+ @property
+ def template_required(self):
+ """Gets the template_required of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
+
+ :return: The template_required of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._template_required
+
+ @template_required.setter
+ def template_required(self, template_required):
+ """Sets the template_required of this EnvelopeGenAndSendProperties.
+
+ When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
+
+ :param template_required: The template_required of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._template_required = template_required
+
+ @property
+ def transform_pdf_fields(self):
+ """Gets the transform_pdf_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The transform_pdf_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._transform_pdf_fields
+
+ @transform_pdf_fields.setter
+ def transform_pdf_fields(self, transform_pdf_fields):
+ """Sets the transform_pdf_fields of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param transform_pdf_fields: The transform_pdf_fields of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._transform_pdf_fields = transform_pdf_fields
+
+ @property
+ def uri(self):
+ """Gets the uri of this EnvelopeGenAndSendProperties. # noqa: E501
+
+ # noqa: E501
+
+ :return: The uri of this EnvelopeGenAndSendProperties. # noqa: E501
+ :rtype: str
+ """
+ return self._uri
+
+ @uri.setter
+ def uri(self, uri):
+ """Sets the uri of this EnvelopeGenAndSendProperties.
+
+ # noqa: E501
+
+ :param uri: The uri of this EnvelopeGenAndSendProperties. # noqa: E501
+ :type: str
+ """
+
+ self._uri = uri
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(EnvelopeGenAndSendProperties, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, EnvelopeGenAndSendProperties):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, EnvelopeGenAndSendProperties):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/envelope_purge_configuration.py b/docusign_esign/models/envelope_purge_configuration.py
index c4006b2..75c25c2 100644
--- a/docusign_esign/models/envelope_purge_configuration.py
+++ b/docusign_esign/models/envelope_purge_configuration.py
@@ -33,15 +33,21 @@ class EnvelopePurgeConfiguration(object):
and the value is json key in definition.
"""
swagger_types = {
+ 'apply_purge_policy_for_unaccounted_recipients': 'str',
'purge_envelopes': 'str',
+ 'purge_envelopes_received': 'str',
'redact_pii': 'str',
+ 'redact_pii_received': 'str',
'remove_tabs_and_envelope_attachments': 'str',
'retention_days': 'str'
}
attribute_map = {
+ 'apply_purge_policy_for_unaccounted_recipients': 'applyPurgePolicyForUnaccountedRecipients',
'purge_envelopes': 'purgeEnvelopes',
+ 'purge_envelopes_received': 'purgeEnvelopesReceived',
'redact_pii': 'redactPII',
+ 'redact_pii_received': 'redactPIIReceived',
'remove_tabs_and_envelope_attachments': 'removeTabsAndEnvelopeAttachments',
'retention_days': 'retentionDays'
}
@@ -52,17 +58,46 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
_configuration = Configuration()
self._configuration = _configuration
+ self._apply_purge_policy_for_unaccounted_recipients = None
self._purge_envelopes = None
+ self._purge_envelopes_received = None
self._redact_pii = None
+ self._redact_pii_received = None
self._remove_tabs_and_envelope_attachments = None
self._retention_days = None
self.discriminator = None
+ setattr(self, "_{}".format('apply_purge_policy_for_unaccounted_recipients'), kwargs.get('apply_purge_policy_for_unaccounted_recipients', None))
setattr(self, "_{}".format('purge_envelopes'), kwargs.get('purge_envelopes', None))
+ setattr(self, "_{}".format('purge_envelopes_received'), kwargs.get('purge_envelopes_received', None))
setattr(self, "_{}".format('redact_pii'), kwargs.get('redact_pii', None))
+ setattr(self, "_{}".format('redact_pii_received'), kwargs.get('redact_pii_received', None))
setattr(self, "_{}".format('remove_tabs_and_envelope_attachments'), kwargs.get('remove_tabs_and_envelope_attachments', None))
setattr(self, "_{}".format('retention_days'), kwargs.get('retention_days', None))
+ @property
+ def apply_purge_policy_for_unaccounted_recipients(self):
+ """Gets the apply_purge_policy_for_unaccounted_recipients of this EnvelopePurgeConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The apply_purge_policy_for_unaccounted_recipients of this EnvelopePurgeConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._apply_purge_policy_for_unaccounted_recipients
+
+ @apply_purge_policy_for_unaccounted_recipients.setter
+ def apply_purge_policy_for_unaccounted_recipients(self, apply_purge_policy_for_unaccounted_recipients):
+ """Sets the apply_purge_policy_for_unaccounted_recipients of this EnvelopePurgeConfiguration.
+
+ # noqa: E501
+
+ :param apply_purge_policy_for_unaccounted_recipients: The apply_purge_policy_for_unaccounted_recipients of this EnvelopePurgeConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._apply_purge_policy_for_unaccounted_recipients = apply_purge_policy_for_unaccounted_recipients
+
@property
def purge_envelopes(self):
"""Gets the purge_envelopes of this EnvelopePurgeConfiguration. # noqa: E501
@@ -86,6 +121,29 @@ def purge_envelopes(self, purge_envelopes):
self._purge_envelopes = purge_envelopes
+ @property
+ def purge_envelopes_received(self):
+ """Gets the purge_envelopes_received of this EnvelopePurgeConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The purge_envelopes_received of this EnvelopePurgeConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._purge_envelopes_received
+
+ @purge_envelopes_received.setter
+ def purge_envelopes_received(self, purge_envelopes_received):
+ """Sets the purge_envelopes_received of this EnvelopePurgeConfiguration.
+
+ # noqa: E501
+
+ :param purge_envelopes_received: The purge_envelopes_received of this EnvelopePurgeConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._purge_envelopes_received = purge_envelopes_received
+
@property
def redact_pii(self):
"""Gets the redact_pii of this EnvelopePurgeConfiguration. # noqa: E501
@@ -109,6 +167,29 @@ def redact_pii(self, redact_pii):
self._redact_pii = redact_pii
+ @property
+ def redact_pii_received(self):
+ """Gets the redact_pii_received of this EnvelopePurgeConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The redact_pii_received of this EnvelopePurgeConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._redact_pii_received
+
+ @redact_pii_received.setter
+ def redact_pii_received(self, redact_pii_received):
+ """Sets the redact_pii_received of this EnvelopePurgeConfiguration.
+
+ # noqa: E501
+
+ :param redact_pii_received: The redact_pii_received of this EnvelopePurgeConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._redact_pii_received = redact_pii_received
+
@property
def remove_tabs_and_envelope_attachments(self):
"""Gets the remove_tabs_and_envelope_attachments of this EnvelopePurgeConfiguration. # noqa: E501
diff --git a/docusign_esign/models/envelope_template.py b/docusign_esign/models/envelope_template.py
index 1bff469..3358b70 100644
--- a/docusign_esign/models/envelope_template.py
+++ b/docusign_esign/models/envelope_template.py
@@ -71,6 +71,7 @@ class EnvelopeTemplate(object):
'enable_wet_sign': 'str',
'enforce_signer_visibility': 'str',
'envelope_attachments': 'list[Attachment]',
+ 'envelope_classification': 'str',
'envelope_custom_metadata': 'EnvelopeCustomMetadata',
'envelope_documents': 'list[EnvelopeDocument]',
'envelope_id': 'str',
@@ -87,6 +88,7 @@ class EnvelopeTemplate(object):
'folder_ids': 'list[str]',
'folder_name': 'str',
'folders': 'list[Folder]',
+ 'has_authorized_signatory_recipient': 'str',
'has_comments': 'str',
'has_form_data_changed': 'str',
'has_wav_file': 'str',
@@ -136,6 +138,7 @@ class EnvelopeTemplate(object):
'u_sig_state': 'str',
'voided_date_time': 'str',
'voided_reason': 'str',
+ 'watermark_language': 'str',
'workflow': 'Workflow'
}
@@ -178,6 +181,7 @@ class EnvelopeTemplate(object):
'enable_wet_sign': 'enableWetSign',
'enforce_signer_visibility': 'enforceSignerVisibility',
'envelope_attachments': 'envelopeAttachments',
+ 'envelope_classification': 'envelopeClassification',
'envelope_custom_metadata': 'envelopeCustomMetadata',
'envelope_documents': 'envelopeDocuments',
'envelope_id': 'envelopeId',
@@ -194,6 +198,7 @@ class EnvelopeTemplate(object):
'folder_ids': 'folderIds',
'folder_name': 'folderName',
'folders': 'folders',
+ 'has_authorized_signatory_recipient': 'hasAuthorizedSignatoryRecipient',
'has_comments': 'hasComments',
'has_form_data_changed': 'hasFormDataChanged',
'has_wav_file': 'hasWavFile',
@@ -243,6 +248,7 @@ class EnvelopeTemplate(object):
'u_sig_state': 'uSigState',
'voided_date_time': 'voidedDateTime',
'voided_reason': 'voidedReason',
+ 'watermark_language': 'watermarkLanguage',
'workflow': 'workflow'
}
@@ -290,6 +296,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._enable_wet_sign = None
self._enforce_signer_visibility = None
self._envelope_attachments = None
+ self._envelope_classification = None
self._envelope_custom_metadata = None
self._envelope_documents = None
self._envelope_id = None
@@ -306,6 +313,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._folder_ids = None
self._folder_name = None
self._folders = None
+ self._has_authorized_signatory_recipient = None
self._has_comments = None
self._has_form_data_changed = None
self._has_wav_file = None
@@ -355,6 +363,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._u_sig_state = None
self._voided_date_time = None
self._voided_reason = None
+ self._watermark_language = None
self._workflow = None
self.discriminator = None
@@ -396,6 +405,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('enable_wet_sign'), kwargs.get('enable_wet_sign', None))
setattr(self, "_{}".format('enforce_signer_visibility'), kwargs.get('enforce_signer_visibility', None))
setattr(self, "_{}".format('envelope_attachments'), kwargs.get('envelope_attachments', None))
+ setattr(self, "_{}".format('envelope_classification'), kwargs.get('envelope_classification', None))
setattr(self, "_{}".format('envelope_custom_metadata'), kwargs.get('envelope_custom_metadata', None))
setattr(self, "_{}".format('envelope_documents'), kwargs.get('envelope_documents', None))
setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
@@ -412,6 +422,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('folder_ids'), kwargs.get('folder_ids', None))
setattr(self, "_{}".format('folder_name'), kwargs.get('folder_name', None))
setattr(self, "_{}".format('folders'), kwargs.get('folders', None))
+ setattr(self, "_{}".format('has_authorized_signatory_recipient'), kwargs.get('has_authorized_signatory_recipient', None))
setattr(self, "_{}".format('has_comments'), kwargs.get('has_comments', None))
setattr(self, "_{}".format('has_form_data_changed'), kwargs.get('has_form_data_changed', None))
setattr(self, "_{}".format('has_wav_file'), kwargs.get('has_wav_file', None))
@@ -461,6 +472,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('u_sig_state'), kwargs.get('u_sig_state', None))
setattr(self, "_{}".format('voided_date_time'), kwargs.get('voided_date_time', None))
setattr(self, "_{}".format('voided_reason'), kwargs.get('voided_reason', None))
+ setattr(self, "_{}".format('watermark_language'), kwargs.get('watermark_language', None))
setattr(self, "_{}".format('workflow'), kwargs.get('workflow', None))
@property
@@ -1337,6 +1349,29 @@ def envelope_attachments(self, envelope_attachments):
self._envelope_attachments = envelope_attachments
+ @property
+ def envelope_classification(self):
+ """Gets the envelope_classification of this EnvelopeTemplate. # noqa: E501
+
+ # noqa: E501
+
+ :return: The envelope_classification of this EnvelopeTemplate. # noqa: E501
+ :rtype: str
+ """
+ return self._envelope_classification
+
+ @envelope_classification.setter
+ def envelope_classification(self, envelope_classification):
+ """Sets the envelope_classification of this EnvelopeTemplate.
+
+ # noqa: E501
+
+ :param envelope_classification: The envelope_classification of this EnvelopeTemplate. # noqa: E501
+ :type: str
+ """
+
+ self._envelope_classification = envelope_classification
+
@property
def envelope_custom_metadata(self):
"""Gets the envelope_custom_metadata of this EnvelopeTemplate. # noqa: E501
@@ -1705,6 +1740,29 @@ def folders(self, folders):
self._folders = folders
+ @property
+ def has_authorized_signatory_recipient(self):
+ """Gets the has_authorized_signatory_recipient of this EnvelopeTemplate. # noqa: E501
+
+ # noqa: E501
+
+ :return: The has_authorized_signatory_recipient of this EnvelopeTemplate. # noqa: E501
+ :rtype: str
+ """
+ return self._has_authorized_signatory_recipient
+
+ @has_authorized_signatory_recipient.setter
+ def has_authorized_signatory_recipient(self, has_authorized_signatory_recipient):
+ """Sets the has_authorized_signatory_recipient of this EnvelopeTemplate.
+
+ # noqa: E501
+
+ :param has_authorized_signatory_recipient: The has_authorized_signatory_recipient of this EnvelopeTemplate. # noqa: E501
+ :type: str
+ """
+
+ self._has_authorized_signatory_recipient = has_authorized_signatory_recipient
+
@property
def has_comments(self):
"""Gets the has_comments of this EnvelopeTemplate. # noqa: E501
@@ -2832,6 +2890,29 @@ def voided_reason(self, voided_reason):
self._voided_reason = voided_reason
+ @property
+ def watermark_language(self):
+ """Gets the watermark_language of this EnvelopeTemplate. # noqa: E501
+
+ # noqa: E501
+
+ :return: The watermark_language of this EnvelopeTemplate. # noqa: E501
+ :rtype: str
+ """
+ return self._watermark_language
+
+ @watermark_language.setter
+ def watermark_language(self, watermark_language):
+ """Sets the watermark_language of this EnvelopeTemplate.
+
+ # noqa: E501
+
+ :param watermark_language: The watermark_language of this EnvelopeTemplate. # noqa: E501
+ :type: str
+ """
+
+ self._watermark_language = watermark_language
+
@property
def workflow(self):
"""Gets the workflow of this EnvelopeTemplate. # noqa: E501
diff --git a/docusign_esign/models/envelopes_share_permission_response.py b/docusign_esign/models/envelopes_share_permission_response.py
new file mode 100644
index 0000000..2359cdf
--- /dev/null
+++ b/docusign_esign/models/envelopes_share_permission_response.py
@@ -0,0 +1,124 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class EnvelopesSharePermissionResponse(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'permission': 'str'
+ }
+
+ attribute_map = {
+ 'permission': 'permission'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """EnvelopesSharePermissionResponse - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._permission = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('permission'), kwargs.get('permission', None))
+
+ @property
+ def permission(self):
+ """Gets the permission of this EnvelopesSharePermissionResponse. # noqa: E501
+
+ # noqa: E501
+
+ :return: The permission of this EnvelopesSharePermissionResponse. # noqa: E501
+ :rtype: str
+ """
+ return self._permission
+
+ @permission.setter
+ def permission(self, permission):
+ """Sets the permission of this EnvelopesSharePermissionResponse.
+
+ # noqa: E501
+
+ :param permission: The permission of this EnvelopesSharePermissionResponse. # noqa: E501
+ :type: str
+ """
+
+ self._permission = permission
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(EnvelopesSharePermissionResponse, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, EnvelopesSharePermissionResponse):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, EnvelopesSharePermissionResponse):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/envelopes_share_request.py b/docusign_esign/models/envelopes_share_request.py
index 40977b2..374aa33 100644
--- a/docusign_esign/models/envelopes_share_request.py
+++ b/docusign_esign/models/envelopes_share_request.py
@@ -35,13 +35,15 @@ class EnvelopesShareRequest(object):
swagger_types = {
'agent_user': 'AuthorizationUser',
'custom_message': 'str',
- 'permission': 'str'
+ 'permission': 'str',
+ 'share_id': 'str'
}
attribute_map = {
'agent_user': 'agentUser',
'custom_message': 'customMessage',
- 'permission': 'permission'
+ 'permission': 'permission',
+ 'share_id': 'shareId'
}
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -53,11 +55,13 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._agent_user = None
self._custom_message = None
self._permission = None
+ self._share_id = None
self.discriminator = None
setattr(self, "_{}".format('agent_user'), kwargs.get('agent_user', None))
setattr(self, "_{}".format('custom_message'), kwargs.get('custom_message', None))
setattr(self, "_{}".format('permission'), kwargs.get('permission', None))
+ setattr(self, "_{}".format('share_id'), kwargs.get('share_id', None))
@property
def agent_user(self):
@@ -128,6 +132,29 @@ def permission(self, permission):
self._permission = permission
+ @property
+ def share_id(self):
+ """Gets the share_id of this EnvelopesShareRequest. # noqa: E501
+
+ # noqa: E501
+
+ :return: The share_id of this EnvelopesShareRequest. # noqa: E501
+ :rtype: str
+ """
+ return self._share_id
+
+ @share_id.setter
+ def share_id(self, share_id):
+ """Sets the share_id of this EnvelopesShareRequest.
+
+ # noqa: E501
+
+ :param share_id: The share_id of this EnvelopesShareRequest. # noqa: E501
+ :type: str
+ """
+
+ self._share_id = share_id
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/docusign_esign/models/extend_payment_configuration.py b/docusign_esign/models/extend_payment_configuration.py
new file mode 100644
index 0000000..ec67c0e
--- /dev/null
+++ b/docusign_esign/models/extend_payment_configuration.py
@@ -0,0 +1,367 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class ExtendPaymentConfiguration(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'app_id': 'str',
+ 'connection_instance_id': 'str',
+ 'currency': 'str',
+ 'duration_end': 'str',
+ 'duration_start': 'str',
+ 'line_items': 'list[ExtendPaymentLineItem]',
+ 'payment_due_days': 'str',
+ 'payment_methods': 'list[str]',
+ 'payment_mode': 'str',
+ 'tab_role': 'str'
+ }
+
+ attribute_map = {
+ 'app_id': 'appId',
+ 'connection_instance_id': 'connectionInstanceId',
+ 'currency': 'currency',
+ 'duration_end': 'durationEnd',
+ 'duration_start': 'durationStart',
+ 'line_items': 'lineItems',
+ 'payment_due_days': 'paymentDueDays',
+ 'payment_methods': 'paymentMethods',
+ 'payment_mode': 'paymentMode',
+ 'tab_role': 'tabRole'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """ExtendPaymentConfiguration - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._app_id = None
+ self._connection_instance_id = None
+ self._currency = None
+ self._duration_end = None
+ self._duration_start = None
+ self._line_items = None
+ self._payment_due_days = None
+ self._payment_methods = None
+ self._payment_mode = None
+ self._tab_role = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('app_id'), kwargs.get('app_id', None))
+ setattr(self, "_{}".format('connection_instance_id'), kwargs.get('connection_instance_id', None))
+ setattr(self, "_{}".format('currency'), kwargs.get('currency', None))
+ setattr(self, "_{}".format('duration_end'), kwargs.get('duration_end', None))
+ setattr(self, "_{}".format('duration_start'), kwargs.get('duration_start', None))
+ setattr(self, "_{}".format('line_items'), kwargs.get('line_items', None))
+ setattr(self, "_{}".format('payment_due_days'), kwargs.get('payment_due_days', None))
+ setattr(self, "_{}".format('payment_methods'), kwargs.get('payment_methods', None))
+ setattr(self, "_{}".format('payment_mode'), kwargs.get('payment_mode', None))
+ setattr(self, "_{}".format('tab_role'), kwargs.get('tab_role', None))
+
+ @property
+ def app_id(self):
+ """Gets the app_id of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The app_id of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._app_id
+
+ @app_id.setter
+ def app_id(self, app_id):
+ """Sets the app_id of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param app_id: The app_id of this ExtendPaymentConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._app_id = app_id
+
+ @property
+ def connection_instance_id(self):
+ """Gets the connection_instance_id of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The connection_instance_id of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._connection_instance_id
+
+ @connection_instance_id.setter
+ def connection_instance_id(self, connection_instance_id):
+ """Sets the connection_instance_id of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param connection_instance_id: The connection_instance_id of this ExtendPaymentConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._connection_instance_id = connection_instance_id
+
+ @property
+ def currency(self):
+ """Gets the currency of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The currency of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._currency
+
+ @currency.setter
+ def currency(self, currency):
+ """Sets the currency of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param currency: The currency of this ExtendPaymentConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._currency = currency
+
+ @property
+ def duration_end(self):
+ """Gets the duration_end of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The duration_end of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._duration_end
+
+ @duration_end.setter
+ def duration_end(self, duration_end):
+ """Sets the duration_end of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param duration_end: The duration_end of this ExtendPaymentConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._duration_end = duration_end
+
+ @property
+ def duration_start(self):
+ """Gets the duration_start of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The duration_start of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._duration_start
+
+ @duration_start.setter
+ def duration_start(self, duration_start):
+ """Sets the duration_start of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param duration_start: The duration_start of this ExtendPaymentConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._duration_start = duration_start
+
+ @property
+ def line_items(self):
+ """Gets the line_items of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The line_items of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: list[ExtendPaymentLineItem]
+ """
+ return self._line_items
+
+ @line_items.setter
+ def line_items(self, line_items):
+ """Sets the line_items of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param line_items: The line_items of this ExtendPaymentConfiguration. # noqa: E501
+ :type: list[ExtendPaymentLineItem]
+ """
+
+ self._line_items = line_items
+
+ @property
+ def payment_due_days(self):
+ """Gets the payment_due_days of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The payment_due_days of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._payment_due_days
+
+ @payment_due_days.setter
+ def payment_due_days(self, payment_due_days):
+ """Sets the payment_due_days of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param payment_due_days: The payment_due_days of this ExtendPaymentConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._payment_due_days = payment_due_days
+
+ @property
+ def payment_methods(self):
+ """Gets the payment_methods of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The payment_methods of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._payment_methods
+
+ @payment_methods.setter
+ def payment_methods(self, payment_methods):
+ """Sets the payment_methods of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param payment_methods: The payment_methods of this ExtendPaymentConfiguration. # noqa: E501
+ :type: list[str]
+ """
+
+ self._payment_methods = payment_methods
+
+ @property
+ def payment_mode(self):
+ """Gets the payment_mode of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The payment_mode of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._payment_mode
+
+ @payment_mode.setter
+ def payment_mode(self, payment_mode):
+ """Sets the payment_mode of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param payment_mode: The payment_mode of this ExtendPaymentConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._payment_mode = payment_mode
+
+ @property
+ def tab_role(self):
+ """Gets the tab_role of this ExtendPaymentConfiguration. # noqa: E501
+
+ # noqa: E501
+
+ :return: The tab_role of this ExtendPaymentConfiguration. # noqa: E501
+ :rtype: str
+ """
+ return self._tab_role
+
+ @tab_role.setter
+ def tab_role(self, tab_role):
+ """Sets the tab_role of this ExtendPaymentConfiguration.
+
+ # noqa: E501
+
+ :param tab_role: The tab_role of this ExtendPaymentConfiguration. # noqa: E501
+ :type: str
+ """
+
+ self._tab_role = tab_role
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(ExtendPaymentConfiguration, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, ExtendPaymentConfiguration):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, ExtendPaymentConfiguration):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/extend_payment_line_item.py b/docusign_esign/models/extend_payment_line_item.py
new file mode 100644
index 0000000..895fd69
--- /dev/null
+++ b/docusign_esign/models/extend_payment_line_item.py
@@ -0,0 +1,313 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class ExtendPaymentLineItem(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'amount_reference': 'str',
+ 'description': 'str',
+ 'name': 'str',
+ 'price_id': 'str',
+ 'product_id': 'str',
+ 'quantity': 'str',
+ 'type': 'str',
+ 'unit_amount': 'str'
+ }
+
+ attribute_map = {
+ 'amount_reference': 'amountReference',
+ 'description': 'description',
+ 'name': 'name',
+ 'price_id': 'priceId',
+ 'product_id': 'productId',
+ 'quantity': 'quantity',
+ 'type': 'type',
+ 'unit_amount': 'unitAmount'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """ExtendPaymentLineItem - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._amount_reference = None
+ self._description = None
+ self._name = None
+ self._price_id = None
+ self._product_id = None
+ self._quantity = None
+ self._type = None
+ self._unit_amount = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('amount_reference'), kwargs.get('amount_reference', None))
+ setattr(self, "_{}".format('description'), kwargs.get('description', None))
+ setattr(self, "_{}".format('name'), kwargs.get('name', None))
+ setattr(self, "_{}".format('price_id'), kwargs.get('price_id', None))
+ setattr(self, "_{}".format('product_id'), kwargs.get('product_id', None))
+ setattr(self, "_{}".format('quantity'), kwargs.get('quantity', None))
+ setattr(self, "_{}".format('type'), kwargs.get('type', None))
+ setattr(self, "_{}".format('unit_amount'), kwargs.get('unit_amount', None))
+
+ @property
+ def amount_reference(self):
+ """Gets the amount_reference of this ExtendPaymentLineItem. # noqa: E501
+
+ # noqa: E501
+
+ :return: The amount_reference of this ExtendPaymentLineItem. # noqa: E501
+ :rtype: str
+ """
+ return self._amount_reference
+
+ @amount_reference.setter
+ def amount_reference(self, amount_reference):
+ """Sets the amount_reference of this ExtendPaymentLineItem.
+
+ # noqa: E501
+
+ :param amount_reference: The amount_reference of this ExtendPaymentLineItem. # noqa: E501
+ :type: str
+ """
+
+ self._amount_reference = amount_reference
+
+ @property
+ def description(self):
+ """Gets the description of this ExtendPaymentLineItem. # noqa: E501
+
+ # noqa: E501
+
+ :return: The description of this ExtendPaymentLineItem. # noqa: E501
+ :rtype: str
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description):
+ """Sets the description of this ExtendPaymentLineItem.
+
+ # noqa: E501
+
+ :param description: The description of this ExtendPaymentLineItem. # noqa: E501
+ :type: str
+ """
+
+ self._description = description
+
+ @property
+ def name(self):
+ """Gets the name of this ExtendPaymentLineItem. # noqa: E501
+
+ # noqa: E501
+
+ :return: The name of this ExtendPaymentLineItem. # noqa: E501
+ :rtype: str
+ """
+ return self._name
+
+ @name.setter
+ def name(self, name):
+ """Sets the name of this ExtendPaymentLineItem.
+
+ # noqa: E501
+
+ :param name: The name of this ExtendPaymentLineItem. # noqa: E501
+ :type: str
+ """
+
+ self._name = name
+
+ @property
+ def price_id(self):
+ """Gets the price_id of this ExtendPaymentLineItem. # noqa: E501
+
+ # noqa: E501
+
+ :return: The price_id of this ExtendPaymentLineItem. # noqa: E501
+ :rtype: str
+ """
+ return self._price_id
+
+ @price_id.setter
+ def price_id(self, price_id):
+ """Sets the price_id of this ExtendPaymentLineItem.
+
+ # noqa: E501
+
+ :param price_id: The price_id of this ExtendPaymentLineItem. # noqa: E501
+ :type: str
+ """
+
+ self._price_id = price_id
+
+ @property
+ def product_id(self):
+ """Gets the product_id of this ExtendPaymentLineItem. # noqa: E501
+
+ # noqa: E501
+
+ :return: The product_id of this ExtendPaymentLineItem. # noqa: E501
+ :rtype: str
+ """
+ return self._product_id
+
+ @product_id.setter
+ def product_id(self, product_id):
+ """Sets the product_id of this ExtendPaymentLineItem.
+
+ # noqa: E501
+
+ :param product_id: The product_id of this ExtendPaymentLineItem. # noqa: E501
+ :type: str
+ """
+
+ self._product_id = product_id
+
+ @property
+ def quantity(self):
+ """Gets the quantity of this ExtendPaymentLineItem. # noqa: E501
+
+ # noqa: E501
+
+ :return: The quantity of this ExtendPaymentLineItem. # noqa: E501
+ :rtype: str
+ """
+ return self._quantity
+
+ @quantity.setter
+ def quantity(self, quantity):
+ """Sets the quantity of this ExtendPaymentLineItem.
+
+ # noqa: E501
+
+ :param quantity: The quantity of this ExtendPaymentLineItem. # noqa: E501
+ :type: str
+ """
+
+ self._quantity = quantity
+
+ @property
+ def type(self):
+ """Gets the type of this ExtendPaymentLineItem. # noqa: E501
+
+ # noqa: E501
+
+ :return: The type of this ExtendPaymentLineItem. # noqa: E501
+ :rtype: str
+ """
+ return self._type
+
+ @type.setter
+ def type(self, type):
+ """Sets the type of this ExtendPaymentLineItem.
+
+ # noqa: E501
+
+ :param type: The type of this ExtendPaymentLineItem. # noqa: E501
+ :type: str
+ """
+
+ self._type = type
+
+ @property
+ def unit_amount(self):
+ """Gets the unit_amount of this ExtendPaymentLineItem. # noqa: E501
+
+ # noqa: E501
+
+ :return: The unit_amount of this ExtendPaymentLineItem. # noqa: E501
+ :rtype: str
+ """
+ return self._unit_amount
+
+ @unit_amount.setter
+ def unit_amount(self, unit_amount):
+ """Sets the unit_amount of this ExtendPaymentLineItem.
+
+ # noqa: E501
+
+ :param unit_amount: The unit_amount of this ExtendPaymentLineItem. # noqa: E501
+ :type: str
+ """
+
+ self._unit_amount = unit_amount
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(ExtendPaymentLineItem, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, ExtendPaymentLineItem):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, ExtendPaymentLineItem):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/formula_tab.py b/docusign_esign/models/formula_tab.py
index 6022993..c8b7275 100644
--- a/docusign_esign/models/formula_tab.py
+++ b/docusign_esign/models/formula_tab.py
@@ -74,6 +74,7 @@ class FormulaTab(object):
'document_id': 'str',
'document_id_metadata': 'PropertyMetadata',
'error_details': 'ErrorDetails',
+ 'extend_payment_configuration': 'ExtendPaymentConfiguration',
'extension_data': 'ExtensionData',
'font': 'str',
'font_color': 'str',
@@ -209,6 +210,7 @@ class FormulaTab(object):
'document_id': 'documentId',
'document_id_metadata': 'documentIdMetadata',
'error_details': 'errorDetails',
+ 'extend_payment_configuration': 'extendPaymentConfiguration',
'extension_data': 'extensionData',
'font': 'font',
'font_color': 'fontColor',
@@ -349,6 +351,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._document_id = None
self._document_id_metadata = None
self._error_details = None
+ self._extend_payment_configuration = None
self._extension_data = None
self._font = None
self._font_color = None
@@ -483,6 +486,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None))
setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None))
setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
+ setattr(self, "_{}".format('extend_payment_configuration'), kwargs.get('extend_payment_configuration', None))
setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None))
setattr(self, "_{}".format('font'), kwargs.get('font', None))
setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None))
@@ -1518,6 +1522,29 @@ def error_details(self, error_details):
self._error_details = error_details
+ @property
+ def extend_payment_configuration(self):
+ """Gets the extend_payment_configuration of this FormulaTab. # noqa: E501
+
+ # noqa: E501
+
+ :return: The extend_payment_configuration of this FormulaTab. # noqa: E501
+ :rtype: ExtendPaymentConfiguration
+ """
+ return self._extend_payment_configuration
+
+ @extend_payment_configuration.setter
+ def extend_payment_configuration(self, extend_payment_configuration):
+ """Sets the extend_payment_configuration of this FormulaTab.
+
+ # noqa: E501
+
+ :param extend_payment_configuration: The extend_payment_configuration of this FormulaTab. # noqa: E501
+ :type: ExtendPaymentConfiguration
+ """
+
+ self._extend_payment_configuration = extend_payment_configuration
+
@property
def extension_data(self):
"""Gets the extension_data of this FormulaTab. # noqa: E501
diff --git a/docusign_esign/models/generated_document.py b/docusign_esign/models/generated_document.py
new file mode 100644
index 0000000..5c74256
--- /dev/null
+++ b/docusign_esign/models/generated_document.py
@@ -0,0 +1,205 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class GeneratedDocument(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'document_as_base64': 'str',
+ 'document_id': 'str',
+ 'document_name': 'str',
+ 'file_extension': 'str'
+ }
+
+ attribute_map = {
+ 'document_as_base64': 'documentAsBase64',
+ 'document_id': 'documentId',
+ 'document_name': 'documentName',
+ 'file_extension': 'fileExtension'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """GeneratedDocument - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._document_as_base64 = None
+ self._document_id = None
+ self._document_name = None
+ self._file_extension = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('document_as_base64'), kwargs.get('document_as_base64', None))
+ setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None))
+ setattr(self, "_{}".format('document_name'), kwargs.get('document_name', None))
+ setattr(self, "_{}".format('file_extension'), kwargs.get('file_extension', None))
+
+ @property
+ def document_as_base64(self):
+ """Gets the document_as_base64 of this GeneratedDocument. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_as_base64 of this GeneratedDocument. # noqa: E501
+ :rtype: str
+ """
+ return self._document_as_base64
+
+ @document_as_base64.setter
+ def document_as_base64(self, document_as_base64):
+ """Sets the document_as_base64 of this GeneratedDocument.
+
+ # noqa: E501
+
+ :param document_as_base64: The document_as_base64 of this GeneratedDocument. # noqa: E501
+ :type: str
+ """
+
+ self._document_as_base64 = document_as_base64
+
+ @property
+ def document_id(self):
+ """Gets the document_id of this GeneratedDocument. # noqa: E501
+
+ Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501
+
+ :return: The document_id of this GeneratedDocument. # noqa: E501
+ :rtype: str
+ """
+ return self._document_id
+
+ @document_id.setter
+ def document_id(self, document_id):
+ """Sets the document_id of this GeneratedDocument.
+
+ Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501
+
+ :param document_id: The document_id of this GeneratedDocument. # noqa: E501
+ :type: str
+ """
+
+ self._document_id = document_id
+
+ @property
+ def document_name(self):
+ """Gets the document_name of this GeneratedDocument. # noqa: E501
+
+ # noqa: E501
+
+ :return: The document_name of this GeneratedDocument. # noqa: E501
+ :rtype: str
+ """
+ return self._document_name
+
+ @document_name.setter
+ def document_name(self, document_name):
+ """Sets the document_name of this GeneratedDocument.
+
+ # noqa: E501
+
+ :param document_name: The document_name of this GeneratedDocument. # noqa: E501
+ :type: str
+ """
+
+ self._document_name = document_name
+
+ @property
+ def file_extension(self):
+ """Gets the file_extension of this GeneratedDocument. # noqa: E501
+
+ # noqa: E501
+
+ :return: The file_extension of this GeneratedDocument. # noqa: E501
+ :rtype: str
+ """
+ return self._file_extension
+
+ @file_extension.setter
+ def file_extension(self, file_extension):
+ """Sets the file_extension of this GeneratedDocument.
+
+ # noqa: E501
+
+ :param file_extension: The file_extension of this GeneratedDocument. # noqa: E501
+ :type: str
+ """
+
+ self._file_extension = file_extension
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(GeneratedDocument, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, GeneratedDocument):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, GeneratedDocument):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/generated_documents_result.py b/docusign_esign/models/generated_documents_result.py
new file mode 100644
index 0000000..876c80b
--- /dev/null
+++ b/docusign_esign/models/generated_documents_result.py
@@ -0,0 +1,124 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class GeneratedDocumentsResult(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'generated_documents': 'list[GeneratedDocument]'
+ }
+
+ attribute_map = {
+ 'generated_documents': 'generatedDocuments'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """GeneratedDocumentsResult - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._generated_documents = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('generated_documents'), kwargs.get('generated_documents', None))
+
+ @property
+ def generated_documents(self):
+ """Gets the generated_documents of this GeneratedDocumentsResult. # noqa: E501
+
+ # noqa: E501
+
+ :return: The generated_documents of this GeneratedDocumentsResult. # noqa: E501
+ :rtype: list[GeneratedDocument]
+ """
+ return self._generated_documents
+
+ @generated_documents.setter
+ def generated_documents(self, generated_documents):
+ """Sets the generated_documents of this GeneratedDocumentsResult.
+
+ # noqa: E501
+
+ :param generated_documents: The generated_documents of this GeneratedDocumentsResult. # noqa: E501
+ :type: list[GeneratedDocument]
+ """
+
+ self._generated_documents = generated_documents
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(GeneratedDocumentsResult, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, GeneratedDocumentsResult):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, GeneratedDocumentsResult):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/payment_audit_event.py b/docusign_esign/models/payment_audit_event.py
new file mode 100644
index 0000000..dfcbb96
--- /dev/null
+++ b/docusign_esign/models/payment_audit_event.py
@@ -0,0 +1,313 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class PaymentAuditEvent(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'account_id': 'str',
+ 'action': 'str',
+ 'actor_display_name': 'str',
+ 'event_description': 'str',
+ 'event_type': 'str',
+ 'responsible_actor': 'str',
+ 'status': 'str',
+ 'timestamp': 'str'
+ }
+
+ attribute_map = {
+ 'account_id': 'accountId',
+ 'action': 'action',
+ 'actor_display_name': 'actorDisplayName',
+ 'event_description': 'eventDescription',
+ 'event_type': 'eventType',
+ 'responsible_actor': 'responsibleActor',
+ 'status': 'status',
+ 'timestamp': 'timestamp'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """PaymentAuditEvent - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._account_id = None
+ self._action = None
+ self._actor_display_name = None
+ self._event_description = None
+ self._event_type = None
+ self._responsible_actor = None
+ self._status = None
+ self._timestamp = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('account_id'), kwargs.get('account_id', None))
+ setattr(self, "_{}".format('action'), kwargs.get('action', None))
+ setattr(self, "_{}".format('actor_display_name'), kwargs.get('actor_display_name', None))
+ setattr(self, "_{}".format('event_description'), kwargs.get('event_description', None))
+ setattr(self, "_{}".format('event_type'), kwargs.get('event_type', None))
+ setattr(self, "_{}".format('responsible_actor'), kwargs.get('responsible_actor', None))
+ setattr(self, "_{}".format('status'), kwargs.get('status', None))
+ setattr(self, "_{}".format('timestamp'), kwargs.get('timestamp', None))
+
+ @property
+ def account_id(self):
+ """Gets the account_id of this PaymentAuditEvent. # noqa: E501
+
+ The account ID associated with the envelope. # noqa: E501
+
+ :return: The account_id of this PaymentAuditEvent. # noqa: E501
+ :rtype: str
+ """
+ return self._account_id
+
+ @account_id.setter
+ def account_id(self, account_id):
+ """Sets the account_id of this PaymentAuditEvent.
+
+ The account ID associated with the envelope. # noqa: E501
+
+ :param account_id: The account_id of this PaymentAuditEvent. # noqa: E501
+ :type: str
+ """
+
+ self._account_id = account_id
+
+ @property
+ def action(self):
+ """Gets the action of this PaymentAuditEvent. # noqa: E501
+
+ # noqa: E501
+
+ :return: The action of this PaymentAuditEvent. # noqa: E501
+ :rtype: str
+ """
+ return self._action
+
+ @action.setter
+ def action(self, action):
+ """Sets the action of this PaymentAuditEvent.
+
+ # noqa: E501
+
+ :param action: The action of this PaymentAuditEvent. # noqa: E501
+ :type: str
+ """
+
+ self._action = action
+
+ @property
+ def actor_display_name(self):
+ """Gets the actor_display_name of this PaymentAuditEvent. # noqa: E501
+
+ # noqa: E501
+
+ :return: The actor_display_name of this PaymentAuditEvent. # noqa: E501
+ :rtype: str
+ """
+ return self._actor_display_name
+
+ @actor_display_name.setter
+ def actor_display_name(self, actor_display_name):
+ """Sets the actor_display_name of this PaymentAuditEvent.
+
+ # noqa: E501
+
+ :param actor_display_name: The actor_display_name of this PaymentAuditEvent. # noqa: E501
+ :type: str
+ """
+
+ self._actor_display_name = actor_display_name
+
+ @property
+ def event_description(self):
+ """Gets the event_description of this PaymentAuditEvent. # noqa: E501
+
+ # noqa: E501
+
+ :return: The event_description of this PaymentAuditEvent. # noqa: E501
+ :rtype: str
+ """
+ return self._event_description
+
+ @event_description.setter
+ def event_description(self, event_description):
+ """Sets the event_description of this PaymentAuditEvent.
+
+ # noqa: E501
+
+ :param event_description: The event_description of this PaymentAuditEvent. # noqa: E501
+ :type: str
+ """
+
+ self._event_description = event_description
+
+ @property
+ def event_type(self):
+ """Gets the event_type of this PaymentAuditEvent. # noqa: E501
+
+ # noqa: E501
+
+ :return: The event_type of this PaymentAuditEvent. # noqa: E501
+ :rtype: str
+ """
+ return self._event_type
+
+ @event_type.setter
+ def event_type(self, event_type):
+ """Sets the event_type of this PaymentAuditEvent.
+
+ # noqa: E501
+
+ :param event_type: The event_type of this PaymentAuditEvent. # noqa: E501
+ :type: str
+ """
+
+ self._event_type = event_type
+
+ @property
+ def responsible_actor(self):
+ """Gets the responsible_actor of this PaymentAuditEvent. # noqa: E501
+
+ # noqa: E501
+
+ :return: The responsible_actor of this PaymentAuditEvent. # noqa: E501
+ :rtype: str
+ """
+ return self._responsible_actor
+
+ @responsible_actor.setter
+ def responsible_actor(self, responsible_actor):
+ """Sets the responsible_actor of this PaymentAuditEvent.
+
+ # noqa: E501
+
+ :param responsible_actor: The responsible_actor of this PaymentAuditEvent. # noqa: E501
+ :type: str
+ """
+
+ self._responsible_actor = responsible_actor
+
+ @property
+ def status(self):
+ """Gets the status of this PaymentAuditEvent. # noqa: E501
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :return: The status of this PaymentAuditEvent. # noqa: E501
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this PaymentAuditEvent.
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :param status: The status of this PaymentAuditEvent. # noqa: E501
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def timestamp(self):
+ """Gets the timestamp of this PaymentAuditEvent. # noqa: E501
+
+ # noqa: E501
+
+ :return: The timestamp of this PaymentAuditEvent. # noqa: E501
+ :rtype: str
+ """
+ return self._timestamp
+
+ @timestamp.setter
+ def timestamp(self, timestamp):
+ """Sets the timestamp of this PaymentAuditEvent.
+
+ # noqa: E501
+
+ :param timestamp: The timestamp of this PaymentAuditEvent. # noqa: E501
+ :type: str
+ """
+
+ self._timestamp = timestamp
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(PaymentAuditEvent, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, PaymentAuditEvent):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, PaymentAuditEvent):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/recipient_identity_verification.py b/docusign_esign/models/recipient_identity_verification.py
index 0d0a4f2..5f376ac 100644
--- a/docusign_esign/models/recipient_identity_verification.py
+++ b/docusign_esign/models/recipient_identity_verification.py
@@ -33,6 +33,7 @@ class RecipientIdentityVerification(object):
and the value is json key in definition.
"""
swagger_types = {
+ 'has_auto_attached_risk_assessment': 'str',
'input_options': 'list[RecipientIdentityInputOption]',
'workflow_id': 'str',
'workflow_id_metadata': 'PropertyMetadata',
@@ -40,6 +41,7 @@ class RecipientIdentityVerification(object):
}
attribute_map = {
+ 'has_auto_attached_risk_assessment': 'hasAutoAttachedRiskAssessment',
'input_options': 'inputOptions',
'workflow_id': 'workflowId',
'workflow_id_metadata': 'workflowIdMetadata',
@@ -52,17 +54,42 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
_configuration = Configuration()
self._configuration = _configuration
+ self._has_auto_attached_risk_assessment = None
self._input_options = None
self._workflow_id = None
self._workflow_id_metadata = None
self._workflow_label = None
self.discriminator = None
+ setattr(self, "_{}".format('has_auto_attached_risk_assessment'), kwargs.get('has_auto_attached_risk_assessment', None))
setattr(self, "_{}".format('input_options'), kwargs.get('input_options', None))
setattr(self, "_{}".format('workflow_id'), kwargs.get('workflow_id', None))
setattr(self, "_{}".format('workflow_id_metadata'), kwargs.get('workflow_id_metadata', None))
setattr(self, "_{}".format('workflow_label'), kwargs.get('workflow_label', None))
+ @property
+ def has_auto_attached_risk_assessment(self):
+ """Gets the has_auto_attached_risk_assessment of this RecipientIdentityVerification. # noqa: E501
+
+ # noqa: E501
+
+ :return: The has_auto_attached_risk_assessment of this RecipientIdentityVerification. # noqa: E501
+ :rtype: str
+ """
+ return self._has_auto_attached_risk_assessment
+
+ @has_auto_attached_risk_assessment.setter
+ def has_auto_attached_risk_assessment(self, has_auto_attached_risk_assessment):
+ """Sets the has_auto_attached_risk_assessment of this RecipientIdentityVerification.
+
+ # noqa: E501
+
+ :param has_auto_attached_risk_assessment: The has_auto_attached_risk_assessment of this RecipientIdentityVerification. # noqa: E501
+ :type: str
+ """
+
+ self._has_auto_attached_risk_assessment = has_auto_attached_risk_assessment
+
@property
def input_options(self):
"""Gets the input_options of this RecipientIdentityVerification. # noqa: E501
diff --git a/docusign_esign/models/recipients.py b/docusign_esign/models/recipients.py
index 7a3a3ce..614df64 100644
--- a/docusign_esign/models/recipients.py
+++ b/docusign_esign/models/recipients.py
@@ -34,6 +34,7 @@ class Recipients(object):
"""
swagger_types = {
'agents': 'list[Agent]',
+ 'authorized_signatories': 'list[AuthorizedSignatory]',
'carbon_copies': 'list[CarbonCopy]',
'certified_deliveries': 'list[CertifiedDelivery]',
'current_routing_order': 'str',
@@ -52,6 +53,7 @@ class Recipients(object):
attribute_map = {
'agents': 'agents',
+ 'authorized_signatories': 'authorizedSignatories',
'carbon_copies': 'carbonCopies',
'certified_deliveries': 'certifiedDeliveries',
'current_routing_order': 'currentRoutingOrder',
@@ -75,6 +77,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._configuration = _configuration
self._agents = None
+ self._authorized_signatories = None
self._carbon_copies = None
self._certified_deliveries = None
self._current_routing_order = None
@@ -92,6 +95,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self.discriminator = None
setattr(self, "_{}".format('agents'), kwargs.get('agents', None))
+ setattr(self, "_{}".format('authorized_signatories'), kwargs.get('authorized_signatories', None))
setattr(self, "_{}".format('carbon_copies'), kwargs.get('carbon_copies', None))
setattr(self, "_{}".format('certified_deliveries'), kwargs.get('certified_deliveries', None))
setattr(self, "_{}".format('current_routing_order'), kwargs.get('current_routing_order', None))
@@ -130,6 +134,29 @@ def agents(self, agents):
self._agents = agents
+ @property
+ def authorized_signatories(self):
+ """Gets the authorized_signatories of this Recipients. # noqa: E501
+
+ # noqa: E501
+
+ :return: The authorized_signatories of this Recipients. # noqa: E501
+ :rtype: list[AuthorizedSignatory]
+ """
+ return self._authorized_signatories
+
+ @authorized_signatories.setter
+ def authorized_signatories(self, authorized_signatories):
+ """Sets the authorized_signatories of this Recipients.
+
+ # noqa: E501
+
+ :param authorized_signatories: The authorized_signatories of this Recipients. # noqa: E501
+ :type: list[AuthorizedSignatory]
+ """
+
+ self._authorized_signatories = authorized_signatories
+
@property
def carbon_copies(self):
"""Gets the carbon_copies of this Recipients. # noqa: E501
diff --git a/docusign_esign/models/recommendation_info.py b/docusign_esign/models/recommendation_info.py
new file mode 100644
index 0000000..1ae567c
--- /dev/null
+++ b/docusign_esign/models/recommendation_info.py
@@ -0,0 +1,232 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class RecommendationInfo(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'description': 'str',
+ 'priority': 'str',
+ 'recommendation_id': 'str',
+ 'status': 'str',
+ 'title': 'str'
+ }
+
+ attribute_map = {
+ 'description': 'description',
+ 'priority': 'priority',
+ 'recommendation_id': 'recommendationId',
+ 'status': 'status',
+ 'title': 'title'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """RecommendationInfo - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._description = None
+ self._priority = None
+ self._recommendation_id = None
+ self._status = None
+ self._title = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('description'), kwargs.get('description', None))
+ setattr(self, "_{}".format('priority'), kwargs.get('priority', None))
+ setattr(self, "_{}".format('recommendation_id'), kwargs.get('recommendation_id', None))
+ setattr(self, "_{}".format('status'), kwargs.get('status', None))
+ setattr(self, "_{}".format('title'), kwargs.get('title', None))
+
+ @property
+ def description(self):
+ """Gets the description of this RecommendationInfo. # noqa: E501
+
+ # noqa: E501
+
+ :return: The description of this RecommendationInfo. # noqa: E501
+ :rtype: str
+ """
+ return self._description
+
+ @description.setter
+ def description(self, description):
+ """Sets the description of this RecommendationInfo.
+
+ # noqa: E501
+
+ :param description: The description of this RecommendationInfo. # noqa: E501
+ :type: str
+ """
+
+ self._description = description
+
+ @property
+ def priority(self):
+ """Gets the priority of this RecommendationInfo. # noqa: E501
+
+ # noqa: E501
+
+ :return: The priority of this RecommendationInfo. # noqa: E501
+ :rtype: str
+ """
+ return self._priority
+
+ @priority.setter
+ def priority(self, priority):
+ """Sets the priority of this RecommendationInfo.
+
+ # noqa: E501
+
+ :param priority: The priority of this RecommendationInfo. # noqa: E501
+ :type: str
+ """
+
+ self._priority = priority
+
+ @property
+ def recommendation_id(self):
+ """Gets the recommendation_id of this RecommendationInfo. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recommendation_id of this RecommendationInfo. # noqa: E501
+ :rtype: str
+ """
+ return self._recommendation_id
+
+ @recommendation_id.setter
+ def recommendation_id(self, recommendation_id):
+ """Sets the recommendation_id of this RecommendationInfo.
+
+ # noqa: E501
+
+ :param recommendation_id: The recommendation_id of this RecommendationInfo. # noqa: E501
+ :type: str
+ """
+
+ self._recommendation_id = recommendation_id
+
+ @property
+ def status(self):
+ """Gets the status of this RecommendationInfo. # noqa: E501
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :return: The status of this RecommendationInfo. # noqa: E501
+ :rtype: str
+ """
+ return self._status
+
+ @status.setter
+ def status(self, status):
+ """Sets the status of this RecommendationInfo.
+
+ Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
+
+ :param status: The status of this RecommendationInfo. # noqa: E501
+ :type: str
+ """
+
+ self._status = status
+
+ @property
+ def title(self):
+ """Gets the title of this RecommendationInfo. # noqa: E501
+
+ # noqa: E501
+
+ :return: The title of this RecommendationInfo. # noqa: E501
+ :rtype: str
+ """
+ return self._title
+
+ @title.setter
+ def title(self, title):
+ """Sets the title of this RecommendationInfo.
+
+ # noqa: E501
+
+ :param title: The title of this RecommendationInfo. # noqa: E501
+ :type: str
+ """
+
+ self._title = title
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(RecommendationInfo, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, RecommendationInfo):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, RecommendationInfo):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/recommendations_list_request.py b/docusign_esign/models/recommendations_list_request.py
new file mode 100644
index 0000000..e0dc6c1
--- /dev/null
+++ b/docusign_esign/models/recommendations_list_request.py
@@ -0,0 +1,124 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class RecommendationsListRequest(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'recommendations': 'list[RecommendationInfo]'
+ }
+
+ attribute_map = {
+ 'recommendations': 'recommendations'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """RecommendationsListRequest - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._recommendations = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('recommendations'), kwargs.get('recommendations', None))
+
+ @property
+ def recommendations(self):
+ """Gets the recommendations of this RecommendationsListRequest. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recommendations of this RecommendationsListRequest. # noqa: E501
+ :rtype: list[RecommendationInfo]
+ """
+ return self._recommendations
+
+ @recommendations.setter
+ def recommendations(self, recommendations):
+ """Sets the recommendations of this RecommendationsListRequest.
+
+ # noqa: E501
+
+ :param recommendations: The recommendations of this RecommendationsListRequest. # noqa: E501
+ :type: list[RecommendationInfo]
+ """
+
+ self._recommendations = recommendations
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(RecommendationsListRequest, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, RecommendationsListRequest):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, RecommendationsListRequest):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/recommendations_list_response.py b/docusign_esign/models/recommendations_list_response.py
new file mode 100644
index 0000000..dbb9751
--- /dev/null
+++ b/docusign_esign/models/recommendations_list_response.py
@@ -0,0 +1,124 @@
+# coding: utf-8
+
+"""
+ Docusign eSignature REST API
+
+ The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
+
+ OpenAPI spec version: v2.1
+ Contact: devcenter@docusign.com
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re # noqa: F401
+
+import six
+
+from docusign_esign.client.configuration import Configuration
+
+
+class RecommendationsListResponse(object):
+ """NOTE: This class is auto generated by the swagger code generator program.
+
+ Do not edit the class manually.
+ """
+
+ """
+ Attributes:
+ swagger_types (dict): The key is attribute name
+ and the value is attribute type.
+ attribute_map (dict): The key is attribute name
+ and the value is json key in definition.
+ """
+ swagger_types = {
+ 'recommendations': 'list[RecommendationInfo]'
+ }
+
+ attribute_map = {
+ 'recommendations': 'recommendations'
+ }
+
+ def __init__(self, _configuration=None, **kwargs): # noqa: E501
+ """RecommendationsListResponse - a model defined in Swagger""" # noqa: E501
+ if _configuration is None:
+ _configuration = Configuration()
+ self._configuration = _configuration
+
+ self._recommendations = None
+ self.discriminator = None
+
+ setattr(self, "_{}".format('recommendations'), kwargs.get('recommendations', None))
+
+ @property
+ def recommendations(self):
+ """Gets the recommendations of this RecommendationsListResponse. # noqa: E501
+
+ # noqa: E501
+
+ :return: The recommendations of this RecommendationsListResponse. # noqa: E501
+ :rtype: list[RecommendationInfo]
+ """
+ return self._recommendations
+
+ @recommendations.setter
+ def recommendations(self, recommendations):
+ """Sets the recommendations of this RecommendationsListResponse.
+
+ # noqa: E501
+
+ :param recommendations: The recommendations of this RecommendationsListResponse. # noqa: E501
+ :type: list[RecommendationInfo]
+ """
+
+ self._recommendations = recommendations
+
+ def to_dict(self):
+ """Returns the model properties as a dict"""
+ result = {}
+
+ for attr, _ in six.iteritems(self.swagger_types):
+ value = getattr(self, attr)
+ if isinstance(value, list):
+ result[attr] = list(map(
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+ value
+ ))
+ elif hasattr(value, "to_dict"):
+ result[attr] = value.to_dict()
+ elif isinstance(value, dict):
+ result[attr] = dict(map(
+ lambda item: (item[0], item[1].to_dict())
+ if hasattr(item[1], "to_dict") else item,
+ value.items()
+ ))
+ else:
+ result[attr] = value
+ if issubclass(RecommendationsListResponse, dict):
+ for key, value in self.items():
+ result[key] = value
+
+ return result
+
+ def to_str(self):
+ """Returns the string representation of the model"""
+ return pprint.pformat(self.to_dict())
+
+ def __repr__(self):
+ """For `print` and `pprint`"""
+ return self.to_str()
+
+ def __eq__(self, other):
+ """Returns true if both objects are equal"""
+ if not isinstance(other, RecommendationsListResponse):
+ return False
+
+ return self.to_dict() == other.to_dict()
+
+ def __ne__(self, other):
+ """Returns true if both objects are not equal"""
+ if not isinstance(other, RecommendationsListResponse):
+ return True
+
+ return self.to_dict() != other.to_dict()
diff --git a/docusign_esign/models/template_recipients.py b/docusign_esign/models/template_recipients.py
index 54ae8d7..700165f 100644
--- a/docusign_esign/models/template_recipients.py
+++ b/docusign_esign/models/template_recipients.py
@@ -34,6 +34,7 @@ class TemplateRecipients(object):
"""
swagger_types = {
'agents': 'list[Agent]',
+ 'authorized_signatories': 'list[AuthorizedSignatory]',
'carbon_copies': 'list[CarbonCopy]',
'certified_deliveries': 'list[CertifiedDelivery]',
'current_routing_order': 'str',
@@ -52,6 +53,7 @@ class TemplateRecipients(object):
attribute_map = {
'agents': 'agents',
+ 'authorized_signatories': 'authorizedSignatories',
'carbon_copies': 'carbonCopies',
'certified_deliveries': 'certifiedDeliveries',
'current_routing_order': 'currentRoutingOrder',
@@ -75,6 +77,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._configuration = _configuration
self._agents = None
+ self._authorized_signatories = None
self._carbon_copies = None
self._certified_deliveries = None
self._current_routing_order = None
@@ -92,6 +95,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self.discriminator = None
setattr(self, "_{}".format('agents'), kwargs.get('agents', None))
+ setattr(self, "_{}".format('authorized_signatories'), kwargs.get('authorized_signatories', None))
setattr(self, "_{}".format('carbon_copies'), kwargs.get('carbon_copies', None))
setattr(self, "_{}".format('certified_deliveries'), kwargs.get('certified_deliveries', None))
setattr(self, "_{}".format('current_routing_order'), kwargs.get('current_routing_order', None))
@@ -130,6 +134,29 @@ def agents(self, agents):
self._agents = agents
+ @property
+ def authorized_signatories(self):
+ """Gets the authorized_signatories of this TemplateRecipients. # noqa: E501
+
+ # noqa: E501
+
+ :return: The authorized_signatories of this TemplateRecipients. # noqa: E501
+ :rtype: list[AuthorizedSignatory]
+ """
+ return self._authorized_signatories
+
+ @authorized_signatories.setter
+ def authorized_signatories(self, authorized_signatories):
+ """Sets the authorized_signatories of this TemplateRecipients.
+
+ # noqa: E501
+
+ :param authorized_signatories: The authorized_signatories of this TemplateRecipients. # noqa: E501
+ :type: list[AuthorizedSignatory]
+ """
+
+ self._authorized_signatories = authorized_signatories
+
@property
def carbon_copies(self):
"""Gets the carbon_copies of this TemplateRecipients. # noqa: E501
diff --git a/docusign_esign/models/template_role.py b/docusign_esign/models/template_role.py
index 0c68339..17085b2 100644
--- a/docusign_esign/models/template_role.py
+++ b/docusign_esign/models/template_role.py
@@ -48,6 +48,9 @@ class TemplateRole(object):
'role_name': 'str',
'routing_order': 'str',
'signing_group_id': 'str',
+ 'signing_group_name': 'str',
+ 'signing_group_type': 'str',
+ 'signing_group_users': 'list[UserInfo]',
'tabs': 'Tabs'
}
@@ -67,6 +70,9 @@ class TemplateRole(object):
'role_name': 'roleName',
'routing_order': 'routingOrder',
'signing_group_id': 'signingGroupId',
+ 'signing_group_name': 'signingGroupName',
+ 'signing_group_type': 'signingGroupType',
+ 'signing_group_users': 'signingGroupUsers',
'tabs': 'tabs'
}
@@ -91,6 +97,9 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._role_name = None
self._routing_order = None
self._signing_group_id = None
+ self._signing_group_name = None
+ self._signing_group_type = None
+ self._signing_group_users = None
self._tabs = None
self.discriminator = None
@@ -109,6 +118,9 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None))
setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None))
setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None))
+ setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None))
+ setattr(self, "_{}".format('signing_group_type'), kwargs.get('signing_group_type', None))
+ setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None))
setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None))
@property
@@ -456,6 +468,75 @@ def signing_group_id(self, signing_group_id):
self._signing_group_id = signing_group_id
+ @property
+ def signing_group_name(self):
+ """Gets the signing_group_name of this TemplateRole. # noqa: E501
+
+ The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
+
+ :return: The signing_group_name of this TemplateRole. # noqa: E501
+ :rtype: str
+ """
+ return self._signing_group_name
+
+ @signing_group_name.setter
+ def signing_group_name(self, signing_group_name):
+ """Sets the signing_group_name of this TemplateRole.
+
+ The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
+
+ :param signing_group_name: The signing_group_name of this TemplateRole. # noqa: E501
+ :type: str
+ """
+
+ self._signing_group_name = signing_group_name
+
+ @property
+ def signing_group_type(self):
+ """Gets the signing_group_type of this TemplateRole. # noqa: E501
+
+ # noqa: E501
+
+ :return: The signing_group_type of this TemplateRole. # noqa: E501
+ :rtype: str
+ """
+ return self._signing_group_type
+
+ @signing_group_type.setter
+ def signing_group_type(self, signing_group_type):
+ """Sets the signing_group_type of this TemplateRole.
+
+ # noqa: E501
+
+ :param signing_group_type: The signing_group_type of this TemplateRole. # noqa: E501
+ :type: str
+ """
+
+ self._signing_group_type = signing_group_type
+
+ @property
+ def signing_group_users(self):
+ """Gets the signing_group_users of this TemplateRole. # noqa: E501
+
+ A complex type that contains information about users in the signing group. # noqa: E501
+
+ :return: The signing_group_users of this TemplateRole. # noqa: E501
+ :rtype: list[UserInfo]
+ """
+ return self._signing_group_users
+
+ @signing_group_users.setter
+ def signing_group_users(self, signing_group_users):
+ """Sets the signing_group_users of this TemplateRole.
+
+ A complex type that contains information about users in the signing group. # noqa: E501
+
+ :param signing_group_users: The signing_group_users of this TemplateRole. # noqa: E501
+ :type: list[UserInfo]
+ """
+
+ self._signing_group_users = signing_group_users
+
@property
def tabs(self):
"""Gets the tabs of this TemplateRole. # noqa: E501
diff --git a/docusign_esign/models/user_account_management_granular_information.py b/docusign_esign/models/user_account_management_granular_information.py
index 965a935..028da8c 100644
--- a/docusign_esign/models/user_account_management_granular_information.py
+++ b/docusign_esign/models/user_account_management_granular_information.py
@@ -59,6 +59,8 @@ class UserAccountManagementGranularInformation(object):
'can_manage_stamps_metadata': 'SettingsMetadata',
'can_manage_users': 'str',
'can_manage_users_metadata': 'SettingsMetadata',
+ 'can_view_only_account_admin_pages': 'str',
+ 'can_view_only_account_admin_pages_metadata': 'SettingsMetadata',
'can_view_users': 'str'
}
@@ -89,6 +91,8 @@ class UserAccountManagementGranularInformation(object):
'can_manage_stamps_metadata': 'canManageStampsMetadata',
'can_manage_users': 'canManageUsers',
'can_manage_users_metadata': 'canManageUsersMetadata',
+ 'can_view_only_account_admin_pages': 'canViewOnlyAccountAdminPages',
+ 'can_view_only_account_admin_pages_metadata': 'canViewOnlyAccountAdminPagesMetadata',
'can_view_users': 'canViewUsers'
}
@@ -124,6 +128,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._can_manage_stamps_metadata = None
self._can_manage_users = None
self._can_manage_users_metadata = None
+ self._can_view_only_account_admin_pages = None
+ self._can_view_only_account_admin_pages_metadata = None
self._can_view_users = None
self.discriminator = None
@@ -153,6 +159,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('can_manage_stamps_metadata'), kwargs.get('can_manage_stamps_metadata', None))
setattr(self, "_{}".format('can_manage_users'), kwargs.get('can_manage_users', None))
setattr(self, "_{}".format('can_manage_users_metadata'), kwargs.get('can_manage_users_metadata', None))
+ setattr(self, "_{}".format('can_view_only_account_admin_pages'), kwargs.get('can_view_only_account_admin_pages', None))
+ setattr(self, "_{}".format('can_view_only_account_admin_pages_metadata'), kwargs.get('can_view_only_account_admin_pages_metadata', None))
setattr(self, "_{}".format('can_view_users'), kwargs.get('can_view_users', None))
@property
@@ -753,6 +761,52 @@ def can_manage_users_metadata(self, can_manage_users_metadata):
self._can_manage_users_metadata = can_manage_users_metadata
+ @property
+ def can_view_only_account_admin_pages(self):
+ """Gets the can_view_only_account_admin_pages of this UserAccountManagementGranularInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The can_view_only_account_admin_pages of this UserAccountManagementGranularInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._can_view_only_account_admin_pages
+
+ @can_view_only_account_admin_pages.setter
+ def can_view_only_account_admin_pages(self, can_view_only_account_admin_pages):
+ """Sets the can_view_only_account_admin_pages of this UserAccountManagementGranularInformation.
+
+ # noqa: E501
+
+ :param can_view_only_account_admin_pages: The can_view_only_account_admin_pages of this UserAccountManagementGranularInformation. # noqa: E501
+ :type: str
+ """
+
+ self._can_view_only_account_admin_pages = can_view_only_account_admin_pages
+
+ @property
+ def can_view_only_account_admin_pages_metadata(self):
+ """Gets the can_view_only_account_admin_pages_metadata of this UserAccountManagementGranularInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The can_view_only_account_admin_pages_metadata of this UserAccountManagementGranularInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._can_view_only_account_admin_pages_metadata
+
+ @can_view_only_account_admin_pages_metadata.setter
+ def can_view_only_account_admin_pages_metadata(self, can_view_only_account_admin_pages_metadata):
+ """Sets the can_view_only_account_admin_pages_metadata of this UserAccountManagementGranularInformation.
+
+ # noqa: E501
+
+ :param can_view_only_account_admin_pages_metadata: The can_view_only_account_admin_pages_metadata of this UserAccountManagementGranularInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._can_view_only_account_admin_pages_metadata = can_view_only_account_admin_pages_metadata
+
@property
def can_view_users(self):
"""Gets the can_view_users of this UserAccountManagementGranularInformation. # noqa: E501
diff --git a/docusign_esign/models/user_authorization.py b/docusign_esign/models/user_authorization.py
index ea83979..62c90b0 100644
--- a/docusign_esign/models/user_authorization.py
+++ b/docusign_esign/models/user_authorization.py
@@ -42,7 +42,9 @@ class UserAuthorization(object):
'modified_by': 'str',
'permission': 'str',
'principal_user': 'AuthorizationUser',
- 'start_date': 'str'
+ 'start_date': 'str',
+ 'task_source': 'str',
+ 'task_type': 'str'
}
attribute_map = {
@@ -55,7 +57,9 @@ class UserAuthorization(object):
'modified_by': 'modifiedBy',
'permission': 'permission',
'principal_user': 'principalUser',
- 'start_date': 'startDate'
+ 'start_date': 'startDate',
+ 'task_source': 'taskSource',
+ 'task_type': 'taskType'
}
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -74,6 +78,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._permission = None
self._principal_user = None
self._start_date = None
+ self._task_source = None
+ self._task_type = None
self.discriminator = None
setattr(self, "_{}".format('agent_user'), kwargs.get('agent_user', None))
@@ -86,6 +92,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('permission'), kwargs.get('permission', None))
setattr(self, "_{}".format('principal_user'), kwargs.get('principal_user', None))
setattr(self, "_{}".format('start_date'), kwargs.get('start_date', None))
+ setattr(self, "_{}".format('task_source'), kwargs.get('task_source', None))
+ setattr(self, "_{}".format('task_type'), kwargs.get('task_type', None))
@property
def agent_user(self):
@@ -317,6 +325,52 @@ def start_date(self, start_date):
self._start_date = start_date
+ @property
+ def task_source(self):
+ """Gets the task_source of this UserAuthorization. # noqa: E501
+
+ # noqa: E501
+
+ :return: The task_source of this UserAuthorization. # noqa: E501
+ :rtype: str
+ """
+ return self._task_source
+
+ @task_source.setter
+ def task_source(self, task_source):
+ """Sets the task_source of this UserAuthorization.
+
+ # noqa: E501
+
+ :param task_source: The task_source of this UserAuthorization. # noqa: E501
+ :type: str
+ """
+
+ self._task_source = task_source
+
+ @property
+ def task_type(self):
+ """Gets the task_type of this UserAuthorization. # noqa: E501
+
+ # noqa: E501
+
+ :return: The task_type of this UserAuthorization. # noqa: E501
+ :rtype: str
+ """
+ return self._task_type
+
+ @task_type.setter
+ def task_type(self, task_type):
+ """Sets the task_type of this UserAuthorization.
+
+ # noqa: E501
+
+ :param task_type: The task_type of this UserAuthorization. # noqa: E501
+ :type: str
+ """
+
+ self._task_type = task_type
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/docusign_esign/models/user_authorization_create_request.py b/docusign_esign/models/user_authorization_create_request.py
index 4c3e54a..a0a7e17 100644
--- a/docusign_esign/models/user_authorization_create_request.py
+++ b/docusign_esign/models/user_authorization_create_request.py
@@ -36,14 +36,18 @@ class UserAuthorizationCreateRequest(object):
'agent_user': 'AuthorizationUser',
'end_date': 'str',
'permission': 'str',
- 'start_date': 'str'
+ 'start_date': 'str',
+ 'task_source': 'str',
+ 'task_type': 'str'
}
attribute_map = {
'agent_user': 'agentUser',
'end_date': 'endDate',
'permission': 'permission',
- 'start_date': 'startDate'
+ 'start_date': 'startDate',
+ 'task_source': 'taskSource',
+ 'task_type': 'taskType'
}
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -56,12 +60,16 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._end_date = None
self._permission = None
self._start_date = None
+ self._task_source = None
+ self._task_type = None
self.discriminator = None
setattr(self, "_{}".format('agent_user'), kwargs.get('agent_user', None))
setattr(self, "_{}".format('end_date'), kwargs.get('end_date', None))
setattr(self, "_{}".format('permission'), kwargs.get('permission', None))
setattr(self, "_{}".format('start_date'), kwargs.get('start_date', None))
+ setattr(self, "_{}".format('task_source'), kwargs.get('task_source', None))
+ setattr(self, "_{}".format('task_type'), kwargs.get('task_type', None))
@property
def agent_user(self):
@@ -155,6 +163,52 @@ def start_date(self, start_date):
self._start_date = start_date
+ @property
+ def task_source(self):
+ """Gets the task_source of this UserAuthorizationCreateRequest. # noqa: E501
+
+ # noqa: E501
+
+ :return: The task_source of this UserAuthorizationCreateRequest. # noqa: E501
+ :rtype: str
+ """
+ return self._task_source
+
+ @task_source.setter
+ def task_source(self, task_source):
+ """Sets the task_source of this UserAuthorizationCreateRequest.
+
+ # noqa: E501
+
+ :param task_source: The task_source of this UserAuthorizationCreateRequest. # noqa: E501
+ :type: str
+ """
+
+ self._task_source = task_source
+
+ @property
+ def task_type(self):
+ """Gets the task_type of this UserAuthorizationCreateRequest. # noqa: E501
+
+ # noqa: E501
+
+ :return: The task_type of this UserAuthorizationCreateRequest. # noqa: E501
+ :rtype: str
+ """
+ return self._task_type
+
+ @task_type.setter
+ def task_type(self, task_type):
+ """Sets the task_type of this UserAuthorizationCreateRequest.
+
+ # noqa: E501
+
+ :param task_type: The task_type of this UserAuthorizationCreateRequest. # noqa: E501
+ :type: str
+ """
+
+ self._task_type = task_type
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/docusign_esign/models/user_authorization_create_request_with_id.py b/docusign_esign/models/user_authorization_create_request_with_id.py
index b5ff516..eda9d43 100644
--- a/docusign_esign/models/user_authorization_create_request_with_id.py
+++ b/docusign_esign/models/user_authorization_create_request_with_id.py
@@ -37,7 +37,9 @@ class UserAuthorizationCreateRequestWithId(object):
'authorization_id': 'str',
'end_date': 'str',
'permission': 'str',
- 'start_date': 'str'
+ 'start_date': 'str',
+ 'task_source': 'str',
+ 'task_type': 'str'
}
attribute_map = {
@@ -45,7 +47,9 @@ class UserAuthorizationCreateRequestWithId(object):
'authorization_id': 'authorizationId',
'end_date': 'endDate',
'permission': 'permission',
- 'start_date': 'startDate'
+ 'start_date': 'startDate',
+ 'task_source': 'taskSource',
+ 'task_type': 'taskType'
}
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -59,6 +63,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._end_date = None
self._permission = None
self._start_date = None
+ self._task_source = None
+ self._task_type = None
self.discriminator = None
setattr(self, "_{}".format('agent_user'), kwargs.get('agent_user', None))
@@ -66,6 +72,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('end_date'), kwargs.get('end_date', None))
setattr(self, "_{}".format('permission'), kwargs.get('permission', None))
setattr(self, "_{}".format('start_date'), kwargs.get('start_date', None))
+ setattr(self, "_{}".format('task_source'), kwargs.get('task_source', None))
+ setattr(self, "_{}".format('task_type'), kwargs.get('task_type', None))
@property
def agent_user(self):
@@ -182,6 +190,52 @@ def start_date(self, start_date):
self._start_date = start_date
+ @property
+ def task_source(self):
+ """Gets the task_source of this UserAuthorizationCreateRequestWithId. # noqa: E501
+
+ # noqa: E501
+
+ :return: The task_source of this UserAuthorizationCreateRequestWithId. # noqa: E501
+ :rtype: str
+ """
+ return self._task_source
+
+ @task_source.setter
+ def task_source(self, task_source):
+ """Sets the task_source of this UserAuthorizationCreateRequestWithId.
+
+ # noqa: E501
+
+ :param task_source: The task_source of this UserAuthorizationCreateRequestWithId. # noqa: E501
+ :type: str
+ """
+
+ self._task_source = task_source
+
+ @property
+ def task_type(self):
+ """Gets the task_type of this UserAuthorizationCreateRequestWithId. # noqa: E501
+
+ # noqa: E501
+
+ :return: The task_type of this UserAuthorizationCreateRequestWithId. # noqa: E501
+ :rtype: str
+ """
+ return self._task_type
+
+ @task_type.setter
+ def task_type(self, task_type):
+ """Sets the task_type of this UserAuthorizationCreateRequestWithId.
+
+ # noqa: E501
+
+ :param task_type: The task_type of this UserAuthorizationCreateRequestWithId. # noqa: E501
+ :type: str
+ """
+
+ self._task_type = task_type
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/docusign_esign/models/user_authorizations_delete_request.py b/docusign_esign/models/user_authorizations_delete_request.py
index 5c514a1..8212daf 100644
--- a/docusign_esign/models/user_authorizations_delete_request.py
+++ b/docusign_esign/models/user_authorizations_delete_request.py
@@ -33,11 +33,13 @@ class UserAuthorizationsDeleteRequest(object):
and the value is json key in definition.
"""
swagger_types = {
- 'authorizations': 'list[str]'
+ 'authorizations': 'list[str]',
+ 'send_notification': 'str'
}
attribute_map = {
- 'authorizations': 'authorizations'
+ 'authorizations': 'authorizations',
+ 'send_notification': 'sendNotification'
}
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -47,9 +49,11 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._configuration = _configuration
self._authorizations = None
+ self._send_notification = None
self.discriminator = None
setattr(self, "_{}".format('authorizations'), kwargs.get('authorizations', None))
+ setattr(self, "_{}".format('send_notification'), kwargs.get('send_notification', None))
@property
def authorizations(self):
@@ -74,6 +78,29 @@ def authorizations(self, authorizations):
self._authorizations = authorizations
+ @property
+ def send_notification(self):
+ """Gets the send_notification of this UserAuthorizationsDeleteRequest. # noqa: E501
+
+ # noqa: E501
+
+ :return: The send_notification of this UserAuthorizationsDeleteRequest. # noqa: E501
+ :rtype: str
+ """
+ return self._send_notification
+
+ @send_notification.setter
+ def send_notification(self, send_notification):
+ """Sets the send_notification of this UserAuthorizationsDeleteRequest.
+
+ # noqa: E501
+
+ :param send_notification: The send_notification of this UserAuthorizationsDeleteRequest. # noqa: E501
+ :type: str
+ """
+
+ self._send_notification = send_notification
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/docusign_esign/models/user_authorizations_request.py b/docusign_esign/models/user_authorizations_request.py
index 738137e..62e7e54 100644
--- a/docusign_esign/models/user_authorizations_request.py
+++ b/docusign_esign/models/user_authorizations_request.py
@@ -33,11 +33,13 @@ class UserAuthorizationsRequest(object):
and the value is json key in definition.
"""
swagger_types = {
- 'authorizations': 'list[UserAuthorizationCreateRequestWithId]'
+ 'authorizations': 'list[UserAuthorizationCreateRequestWithId]',
+ 'send_notification': 'str'
}
attribute_map = {
- 'authorizations': 'authorizations'
+ 'authorizations': 'authorizations',
+ 'send_notification': 'sendNotification'
}
def __init__(self, _configuration=None, **kwargs): # noqa: E501
@@ -47,9 +49,11 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._configuration = _configuration
self._authorizations = None
+ self._send_notification = None
self.discriminator = None
setattr(self, "_{}".format('authorizations'), kwargs.get('authorizations', None))
+ setattr(self, "_{}".format('send_notification'), kwargs.get('send_notification', None))
@property
def authorizations(self):
@@ -74,6 +78,29 @@ def authorizations(self, authorizations):
self._authorizations = authorizations
+ @property
+ def send_notification(self):
+ """Gets the send_notification of this UserAuthorizationsRequest. # noqa: E501
+
+ # noqa: E501
+
+ :return: The send_notification of this UserAuthorizationsRequest. # noqa: E501
+ :rtype: str
+ """
+ return self._send_notification
+
+ @send_notification.setter
+ def send_notification(self, send_notification):
+ """Sets the send_notification of this UserAuthorizationsRequest.
+
+ # noqa: E501
+
+ :param send_notification: The send_notification of this UserAuthorizationsRequest. # noqa: E501
+ :type: str
+ """
+
+ self._send_notification = send_notification
+
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
diff --git a/docusign_esign/models/user_information.py b/docusign_esign/models/user_information.py
index 69a5f76..6e0cb24 100644
--- a/docusign_esign/models/user_information.py
+++ b/docusign_esign/models/user_information.py
@@ -59,6 +59,7 @@ class UserInformation(object):
'last_name': 'str',
'license_status': 'str',
'license_type': 'str',
+ 'license_types': 'list[str]',
'login_status': 'str',
'middle_name': 'str',
'password': 'str',
@@ -110,6 +111,7 @@ class UserInformation(object):
'last_name': 'lastName',
'license_status': 'licenseStatus',
'license_type': 'licenseType',
+ 'license_types': 'licenseTypes',
'login_status': 'loginStatus',
'middle_name': 'middleName',
'password': 'password',
@@ -166,6 +168,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._last_name = None
self._license_status = None
self._license_type = None
+ self._license_types = None
self._login_status = None
self._middle_name = None
self._password = None
@@ -216,6 +219,7 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None))
setattr(self, "_{}".format('license_status'), kwargs.get('license_status', None))
setattr(self, "_{}".format('license_type'), kwargs.get('license_type', None))
+ setattr(self, "_{}".format('license_types'), kwargs.get('license_types', None))
setattr(self, "_{}".format('login_status'), kwargs.get('login_status', None))
setattr(self, "_{}".format('middle_name'), kwargs.get('middle_name', None))
setattr(self, "_{}".format('password'), kwargs.get('password', None))
@@ -837,6 +841,29 @@ def license_type(self, license_type):
self._license_type = license_type
+ @property
+ def license_types(self):
+ """Gets the license_types of this UserInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The license_types of this UserInformation. # noqa: E501
+ :rtype: list[str]
+ """
+ return self._license_types
+
+ @license_types.setter
+ def license_types(self, license_types):
+ """Sets the license_types of this UserInformation.
+
+ # noqa: E501
+
+ :param license_types: The license_types of this UserInformation. # noqa: E501
+ :type: list[str]
+ """
+
+ self._license_types = license_types
+
@property
def login_status(self):
"""Gets the login_status of this UserInformation. # noqa: E501
diff --git a/docusign_esign/models/user_settings_information.py b/docusign_esign/models/user_settings_information.py
index d8f68b6..5112049 100644
--- a/docusign_esign/models/user_settings_information.py
+++ b/docusign_esign/models/user_settings_information.py
@@ -125,6 +125,10 @@ class UserSettingsInformation(object):
'is_managed_by_scim_metadata': 'SettingsMetadata',
'is_membership_managed_by_scim': 'str',
'is_membership_managed_by_scim_metadata': 'SettingsMetadata',
+ 'is_membership_redacted': 'str',
+ 'is_membership_redacted_metadata': 'SettingsMetadata',
+ 'is_user_redacted': 'str',
+ 'is_user_redacted_metadata': 'SettingsMetadata',
'locale': 'str',
'locale_metadata': 'SettingsMetadata',
'locale_policy': 'LocalePolicy',
@@ -142,6 +146,8 @@ class UserSettingsInformation(object):
'power_form_mode_metadata': 'SettingsMetadata',
'recipient_viewed_notification': 'str',
'recipient_viewed_notification_metadata': 'SettingsMetadata',
+ 'redact_at_metadata': 'SettingsMetadata',
+ 'redact_membership_at': 'str',
'seal_identifiers': 'list[SealIdentifier]',
'self_signed_recipient_email_document': 'str',
'self_signed_recipient_email_document_metadata': 'SettingsMetadata',
@@ -277,6 +283,10 @@ class UserSettingsInformation(object):
'is_managed_by_scim_metadata': 'isManagedByScimMetadata',
'is_membership_managed_by_scim': 'isMembershipManagedByScim',
'is_membership_managed_by_scim_metadata': 'isMembershipManagedByScimMetadata',
+ 'is_membership_redacted': 'isMembershipRedacted',
+ 'is_membership_redacted_metadata': 'isMembershipRedactedMetadata',
+ 'is_user_redacted': 'isUserRedacted',
+ 'is_user_redacted_metadata': 'isUserRedactedMetadata',
'locale': 'locale',
'locale_metadata': 'localeMetadata',
'locale_policy': 'localePolicy',
@@ -294,6 +304,8 @@ class UserSettingsInformation(object):
'power_form_mode_metadata': 'powerFormModeMetadata',
'recipient_viewed_notification': 'recipientViewedNotification',
'recipient_viewed_notification_metadata': 'recipientViewedNotificationMetadata',
+ 'redact_at_metadata': 'redactAtMetadata',
+ 'redact_membership_at': 'redactMembershipAt',
'seal_identifiers': 'sealIdentifiers',
'self_signed_recipient_email_document': 'selfSignedRecipientEmailDocument',
'self_signed_recipient_email_document_metadata': 'selfSignedRecipientEmailDocumentMetadata',
@@ -434,6 +446,10 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._is_managed_by_scim_metadata = None
self._is_membership_managed_by_scim = None
self._is_membership_managed_by_scim_metadata = None
+ self._is_membership_redacted = None
+ self._is_membership_redacted_metadata = None
+ self._is_user_redacted = None
+ self._is_user_redacted_metadata = None
self._locale = None
self._locale_metadata = None
self._locale_policy = None
@@ -451,6 +467,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
self._power_form_mode_metadata = None
self._recipient_viewed_notification = None
self._recipient_viewed_notification_metadata = None
+ self._redact_at_metadata = None
+ self._redact_membership_at = None
self._seal_identifiers = None
self._self_signed_recipient_email_document = None
self._self_signed_recipient_email_document_metadata = None
@@ -585,6 +603,10 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('is_managed_by_scim_metadata'), kwargs.get('is_managed_by_scim_metadata', None))
setattr(self, "_{}".format('is_membership_managed_by_scim'), kwargs.get('is_membership_managed_by_scim', None))
setattr(self, "_{}".format('is_membership_managed_by_scim_metadata'), kwargs.get('is_membership_managed_by_scim_metadata', None))
+ setattr(self, "_{}".format('is_membership_redacted'), kwargs.get('is_membership_redacted', None))
+ setattr(self, "_{}".format('is_membership_redacted_metadata'), kwargs.get('is_membership_redacted_metadata', None))
+ setattr(self, "_{}".format('is_user_redacted'), kwargs.get('is_user_redacted', None))
+ setattr(self, "_{}".format('is_user_redacted_metadata'), kwargs.get('is_user_redacted_metadata', None))
setattr(self, "_{}".format('locale'), kwargs.get('locale', None))
setattr(self, "_{}".format('locale_metadata'), kwargs.get('locale_metadata', None))
setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None))
@@ -602,6 +624,8 @@ def __init__(self, _configuration=None, **kwargs): # noqa: E501
setattr(self, "_{}".format('power_form_mode_metadata'), kwargs.get('power_form_mode_metadata', None))
setattr(self, "_{}".format('recipient_viewed_notification'), kwargs.get('recipient_viewed_notification', None))
setattr(self, "_{}".format('recipient_viewed_notification_metadata'), kwargs.get('recipient_viewed_notification_metadata', None))
+ setattr(self, "_{}".format('redact_at_metadata'), kwargs.get('redact_at_metadata', None))
+ setattr(self, "_{}".format('redact_membership_at'), kwargs.get('redact_membership_at', None))
setattr(self, "_{}".format('seal_identifiers'), kwargs.get('seal_identifiers', None))
setattr(self, "_{}".format('self_signed_recipient_email_document'), kwargs.get('self_signed_recipient_email_document', None))
setattr(self, "_{}".format('self_signed_recipient_email_document_metadata'), kwargs.get('self_signed_recipient_email_document_metadata', None))
@@ -2759,6 +2783,98 @@ def is_membership_managed_by_scim_metadata(self, is_membership_managed_by_scim_m
self._is_membership_managed_by_scim_metadata = is_membership_managed_by_scim_metadata
+ @property
+ def is_membership_redacted(self):
+ """Gets the is_membership_redacted of this UserSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_membership_redacted of this UserSettingsInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._is_membership_redacted
+
+ @is_membership_redacted.setter
+ def is_membership_redacted(self, is_membership_redacted):
+ """Sets the is_membership_redacted of this UserSettingsInformation.
+
+ # noqa: E501
+
+ :param is_membership_redacted: The is_membership_redacted of this UserSettingsInformation. # noqa: E501
+ :type: str
+ """
+
+ self._is_membership_redacted = is_membership_redacted
+
+ @property
+ def is_membership_redacted_metadata(self):
+ """Gets the is_membership_redacted_metadata of this UserSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_membership_redacted_metadata of this UserSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._is_membership_redacted_metadata
+
+ @is_membership_redacted_metadata.setter
+ def is_membership_redacted_metadata(self, is_membership_redacted_metadata):
+ """Sets the is_membership_redacted_metadata of this UserSettingsInformation.
+
+ # noqa: E501
+
+ :param is_membership_redacted_metadata: The is_membership_redacted_metadata of this UserSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._is_membership_redacted_metadata = is_membership_redacted_metadata
+
+ @property
+ def is_user_redacted(self):
+ """Gets the is_user_redacted of this UserSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_user_redacted of this UserSettingsInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._is_user_redacted
+
+ @is_user_redacted.setter
+ def is_user_redacted(self, is_user_redacted):
+ """Sets the is_user_redacted of this UserSettingsInformation.
+
+ # noqa: E501
+
+ :param is_user_redacted: The is_user_redacted of this UserSettingsInformation. # noqa: E501
+ :type: str
+ """
+
+ self._is_user_redacted = is_user_redacted
+
+ @property
+ def is_user_redacted_metadata(self):
+ """Gets the is_user_redacted_metadata of this UserSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The is_user_redacted_metadata of this UserSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._is_user_redacted_metadata
+
+ @is_user_redacted_metadata.setter
+ def is_user_redacted_metadata(self, is_user_redacted_metadata):
+ """Sets the is_user_redacted_metadata of this UserSettingsInformation.
+
+ # noqa: E501
+
+ :param is_user_redacted_metadata: The is_user_redacted_metadata of this UserSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._is_user_redacted_metadata = is_user_redacted_metadata
+
@property
def locale(self):
"""Gets the locale of this UserSettingsInformation. # noqa: E501
@@ -3150,6 +3266,52 @@ def recipient_viewed_notification_metadata(self, recipient_viewed_notification_m
self._recipient_viewed_notification_metadata = recipient_viewed_notification_metadata
+ @property
+ def redact_at_metadata(self):
+ """Gets the redact_at_metadata of this UserSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The redact_at_metadata of this UserSettingsInformation. # noqa: E501
+ :rtype: SettingsMetadata
+ """
+ return self._redact_at_metadata
+
+ @redact_at_metadata.setter
+ def redact_at_metadata(self, redact_at_metadata):
+ """Sets the redact_at_metadata of this UserSettingsInformation.
+
+ # noqa: E501
+
+ :param redact_at_metadata: The redact_at_metadata of this UserSettingsInformation. # noqa: E501
+ :type: SettingsMetadata
+ """
+
+ self._redact_at_metadata = redact_at_metadata
+
+ @property
+ def redact_membership_at(self):
+ """Gets the redact_membership_at of this UserSettingsInformation. # noqa: E501
+
+ # noqa: E501
+
+ :return: The redact_membership_at of this UserSettingsInformation. # noqa: E501
+ :rtype: str
+ """
+ return self._redact_membership_at
+
+ @redact_membership_at.setter
+ def redact_membership_at(self, redact_membership_at):
+ """Sets the redact_membership_at of this UserSettingsInformation.
+
+ # noqa: E501
+
+ :param redact_membership_at: The redact_membership_at of this UserSettingsInformation. # noqa: E501
+ :type: str
+ """
+
+ self._redact_membership_at = redact_membership_at
+
@property
def seal_identifiers(self):
"""Gets the seal_identifiers of this UserSettingsInformation. # noqa: E501
diff --git a/setup.py b/setup.py
index eb8f6f2..6a35be8 100644
--- a/setup.py
+++ b/setup.py
@@ -14,7 +14,7 @@
from setuptools import setup, find_packages, Command, os # noqa: H301
NAME = "docusign-esign"
-VERSION = "8.0.0rc1"
+VERSION = "8.0.0"
# To install the library, run the following
#
# python setup.py install