docusign_esign.models.witness
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
1# coding: utf-8 2 3""" 4 Docusign eSignature REST API 5 6 The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class Witness(object): 23 """NOTE: This class is auto generated by the swagger code generator program. 24 25 Do not edit the class manually. 26 """ 27 28 """ 29 Attributes: 30 swagger_types (dict): The key is attribute name 31 and the value is attribute type. 32 attribute_map (dict): The key is attribute name 33 and the value is json key in definition. 34 """ 35 swagger_types = { 36 'access_code': 'str', 37 'access_code_metadata': 'PropertyMetadata', 38 'add_access_code_to_email': 'str', 39 'additional_notifications': 'list[RecipientAdditionalNotification]', 40 'agent_can_edit_email': 'str', 41 'agent_can_edit_name': 'str', 42 'allow_system_override_for_locked_recipient': 'str', 43 'auto_navigation': 'str', 44 'auto_responded_reason': 'str', 45 'bulk_recipients_uri': 'str', 46 'bulk_send_v2_recipient': 'str', 47 'can_sign_offline': 'str', 48 'client_user_id': 'str', 49 'completed_count': 'str', 50 'consent_details_list': 'list[ConsentDetails]', 51 'creation_reason': 'str', 52 'custom_fields': 'list[str]', 53 'declined_date_time': 'str', 54 'declined_reason': 'str', 55 'default_recipient': 'str', 56 'delegated_by': 'DelegationInfo', 57 'delegated_to': 'list[DelegationInfo]', 58 'delivered_date_time': 'str', 59 'delivery_method': 'str', 60 'delivery_method_metadata': 'PropertyMetadata', 61 'designator_id': 'str', 62 'designator_id_guid': 'str', 63 'document_template_id': 'str', 64 'document_visibility': 'list[DocumentVisibility]', 65 'email': 'str', 66 'email_metadata': 'PropertyMetadata', 67 'email_notification': 'RecipientEmailNotification', 68 'email_recipient_post_signing_url': 'str', 69 'embedded_recipient_start_url': 'str', 70 'error_details': 'ErrorDetails', 71 'excluded_documents': 'list[str]', 72 'fax_number': 'str', 73 'fax_number_metadata': 'PropertyMetadata', 74 'first_name': 'str', 75 'first_name_metadata': 'PropertyMetadata', 76 'full_name': 'str', 77 'full_name_metadata': 'PropertyMetadata', 78 'id_check_configuration_name': 'str', 79 'id_check_configuration_name_metadata': 'PropertyMetadata', 80 'id_check_information_input': 'IdCheckInformationInput', 81 'identity_verification': 'RecipientIdentityVerification', 82 'inherit_email_notification_configuration': 'str', 83 'is_bulk_recipient': 'str', 84 'is_bulk_recipient_metadata': 'PropertyMetadata', 85 'last_name': 'str', 86 'last_name_metadata': 'PropertyMetadata', 87 'locked_recipient_phone_auth_editable': 'str', 88 'locked_recipient_sms_editable': 'str', 89 'name': 'str', 90 'name_metadata': 'PropertyMetadata', 91 'notary_id': 'str', 92 'notary_signer_email_sent': 'str', 93 'note': 'str', 94 'note_metadata': 'PropertyMetadata', 95 'offline_attributes': 'OfflineAttributes', 96 'phone_authentication': 'RecipientPhoneAuthentication', 97 'phone_number': 'RecipientPhoneNumber', 98 'proof_file': 'RecipientProofFile', 99 'recipient_attachments': 'list[RecipientAttachment]', 100 'recipient_authentication_status': 'AuthenticationStatus', 101 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 102 'recipient_id': 'str', 103 'recipient_id_guid': 'str', 104 'recipient_signature_providers': 'list[RecipientSignatureProvider]', 105 'recipient_supplies_tabs': 'str', 106 'recipient_type': 'str', 107 'recipient_type_metadata': 'PropertyMetadata', 108 'require_id_lookup': 'str', 109 'require_id_lookup_metadata': 'PropertyMetadata', 110 'require_signer_certificate': 'str', 111 'require_sign_on_paper': 'str', 112 'require_upload_signature': 'str', 113 'role_name': 'str', 114 'routing_order': 'str', 115 'routing_order_metadata': 'PropertyMetadata', 116 'sent_date_time': 'str', 117 'signature_info': 'RecipientSignatureInformation', 118 'signed_date_time': 'str', 119 'sign_in_each_location': 'str', 120 'sign_in_each_location_metadata': 'PropertyMetadata', 121 'signing_group_id': 'str', 122 'signing_group_id_metadata': 'PropertyMetadata', 123 'signing_group_name': 'str', 124 'signing_group_type': 'str', 125 'signing_group_users': 'list[UserInfo]', 126 'sms_authentication': 'RecipientSMSAuthentication', 127 'social_authentications': 'list[SocialAuthentication]', 128 'status': 'str', 129 'status_code': 'str', 130 'suppress_emails': 'str', 131 'tabs': 'Tabs', 132 'template_locked': 'str', 133 'template_required': 'str', 134 'total_tab_count': 'str', 135 'user_id': 'str', 136 'web_form_recipient_view_id': 'str', 137 'witness_for': 'str', 138 'witness_for_guid': 'str' 139 } 140 141 attribute_map = { 142 'access_code': 'accessCode', 143 'access_code_metadata': 'accessCodeMetadata', 144 'add_access_code_to_email': 'addAccessCodeToEmail', 145 'additional_notifications': 'additionalNotifications', 146 'agent_can_edit_email': 'agentCanEditEmail', 147 'agent_can_edit_name': 'agentCanEditName', 148 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 149 'auto_navigation': 'autoNavigation', 150 'auto_responded_reason': 'autoRespondedReason', 151 'bulk_recipients_uri': 'bulkRecipientsUri', 152 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 153 'can_sign_offline': 'canSignOffline', 154 'client_user_id': 'clientUserId', 155 'completed_count': 'completedCount', 156 'consent_details_list': 'consentDetailsList', 157 'creation_reason': 'creationReason', 158 'custom_fields': 'customFields', 159 'declined_date_time': 'declinedDateTime', 160 'declined_reason': 'declinedReason', 161 'default_recipient': 'defaultRecipient', 162 'delegated_by': 'delegatedBy', 163 'delegated_to': 'delegatedTo', 164 'delivered_date_time': 'deliveredDateTime', 165 'delivery_method': 'deliveryMethod', 166 'delivery_method_metadata': 'deliveryMethodMetadata', 167 'designator_id': 'designatorId', 168 'designator_id_guid': 'designatorIdGuid', 169 'document_template_id': 'documentTemplateId', 170 'document_visibility': 'documentVisibility', 171 'email': 'email', 172 'email_metadata': 'emailMetadata', 173 'email_notification': 'emailNotification', 174 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 175 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 176 'error_details': 'errorDetails', 177 'excluded_documents': 'excludedDocuments', 178 'fax_number': 'faxNumber', 179 'fax_number_metadata': 'faxNumberMetadata', 180 'first_name': 'firstName', 181 'first_name_metadata': 'firstNameMetadata', 182 'full_name': 'fullName', 183 'full_name_metadata': 'fullNameMetadata', 184 'id_check_configuration_name': 'idCheckConfigurationName', 185 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 186 'id_check_information_input': 'idCheckInformationInput', 187 'identity_verification': 'identityVerification', 188 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 189 'is_bulk_recipient': 'isBulkRecipient', 190 'is_bulk_recipient_metadata': 'isBulkRecipientMetadata', 191 'last_name': 'lastName', 192 'last_name_metadata': 'lastNameMetadata', 193 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 194 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 195 'name': 'name', 196 'name_metadata': 'nameMetadata', 197 'notary_id': 'notaryId', 198 'notary_signer_email_sent': 'notarySignerEmailSent', 199 'note': 'note', 200 'note_metadata': 'noteMetadata', 201 'offline_attributes': 'offlineAttributes', 202 'phone_authentication': 'phoneAuthentication', 203 'phone_number': 'phoneNumber', 204 'proof_file': 'proofFile', 205 'recipient_attachments': 'recipientAttachments', 206 'recipient_authentication_status': 'recipientAuthenticationStatus', 207 'recipient_feature_metadata': 'recipientFeatureMetadata', 208 'recipient_id': 'recipientId', 209 'recipient_id_guid': 'recipientIdGuid', 210 'recipient_signature_providers': 'recipientSignatureProviders', 211 'recipient_supplies_tabs': 'recipientSuppliesTabs', 212 'recipient_type': 'recipientType', 213 'recipient_type_metadata': 'recipientTypeMetadata', 214 'require_id_lookup': 'requireIdLookup', 215 'require_id_lookup_metadata': 'requireIdLookupMetadata', 216 'require_signer_certificate': 'requireSignerCertificate', 217 'require_sign_on_paper': 'requireSignOnPaper', 218 'require_upload_signature': 'requireUploadSignature', 219 'role_name': 'roleName', 220 'routing_order': 'routingOrder', 221 'routing_order_metadata': 'routingOrderMetadata', 222 'sent_date_time': 'sentDateTime', 223 'signature_info': 'signatureInfo', 224 'signed_date_time': 'signedDateTime', 225 'sign_in_each_location': 'signInEachLocation', 226 'sign_in_each_location_metadata': 'signInEachLocationMetadata', 227 'signing_group_id': 'signingGroupId', 228 'signing_group_id_metadata': 'signingGroupIdMetadata', 229 'signing_group_name': 'signingGroupName', 230 'signing_group_type': 'signingGroupType', 231 'signing_group_users': 'signingGroupUsers', 232 'sms_authentication': 'smsAuthentication', 233 'social_authentications': 'socialAuthentications', 234 'status': 'status', 235 'status_code': 'statusCode', 236 'suppress_emails': 'suppressEmails', 237 'tabs': 'tabs', 238 'template_locked': 'templateLocked', 239 'template_required': 'templateRequired', 240 'total_tab_count': 'totalTabCount', 241 'user_id': 'userId', 242 'web_form_recipient_view_id': 'webFormRecipientViewId', 243 'witness_for': 'witnessFor', 244 'witness_for_guid': 'witnessForGuid' 245 } 246 247 def __init__(self, _configuration=None, **kwargs): # noqa: E501 248 """Witness - a model defined in Swagger""" # noqa: E501 249 if _configuration is None: 250 _configuration = Configuration() 251 self._configuration = _configuration 252 253 self._access_code = None 254 self._access_code_metadata = None 255 self._add_access_code_to_email = None 256 self._additional_notifications = None 257 self._agent_can_edit_email = None 258 self._agent_can_edit_name = None 259 self._allow_system_override_for_locked_recipient = None 260 self._auto_navigation = None 261 self._auto_responded_reason = None 262 self._bulk_recipients_uri = None 263 self._bulk_send_v2_recipient = None 264 self._can_sign_offline = None 265 self._client_user_id = None 266 self._completed_count = None 267 self._consent_details_list = None 268 self._creation_reason = None 269 self._custom_fields = None 270 self._declined_date_time = None 271 self._declined_reason = None 272 self._default_recipient = None 273 self._delegated_by = None 274 self._delegated_to = None 275 self._delivered_date_time = None 276 self._delivery_method = None 277 self._delivery_method_metadata = None 278 self._designator_id = None 279 self._designator_id_guid = None 280 self._document_template_id = None 281 self._document_visibility = None 282 self._email = None 283 self._email_metadata = None 284 self._email_notification = None 285 self._email_recipient_post_signing_url = None 286 self._embedded_recipient_start_url = None 287 self._error_details = None 288 self._excluded_documents = None 289 self._fax_number = None 290 self._fax_number_metadata = None 291 self._first_name = None 292 self._first_name_metadata = None 293 self._full_name = None 294 self._full_name_metadata = None 295 self._id_check_configuration_name = None 296 self._id_check_configuration_name_metadata = None 297 self._id_check_information_input = None 298 self._identity_verification = None 299 self._inherit_email_notification_configuration = None 300 self._is_bulk_recipient = None 301 self._is_bulk_recipient_metadata = None 302 self._last_name = None 303 self._last_name_metadata = None 304 self._locked_recipient_phone_auth_editable = None 305 self._locked_recipient_sms_editable = None 306 self._name = None 307 self._name_metadata = None 308 self._notary_id = None 309 self._notary_signer_email_sent = None 310 self._note = None 311 self._note_metadata = None 312 self._offline_attributes = None 313 self._phone_authentication = None 314 self._phone_number = None 315 self._proof_file = None 316 self._recipient_attachments = None 317 self._recipient_authentication_status = None 318 self._recipient_feature_metadata = None 319 self._recipient_id = None 320 self._recipient_id_guid = None 321 self._recipient_signature_providers = None 322 self._recipient_supplies_tabs = None 323 self._recipient_type = None 324 self._recipient_type_metadata = None 325 self._require_id_lookup = None 326 self._require_id_lookup_metadata = None 327 self._require_signer_certificate = None 328 self._require_sign_on_paper = None 329 self._require_upload_signature = None 330 self._role_name = None 331 self._routing_order = None 332 self._routing_order_metadata = None 333 self._sent_date_time = None 334 self._signature_info = None 335 self._signed_date_time = None 336 self._sign_in_each_location = None 337 self._sign_in_each_location_metadata = None 338 self._signing_group_id = None 339 self._signing_group_id_metadata = None 340 self._signing_group_name = None 341 self._signing_group_type = None 342 self._signing_group_users = None 343 self._sms_authentication = None 344 self._social_authentications = None 345 self._status = None 346 self._status_code = None 347 self._suppress_emails = None 348 self._tabs = None 349 self._template_locked = None 350 self._template_required = None 351 self._total_tab_count = None 352 self._user_id = None 353 self._web_form_recipient_view_id = None 354 self._witness_for = None 355 self._witness_for_guid = None 356 self.discriminator = None 357 358 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 359 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 360 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 361 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 362 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 363 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 364 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 365 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 366 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 367 setattr(self, "_{}".format('bulk_recipients_uri'), kwargs.get('bulk_recipients_uri', None)) 368 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 369 setattr(self, "_{}".format('can_sign_offline'), kwargs.get('can_sign_offline', None)) 370 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 371 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 372 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 373 setattr(self, "_{}".format('creation_reason'), kwargs.get('creation_reason', None)) 374 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 375 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 376 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 377 setattr(self, "_{}".format('default_recipient'), kwargs.get('default_recipient', None)) 378 setattr(self, "_{}".format('delegated_by'), kwargs.get('delegated_by', None)) 379 setattr(self, "_{}".format('delegated_to'), kwargs.get('delegated_to', None)) 380 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 381 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 382 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 383 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 384 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 385 setattr(self, "_{}".format('document_template_id'), kwargs.get('document_template_id', None)) 386 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 387 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 388 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 389 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 390 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 391 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 392 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 393 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 394 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 395 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 396 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 397 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 398 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 399 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 400 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 401 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 402 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 403 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 404 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 405 setattr(self, "_{}".format('is_bulk_recipient'), kwargs.get('is_bulk_recipient', None)) 406 setattr(self, "_{}".format('is_bulk_recipient_metadata'), kwargs.get('is_bulk_recipient_metadata', None)) 407 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 408 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 409 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 410 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 411 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 412 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 413 setattr(self, "_{}".format('notary_id'), kwargs.get('notary_id', None)) 414 setattr(self, "_{}".format('notary_signer_email_sent'), kwargs.get('notary_signer_email_sent', None)) 415 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 416 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 417 setattr(self, "_{}".format('offline_attributes'), kwargs.get('offline_attributes', None)) 418 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 419 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 420 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 421 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 422 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 423 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 424 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 425 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 426 setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None)) 427 setattr(self, "_{}".format('recipient_supplies_tabs'), kwargs.get('recipient_supplies_tabs', None)) 428 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 429 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 430 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 431 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 432 setattr(self, "_{}".format('require_signer_certificate'), kwargs.get('require_signer_certificate', None)) 433 setattr(self, "_{}".format('require_sign_on_paper'), kwargs.get('require_sign_on_paper', None)) 434 setattr(self, "_{}".format('require_upload_signature'), kwargs.get('require_upload_signature', None)) 435 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 436 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 437 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 438 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 439 setattr(self, "_{}".format('signature_info'), kwargs.get('signature_info', None)) 440 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 441 setattr(self, "_{}".format('sign_in_each_location'), kwargs.get('sign_in_each_location', None)) 442 setattr(self, "_{}".format('sign_in_each_location_metadata'), kwargs.get('sign_in_each_location_metadata', None)) 443 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 444 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 445 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 446 setattr(self, "_{}".format('signing_group_type'), kwargs.get('signing_group_type', None)) 447 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 448 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 449 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 450 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 451 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 452 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 453 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 454 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 455 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 456 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 457 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 458 setattr(self, "_{}".format('web_form_recipient_view_id'), kwargs.get('web_form_recipient_view_id', None)) 459 setattr(self, "_{}".format('witness_for'), kwargs.get('witness_for', None)) 460 setattr(self, "_{}".format('witness_for_guid'), kwargs.get('witness_for_guid', None)) 461 462 @property 463 def access_code(self): 464 """Gets the access_code of this Witness. # noqa: E501 465 466 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 467 468 :return: The access_code of this Witness. # noqa: E501 469 :rtype: str 470 """ 471 return self._access_code 472 473 @access_code.setter 474 def access_code(self, access_code): 475 """Sets the access_code of this Witness. 476 477 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 478 479 :param access_code: The access_code of this Witness. # noqa: E501 480 :type: str 481 """ 482 483 self._access_code = access_code 484 485 @property 486 def access_code_metadata(self): 487 """Gets the access_code_metadata of this Witness. # noqa: E501 488 489 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 490 491 :return: The access_code_metadata of this Witness. # noqa: E501 492 :rtype: PropertyMetadata 493 """ 494 return self._access_code_metadata 495 496 @access_code_metadata.setter 497 def access_code_metadata(self, access_code_metadata): 498 """Sets the access_code_metadata of this Witness. 499 500 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 501 502 :param access_code_metadata: The access_code_metadata of this Witness. # noqa: E501 503 :type: PropertyMetadata 504 """ 505 506 self._access_code_metadata = access_code_metadata 507 508 @property 509 def add_access_code_to_email(self): 510 """Gets the add_access_code_to_email of this Witness. # noqa: E501 511 512 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 513 514 :return: The add_access_code_to_email of this Witness. # noqa: E501 515 :rtype: str 516 """ 517 return self._add_access_code_to_email 518 519 @add_access_code_to_email.setter 520 def add_access_code_to_email(self, add_access_code_to_email): 521 """Sets the add_access_code_to_email of this Witness. 522 523 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 524 525 :param add_access_code_to_email: The add_access_code_to_email of this Witness. # noqa: E501 526 :type: str 527 """ 528 529 self._add_access_code_to_email = add_access_code_to_email 530 531 @property 532 def additional_notifications(self): 533 """Gets the additional_notifications of this Witness. # noqa: E501 534 535 # noqa: E501 536 537 :return: The additional_notifications of this Witness. # noqa: E501 538 :rtype: list[RecipientAdditionalNotification] 539 """ 540 return self._additional_notifications 541 542 @additional_notifications.setter 543 def additional_notifications(self, additional_notifications): 544 """Sets the additional_notifications of this Witness. 545 546 # noqa: E501 547 548 :param additional_notifications: The additional_notifications of this Witness. # noqa: E501 549 :type: list[RecipientAdditionalNotification] 550 """ 551 552 self._additional_notifications = additional_notifications 553 554 @property 555 def agent_can_edit_email(self): 556 """Gets the agent_can_edit_email of this Witness. # noqa: E501 557 558 # noqa: E501 559 560 :return: The agent_can_edit_email of this Witness. # noqa: E501 561 :rtype: str 562 """ 563 return self._agent_can_edit_email 564 565 @agent_can_edit_email.setter 566 def agent_can_edit_email(self, agent_can_edit_email): 567 """Sets the agent_can_edit_email of this Witness. 568 569 # noqa: E501 570 571 :param agent_can_edit_email: The agent_can_edit_email of this Witness. # noqa: E501 572 :type: str 573 """ 574 575 self._agent_can_edit_email = agent_can_edit_email 576 577 @property 578 def agent_can_edit_name(self): 579 """Gets the agent_can_edit_name of this Witness. # noqa: E501 580 581 # noqa: E501 582 583 :return: The agent_can_edit_name of this Witness. # noqa: E501 584 :rtype: str 585 """ 586 return self._agent_can_edit_name 587 588 @agent_can_edit_name.setter 589 def agent_can_edit_name(self, agent_can_edit_name): 590 """Sets the agent_can_edit_name of this Witness. 591 592 # noqa: E501 593 594 :param agent_can_edit_name: The agent_can_edit_name of this Witness. # noqa: E501 595 :type: str 596 """ 597 598 self._agent_can_edit_name = agent_can_edit_name 599 600 @property 601 def allow_system_override_for_locked_recipient(self): 602 """Gets the allow_system_override_for_locked_recipient of this Witness. # noqa: E501 603 604 # noqa: E501 605 606 :return: The allow_system_override_for_locked_recipient of this Witness. # noqa: E501 607 :rtype: str 608 """ 609 return self._allow_system_override_for_locked_recipient 610 611 @allow_system_override_for_locked_recipient.setter 612 def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): 613 """Sets the allow_system_override_for_locked_recipient of this Witness. 614 615 # noqa: E501 616 617 :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this Witness. # noqa: E501 618 :type: str 619 """ 620 621 self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient 622 623 @property 624 def auto_navigation(self): 625 """Gets the auto_navigation of this Witness. # noqa: E501 626 627 # noqa: E501 628 629 :return: The auto_navigation of this Witness. # noqa: E501 630 :rtype: str 631 """ 632 return self._auto_navigation 633 634 @auto_navigation.setter 635 def auto_navigation(self, auto_navigation): 636 """Sets the auto_navigation of this Witness. 637 638 # noqa: E501 639 640 :param auto_navigation: The auto_navigation of this Witness. # noqa: E501 641 :type: str 642 """ 643 644 self._auto_navigation = auto_navigation 645 646 @property 647 def auto_responded_reason(self): 648 """Gets the auto_responded_reason of this Witness. # noqa: E501 649 650 # noqa: E501 651 652 :return: The auto_responded_reason of this Witness. # noqa: E501 653 :rtype: str 654 """ 655 return self._auto_responded_reason 656 657 @auto_responded_reason.setter 658 def auto_responded_reason(self, auto_responded_reason): 659 """Sets the auto_responded_reason of this Witness. 660 661 # noqa: E501 662 663 :param auto_responded_reason: The auto_responded_reason of this Witness. # noqa: E501 664 :type: str 665 """ 666 667 self._auto_responded_reason = auto_responded_reason 668 669 @property 670 def bulk_recipients_uri(self): 671 """Gets the bulk_recipients_uri of this Witness. # noqa: E501 672 673 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 674 675 :return: The bulk_recipients_uri of this Witness. # noqa: E501 676 :rtype: str 677 """ 678 return self._bulk_recipients_uri 679 680 @bulk_recipients_uri.setter 681 def bulk_recipients_uri(self, bulk_recipients_uri): 682 """Sets the bulk_recipients_uri of this Witness. 683 684 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 685 686 :param bulk_recipients_uri: The bulk_recipients_uri of this Witness. # noqa: E501 687 :type: str 688 """ 689 690 self._bulk_recipients_uri = bulk_recipients_uri 691 692 @property 693 def bulk_send_v2_recipient(self): 694 """Gets the bulk_send_v2_recipient of this Witness. # noqa: E501 695 696 # noqa: E501 697 698 :return: The bulk_send_v2_recipient of this Witness. # noqa: E501 699 :rtype: str 700 """ 701 return self._bulk_send_v2_recipient 702 703 @bulk_send_v2_recipient.setter 704 def bulk_send_v2_recipient(self, bulk_send_v2_recipient): 705 """Sets the bulk_send_v2_recipient of this Witness. 706 707 # noqa: E501 708 709 :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this Witness. # noqa: E501 710 :type: str 711 """ 712 713 self._bulk_send_v2_recipient = bulk_send_v2_recipient 714 715 @property 716 def can_sign_offline(self): 717 """Gets the can_sign_offline of this Witness. # noqa: E501 718 719 When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 720 721 :return: The can_sign_offline of this Witness. # noqa: E501 722 :rtype: str 723 """ 724 return self._can_sign_offline 725 726 @can_sign_offline.setter 727 def can_sign_offline(self, can_sign_offline): 728 """Sets the can_sign_offline of this Witness. 729 730 When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 731 732 :param can_sign_offline: The can_sign_offline of this Witness. # noqa: E501 733 :type: str 734 """ 735 736 self._can_sign_offline = can_sign_offline 737 738 @property 739 def client_user_id(self): 740 """Gets the client_user_id of this Witness. # noqa: E501 741 742 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 743 744 :return: The client_user_id of this Witness. # noqa: E501 745 :rtype: str 746 """ 747 return self._client_user_id 748 749 @client_user_id.setter 750 def client_user_id(self, client_user_id): 751 """Sets the client_user_id of this Witness. 752 753 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 754 755 :param client_user_id: The client_user_id of this Witness. # noqa: E501 756 :type: str 757 """ 758 759 self._client_user_id = client_user_id 760 761 @property 762 def completed_count(self): 763 """Gets the completed_count of this Witness. # noqa: E501 764 765 # noqa: E501 766 767 :return: The completed_count of this Witness. # noqa: E501 768 :rtype: str 769 """ 770 return self._completed_count 771 772 @completed_count.setter 773 def completed_count(self, completed_count): 774 """Sets the completed_count of this Witness. 775 776 # noqa: E501 777 778 :param completed_count: The completed_count of this Witness. # noqa: E501 779 :type: str 780 """ 781 782 self._completed_count = completed_count 783 784 @property 785 def consent_details_list(self): 786 """Gets the consent_details_list of this Witness. # noqa: E501 787 788 # noqa: E501 789 790 :return: The consent_details_list of this Witness. # noqa: E501 791 :rtype: list[ConsentDetails] 792 """ 793 return self._consent_details_list 794 795 @consent_details_list.setter 796 def consent_details_list(self, consent_details_list): 797 """Sets the consent_details_list of this Witness. 798 799 # noqa: E501 800 801 :param consent_details_list: The consent_details_list of this Witness. # noqa: E501 802 :type: list[ConsentDetails] 803 """ 804 805 self._consent_details_list = consent_details_list 806 807 @property 808 def creation_reason(self): 809 """Gets the creation_reason of this Witness. # noqa: E501 810 811 # noqa: E501 812 813 :return: The creation_reason of this Witness. # noqa: E501 814 :rtype: str 815 """ 816 return self._creation_reason 817 818 @creation_reason.setter 819 def creation_reason(self, creation_reason): 820 """Sets the creation_reason of this Witness. 821 822 # noqa: E501 823 824 :param creation_reason: The creation_reason of this Witness. # noqa: E501 825 :type: str 826 """ 827 828 self._creation_reason = creation_reason 829 830 @property 831 def custom_fields(self): 832 """Gets the custom_fields of this Witness. # noqa: E501 833 834 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 835 836 :return: The custom_fields of this Witness. # noqa: E501 837 :rtype: list[str] 838 """ 839 return self._custom_fields 840 841 @custom_fields.setter 842 def custom_fields(self, custom_fields): 843 """Sets the custom_fields of this Witness. 844 845 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 846 847 :param custom_fields: The custom_fields of this Witness. # noqa: E501 848 :type: list[str] 849 """ 850 851 self._custom_fields = custom_fields 852 853 @property 854 def declined_date_time(self): 855 """Gets the declined_date_time of this Witness. # noqa: E501 856 857 The date and time the recipient declined the document. # noqa: E501 858 859 :return: The declined_date_time of this Witness. # noqa: E501 860 :rtype: str 861 """ 862 return self._declined_date_time 863 864 @declined_date_time.setter 865 def declined_date_time(self, declined_date_time): 866 """Sets the declined_date_time of this Witness. 867 868 The date and time the recipient declined the document. # noqa: E501 869 870 :param declined_date_time: The declined_date_time of this Witness. # noqa: E501 871 :type: str 872 """ 873 874 self._declined_date_time = declined_date_time 875 876 @property 877 def declined_reason(self): 878 """Gets the declined_reason of this Witness. # noqa: E501 879 880 The reason the recipient declined the document. # noqa: E501 881 882 :return: The declined_reason of this Witness. # noqa: E501 883 :rtype: str 884 """ 885 return self._declined_reason 886 887 @declined_reason.setter 888 def declined_reason(self, declined_reason): 889 """Sets the declined_reason of this Witness. 890 891 The reason the recipient declined the document. # noqa: E501 892 893 :param declined_reason: The declined_reason of this Witness. # noqa: E501 894 :type: str 895 """ 896 897 self._declined_reason = declined_reason 898 899 @property 900 def default_recipient(self): 901 """Gets the default_recipient of this Witness. # noqa: E501 902 903 # noqa: E501 904 905 :return: The default_recipient of this Witness. # noqa: E501 906 :rtype: str 907 """ 908 return self._default_recipient 909 910 @default_recipient.setter 911 def default_recipient(self, default_recipient): 912 """Sets the default_recipient of this Witness. 913 914 # noqa: E501 915 916 :param default_recipient: The default_recipient of this Witness. # noqa: E501 917 :type: str 918 """ 919 920 self._default_recipient = default_recipient 921 922 @property 923 def delegated_by(self): 924 """Gets the delegated_by of this Witness. # noqa: E501 925 926 # noqa: E501 927 928 :return: The delegated_by of this Witness. # noqa: E501 929 :rtype: DelegationInfo 930 """ 931 return self._delegated_by 932 933 @delegated_by.setter 934 def delegated_by(self, delegated_by): 935 """Sets the delegated_by of this Witness. 936 937 # noqa: E501 938 939 :param delegated_by: The delegated_by of this Witness. # noqa: E501 940 :type: DelegationInfo 941 """ 942 943 self._delegated_by = delegated_by 944 945 @property 946 def delegated_to(self): 947 """Gets the delegated_to of this Witness. # noqa: E501 948 949 # noqa: E501 950 951 :return: The delegated_to of this Witness. # noqa: E501 952 :rtype: list[DelegationInfo] 953 """ 954 return self._delegated_to 955 956 @delegated_to.setter 957 def delegated_to(self, delegated_to): 958 """Sets the delegated_to of this Witness. 959 960 # noqa: E501 961 962 :param delegated_to: The delegated_to of this Witness. # noqa: E501 963 :type: list[DelegationInfo] 964 """ 965 966 self._delegated_to = delegated_to 967 968 @property 969 def delivered_date_time(self): 970 """Gets the delivered_date_time of this Witness. # noqa: E501 971 972 Reserved: For DocuSign use only. # noqa: E501 973 974 :return: The delivered_date_time of this Witness. # noqa: E501 975 :rtype: str 976 """ 977 return self._delivered_date_time 978 979 @delivered_date_time.setter 980 def delivered_date_time(self, delivered_date_time): 981 """Sets the delivered_date_time of this Witness. 982 983 Reserved: For DocuSign use only. # noqa: E501 984 985 :param delivered_date_time: The delivered_date_time of this Witness. # noqa: E501 986 :type: str 987 """ 988 989 self._delivered_date_time = delivered_date_time 990 991 @property 992 def delivery_method(self): 993 """Gets the delivery_method of this Witness. # noqa: E501 994 995 Reserved: For DocuSign use only. # noqa: E501 996 997 :return: The delivery_method of this Witness. # noqa: E501 998 :rtype: str 999 """ 1000 return self._delivery_method 1001 1002 @delivery_method.setter 1003 def delivery_method(self, delivery_method): 1004 """Sets the delivery_method of this Witness. 1005 1006 Reserved: For DocuSign use only. # noqa: E501 1007 1008 :param delivery_method: The delivery_method of this Witness. # noqa: E501 1009 :type: str 1010 """ 1011 1012 self._delivery_method = delivery_method 1013 1014 @property 1015 def delivery_method_metadata(self): 1016 """Gets the delivery_method_metadata of this Witness. # noqa: E501 1017 1018 Reserved for DocuSign. # noqa: E501 1019 1020 :return: The delivery_method_metadata of this Witness. # noqa: E501 1021 :rtype: PropertyMetadata 1022 """ 1023 return self._delivery_method_metadata 1024 1025 @delivery_method_metadata.setter 1026 def delivery_method_metadata(self, delivery_method_metadata): 1027 """Sets the delivery_method_metadata of this Witness. 1028 1029 Reserved for DocuSign. # noqa: E501 1030 1031 :param delivery_method_metadata: The delivery_method_metadata of this Witness. # noqa: E501 1032 :type: PropertyMetadata 1033 """ 1034 1035 self._delivery_method_metadata = delivery_method_metadata 1036 1037 @property 1038 def designator_id(self): 1039 """Gets the designator_id of this Witness. # noqa: E501 1040 1041 # noqa: E501 1042 1043 :return: The designator_id of this Witness. # noqa: E501 1044 :rtype: str 1045 """ 1046 return self._designator_id 1047 1048 @designator_id.setter 1049 def designator_id(self, designator_id): 1050 """Sets the designator_id of this Witness. 1051 1052 # noqa: E501 1053 1054 :param designator_id: The designator_id of this Witness. # noqa: E501 1055 :type: str 1056 """ 1057 1058 self._designator_id = designator_id 1059 1060 @property 1061 def designator_id_guid(self): 1062 """Gets the designator_id_guid of this Witness. # noqa: E501 1063 1064 # noqa: E501 1065 1066 :return: The designator_id_guid of this Witness. # noqa: E501 1067 :rtype: str 1068 """ 1069 return self._designator_id_guid 1070 1071 @designator_id_guid.setter 1072 def designator_id_guid(self, designator_id_guid): 1073 """Sets the designator_id_guid of this Witness. 1074 1075 # noqa: E501 1076 1077 :param designator_id_guid: The designator_id_guid of this Witness. # noqa: E501 1078 :type: str 1079 """ 1080 1081 self._designator_id_guid = designator_id_guid 1082 1083 @property 1084 def document_template_id(self): 1085 """Gets the document_template_id of this Witness. # noqa: E501 1086 1087 # noqa: E501 1088 1089 :return: The document_template_id of this Witness. # noqa: E501 1090 :rtype: str 1091 """ 1092 return self._document_template_id 1093 1094 @document_template_id.setter 1095 def document_template_id(self, document_template_id): 1096 """Sets the document_template_id of this Witness. 1097 1098 # noqa: E501 1099 1100 :param document_template_id: The document_template_id of this Witness. # noqa: E501 1101 :type: str 1102 """ 1103 1104 self._document_template_id = document_template_id 1105 1106 @property 1107 def document_visibility(self): 1108 """Gets the document_visibility of this Witness. # noqa: E501 1109 1110 # noqa: E501 1111 1112 :return: The document_visibility of this Witness. # noqa: E501 1113 :rtype: list[DocumentVisibility] 1114 """ 1115 return self._document_visibility 1116 1117 @document_visibility.setter 1118 def document_visibility(self, document_visibility): 1119 """Sets the document_visibility of this Witness. 1120 1121 # noqa: E501 1122 1123 :param document_visibility: The document_visibility of this Witness. # noqa: E501 1124 :type: list[DocumentVisibility] 1125 """ 1126 1127 self._document_visibility = document_visibility 1128 1129 @property 1130 def email(self): 1131 """Gets the email of this Witness. # noqa: E501 1132 1133 # noqa: E501 1134 1135 :return: The email of this Witness. # noqa: E501 1136 :rtype: str 1137 """ 1138 return self._email 1139 1140 @email.setter 1141 def email(self, email): 1142 """Sets the email of this Witness. 1143 1144 # noqa: E501 1145 1146 :param email: The email of this Witness. # noqa: E501 1147 :type: str 1148 """ 1149 1150 self._email = email 1151 1152 @property 1153 def email_metadata(self): 1154 """Gets the email_metadata of this Witness. # noqa: E501 1155 1156 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 1157 1158 :return: The email_metadata of this Witness. # noqa: E501 1159 :rtype: PropertyMetadata 1160 """ 1161 return self._email_metadata 1162 1163 @email_metadata.setter 1164 def email_metadata(self, email_metadata): 1165 """Sets the email_metadata of this Witness. 1166 1167 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 1168 1169 :param email_metadata: The email_metadata of this Witness. # noqa: E501 1170 :type: PropertyMetadata 1171 """ 1172 1173 self._email_metadata = email_metadata 1174 1175 @property 1176 def email_notification(self): 1177 """Gets the email_notification of this Witness. # noqa: E501 1178 1179 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 1180 1181 :return: The email_notification of this Witness. # noqa: E501 1182 :rtype: RecipientEmailNotification 1183 """ 1184 return self._email_notification 1185 1186 @email_notification.setter 1187 def email_notification(self, email_notification): 1188 """Sets the email_notification of this Witness. 1189 1190 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 1191 1192 :param email_notification: The email_notification of this Witness. # noqa: E501 1193 :type: RecipientEmailNotification 1194 """ 1195 1196 self._email_notification = email_notification 1197 1198 @property 1199 def email_recipient_post_signing_url(self): 1200 """Gets the email_recipient_post_signing_url of this Witness. # noqa: E501 1201 1202 # noqa: E501 1203 1204 :return: The email_recipient_post_signing_url of this Witness. # noqa: E501 1205 :rtype: str 1206 """ 1207 return self._email_recipient_post_signing_url 1208 1209 @email_recipient_post_signing_url.setter 1210 def email_recipient_post_signing_url(self, email_recipient_post_signing_url): 1211 """Sets the email_recipient_post_signing_url of this Witness. 1212 1213 # noqa: E501 1214 1215 :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this Witness. # noqa: E501 1216 :type: str 1217 """ 1218 1219 self._email_recipient_post_signing_url = email_recipient_post_signing_url 1220 1221 @property 1222 def embedded_recipient_start_url(self): 1223 """Gets the embedded_recipient_start_url of this Witness. # noqa: E501 1224 1225 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 1226 1227 :return: The embedded_recipient_start_url of this Witness. # noqa: E501 1228 :rtype: str 1229 """ 1230 return self._embedded_recipient_start_url 1231 1232 @embedded_recipient_start_url.setter 1233 def embedded_recipient_start_url(self, embedded_recipient_start_url): 1234 """Sets the embedded_recipient_start_url of this Witness. 1235 1236 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 1237 1238 :param embedded_recipient_start_url: The embedded_recipient_start_url of this Witness. # noqa: E501 1239 :type: str 1240 """ 1241 1242 self._embedded_recipient_start_url = embedded_recipient_start_url 1243 1244 @property 1245 def error_details(self): 1246 """Gets the error_details of this Witness. # noqa: E501 1247 1248 Array or errors. # noqa: E501 1249 1250 :return: The error_details of this Witness. # noqa: E501 1251 :rtype: ErrorDetails 1252 """ 1253 return self._error_details 1254 1255 @error_details.setter 1256 def error_details(self, error_details): 1257 """Sets the error_details of this Witness. 1258 1259 Array or errors. # noqa: E501 1260 1261 :param error_details: The error_details of this Witness. # noqa: E501 1262 :type: ErrorDetails 1263 """ 1264 1265 self._error_details = error_details 1266 1267 @property 1268 def excluded_documents(self): 1269 """Gets the excluded_documents of this Witness. # noqa: E501 1270 1271 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 1272 1273 :return: The excluded_documents of this Witness. # noqa: E501 1274 :rtype: list[str] 1275 """ 1276 return self._excluded_documents 1277 1278 @excluded_documents.setter 1279 def excluded_documents(self, excluded_documents): 1280 """Sets the excluded_documents of this Witness. 1281 1282 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 1283 1284 :param excluded_documents: The excluded_documents of this Witness. # noqa: E501 1285 :type: list[str] 1286 """ 1287 1288 self._excluded_documents = excluded_documents 1289 1290 @property 1291 def fax_number(self): 1292 """Gets the fax_number of this Witness. # noqa: E501 1293 1294 Reserved: # noqa: E501 1295 1296 :return: The fax_number of this Witness. # noqa: E501 1297 :rtype: str 1298 """ 1299 return self._fax_number 1300 1301 @fax_number.setter 1302 def fax_number(self, fax_number): 1303 """Sets the fax_number of this Witness. 1304 1305 Reserved: # noqa: E501 1306 1307 :param fax_number: The fax_number of this Witness. # noqa: E501 1308 :type: str 1309 """ 1310 1311 self._fax_number = fax_number 1312 1313 @property 1314 def fax_number_metadata(self): 1315 """Gets the fax_number_metadata of this Witness. # noqa: E501 1316 1317 Reserved for DocuSign. # noqa: E501 1318 1319 :return: The fax_number_metadata of this Witness. # noqa: E501 1320 :rtype: PropertyMetadata 1321 """ 1322 return self._fax_number_metadata 1323 1324 @fax_number_metadata.setter 1325 def fax_number_metadata(self, fax_number_metadata): 1326 """Sets the fax_number_metadata of this Witness. 1327 1328 Reserved for DocuSign. # noqa: E501 1329 1330 :param fax_number_metadata: The fax_number_metadata of this Witness. # noqa: E501 1331 :type: PropertyMetadata 1332 """ 1333 1334 self._fax_number_metadata = fax_number_metadata 1335 1336 @property 1337 def first_name(self): 1338 """Gets the first_name of this Witness. # noqa: E501 1339 1340 The user's first name. Maximum Length: 50 characters. # noqa: E501 1341 1342 :return: The first_name of this Witness. # noqa: E501 1343 :rtype: str 1344 """ 1345 return self._first_name 1346 1347 @first_name.setter 1348 def first_name(self, first_name): 1349 """Sets the first_name of this Witness. 1350 1351 The user's first name. Maximum Length: 50 characters. # noqa: E501 1352 1353 :param first_name: The first_name of this Witness. # noqa: E501 1354 :type: str 1355 """ 1356 1357 self._first_name = first_name 1358 1359 @property 1360 def first_name_metadata(self): 1361 """Gets the first_name_metadata of this Witness. # noqa: E501 1362 1363 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1364 1365 :return: The first_name_metadata of this Witness. # noqa: E501 1366 :rtype: PropertyMetadata 1367 """ 1368 return self._first_name_metadata 1369 1370 @first_name_metadata.setter 1371 def first_name_metadata(self, first_name_metadata): 1372 """Sets the first_name_metadata of this Witness. 1373 1374 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1375 1376 :param first_name_metadata: The first_name_metadata of this Witness. # noqa: E501 1377 :type: PropertyMetadata 1378 """ 1379 1380 self._first_name_metadata = first_name_metadata 1381 1382 @property 1383 def full_name(self): 1384 """Gets the full_name of this Witness. # noqa: E501 1385 1386 # noqa: E501 1387 1388 :return: The full_name of this Witness. # noqa: E501 1389 :rtype: str 1390 """ 1391 return self._full_name 1392 1393 @full_name.setter 1394 def full_name(self, full_name): 1395 """Sets the full_name of this Witness. 1396 1397 # noqa: E501 1398 1399 :param full_name: The full_name of this Witness. # noqa: E501 1400 :type: str 1401 """ 1402 1403 self._full_name = full_name 1404 1405 @property 1406 def full_name_metadata(self): 1407 """Gets the full_name_metadata of this Witness. # noqa: E501 1408 1409 Reserved for DocuSign. # noqa: E501 1410 1411 :return: The full_name_metadata of this Witness. # noqa: E501 1412 :rtype: PropertyMetadata 1413 """ 1414 return self._full_name_metadata 1415 1416 @full_name_metadata.setter 1417 def full_name_metadata(self, full_name_metadata): 1418 """Sets the full_name_metadata of this Witness. 1419 1420 Reserved for DocuSign. # noqa: E501 1421 1422 :param full_name_metadata: The full_name_metadata of this Witness. # noqa: E501 1423 :type: PropertyMetadata 1424 """ 1425 1426 self._full_name_metadata = full_name_metadata 1427 1428 @property 1429 def id_check_configuration_name(self): 1430 """Gets the id_check_configuration_name of this Witness. # noqa: E501 1431 1432 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 1433 1434 :return: The id_check_configuration_name of this Witness. # noqa: E501 1435 :rtype: str 1436 """ 1437 return self._id_check_configuration_name 1438 1439 @id_check_configuration_name.setter 1440 def id_check_configuration_name(self, id_check_configuration_name): 1441 """Sets the id_check_configuration_name of this Witness. 1442 1443 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 1444 1445 :param id_check_configuration_name: The id_check_configuration_name of this Witness. # noqa: E501 1446 :type: str 1447 """ 1448 1449 self._id_check_configuration_name = id_check_configuration_name 1450 1451 @property 1452 def id_check_configuration_name_metadata(self): 1453 """Gets the id_check_configuration_name_metadata of this Witness. # noqa: E501 1454 1455 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1456 1457 :return: The id_check_configuration_name_metadata of this Witness. # noqa: E501 1458 :rtype: PropertyMetadata 1459 """ 1460 return self._id_check_configuration_name_metadata 1461 1462 @id_check_configuration_name_metadata.setter 1463 def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): 1464 """Sets the id_check_configuration_name_metadata of this Witness. 1465 1466 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1467 1468 :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this Witness. # noqa: E501 1469 :type: PropertyMetadata 1470 """ 1471 1472 self._id_check_configuration_name_metadata = id_check_configuration_name_metadata 1473 1474 @property 1475 def id_check_information_input(self): 1476 """Gets the id_check_information_input of this Witness. # noqa: E501 1477 1478 An object that contains input information related to a recipient ID check. # noqa: E501 1479 1480 :return: The id_check_information_input of this Witness. # noqa: E501 1481 :rtype: IdCheckInformationInput 1482 """ 1483 return self._id_check_information_input 1484 1485 @id_check_information_input.setter 1486 def id_check_information_input(self, id_check_information_input): 1487 """Sets the id_check_information_input of this Witness. 1488 1489 An object that contains input information related to a recipient ID check. # noqa: E501 1490 1491 :param id_check_information_input: The id_check_information_input of this Witness. # noqa: E501 1492 :type: IdCheckInformationInput 1493 """ 1494 1495 self._id_check_information_input = id_check_information_input 1496 1497 @property 1498 def identity_verification(self): 1499 """Gets the identity_verification of this Witness. # noqa: E501 1500 1501 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501 1502 1503 :return: The identity_verification of this Witness. # noqa: E501 1504 :rtype: RecipientIdentityVerification 1505 """ 1506 return self._identity_verification 1507 1508 @identity_verification.setter 1509 def identity_verification(self, identity_verification): 1510 """Sets the identity_verification of this Witness. 1511 1512 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501 1513 1514 :param identity_verification: The identity_verification of this Witness. # noqa: E501 1515 :type: RecipientIdentityVerification 1516 """ 1517 1518 self._identity_verification = identity_verification 1519 1520 @property 1521 def inherit_email_notification_configuration(self): 1522 """Gets the inherit_email_notification_configuration of this Witness. # noqa: E501 1523 1524 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 1525 1526 :return: The inherit_email_notification_configuration of this Witness. # noqa: E501 1527 :rtype: str 1528 """ 1529 return self._inherit_email_notification_configuration 1530 1531 @inherit_email_notification_configuration.setter 1532 def inherit_email_notification_configuration(self, inherit_email_notification_configuration): 1533 """Sets the inherit_email_notification_configuration of this Witness. 1534 1535 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 1536 1537 :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this Witness. # noqa: E501 1538 :type: str 1539 """ 1540 1541 self._inherit_email_notification_configuration = inherit_email_notification_configuration 1542 1543 @property 1544 def is_bulk_recipient(self): 1545 """Gets the is_bulk_recipient of this Witness. # noqa: E501 1546 1547 # noqa: E501 1548 1549 :return: The is_bulk_recipient of this Witness. # noqa: E501 1550 :rtype: str 1551 """ 1552 return self._is_bulk_recipient 1553 1554 @is_bulk_recipient.setter 1555 def is_bulk_recipient(self, is_bulk_recipient): 1556 """Sets the is_bulk_recipient of this Witness. 1557 1558 # noqa: E501 1559 1560 :param is_bulk_recipient: The is_bulk_recipient of this Witness. # noqa: E501 1561 :type: str 1562 """ 1563 1564 self._is_bulk_recipient = is_bulk_recipient 1565 1566 @property 1567 def is_bulk_recipient_metadata(self): 1568 """Gets the is_bulk_recipient_metadata of this Witness. # noqa: E501 1569 1570 Reserved for DocuSign. # noqa: E501 1571 1572 :return: The is_bulk_recipient_metadata of this Witness. # noqa: E501 1573 :rtype: PropertyMetadata 1574 """ 1575 return self._is_bulk_recipient_metadata 1576 1577 @is_bulk_recipient_metadata.setter 1578 def is_bulk_recipient_metadata(self, is_bulk_recipient_metadata): 1579 """Sets the is_bulk_recipient_metadata of this Witness. 1580 1581 Reserved for DocuSign. # noqa: E501 1582 1583 :param is_bulk_recipient_metadata: The is_bulk_recipient_metadata of this Witness. # noqa: E501 1584 :type: PropertyMetadata 1585 """ 1586 1587 self._is_bulk_recipient_metadata = is_bulk_recipient_metadata 1588 1589 @property 1590 def last_name(self): 1591 """Gets the last_name of this Witness. # noqa: E501 1592 1593 # noqa: E501 1594 1595 :return: The last_name of this Witness. # noqa: E501 1596 :rtype: str 1597 """ 1598 return self._last_name 1599 1600 @last_name.setter 1601 def last_name(self, last_name): 1602 """Sets the last_name of this Witness. 1603 1604 # noqa: E501 1605 1606 :param last_name: The last_name of this Witness. # noqa: E501 1607 :type: str 1608 """ 1609 1610 self._last_name = last_name 1611 1612 @property 1613 def last_name_metadata(self): 1614 """Gets the last_name_metadata of this Witness. # noqa: E501 1615 1616 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1617 1618 :return: The last_name_metadata of this Witness. # noqa: E501 1619 :rtype: PropertyMetadata 1620 """ 1621 return self._last_name_metadata 1622 1623 @last_name_metadata.setter 1624 def last_name_metadata(self, last_name_metadata): 1625 """Sets the last_name_metadata of this Witness. 1626 1627 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1628 1629 :param last_name_metadata: The last_name_metadata of this Witness. # noqa: E501 1630 :type: PropertyMetadata 1631 """ 1632 1633 self._last_name_metadata = last_name_metadata 1634 1635 @property 1636 def locked_recipient_phone_auth_editable(self): 1637 """Gets the locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1638 1639 # noqa: E501 1640 1641 :return: The locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1642 :rtype: str 1643 """ 1644 return self._locked_recipient_phone_auth_editable 1645 1646 @locked_recipient_phone_auth_editable.setter 1647 def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): 1648 """Sets the locked_recipient_phone_auth_editable of this Witness. 1649 1650 # noqa: E501 1651 1652 :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1653 :type: str 1654 """ 1655 1656 self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable 1657 1658 @property 1659 def locked_recipient_sms_editable(self): 1660 """Gets the locked_recipient_sms_editable of this Witness. # noqa: E501 1661 1662 # noqa: E501 1663 1664 :return: The locked_recipient_sms_editable of this Witness. # noqa: E501 1665 :rtype: str 1666 """ 1667 return self._locked_recipient_sms_editable 1668 1669 @locked_recipient_sms_editable.setter 1670 def locked_recipient_sms_editable(self, locked_recipient_sms_editable): 1671 """Sets the locked_recipient_sms_editable of this Witness. 1672 1673 # noqa: E501 1674 1675 :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this Witness. # noqa: E501 1676 :type: str 1677 """ 1678 1679 self._locked_recipient_sms_editable = locked_recipient_sms_editable 1680 1681 @property 1682 def name(self): 1683 """Gets the name of this Witness. # noqa: E501 1684 1685 # noqa: E501 1686 1687 :return: The name of this Witness. # noqa: E501 1688 :rtype: str 1689 """ 1690 return self._name 1691 1692 @name.setter 1693 def name(self, name): 1694 """Sets the name of this Witness. 1695 1696 # noqa: E501 1697 1698 :param name: The name of this Witness. # noqa: E501 1699 :type: str 1700 """ 1701 1702 self._name = name 1703 1704 @property 1705 def name_metadata(self): 1706 """Gets the name_metadata of this Witness. # noqa: E501 1707 1708 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1709 1710 :return: The name_metadata of this Witness. # noqa: E501 1711 :rtype: PropertyMetadata 1712 """ 1713 return self._name_metadata 1714 1715 @name_metadata.setter 1716 def name_metadata(self, name_metadata): 1717 """Sets the name_metadata of this Witness. 1718 1719 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1720 1721 :param name_metadata: The name_metadata of this Witness. # noqa: E501 1722 :type: PropertyMetadata 1723 """ 1724 1725 self._name_metadata = name_metadata 1726 1727 @property 1728 def notary_id(self): 1729 """Gets the notary_id of this Witness. # noqa: E501 1730 1731 # noqa: E501 1732 1733 :return: The notary_id of this Witness. # noqa: E501 1734 :rtype: str 1735 """ 1736 return self._notary_id 1737 1738 @notary_id.setter 1739 def notary_id(self, notary_id): 1740 """Sets the notary_id of this Witness. 1741 1742 # noqa: E501 1743 1744 :param notary_id: The notary_id of this Witness. # noqa: E501 1745 :type: str 1746 """ 1747 1748 self._notary_id = notary_id 1749 1750 @property 1751 def notary_signer_email_sent(self): 1752 """Gets the notary_signer_email_sent of this Witness. # noqa: E501 1753 1754 # noqa: E501 1755 1756 :return: The notary_signer_email_sent of this Witness. # noqa: E501 1757 :rtype: str 1758 """ 1759 return self._notary_signer_email_sent 1760 1761 @notary_signer_email_sent.setter 1762 def notary_signer_email_sent(self, notary_signer_email_sent): 1763 """Sets the notary_signer_email_sent of this Witness. 1764 1765 # noqa: E501 1766 1767 :param notary_signer_email_sent: The notary_signer_email_sent of this Witness. # noqa: E501 1768 :type: str 1769 """ 1770 1771 self._notary_signer_email_sent = notary_signer_email_sent 1772 1773 @property 1774 def note(self): 1775 """Gets the note of this Witness. # noqa: E501 1776 1777 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 1778 1779 :return: The note of this Witness. # noqa: E501 1780 :rtype: str 1781 """ 1782 return self._note 1783 1784 @note.setter 1785 def note(self, note): 1786 """Sets the note of this Witness. 1787 1788 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 1789 1790 :param note: The note of this Witness. # noqa: E501 1791 :type: str 1792 """ 1793 1794 self._note = note 1795 1796 @property 1797 def note_metadata(self): 1798 """Gets the note_metadata of this Witness. # noqa: E501 1799 1800 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1801 1802 :return: The note_metadata of this Witness. # noqa: E501 1803 :rtype: PropertyMetadata 1804 """ 1805 return self._note_metadata 1806 1807 @note_metadata.setter 1808 def note_metadata(self, note_metadata): 1809 """Sets the note_metadata of this Witness. 1810 1811 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1812 1813 :param note_metadata: The note_metadata of this Witness. # noqa: E501 1814 :type: PropertyMetadata 1815 """ 1816 1817 self._note_metadata = note_metadata 1818 1819 @property 1820 def offline_attributes(self): 1821 """Gets the offline_attributes of this Witness. # noqa: E501 1822 1823 Reserved for DocuSign. # noqa: E501 1824 1825 :return: The offline_attributes of this Witness. # noqa: E501 1826 :rtype: OfflineAttributes 1827 """ 1828 return self._offline_attributes 1829 1830 @offline_attributes.setter 1831 def offline_attributes(self, offline_attributes): 1832 """Sets the offline_attributes of this Witness. 1833 1834 Reserved for DocuSign. # noqa: E501 1835 1836 :param offline_attributes: The offline_attributes of this Witness. # noqa: E501 1837 :type: OfflineAttributes 1838 """ 1839 1840 self._offline_attributes = offline_attributes 1841 1842 @property 1843 def phone_authentication(self): 1844 """Gets the phone_authentication of this Witness. # noqa: E501 1845 1846 When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. # noqa: E501 1847 1848 :return: The phone_authentication of this Witness. # noqa: E501 1849 :rtype: RecipientPhoneAuthentication 1850 """ 1851 return self._phone_authentication 1852 1853 @phone_authentication.setter 1854 def phone_authentication(self, phone_authentication): 1855 """Sets the phone_authentication of this Witness. 1856 1857 When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. # noqa: E501 1858 1859 :param phone_authentication: The phone_authentication of this Witness. # noqa: E501 1860 :type: RecipientPhoneAuthentication 1861 """ 1862 1863 self._phone_authentication = phone_authentication 1864 1865 @property 1866 def phone_number(self): 1867 """Gets the phone_number of this Witness. # noqa: E501 1868 1869 Describes the recipient phone number. # noqa: E501 1870 1871 :return: The phone_number of this Witness. # noqa: E501 1872 :rtype: RecipientPhoneNumber 1873 """ 1874 return self._phone_number 1875 1876 @phone_number.setter 1877 def phone_number(self, phone_number): 1878 """Sets the phone_number of this Witness. 1879 1880 Describes the recipient phone number. # noqa: E501 1881 1882 :param phone_number: The phone_number of this Witness. # noqa: E501 1883 :type: RecipientPhoneNumber 1884 """ 1885 1886 self._phone_number = phone_number 1887 1888 @property 1889 def proof_file(self): 1890 """Gets the proof_file of this Witness. # noqa: E501 1891 1892 The proof file of the recipient. # noqa: E501 1893 1894 :return: The proof_file of this Witness. # noqa: E501 1895 :rtype: RecipientProofFile 1896 """ 1897 return self._proof_file 1898 1899 @proof_file.setter 1900 def proof_file(self, proof_file): 1901 """Sets the proof_file of this Witness. 1902 1903 The proof file of the recipient. # noqa: E501 1904 1905 :param proof_file: The proof_file of this Witness. # noqa: E501 1906 :type: RecipientProofFile 1907 """ 1908 1909 self._proof_file = proof_file 1910 1911 @property 1912 def recipient_attachments(self): 1913 """Gets the recipient_attachments of this Witness. # noqa: E501 1914 1915 Reserved: # noqa: E501 1916 1917 :return: The recipient_attachments of this Witness. # noqa: E501 1918 :rtype: list[RecipientAttachment] 1919 """ 1920 return self._recipient_attachments 1921 1922 @recipient_attachments.setter 1923 def recipient_attachments(self, recipient_attachments): 1924 """Sets the recipient_attachments of this Witness. 1925 1926 Reserved: # noqa: E501 1927 1928 :param recipient_attachments: The recipient_attachments of this Witness. # noqa: E501 1929 :type: list[RecipientAttachment] 1930 """ 1931 1932 self._recipient_attachments = recipient_attachments 1933 1934 @property 1935 def recipient_authentication_status(self): 1936 """Gets the recipient_authentication_status of this Witness. # noqa: E501 1937 1938 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1939 1940 :return: The recipient_authentication_status of this Witness. # noqa: E501 1941 :rtype: AuthenticationStatus 1942 """ 1943 return self._recipient_authentication_status 1944 1945 @recipient_authentication_status.setter 1946 def recipient_authentication_status(self, recipient_authentication_status): 1947 """Sets the recipient_authentication_status of this Witness. 1948 1949 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1950 1951 :param recipient_authentication_status: The recipient_authentication_status of this Witness. # noqa: E501 1952 :type: AuthenticationStatus 1953 """ 1954 1955 self._recipient_authentication_status = recipient_authentication_status 1956 1957 @property 1958 def recipient_feature_metadata(self): 1959 """Gets the recipient_feature_metadata of this Witness. # noqa: E501 1960 1961 # noqa: E501 1962 1963 :return: The recipient_feature_metadata of this Witness. # noqa: E501 1964 :rtype: list[FeatureAvailableMetadata] 1965 """ 1966 return self._recipient_feature_metadata 1967 1968 @recipient_feature_metadata.setter 1969 def recipient_feature_metadata(self, recipient_feature_metadata): 1970 """Sets the recipient_feature_metadata of this Witness. 1971 1972 # noqa: E501 1973 1974 :param recipient_feature_metadata: The recipient_feature_metadata of this Witness. # noqa: E501 1975 :type: list[FeatureAvailableMetadata] 1976 """ 1977 1978 self._recipient_feature_metadata = recipient_feature_metadata 1979 1980 @property 1981 def recipient_id(self): 1982 """Gets the recipient_id of this Witness. # noqa: E501 1983 1984 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1985 1986 :return: The recipient_id of this Witness. # noqa: E501 1987 :rtype: str 1988 """ 1989 return self._recipient_id 1990 1991 @recipient_id.setter 1992 def recipient_id(self, recipient_id): 1993 """Sets the recipient_id of this Witness. 1994 1995 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1996 1997 :param recipient_id: The recipient_id of this Witness. # noqa: E501 1998 :type: str 1999 """ 2000 2001 self._recipient_id = recipient_id 2002 2003 @property 2004 def recipient_id_guid(self): 2005 """Gets the recipient_id_guid of this Witness. # noqa: E501 2006 2007 # noqa: E501 2008 2009 :return: The recipient_id_guid of this Witness. # noqa: E501 2010 :rtype: str 2011 """ 2012 return self._recipient_id_guid 2013 2014 @recipient_id_guid.setter 2015 def recipient_id_guid(self, recipient_id_guid): 2016 """Sets the recipient_id_guid of this Witness. 2017 2018 # noqa: E501 2019 2020 :param recipient_id_guid: The recipient_id_guid of this Witness. # noqa: E501 2021 :type: str 2022 """ 2023 2024 self._recipient_id_guid = recipient_id_guid 2025 2026 @property 2027 def recipient_signature_providers(self): 2028 """Gets the recipient_signature_providers of this Witness. # noqa: E501 2029 2030 # noqa: E501 2031 2032 :return: The recipient_signature_providers of this Witness. # noqa: E501 2033 :rtype: list[RecipientSignatureProvider] 2034 """ 2035 return self._recipient_signature_providers 2036 2037 @recipient_signature_providers.setter 2038 def recipient_signature_providers(self, recipient_signature_providers): 2039 """Sets the recipient_signature_providers of this Witness. 2040 2041 # noqa: E501 2042 2043 :param recipient_signature_providers: The recipient_signature_providers of this Witness. # noqa: E501 2044 :type: list[RecipientSignatureProvider] 2045 """ 2046 2047 self._recipient_signature_providers = recipient_signature_providers 2048 2049 @property 2050 def recipient_supplies_tabs(self): 2051 """Gets the recipient_supplies_tabs of this Witness. # noqa: E501 2052 2053 # noqa: E501 2054 2055 :return: The recipient_supplies_tabs of this Witness. # noqa: E501 2056 :rtype: str 2057 """ 2058 return self._recipient_supplies_tabs 2059 2060 @recipient_supplies_tabs.setter 2061 def recipient_supplies_tabs(self, recipient_supplies_tabs): 2062 """Sets the recipient_supplies_tabs of this Witness. 2063 2064 # noqa: E501 2065 2066 :param recipient_supplies_tabs: The recipient_supplies_tabs of this Witness. # noqa: E501 2067 :type: str 2068 """ 2069 2070 self._recipient_supplies_tabs = recipient_supplies_tabs 2071 2072 @property 2073 def recipient_type(self): 2074 """Gets the recipient_type of this Witness. # noqa: E501 2075 2076 # noqa: E501 2077 2078 :return: The recipient_type of this Witness. # noqa: E501 2079 :rtype: str 2080 """ 2081 return self._recipient_type 2082 2083 @recipient_type.setter 2084 def recipient_type(self, recipient_type): 2085 """Sets the recipient_type of this Witness. 2086 2087 # noqa: E501 2088 2089 :param recipient_type: The recipient_type of this Witness. # noqa: E501 2090 :type: str 2091 """ 2092 2093 self._recipient_type = recipient_type 2094 2095 @property 2096 def recipient_type_metadata(self): 2097 """Gets the recipient_type_metadata of this Witness. # noqa: E501 2098 2099 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 2100 2101 :return: The recipient_type_metadata of this Witness. # noqa: E501 2102 :rtype: PropertyMetadata 2103 """ 2104 return self._recipient_type_metadata 2105 2106 @recipient_type_metadata.setter 2107 def recipient_type_metadata(self, recipient_type_metadata): 2108 """Sets the recipient_type_metadata of this Witness. 2109 2110 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 2111 2112 :param recipient_type_metadata: The recipient_type_metadata of this Witness. # noqa: E501 2113 :type: PropertyMetadata 2114 """ 2115 2116 self._recipient_type_metadata = recipient_type_metadata 2117 2118 @property 2119 def require_id_lookup(self): 2120 """Gets the require_id_lookup of this Witness. # noqa: E501 2121 2122 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 2123 2124 :return: The require_id_lookup of this Witness. # noqa: E501 2125 :rtype: str 2126 """ 2127 return self._require_id_lookup 2128 2129 @require_id_lookup.setter 2130 def require_id_lookup(self, require_id_lookup): 2131 """Sets the require_id_lookup of this Witness. 2132 2133 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 2134 2135 :param require_id_lookup: The require_id_lookup of this Witness. # noqa: E501 2136 :type: str 2137 """ 2138 2139 self._require_id_lookup = require_id_lookup 2140 2141 @property 2142 def require_id_lookup_metadata(self): 2143 """Gets the require_id_lookup_metadata of this Witness. # noqa: E501 2144 2145 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 2146 2147 :return: The require_id_lookup_metadata of this Witness. # noqa: E501 2148 :rtype: PropertyMetadata 2149 """ 2150 return self._require_id_lookup_metadata 2151 2152 @require_id_lookup_metadata.setter 2153 def require_id_lookup_metadata(self, require_id_lookup_metadata): 2154 """Sets the require_id_lookup_metadata of this Witness. 2155 2156 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 2157 2158 :param require_id_lookup_metadata: The require_id_lookup_metadata of this Witness. # noqa: E501 2159 :type: PropertyMetadata 2160 """ 2161 2162 self._require_id_lookup_metadata = require_id_lookup_metadata 2163 2164 @property 2165 def require_signer_certificate(self): 2166 """Gets the require_signer_certificate of this Witness. # noqa: E501 2167 2168 # noqa: E501 2169 2170 :return: The require_signer_certificate of this Witness. # noqa: E501 2171 :rtype: str 2172 """ 2173 return self._require_signer_certificate 2174 2175 @require_signer_certificate.setter 2176 def require_signer_certificate(self, require_signer_certificate): 2177 """Sets the require_signer_certificate of this Witness. 2178 2179 # noqa: E501 2180 2181 :param require_signer_certificate: The require_signer_certificate of this Witness. # noqa: E501 2182 :type: str 2183 """ 2184 2185 self._require_signer_certificate = require_signer_certificate 2186 2187 @property 2188 def require_sign_on_paper(self): 2189 """Gets the require_sign_on_paper of this Witness. # noqa: E501 2190 2191 # noqa: E501 2192 2193 :return: The require_sign_on_paper of this Witness. # noqa: E501 2194 :rtype: str 2195 """ 2196 return self._require_sign_on_paper 2197 2198 @require_sign_on_paper.setter 2199 def require_sign_on_paper(self, require_sign_on_paper): 2200 """Sets the require_sign_on_paper of this Witness. 2201 2202 # noqa: E501 2203 2204 :param require_sign_on_paper: The require_sign_on_paper of this Witness. # noqa: E501 2205 :type: str 2206 """ 2207 2208 self._require_sign_on_paper = require_sign_on_paper 2209 2210 @property 2211 def require_upload_signature(self): 2212 """Gets the require_upload_signature of this Witness. # noqa: E501 2213 2214 # noqa: E501 2215 2216 :return: The require_upload_signature of this Witness. # noqa: E501 2217 :rtype: str 2218 """ 2219 return self._require_upload_signature 2220 2221 @require_upload_signature.setter 2222 def require_upload_signature(self, require_upload_signature): 2223 """Sets the require_upload_signature of this Witness. 2224 2225 # noqa: E501 2226 2227 :param require_upload_signature: The require_upload_signature of this Witness. # noqa: E501 2228 :type: str 2229 """ 2230 2231 self._require_upload_signature = require_upload_signature 2232 2233 @property 2234 def role_name(self): 2235 """Gets the role_name of this Witness. # noqa: E501 2236 2237 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 2238 2239 :return: The role_name of this Witness. # noqa: E501 2240 :rtype: str 2241 """ 2242 return self._role_name 2243 2244 @role_name.setter 2245 def role_name(self, role_name): 2246 """Sets the role_name of this Witness. 2247 2248 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 2249 2250 :param role_name: The role_name of this Witness. # noqa: E501 2251 :type: str 2252 """ 2253 2254 self._role_name = role_name 2255 2256 @property 2257 def routing_order(self): 2258 """Gets the routing_order of this Witness. # noqa: E501 2259 2260 Specifies the routing order of the recipient in the envelope. # noqa: E501 2261 2262 :return: The routing_order of this Witness. # noqa: E501 2263 :rtype: str 2264 """ 2265 return self._routing_order 2266 2267 @routing_order.setter 2268 def routing_order(self, routing_order): 2269 """Sets the routing_order of this Witness. 2270 2271 Specifies the routing order of the recipient in the envelope. # noqa: E501 2272 2273 :param routing_order: The routing_order of this Witness. # noqa: E501 2274 :type: str 2275 """ 2276 2277 self._routing_order = routing_order 2278 2279 @property 2280 def routing_order_metadata(self): 2281 """Gets the routing_order_metadata of this Witness. # noqa: E501 2282 2283 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 2284 2285 :return: The routing_order_metadata of this Witness. # noqa: E501 2286 :rtype: PropertyMetadata 2287 """ 2288 return self._routing_order_metadata 2289 2290 @routing_order_metadata.setter 2291 def routing_order_metadata(self, routing_order_metadata): 2292 """Sets the routing_order_metadata of this Witness. 2293 2294 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 2295 2296 :param routing_order_metadata: The routing_order_metadata of this Witness. # noqa: E501 2297 :type: PropertyMetadata 2298 """ 2299 2300 self._routing_order_metadata = routing_order_metadata 2301 2302 @property 2303 def sent_date_time(self): 2304 """Gets the sent_date_time of this Witness. # noqa: E501 2305 2306 The date and time the envelope was sent. # noqa: E501 2307 2308 :return: The sent_date_time of this Witness. # noqa: E501 2309 :rtype: str 2310 """ 2311 return self._sent_date_time 2312 2313 @sent_date_time.setter 2314 def sent_date_time(self, sent_date_time): 2315 """Sets the sent_date_time of this Witness. 2316 2317 The date and time the envelope was sent. # noqa: E501 2318 2319 :param sent_date_time: The sent_date_time of this Witness. # noqa: E501 2320 :type: str 2321 """ 2322 2323 self._sent_date_time = sent_date_time 2324 2325 @property 2326 def signature_info(self): 2327 """Gets the signature_info of this Witness. # noqa: E501 2328 2329 Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501 2330 2331 :return: The signature_info of this Witness. # noqa: E501 2332 :rtype: RecipientSignatureInformation 2333 """ 2334 return self._signature_info 2335 2336 @signature_info.setter 2337 def signature_info(self, signature_info): 2338 """Sets the signature_info of this Witness. 2339 2340 Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501 2341 2342 :param signature_info: The signature_info of this Witness. # noqa: E501 2343 :type: RecipientSignatureInformation 2344 """ 2345 2346 self._signature_info = signature_info 2347 2348 @property 2349 def signed_date_time(self): 2350 """Gets the signed_date_time of this Witness. # noqa: E501 2351 2352 Reserved: For DocuSign use only. # noqa: E501 2353 2354 :return: The signed_date_time of this Witness. # noqa: E501 2355 :rtype: str 2356 """ 2357 return self._signed_date_time 2358 2359 @signed_date_time.setter 2360 def signed_date_time(self, signed_date_time): 2361 """Sets the signed_date_time of this Witness. 2362 2363 Reserved: For DocuSign use only. # noqa: E501 2364 2365 :param signed_date_time: The signed_date_time of this Witness. # noqa: E501 2366 :type: str 2367 """ 2368 2369 self._signed_date_time = signed_date_time 2370 2371 @property 2372 def sign_in_each_location(self): 2373 """Gets the sign_in_each_location of this Witness. # noqa: E501 2374 2375 When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 2376 2377 :return: The sign_in_each_location of this Witness. # noqa: E501 2378 :rtype: str 2379 """ 2380 return self._sign_in_each_location 2381 2382 @sign_in_each_location.setter 2383 def sign_in_each_location(self, sign_in_each_location): 2384 """Sets the sign_in_each_location of this Witness. 2385 2386 When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 2387 2388 :param sign_in_each_location: The sign_in_each_location of this Witness. # noqa: E501 2389 :type: str 2390 """ 2391 2392 self._sign_in_each_location = sign_in_each_location 2393 2394 @property 2395 def sign_in_each_location_metadata(self): 2396 """Gets the sign_in_each_location_metadata of this Witness. # noqa: E501 2397 2398 Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. # noqa: E501 2399 2400 :return: The sign_in_each_location_metadata of this Witness. # noqa: E501 2401 :rtype: PropertyMetadata 2402 """ 2403 return self._sign_in_each_location_metadata 2404 2405 @sign_in_each_location_metadata.setter 2406 def sign_in_each_location_metadata(self, sign_in_each_location_metadata): 2407 """Sets the sign_in_each_location_metadata of this Witness. 2408 2409 Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. # noqa: E501 2410 2411 :param sign_in_each_location_metadata: The sign_in_each_location_metadata of this Witness. # noqa: E501 2412 :type: PropertyMetadata 2413 """ 2414 2415 self._sign_in_each_location_metadata = sign_in_each_location_metadata 2416 2417 @property 2418 def signing_group_id(self): 2419 """Gets the signing_group_id of this Witness. # noqa: E501 2420 2421 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 2422 2423 :return: The signing_group_id of this Witness. # noqa: E501 2424 :rtype: str 2425 """ 2426 return self._signing_group_id 2427 2428 @signing_group_id.setter 2429 def signing_group_id(self, signing_group_id): 2430 """Sets the signing_group_id of this Witness. 2431 2432 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 2433 2434 :param signing_group_id: The signing_group_id of this Witness. # noqa: E501 2435 :type: str 2436 """ 2437 2438 self._signing_group_id = signing_group_id 2439 2440 @property 2441 def signing_group_id_metadata(self): 2442 """Gets the signing_group_id_metadata of this Witness. # noqa: E501 2443 2444 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 2445 2446 :return: The signing_group_id_metadata of this Witness. # noqa: E501 2447 :rtype: PropertyMetadata 2448 """ 2449 return self._signing_group_id_metadata 2450 2451 @signing_group_id_metadata.setter 2452 def signing_group_id_metadata(self, signing_group_id_metadata): 2453 """Sets the signing_group_id_metadata of this Witness. 2454 2455 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 2456 2457 :param signing_group_id_metadata: The signing_group_id_metadata of this Witness. # noqa: E501 2458 :type: PropertyMetadata 2459 """ 2460 2461 self._signing_group_id_metadata = signing_group_id_metadata 2462 2463 @property 2464 def signing_group_name(self): 2465 """Gets the signing_group_name of this Witness. # noqa: E501 2466 2467 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 2468 2469 :return: The signing_group_name of this Witness. # noqa: E501 2470 :rtype: str 2471 """ 2472 return self._signing_group_name 2473 2474 @signing_group_name.setter 2475 def signing_group_name(self, signing_group_name): 2476 """Sets the signing_group_name of this Witness. 2477 2478 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 2479 2480 :param signing_group_name: The signing_group_name of this Witness. # noqa: E501 2481 :type: str 2482 """ 2483 2484 self._signing_group_name = signing_group_name 2485 2486 @property 2487 def signing_group_type(self): 2488 """Gets the signing_group_type of this Witness. # noqa: E501 2489 2490 # noqa: E501 2491 2492 :return: The signing_group_type of this Witness. # noqa: E501 2493 :rtype: str 2494 """ 2495 return self._signing_group_type 2496 2497 @signing_group_type.setter 2498 def signing_group_type(self, signing_group_type): 2499 """Sets the signing_group_type of this Witness. 2500 2501 # noqa: E501 2502 2503 :param signing_group_type: The signing_group_type of this Witness. # noqa: E501 2504 :type: str 2505 """ 2506 2507 self._signing_group_type = signing_group_type 2508 2509 @property 2510 def signing_group_users(self): 2511 """Gets the signing_group_users of this Witness. # noqa: E501 2512 2513 A complex type that contains information about users in the signing group. # noqa: E501 2514 2515 :return: The signing_group_users of this Witness. # noqa: E501 2516 :rtype: list[UserInfo] 2517 """ 2518 return self._signing_group_users 2519 2520 @signing_group_users.setter 2521 def signing_group_users(self, signing_group_users): 2522 """Sets the signing_group_users of this Witness. 2523 2524 A complex type that contains information about users in the signing group. # noqa: E501 2525 2526 :param signing_group_users: The signing_group_users of this Witness. # noqa: E501 2527 :type: list[UserInfo] 2528 """ 2529 2530 self._signing_group_users = signing_group_users 2531 2532 @property 2533 def sms_authentication(self): 2534 """Gets the sms_authentication of this Witness. # noqa: E501 2535 2536 When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501 2537 2538 :return: The sms_authentication of this Witness. # noqa: E501 2539 :rtype: RecipientSMSAuthentication 2540 """ 2541 return self._sms_authentication 2542 2543 @sms_authentication.setter 2544 def sms_authentication(self, sms_authentication): 2545 """Sets the sms_authentication of this Witness. 2546 2547 When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501 2548 2549 :param sms_authentication: The sms_authentication of this Witness. # noqa: E501 2550 :type: RecipientSMSAuthentication 2551 """ 2552 2553 self._sms_authentication = sms_authentication 2554 2555 @property 2556 def social_authentications(self): 2557 """Gets the social_authentications of this Witness. # noqa: E501 2558 2559 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2560 2561 :return: The social_authentications of this Witness. # noqa: E501 2562 :rtype: list[SocialAuthentication] 2563 """ 2564 return self._social_authentications 2565 2566 @social_authentications.setter 2567 def social_authentications(self, social_authentications): 2568 """Sets the social_authentications of this Witness. 2569 2570 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2571 2572 :param social_authentications: The social_authentications of this Witness. # noqa: E501 2573 :type: list[SocialAuthentication] 2574 """ 2575 2576 self._social_authentications = social_authentications 2577 2578 @property 2579 def status(self): 2580 """Gets the status of this Witness. # noqa: E501 2581 2582 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 2583 2584 :return: The status of this Witness. # noqa: E501 2585 :rtype: str 2586 """ 2587 return self._status 2588 2589 @status.setter 2590 def status(self, status): 2591 """Sets the status of this Witness. 2592 2593 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 2594 2595 :param status: The status of this Witness. # noqa: E501 2596 :type: str 2597 """ 2598 2599 self._status = status 2600 2601 @property 2602 def status_code(self): 2603 """Gets the status_code of this Witness. # noqa: E501 2604 2605 # noqa: E501 2606 2607 :return: The status_code of this Witness. # noqa: E501 2608 :rtype: str 2609 """ 2610 return self._status_code 2611 2612 @status_code.setter 2613 def status_code(self, status_code): 2614 """Sets the status_code of this Witness. 2615 2616 # noqa: E501 2617 2618 :param status_code: The status_code of this Witness. # noqa: E501 2619 :type: str 2620 """ 2621 2622 self._status_code = status_code 2623 2624 @property 2625 def suppress_emails(self): 2626 """Gets the suppress_emails of this Witness. # noqa: E501 2627 2628 # noqa: E501 2629 2630 :return: The suppress_emails of this Witness. # noqa: E501 2631 :rtype: str 2632 """ 2633 return self._suppress_emails 2634 2635 @suppress_emails.setter 2636 def suppress_emails(self, suppress_emails): 2637 """Sets the suppress_emails of this Witness. 2638 2639 # noqa: E501 2640 2641 :param suppress_emails: The suppress_emails of this Witness. # noqa: E501 2642 :type: str 2643 """ 2644 2645 self._suppress_emails = suppress_emails 2646 2647 @property 2648 def tabs(self): 2649 """Gets the tabs of this Witness. # noqa: E501 2650 2651 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 2652 2653 :return: The tabs of this Witness. # noqa: E501 2654 :rtype: Tabs 2655 """ 2656 return self._tabs 2657 2658 @tabs.setter 2659 def tabs(self, tabs): 2660 """Sets the tabs of this Witness. 2661 2662 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 2663 2664 :param tabs: The tabs of this Witness. # noqa: E501 2665 :type: Tabs 2666 """ 2667 2668 self._tabs = tabs 2669 2670 @property 2671 def template_locked(self): 2672 """Gets the template_locked of this Witness. # noqa: E501 2673 2674 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2675 2676 :return: The template_locked of this Witness. # noqa: E501 2677 :rtype: str 2678 """ 2679 return self._template_locked 2680 2681 @template_locked.setter 2682 def template_locked(self, template_locked): 2683 """Sets the template_locked of this Witness. 2684 2685 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2686 2687 :param template_locked: The template_locked of this Witness. # noqa: E501 2688 :type: str 2689 """ 2690 2691 self._template_locked = template_locked 2692 2693 @property 2694 def template_required(self): 2695 """Gets the template_required of this Witness. # noqa: E501 2696 2697 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2698 2699 :return: The template_required of this Witness. # noqa: E501 2700 :rtype: str 2701 """ 2702 return self._template_required 2703 2704 @template_required.setter 2705 def template_required(self, template_required): 2706 """Sets the template_required of this Witness. 2707 2708 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2709 2710 :param template_required: The template_required of this Witness. # noqa: E501 2711 :type: str 2712 """ 2713 2714 self._template_required = template_required 2715 2716 @property 2717 def total_tab_count(self): 2718 """Gets the total_tab_count of this Witness. # noqa: E501 2719 2720 # noqa: E501 2721 2722 :return: The total_tab_count of this Witness. # noqa: E501 2723 :rtype: str 2724 """ 2725 return self._total_tab_count 2726 2727 @total_tab_count.setter 2728 def total_tab_count(self, total_tab_count): 2729 """Sets the total_tab_count of this Witness. 2730 2731 # noqa: E501 2732 2733 :param total_tab_count: The total_tab_count of this Witness. # noqa: E501 2734 :type: str 2735 """ 2736 2737 self._total_tab_count = total_tab_count 2738 2739 @property 2740 def user_id(self): 2741 """Gets the user_id of this Witness. # noqa: E501 2742 2743 # noqa: E501 2744 2745 :return: The user_id of this Witness. # noqa: E501 2746 :rtype: str 2747 """ 2748 return self._user_id 2749 2750 @user_id.setter 2751 def user_id(self, user_id): 2752 """Sets the user_id of this Witness. 2753 2754 # noqa: E501 2755 2756 :param user_id: The user_id of this Witness. # noqa: E501 2757 :type: str 2758 """ 2759 2760 self._user_id = user_id 2761 2762 @property 2763 def web_form_recipient_view_id(self): 2764 """Gets the web_form_recipient_view_id of this Witness. # noqa: E501 2765 2766 # noqa: E501 2767 2768 :return: The web_form_recipient_view_id of this Witness. # noqa: E501 2769 :rtype: str 2770 """ 2771 return self._web_form_recipient_view_id 2772 2773 @web_form_recipient_view_id.setter 2774 def web_form_recipient_view_id(self, web_form_recipient_view_id): 2775 """Sets the web_form_recipient_view_id of this Witness. 2776 2777 # noqa: E501 2778 2779 :param web_form_recipient_view_id: The web_form_recipient_view_id of this Witness. # noqa: E501 2780 :type: str 2781 """ 2782 2783 self._web_form_recipient_view_id = web_form_recipient_view_id 2784 2785 @property 2786 def witness_for(self): 2787 """Gets the witness_for of this Witness. # noqa: E501 2788 2789 # noqa: E501 2790 2791 :return: The witness_for of this Witness. # noqa: E501 2792 :rtype: str 2793 """ 2794 return self._witness_for 2795 2796 @witness_for.setter 2797 def witness_for(self, witness_for): 2798 """Sets the witness_for of this Witness. 2799 2800 # noqa: E501 2801 2802 :param witness_for: The witness_for of this Witness. # noqa: E501 2803 :type: str 2804 """ 2805 2806 self._witness_for = witness_for 2807 2808 @property 2809 def witness_for_guid(self): 2810 """Gets the witness_for_guid of this Witness. # noqa: E501 2811 2812 # noqa: E501 2813 2814 :return: The witness_for_guid of this Witness. # noqa: E501 2815 :rtype: str 2816 """ 2817 return self._witness_for_guid 2818 2819 @witness_for_guid.setter 2820 def witness_for_guid(self, witness_for_guid): 2821 """Sets the witness_for_guid of this Witness. 2822 2823 # noqa: E501 2824 2825 :param witness_for_guid: The witness_for_guid of this Witness. # noqa: E501 2826 :type: str 2827 """ 2828 2829 self._witness_for_guid = witness_for_guid 2830 2831 def to_dict(self): 2832 """Returns the model properties as a dict""" 2833 result = {} 2834 2835 for attr, _ in six.iteritems(self.swagger_types): 2836 value = getattr(self, attr) 2837 if isinstance(value, list): 2838 result[attr] = list(map( 2839 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2840 value 2841 )) 2842 elif hasattr(value, "to_dict"): 2843 result[attr] = value.to_dict() 2844 elif isinstance(value, dict): 2845 result[attr] = dict(map( 2846 lambda item: (item[0], item[1].to_dict()) 2847 if hasattr(item[1], "to_dict") else item, 2848 value.items() 2849 )) 2850 else: 2851 result[attr] = value 2852 if issubclass(Witness, dict): 2853 for key, value in self.items(): 2854 result[key] = value 2855 2856 return result 2857 2858 def to_str(self): 2859 """Returns the string representation of the model""" 2860 return pprint.pformat(self.to_dict()) 2861 2862 def __repr__(self): 2863 """For `print` and `pprint`""" 2864 return self.to_str() 2865 2866 def __eq__(self, other): 2867 """Returns true if both objects are equal""" 2868 if not isinstance(other, Witness): 2869 return False 2870 2871 return self.to_dict() == other.to_dict() 2872 2873 def __ne__(self, other): 2874 """Returns true if both objects are not equal""" 2875 if not isinstance(other, Witness): 2876 return True 2877 2878 return self.to_dict() != other.to_dict()
class
Witness:
23class Witness(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'access_code': 'str', 38 'access_code_metadata': 'PropertyMetadata', 39 'add_access_code_to_email': 'str', 40 'additional_notifications': 'list[RecipientAdditionalNotification]', 41 'agent_can_edit_email': 'str', 42 'agent_can_edit_name': 'str', 43 'allow_system_override_for_locked_recipient': 'str', 44 'auto_navigation': 'str', 45 'auto_responded_reason': 'str', 46 'bulk_recipients_uri': 'str', 47 'bulk_send_v2_recipient': 'str', 48 'can_sign_offline': 'str', 49 'client_user_id': 'str', 50 'completed_count': 'str', 51 'consent_details_list': 'list[ConsentDetails]', 52 'creation_reason': 'str', 53 'custom_fields': 'list[str]', 54 'declined_date_time': 'str', 55 'declined_reason': 'str', 56 'default_recipient': 'str', 57 'delegated_by': 'DelegationInfo', 58 'delegated_to': 'list[DelegationInfo]', 59 'delivered_date_time': 'str', 60 'delivery_method': 'str', 61 'delivery_method_metadata': 'PropertyMetadata', 62 'designator_id': 'str', 63 'designator_id_guid': 'str', 64 'document_template_id': 'str', 65 'document_visibility': 'list[DocumentVisibility]', 66 'email': 'str', 67 'email_metadata': 'PropertyMetadata', 68 'email_notification': 'RecipientEmailNotification', 69 'email_recipient_post_signing_url': 'str', 70 'embedded_recipient_start_url': 'str', 71 'error_details': 'ErrorDetails', 72 'excluded_documents': 'list[str]', 73 'fax_number': 'str', 74 'fax_number_metadata': 'PropertyMetadata', 75 'first_name': 'str', 76 'first_name_metadata': 'PropertyMetadata', 77 'full_name': 'str', 78 'full_name_metadata': 'PropertyMetadata', 79 'id_check_configuration_name': 'str', 80 'id_check_configuration_name_metadata': 'PropertyMetadata', 81 'id_check_information_input': 'IdCheckInformationInput', 82 'identity_verification': 'RecipientIdentityVerification', 83 'inherit_email_notification_configuration': 'str', 84 'is_bulk_recipient': 'str', 85 'is_bulk_recipient_metadata': 'PropertyMetadata', 86 'last_name': 'str', 87 'last_name_metadata': 'PropertyMetadata', 88 'locked_recipient_phone_auth_editable': 'str', 89 'locked_recipient_sms_editable': 'str', 90 'name': 'str', 91 'name_metadata': 'PropertyMetadata', 92 'notary_id': 'str', 93 'notary_signer_email_sent': 'str', 94 'note': 'str', 95 'note_metadata': 'PropertyMetadata', 96 'offline_attributes': 'OfflineAttributes', 97 'phone_authentication': 'RecipientPhoneAuthentication', 98 'phone_number': 'RecipientPhoneNumber', 99 'proof_file': 'RecipientProofFile', 100 'recipient_attachments': 'list[RecipientAttachment]', 101 'recipient_authentication_status': 'AuthenticationStatus', 102 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 103 'recipient_id': 'str', 104 'recipient_id_guid': 'str', 105 'recipient_signature_providers': 'list[RecipientSignatureProvider]', 106 'recipient_supplies_tabs': 'str', 107 'recipient_type': 'str', 108 'recipient_type_metadata': 'PropertyMetadata', 109 'require_id_lookup': 'str', 110 'require_id_lookup_metadata': 'PropertyMetadata', 111 'require_signer_certificate': 'str', 112 'require_sign_on_paper': 'str', 113 'require_upload_signature': 'str', 114 'role_name': 'str', 115 'routing_order': 'str', 116 'routing_order_metadata': 'PropertyMetadata', 117 'sent_date_time': 'str', 118 'signature_info': 'RecipientSignatureInformation', 119 'signed_date_time': 'str', 120 'sign_in_each_location': 'str', 121 'sign_in_each_location_metadata': 'PropertyMetadata', 122 'signing_group_id': 'str', 123 'signing_group_id_metadata': 'PropertyMetadata', 124 'signing_group_name': 'str', 125 'signing_group_type': 'str', 126 'signing_group_users': 'list[UserInfo]', 127 'sms_authentication': 'RecipientSMSAuthentication', 128 'social_authentications': 'list[SocialAuthentication]', 129 'status': 'str', 130 'status_code': 'str', 131 'suppress_emails': 'str', 132 'tabs': 'Tabs', 133 'template_locked': 'str', 134 'template_required': 'str', 135 'total_tab_count': 'str', 136 'user_id': 'str', 137 'web_form_recipient_view_id': 'str', 138 'witness_for': 'str', 139 'witness_for_guid': 'str' 140 } 141 142 attribute_map = { 143 'access_code': 'accessCode', 144 'access_code_metadata': 'accessCodeMetadata', 145 'add_access_code_to_email': 'addAccessCodeToEmail', 146 'additional_notifications': 'additionalNotifications', 147 'agent_can_edit_email': 'agentCanEditEmail', 148 'agent_can_edit_name': 'agentCanEditName', 149 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 150 'auto_navigation': 'autoNavigation', 151 'auto_responded_reason': 'autoRespondedReason', 152 'bulk_recipients_uri': 'bulkRecipientsUri', 153 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 154 'can_sign_offline': 'canSignOffline', 155 'client_user_id': 'clientUserId', 156 'completed_count': 'completedCount', 157 'consent_details_list': 'consentDetailsList', 158 'creation_reason': 'creationReason', 159 'custom_fields': 'customFields', 160 'declined_date_time': 'declinedDateTime', 161 'declined_reason': 'declinedReason', 162 'default_recipient': 'defaultRecipient', 163 'delegated_by': 'delegatedBy', 164 'delegated_to': 'delegatedTo', 165 'delivered_date_time': 'deliveredDateTime', 166 'delivery_method': 'deliveryMethod', 167 'delivery_method_metadata': 'deliveryMethodMetadata', 168 'designator_id': 'designatorId', 169 'designator_id_guid': 'designatorIdGuid', 170 'document_template_id': 'documentTemplateId', 171 'document_visibility': 'documentVisibility', 172 'email': 'email', 173 'email_metadata': 'emailMetadata', 174 'email_notification': 'emailNotification', 175 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 176 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 177 'error_details': 'errorDetails', 178 'excluded_documents': 'excludedDocuments', 179 'fax_number': 'faxNumber', 180 'fax_number_metadata': 'faxNumberMetadata', 181 'first_name': 'firstName', 182 'first_name_metadata': 'firstNameMetadata', 183 'full_name': 'fullName', 184 'full_name_metadata': 'fullNameMetadata', 185 'id_check_configuration_name': 'idCheckConfigurationName', 186 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 187 'id_check_information_input': 'idCheckInformationInput', 188 'identity_verification': 'identityVerification', 189 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 190 'is_bulk_recipient': 'isBulkRecipient', 191 'is_bulk_recipient_metadata': 'isBulkRecipientMetadata', 192 'last_name': 'lastName', 193 'last_name_metadata': 'lastNameMetadata', 194 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 195 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 196 'name': 'name', 197 'name_metadata': 'nameMetadata', 198 'notary_id': 'notaryId', 199 'notary_signer_email_sent': 'notarySignerEmailSent', 200 'note': 'note', 201 'note_metadata': 'noteMetadata', 202 'offline_attributes': 'offlineAttributes', 203 'phone_authentication': 'phoneAuthentication', 204 'phone_number': 'phoneNumber', 205 'proof_file': 'proofFile', 206 'recipient_attachments': 'recipientAttachments', 207 'recipient_authentication_status': 'recipientAuthenticationStatus', 208 'recipient_feature_metadata': 'recipientFeatureMetadata', 209 'recipient_id': 'recipientId', 210 'recipient_id_guid': 'recipientIdGuid', 211 'recipient_signature_providers': 'recipientSignatureProviders', 212 'recipient_supplies_tabs': 'recipientSuppliesTabs', 213 'recipient_type': 'recipientType', 214 'recipient_type_metadata': 'recipientTypeMetadata', 215 'require_id_lookup': 'requireIdLookup', 216 'require_id_lookup_metadata': 'requireIdLookupMetadata', 217 'require_signer_certificate': 'requireSignerCertificate', 218 'require_sign_on_paper': 'requireSignOnPaper', 219 'require_upload_signature': 'requireUploadSignature', 220 'role_name': 'roleName', 221 'routing_order': 'routingOrder', 222 'routing_order_metadata': 'routingOrderMetadata', 223 'sent_date_time': 'sentDateTime', 224 'signature_info': 'signatureInfo', 225 'signed_date_time': 'signedDateTime', 226 'sign_in_each_location': 'signInEachLocation', 227 'sign_in_each_location_metadata': 'signInEachLocationMetadata', 228 'signing_group_id': 'signingGroupId', 229 'signing_group_id_metadata': 'signingGroupIdMetadata', 230 'signing_group_name': 'signingGroupName', 231 'signing_group_type': 'signingGroupType', 232 'signing_group_users': 'signingGroupUsers', 233 'sms_authentication': 'smsAuthentication', 234 'social_authentications': 'socialAuthentications', 235 'status': 'status', 236 'status_code': 'statusCode', 237 'suppress_emails': 'suppressEmails', 238 'tabs': 'tabs', 239 'template_locked': 'templateLocked', 240 'template_required': 'templateRequired', 241 'total_tab_count': 'totalTabCount', 242 'user_id': 'userId', 243 'web_form_recipient_view_id': 'webFormRecipientViewId', 244 'witness_for': 'witnessFor', 245 'witness_for_guid': 'witnessForGuid' 246 } 247 248 def __init__(self, _configuration=None, **kwargs): # noqa: E501 249 """Witness - a model defined in Swagger""" # noqa: E501 250 if _configuration is None: 251 _configuration = Configuration() 252 self._configuration = _configuration 253 254 self._access_code = None 255 self._access_code_metadata = None 256 self._add_access_code_to_email = None 257 self._additional_notifications = None 258 self._agent_can_edit_email = None 259 self._agent_can_edit_name = None 260 self._allow_system_override_for_locked_recipient = None 261 self._auto_navigation = None 262 self._auto_responded_reason = None 263 self._bulk_recipients_uri = None 264 self._bulk_send_v2_recipient = None 265 self._can_sign_offline = None 266 self._client_user_id = None 267 self._completed_count = None 268 self._consent_details_list = None 269 self._creation_reason = None 270 self._custom_fields = None 271 self._declined_date_time = None 272 self._declined_reason = None 273 self._default_recipient = None 274 self._delegated_by = None 275 self._delegated_to = None 276 self._delivered_date_time = None 277 self._delivery_method = None 278 self._delivery_method_metadata = None 279 self._designator_id = None 280 self._designator_id_guid = None 281 self._document_template_id = None 282 self._document_visibility = None 283 self._email = None 284 self._email_metadata = None 285 self._email_notification = None 286 self._email_recipient_post_signing_url = None 287 self._embedded_recipient_start_url = None 288 self._error_details = None 289 self._excluded_documents = None 290 self._fax_number = None 291 self._fax_number_metadata = None 292 self._first_name = None 293 self._first_name_metadata = None 294 self._full_name = None 295 self._full_name_metadata = None 296 self._id_check_configuration_name = None 297 self._id_check_configuration_name_metadata = None 298 self._id_check_information_input = None 299 self._identity_verification = None 300 self._inherit_email_notification_configuration = None 301 self._is_bulk_recipient = None 302 self._is_bulk_recipient_metadata = None 303 self._last_name = None 304 self._last_name_metadata = None 305 self._locked_recipient_phone_auth_editable = None 306 self._locked_recipient_sms_editable = None 307 self._name = None 308 self._name_metadata = None 309 self._notary_id = None 310 self._notary_signer_email_sent = None 311 self._note = None 312 self._note_metadata = None 313 self._offline_attributes = None 314 self._phone_authentication = None 315 self._phone_number = None 316 self._proof_file = None 317 self._recipient_attachments = None 318 self._recipient_authentication_status = None 319 self._recipient_feature_metadata = None 320 self._recipient_id = None 321 self._recipient_id_guid = None 322 self._recipient_signature_providers = None 323 self._recipient_supplies_tabs = None 324 self._recipient_type = None 325 self._recipient_type_metadata = None 326 self._require_id_lookup = None 327 self._require_id_lookup_metadata = None 328 self._require_signer_certificate = None 329 self._require_sign_on_paper = None 330 self._require_upload_signature = None 331 self._role_name = None 332 self._routing_order = None 333 self._routing_order_metadata = None 334 self._sent_date_time = None 335 self._signature_info = None 336 self._signed_date_time = None 337 self._sign_in_each_location = None 338 self._sign_in_each_location_metadata = None 339 self._signing_group_id = None 340 self._signing_group_id_metadata = None 341 self._signing_group_name = None 342 self._signing_group_type = None 343 self._signing_group_users = None 344 self._sms_authentication = None 345 self._social_authentications = None 346 self._status = None 347 self._status_code = None 348 self._suppress_emails = None 349 self._tabs = None 350 self._template_locked = None 351 self._template_required = None 352 self._total_tab_count = None 353 self._user_id = None 354 self._web_form_recipient_view_id = None 355 self._witness_for = None 356 self._witness_for_guid = None 357 self.discriminator = None 358 359 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 360 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 361 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 362 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 363 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 364 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 365 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 366 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 367 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 368 setattr(self, "_{}".format('bulk_recipients_uri'), kwargs.get('bulk_recipients_uri', None)) 369 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 370 setattr(self, "_{}".format('can_sign_offline'), kwargs.get('can_sign_offline', None)) 371 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 372 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 373 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 374 setattr(self, "_{}".format('creation_reason'), kwargs.get('creation_reason', None)) 375 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 376 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 377 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 378 setattr(self, "_{}".format('default_recipient'), kwargs.get('default_recipient', None)) 379 setattr(self, "_{}".format('delegated_by'), kwargs.get('delegated_by', None)) 380 setattr(self, "_{}".format('delegated_to'), kwargs.get('delegated_to', None)) 381 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 382 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 383 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 384 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 385 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 386 setattr(self, "_{}".format('document_template_id'), kwargs.get('document_template_id', None)) 387 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 388 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 389 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 390 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 391 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 392 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 393 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 394 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 395 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 396 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 397 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 398 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 399 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 400 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 401 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 402 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 403 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 404 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 405 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 406 setattr(self, "_{}".format('is_bulk_recipient'), kwargs.get('is_bulk_recipient', None)) 407 setattr(self, "_{}".format('is_bulk_recipient_metadata'), kwargs.get('is_bulk_recipient_metadata', None)) 408 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 409 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 410 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 411 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 412 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 413 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 414 setattr(self, "_{}".format('notary_id'), kwargs.get('notary_id', None)) 415 setattr(self, "_{}".format('notary_signer_email_sent'), kwargs.get('notary_signer_email_sent', None)) 416 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 417 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 418 setattr(self, "_{}".format('offline_attributes'), kwargs.get('offline_attributes', None)) 419 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 420 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 421 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 422 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 423 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 424 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 425 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 426 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 427 setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None)) 428 setattr(self, "_{}".format('recipient_supplies_tabs'), kwargs.get('recipient_supplies_tabs', None)) 429 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 430 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 431 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 432 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 433 setattr(self, "_{}".format('require_signer_certificate'), kwargs.get('require_signer_certificate', None)) 434 setattr(self, "_{}".format('require_sign_on_paper'), kwargs.get('require_sign_on_paper', None)) 435 setattr(self, "_{}".format('require_upload_signature'), kwargs.get('require_upload_signature', None)) 436 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 437 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 438 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 439 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 440 setattr(self, "_{}".format('signature_info'), kwargs.get('signature_info', None)) 441 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 442 setattr(self, "_{}".format('sign_in_each_location'), kwargs.get('sign_in_each_location', None)) 443 setattr(self, "_{}".format('sign_in_each_location_metadata'), kwargs.get('sign_in_each_location_metadata', None)) 444 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 445 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 446 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 447 setattr(self, "_{}".format('signing_group_type'), kwargs.get('signing_group_type', None)) 448 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 449 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 450 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 451 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 452 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 453 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 454 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 455 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 456 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 457 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 458 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 459 setattr(self, "_{}".format('web_form_recipient_view_id'), kwargs.get('web_form_recipient_view_id', None)) 460 setattr(self, "_{}".format('witness_for'), kwargs.get('witness_for', None)) 461 setattr(self, "_{}".format('witness_for_guid'), kwargs.get('witness_for_guid', None)) 462 463 @property 464 def access_code(self): 465 """Gets the access_code of this Witness. # noqa: E501 466 467 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 468 469 :return: The access_code of this Witness. # noqa: E501 470 :rtype: str 471 """ 472 return self._access_code 473 474 @access_code.setter 475 def access_code(self, access_code): 476 """Sets the access_code of this Witness. 477 478 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 479 480 :param access_code: The access_code of this Witness. # noqa: E501 481 :type: str 482 """ 483 484 self._access_code = access_code 485 486 @property 487 def access_code_metadata(self): 488 """Gets the access_code_metadata of this Witness. # noqa: E501 489 490 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 491 492 :return: The access_code_metadata of this Witness. # noqa: E501 493 :rtype: PropertyMetadata 494 """ 495 return self._access_code_metadata 496 497 @access_code_metadata.setter 498 def access_code_metadata(self, access_code_metadata): 499 """Sets the access_code_metadata of this Witness. 500 501 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 502 503 :param access_code_metadata: The access_code_metadata of this Witness. # noqa: E501 504 :type: PropertyMetadata 505 """ 506 507 self._access_code_metadata = access_code_metadata 508 509 @property 510 def add_access_code_to_email(self): 511 """Gets the add_access_code_to_email of this Witness. # noqa: E501 512 513 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 514 515 :return: The add_access_code_to_email of this Witness. # noqa: E501 516 :rtype: str 517 """ 518 return self._add_access_code_to_email 519 520 @add_access_code_to_email.setter 521 def add_access_code_to_email(self, add_access_code_to_email): 522 """Sets the add_access_code_to_email of this Witness. 523 524 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 525 526 :param add_access_code_to_email: The add_access_code_to_email of this Witness. # noqa: E501 527 :type: str 528 """ 529 530 self._add_access_code_to_email = add_access_code_to_email 531 532 @property 533 def additional_notifications(self): 534 """Gets the additional_notifications of this Witness. # noqa: E501 535 536 # noqa: E501 537 538 :return: The additional_notifications of this Witness. # noqa: E501 539 :rtype: list[RecipientAdditionalNotification] 540 """ 541 return self._additional_notifications 542 543 @additional_notifications.setter 544 def additional_notifications(self, additional_notifications): 545 """Sets the additional_notifications of this Witness. 546 547 # noqa: E501 548 549 :param additional_notifications: The additional_notifications of this Witness. # noqa: E501 550 :type: list[RecipientAdditionalNotification] 551 """ 552 553 self._additional_notifications = additional_notifications 554 555 @property 556 def agent_can_edit_email(self): 557 """Gets the agent_can_edit_email of this Witness. # noqa: E501 558 559 # noqa: E501 560 561 :return: The agent_can_edit_email of this Witness. # noqa: E501 562 :rtype: str 563 """ 564 return self._agent_can_edit_email 565 566 @agent_can_edit_email.setter 567 def agent_can_edit_email(self, agent_can_edit_email): 568 """Sets the agent_can_edit_email of this Witness. 569 570 # noqa: E501 571 572 :param agent_can_edit_email: The agent_can_edit_email of this Witness. # noqa: E501 573 :type: str 574 """ 575 576 self._agent_can_edit_email = agent_can_edit_email 577 578 @property 579 def agent_can_edit_name(self): 580 """Gets the agent_can_edit_name of this Witness. # noqa: E501 581 582 # noqa: E501 583 584 :return: The agent_can_edit_name of this Witness. # noqa: E501 585 :rtype: str 586 """ 587 return self._agent_can_edit_name 588 589 @agent_can_edit_name.setter 590 def agent_can_edit_name(self, agent_can_edit_name): 591 """Sets the agent_can_edit_name of this Witness. 592 593 # noqa: E501 594 595 :param agent_can_edit_name: The agent_can_edit_name of this Witness. # noqa: E501 596 :type: str 597 """ 598 599 self._agent_can_edit_name = agent_can_edit_name 600 601 @property 602 def allow_system_override_for_locked_recipient(self): 603 """Gets the allow_system_override_for_locked_recipient of this Witness. # noqa: E501 604 605 # noqa: E501 606 607 :return: The allow_system_override_for_locked_recipient of this Witness. # noqa: E501 608 :rtype: str 609 """ 610 return self._allow_system_override_for_locked_recipient 611 612 @allow_system_override_for_locked_recipient.setter 613 def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): 614 """Sets the allow_system_override_for_locked_recipient of this Witness. 615 616 # noqa: E501 617 618 :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this Witness. # noqa: E501 619 :type: str 620 """ 621 622 self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient 623 624 @property 625 def auto_navigation(self): 626 """Gets the auto_navigation of this Witness. # noqa: E501 627 628 # noqa: E501 629 630 :return: The auto_navigation of this Witness. # noqa: E501 631 :rtype: str 632 """ 633 return self._auto_navigation 634 635 @auto_navigation.setter 636 def auto_navigation(self, auto_navigation): 637 """Sets the auto_navigation of this Witness. 638 639 # noqa: E501 640 641 :param auto_navigation: The auto_navigation of this Witness. # noqa: E501 642 :type: str 643 """ 644 645 self._auto_navigation = auto_navigation 646 647 @property 648 def auto_responded_reason(self): 649 """Gets the auto_responded_reason of this Witness. # noqa: E501 650 651 # noqa: E501 652 653 :return: The auto_responded_reason of this Witness. # noqa: E501 654 :rtype: str 655 """ 656 return self._auto_responded_reason 657 658 @auto_responded_reason.setter 659 def auto_responded_reason(self, auto_responded_reason): 660 """Sets the auto_responded_reason of this Witness. 661 662 # noqa: E501 663 664 :param auto_responded_reason: The auto_responded_reason of this Witness. # noqa: E501 665 :type: str 666 """ 667 668 self._auto_responded_reason = auto_responded_reason 669 670 @property 671 def bulk_recipients_uri(self): 672 """Gets the bulk_recipients_uri of this Witness. # noqa: E501 673 674 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 675 676 :return: The bulk_recipients_uri of this Witness. # noqa: E501 677 :rtype: str 678 """ 679 return self._bulk_recipients_uri 680 681 @bulk_recipients_uri.setter 682 def bulk_recipients_uri(self, bulk_recipients_uri): 683 """Sets the bulk_recipients_uri of this Witness. 684 685 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 686 687 :param bulk_recipients_uri: The bulk_recipients_uri of this Witness. # noqa: E501 688 :type: str 689 """ 690 691 self._bulk_recipients_uri = bulk_recipients_uri 692 693 @property 694 def bulk_send_v2_recipient(self): 695 """Gets the bulk_send_v2_recipient of this Witness. # noqa: E501 696 697 # noqa: E501 698 699 :return: The bulk_send_v2_recipient of this Witness. # noqa: E501 700 :rtype: str 701 """ 702 return self._bulk_send_v2_recipient 703 704 @bulk_send_v2_recipient.setter 705 def bulk_send_v2_recipient(self, bulk_send_v2_recipient): 706 """Sets the bulk_send_v2_recipient of this Witness. 707 708 # noqa: E501 709 710 :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this Witness. # noqa: E501 711 :type: str 712 """ 713 714 self._bulk_send_v2_recipient = bulk_send_v2_recipient 715 716 @property 717 def can_sign_offline(self): 718 """Gets the can_sign_offline of this Witness. # noqa: E501 719 720 When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 721 722 :return: The can_sign_offline of this Witness. # noqa: E501 723 :rtype: str 724 """ 725 return self._can_sign_offline 726 727 @can_sign_offline.setter 728 def can_sign_offline(self, can_sign_offline): 729 """Sets the can_sign_offline of this Witness. 730 731 When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 732 733 :param can_sign_offline: The can_sign_offline of this Witness. # noqa: E501 734 :type: str 735 """ 736 737 self._can_sign_offline = can_sign_offline 738 739 @property 740 def client_user_id(self): 741 """Gets the client_user_id of this Witness. # noqa: E501 742 743 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 744 745 :return: The client_user_id of this Witness. # noqa: E501 746 :rtype: str 747 """ 748 return self._client_user_id 749 750 @client_user_id.setter 751 def client_user_id(self, client_user_id): 752 """Sets the client_user_id of this Witness. 753 754 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 755 756 :param client_user_id: The client_user_id of this Witness. # noqa: E501 757 :type: str 758 """ 759 760 self._client_user_id = client_user_id 761 762 @property 763 def completed_count(self): 764 """Gets the completed_count of this Witness. # noqa: E501 765 766 # noqa: E501 767 768 :return: The completed_count of this Witness. # noqa: E501 769 :rtype: str 770 """ 771 return self._completed_count 772 773 @completed_count.setter 774 def completed_count(self, completed_count): 775 """Sets the completed_count of this Witness. 776 777 # noqa: E501 778 779 :param completed_count: The completed_count of this Witness. # noqa: E501 780 :type: str 781 """ 782 783 self._completed_count = completed_count 784 785 @property 786 def consent_details_list(self): 787 """Gets the consent_details_list of this Witness. # noqa: E501 788 789 # noqa: E501 790 791 :return: The consent_details_list of this Witness. # noqa: E501 792 :rtype: list[ConsentDetails] 793 """ 794 return self._consent_details_list 795 796 @consent_details_list.setter 797 def consent_details_list(self, consent_details_list): 798 """Sets the consent_details_list of this Witness. 799 800 # noqa: E501 801 802 :param consent_details_list: The consent_details_list of this Witness. # noqa: E501 803 :type: list[ConsentDetails] 804 """ 805 806 self._consent_details_list = consent_details_list 807 808 @property 809 def creation_reason(self): 810 """Gets the creation_reason of this Witness. # noqa: E501 811 812 # noqa: E501 813 814 :return: The creation_reason of this Witness. # noqa: E501 815 :rtype: str 816 """ 817 return self._creation_reason 818 819 @creation_reason.setter 820 def creation_reason(self, creation_reason): 821 """Sets the creation_reason of this Witness. 822 823 # noqa: E501 824 825 :param creation_reason: The creation_reason of this Witness. # noqa: E501 826 :type: str 827 """ 828 829 self._creation_reason = creation_reason 830 831 @property 832 def custom_fields(self): 833 """Gets the custom_fields of this Witness. # noqa: E501 834 835 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 836 837 :return: The custom_fields of this Witness. # noqa: E501 838 :rtype: list[str] 839 """ 840 return self._custom_fields 841 842 @custom_fields.setter 843 def custom_fields(self, custom_fields): 844 """Sets the custom_fields of this Witness. 845 846 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 847 848 :param custom_fields: The custom_fields of this Witness. # noqa: E501 849 :type: list[str] 850 """ 851 852 self._custom_fields = custom_fields 853 854 @property 855 def declined_date_time(self): 856 """Gets the declined_date_time of this Witness. # noqa: E501 857 858 The date and time the recipient declined the document. # noqa: E501 859 860 :return: The declined_date_time of this Witness. # noqa: E501 861 :rtype: str 862 """ 863 return self._declined_date_time 864 865 @declined_date_time.setter 866 def declined_date_time(self, declined_date_time): 867 """Sets the declined_date_time of this Witness. 868 869 The date and time the recipient declined the document. # noqa: E501 870 871 :param declined_date_time: The declined_date_time of this Witness. # noqa: E501 872 :type: str 873 """ 874 875 self._declined_date_time = declined_date_time 876 877 @property 878 def declined_reason(self): 879 """Gets the declined_reason of this Witness. # noqa: E501 880 881 The reason the recipient declined the document. # noqa: E501 882 883 :return: The declined_reason of this Witness. # noqa: E501 884 :rtype: str 885 """ 886 return self._declined_reason 887 888 @declined_reason.setter 889 def declined_reason(self, declined_reason): 890 """Sets the declined_reason of this Witness. 891 892 The reason the recipient declined the document. # noqa: E501 893 894 :param declined_reason: The declined_reason of this Witness. # noqa: E501 895 :type: str 896 """ 897 898 self._declined_reason = declined_reason 899 900 @property 901 def default_recipient(self): 902 """Gets the default_recipient of this Witness. # noqa: E501 903 904 # noqa: E501 905 906 :return: The default_recipient of this Witness. # noqa: E501 907 :rtype: str 908 """ 909 return self._default_recipient 910 911 @default_recipient.setter 912 def default_recipient(self, default_recipient): 913 """Sets the default_recipient of this Witness. 914 915 # noqa: E501 916 917 :param default_recipient: The default_recipient of this Witness. # noqa: E501 918 :type: str 919 """ 920 921 self._default_recipient = default_recipient 922 923 @property 924 def delegated_by(self): 925 """Gets the delegated_by of this Witness. # noqa: E501 926 927 # noqa: E501 928 929 :return: The delegated_by of this Witness. # noqa: E501 930 :rtype: DelegationInfo 931 """ 932 return self._delegated_by 933 934 @delegated_by.setter 935 def delegated_by(self, delegated_by): 936 """Sets the delegated_by of this Witness. 937 938 # noqa: E501 939 940 :param delegated_by: The delegated_by of this Witness. # noqa: E501 941 :type: DelegationInfo 942 """ 943 944 self._delegated_by = delegated_by 945 946 @property 947 def delegated_to(self): 948 """Gets the delegated_to of this Witness. # noqa: E501 949 950 # noqa: E501 951 952 :return: The delegated_to of this Witness. # noqa: E501 953 :rtype: list[DelegationInfo] 954 """ 955 return self._delegated_to 956 957 @delegated_to.setter 958 def delegated_to(self, delegated_to): 959 """Sets the delegated_to of this Witness. 960 961 # noqa: E501 962 963 :param delegated_to: The delegated_to of this Witness. # noqa: E501 964 :type: list[DelegationInfo] 965 """ 966 967 self._delegated_to = delegated_to 968 969 @property 970 def delivered_date_time(self): 971 """Gets the delivered_date_time of this Witness. # noqa: E501 972 973 Reserved: For DocuSign use only. # noqa: E501 974 975 :return: The delivered_date_time of this Witness. # noqa: E501 976 :rtype: str 977 """ 978 return self._delivered_date_time 979 980 @delivered_date_time.setter 981 def delivered_date_time(self, delivered_date_time): 982 """Sets the delivered_date_time of this Witness. 983 984 Reserved: For DocuSign use only. # noqa: E501 985 986 :param delivered_date_time: The delivered_date_time of this Witness. # noqa: E501 987 :type: str 988 """ 989 990 self._delivered_date_time = delivered_date_time 991 992 @property 993 def delivery_method(self): 994 """Gets the delivery_method of this Witness. # noqa: E501 995 996 Reserved: For DocuSign use only. # noqa: E501 997 998 :return: The delivery_method of this Witness. # noqa: E501 999 :rtype: str 1000 """ 1001 return self._delivery_method 1002 1003 @delivery_method.setter 1004 def delivery_method(self, delivery_method): 1005 """Sets the delivery_method of this Witness. 1006 1007 Reserved: For DocuSign use only. # noqa: E501 1008 1009 :param delivery_method: The delivery_method of this Witness. # noqa: E501 1010 :type: str 1011 """ 1012 1013 self._delivery_method = delivery_method 1014 1015 @property 1016 def delivery_method_metadata(self): 1017 """Gets the delivery_method_metadata of this Witness. # noqa: E501 1018 1019 Reserved for DocuSign. # noqa: E501 1020 1021 :return: The delivery_method_metadata of this Witness. # noqa: E501 1022 :rtype: PropertyMetadata 1023 """ 1024 return self._delivery_method_metadata 1025 1026 @delivery_method_metadata.setter 1027 def delivery_method_metadata(self, delivery_method_metadata): 1028 """Sets the delivery_method_metadata of this Witness. 1029 1030 Reserved for DocuSign. # noqa: E501 1031 1032 :param delivery_method_metadata: The delivery_method_metadata of this Witness. # noqa: E501 1033 :type: PropertyMetadata 1034 """ 1035 1036 self._delivery_method_metadata = delivery_method_metadata 1037 1038 @property 1039 def designator_id(self): 1040 """Gets the designator_id of this Witness. # noqa: E501 1041 1042 # noqa: E501 1043 1044 :return: The designator_id of this Witness. # noqa: E501 1045 :rtype: str 1046 """ 1047 return self._designator_id 1048 1049 @designator_id.setter 1050 def designator_id(self, designator_id): 1051 """Sets the designator_id of this Witness. 1052 1053 # noqa: E501 1054 1055 :param designator_id: The designator_id of this Witness. # noqa: E501 1056 :type: str 1057 """ 1058 1059 self._designator_id = designator_id 1060 1061 @property 1062 def designator_id_guid(self): 1063 """Gets the designator_id_guid of this Witness. # noqa: E501 1064 1065 # noqa: E501 1066 1067 :return: The designator_id_guid of this Witness. # noqa: E501 1068 :rtype: str 1069 """ 1070 return self._designator_id_guid 1071 1072 @designator_id_guid.setter 1073 def designator_id_guid(self, designator_id_guid): 1074 """Sets the designator_id_guid of this Witness. 1075 1076 # noqa: E501 1077 1078 :param designator_id_guid: The designator_id_guid of this Witness. # noqa: E501 1079 :type: str 1080 """ 1081 1082 self._designator_id_guid = designator_id_guid 1083 1084 @property 1085 def document_template_id(self): 1086 """Gets the document_template_id of this Witness. # noqa: E501 1087 1088 # noqa: E501 1089 1090 :return: The document_template_id of this Witness. # noqa: E501 1091 :rtype: str 1092 """ 1093 return self._document_template_id 1094 1095 @document_template_id.setter 1096 def document_template_id(self, document_template_id): 1097 """Sets the document_template_id of this Witness. 1098 1099 # noqa: E501 1100 1101 :param document_template_id: The document_template_id of this Witness. # noqa: E501 1102 :type: str 1103 """ 1104 1105 self._document_template_id = document_template_id 1106 1107 @property 1108 def document_visibility(self): 1109 """Gets the document_visibility of this Witness. # noqa: E501 1110 1111 # noqa: E501 1112 1113 :return: The document_visibility of this Witness. # noqa: E501 1114 :rtype: list[DocumentVisibility] 1115 """ 1116 return self._document_visibility 1117 1118 @document_visibility.setter 1119 def document_visibility(self, document_visibility): 1120 """Sets the document_visibility of this Witness. 1121 1122 # noqa: E501 1123 1124 :param document_visibility: The document_visibility of this Witness. # noqa: E501 1125 :type: list[DocumentVisibility] 1126 """ 1127 1128 self._document_visibility = document_visibility 1129 1130 @property 1131 def email(self): 1132 """Gets the email of this Witness. # noqa: E501 1133 1134 # noqa: E501 1135 1136 :return: The email of this Witness. # noqa: E501 1137 :rtype: str 1138 """ 1139 return self._email 1140 1141 @email.setter 1142 def email(self, email): 1143 """Sets the email of this Witness. 1144 1145 # noqa: E501 1146 1147 :param email: The email of this Witness. # noqa: E501 1148 :type: str 1149 """ 1150 1151 self._email = email 1152 1153 @property 1154 def email_metadata(self): 1155 """Gets the email_metadata of this Witness. # noqa: E501 1156 1157 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 1158 1159 :return: The email_metadata of this Witness. # noqa: E501 1160 :rtype: PropertyMetadata 1161 """ 1162 return self._email_metadata 1163 1164 @email_metadata.setter 1165 def email_metadata(self, email_metadata): 1166 """Sets the email_metadata of this Witness. 1167 1168 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 1169 1170 :param email_metadata: The email_metadata of this Witness. # noqa: E501 1171 :type: PropertyMetadata 1172 """ 1173 1174 self._email_metadata = email_metadata 1175 1176 @property 1177 def email_notification(self): 1178 """Gets the email_notification of this Witness. # noqa: E501 1179 1180 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 1181 1182 :return: The email_notification of this Witness. # noqa: E501 1183 :rtype: RecipientEmailNotification 1184 """ 1185 return self._email_notification 1186 1187 @email_notification.setter 1188 def email_notification(self, email_notification): 1189 """Sets the email_notification of this Witness. 1190 1191 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 1192 1193 :param email_notification: The email_notification of this Witness. # noqa: E501 1194 :type: RecipientEmailNotification 1195 """ 1196 1197 self._email_notification = email_notification 1198 1199 @property 1200 def email_recipient_post_signing_url(self): 1201 """Gets the email_recipient_post_signing_url of this Witness. # noqa: E501 1202 1203 # noqa: E501 1204 1205 :return: The email_recipient_post_signing_url of this Witness. # noqa: E501 1206 :rtype: str 1207 """ 1208 return self._email_recipient_post_signing_url 1209 1210 @email_recipient_post_signing_url.setter 1211 def email_recipient_post_signing_url(self, email_recipient_post_signing_url): 1212 """Sets the email_recipient_post_signing_url of this Witness. 1213 1214 # noqa: E501 1215 1216 :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this Witness. # noqa: E501 1217 :type: str 1218 """ 1219 1220 self._email_recipient_post_signing_url = email_recipient_post_signing_url 1221 1222 @property 1223 def embedded_recipient_start_url(self): 1224 """Gets the embedded_recipient_start_url of this Witness. # noqa: E501 1225 1226 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 1227 1228 :return: The embedded_recipient_start_url of this Witness. # noqa: E501 1229 :rtype: str 1230 """ 1231 return self._embedded_recipient_start_url 1232 1233 @embedded_recipient_start_url.setter 1234 def embedded_recipient_start_url(self, embedded_recipient_start_url): 1235 """Sets the embedded_recipient_start_url of this Witness. 1236 1237 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 1238 1239 :param embedded_recipient_start_url: The embedded_recipient_start_url of this Witness. # noqa: E501 1240 :type: str 1241 """ 1242 1243 self._embedded_recipient_start_url = embedded_recipient_start_url 1244 1245 @property 1246 def error_details(self): 1247 """Gets the error_details of this Witness. # noqa: E501 1248 1249 Array or errors. # noqa: E501 1250 1251 :return: The error_details of this Witness. # noqa: E501 1252 :rtype: ErrorDetails 1253 """ 1254 return self._error_details 1255 1256 @error_details.setter 1257 def error_details(self, error_details): 1258 """Sets the error_details of this Witness. 1259 1260 Array or errors. # noqa: E501 1261 1262 :param error_details: The error_details of this Witness. # noqa: E501 1263 :type: ErrorDetails 1264 """ 1265 1266 self._error_details = error_details 1267 1268 @property 1269 def excluded_documents(self): 1270 """Gets the excluded_documents of this Witness. # noqa: E501 1271 1272 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 1273 1274 :return: The excluded_documents of this Witness. # noqa: E501 1275 :rtype: list[str] 1276 """ 1277 return self._excluded_documents 1278 1279 @excluded_documents.setter 1280 def excluded_documents(self, excluded_documents): 1281 """Sets the excluded_documents of this Witness. 1282 1283 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 1284 1285 :param excluded_documents: The excluded_documents of this Witness. # noqa: E501 1286 :type: list[str] 1287 """ 1288 1289 self._excluded_documents = excluded_documents 1290 1291 @property 1292 def fax_number(self): 1293 """Gets the fax_number of this Witness. # noqa: E501 1294 1295 Reserved: # noqa: E501 1296 1297 :return: The fax_number of this Witness. # noqa: E501 1298 :rtype: str 1299 """ 1300 return self._fax_number 1301 1302 @fax_number.setter 1303 def fax_number(self, fax_number): 1304 """Sets the fax_number of this Witness. 1305 1306 Reserved: # noqa: E501 1307 1308 :param fax_number: The fax_number of this Witness. # noqa: E501 1309 :type: str 1310 """ 1311 1312 self._fax_number = fax_number 1313 1314 @property 1315 def fax_number_metadata(self): 1316 """Gets the fax_number_metadata of this Witness. # noqa: E501 1317 1318 Reserved for DocuSign. # noqa: E501 1319 1320 :return: The fax_number_metadata of this Witness. # noqa: E501 1321 :rtype: PropertyMetadata 1322 """ 1323 return self._fax_number_metadata 1324 1325 @fax_number_metadata.setter 1326 def fax_number_metadata(self, fax_number_metadata): 1327 """Sets the fax_number_metadata of this Witness. 1328 1329 Reserved for DocuSign. # noqa: E501 1330 1331 :param fax_number_metadata: The fax_number_metadata of this Witness. # noqa: E501 1332 :type: PropertyMetadata 1333 """ 1334 1335 self._fax_number_metadata = fax_number_metadata 1336 1337 @property 1338 def first_name(self): 1339 """Gets the first_name of this Witness. # noqa: E501 1340 1341 The user's first name. Maximum Length: 50 characters. # noqa: E501 1342 1343 :return: The first_name of this Witness. # noqa: E501 1344 :rtype: str 1345 """ 1346 return self._first_name 1347 1348 @first_name.setter 1349 def first_name(self, first_name): 1350 """Sets the first_name of this Witness. 1351 1352 The user's first name. Maximum Length: 50 characters. # noqa: E501 1353 1354 :param first_name: The first_name of this Witness. # noqa: E501 1355 :type: str 1356 """ 1357 1358 self._first_name = first_name 1359 1360 @property 1361 def first_name_metadata(self): 1362 """Gets the first_name_metadata of this Witness. # noqa: E501 1363 1364 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1365 1366 :return: The first_name_metadata of this Witness. # noqa: E501 1367 :rtype: PropertyMetadata 1368 """ 1369 return self._first_name_metadata 1370 1371 @first_name_metadata.setter 1372 def first_name_metadata(self, first_name_metadata): 1373 """Sets the first_name_metadata of this Witness. 1374 1375 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1376 1377 :param first_name_metadata: The first_name_metadata of this Witness. # noqa: E501 1378 :type: PropertyMetadata 1379 """ 1380 1381 self._first_name_metadata = first_name_metadata 1382 1383 @property 1384 def full_name(self): 1385 """Gets the full_name of this Witness. # noqa: E501 1386 1387 # noqa: E501 1388 1389 :return: The full_name of this Witness. # noqa: E501 1390 :rtype: str 1391 """ 1392 return self._full_name 1393 1394 @full_name.setter 1395 def full_name(self, full_name): 1396 """Sets the full_name of this Witness. 1397 1398 # noqa: E501 1399 1400 :param full_name: The full_name of this Witness. # noqa: E501 1401 :type: str 1402 """ 1403 1404 self._full_name = full_name 1405 1406 @property 1407 def full_name_metadata(self): 1408 """Gets the full_name_metadata of this Witness. # noqa: E501 1409 1410 Reserved for DocuSign. # noqa: E501 1411 1412 :return: The full_name_metadata of this Witness. # noqa: E501 1413 :rtype: PropertyMetadata 1414 """ 1415 return self._full_name_metadata 1416 1417 @full_name_metadata.setter 1418 def full_name_metadata(self, full_name_metadata): 1419 """Sets the full_name_metadata of this Witness. 1420 1421 Reserved for DocuSign. # noqa: E501 1422 1423 :param full_name_metadata: The full_name_metadata of this Witness. # noqa: E501 1424 :type: PropertyMetadata 1425 """ 1426 1427 self._full_name_metadata = full_name_metadata 1428 1429 @property 1430 def id_check_configuration_name(self): 1431 """Gets the id_check_configuration_name of this Witness. # noqa: E501 1432 1433 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 1434 1435 :return: The id_check_configuration_name of this Witness. # noqa: E501 1436 :rtype: str 1437 """ 1438 return self._id_check_configuration_name 1439 1440 @id_check_configuration_name.setter 1441 def id_check_configuration_name(self, id_check_configuration_name): 1442 """Sets the id_check_configuration_name of this Witness. 1443 1444 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 1445 1446 :param id_check_configuration_name: The id_check_configuration_name of this Witness. # noqa: E501 1447 :type: str 1448 """ 1449 1450 self._id_check_configuration_name = id_check_configuration_name 1451 1452 @property 1453 def id_check_configuration_name_metadata(self): 1454 """Gets the id_check_configuration_name_metadata of this Witness. # noqa: E501 1455 1456 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1457 1458 :return: The id_check_configuration_name_metadata of this Witness. # noqa: E501 1459 :rtype: PropertyMetadata 1460 """ 1461 return self._id_check_configuration_name_metadata 1462 1463 @id_check_configuration_name_metadata.setter 1464 def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): 1465 """Sets the id_check_configuration_name_metadata of this Witness. 1466 1467 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1468 1469 :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this Witness. # noqa: E501 1470 :type: PropertyMetadata 1471 """ 1472 1473 self._id_check_configuration_name_metadata = id_check_configuration_name_metadata 1474 1475 @property 1476 def id_check_information_input(self): 1477 """Gets the id_check_information_input of this Witness. # noqa: E501 1478 1479 An object that contains input information related to a recipient ID check. # noqa: E501 1480 1481 :return: The id_check_information_input of this Witness. # noqa: E501 1482 :rtype: IdCheckInformationInput 1483 """ 1484 return self._id_check_information_input 1485 1486 @id_check_information_input.setter 1487 def id_check_information_input(self, id_check_information_input): 1488 """Sets the id_check_information_input of this Witness. 1489 1490 An object that contains input information related to a recipient ID check. # noqa: E501 1491 1492 :param id_check_information_input: The id_check_information_input of this Witness. # noqa: E501 1493 :type: IdCheckInformationInput 1494 """ 1495 1496 self._id_check_information_input = id_check_information_input 1497 1498 @property 1499 def identity_verification(self): 1500 """Gets the identity_verification of this Witness. # noqa: E501 1501 1502 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501 1503 1504 :return: The identity_verification of this Witness. # noqa: E501 1505 :rtype: RecipientIdentityVerification 1506 """ 1507 return self._identity_verification 1508 1509 @identity_verification.setter 1510 def identity_verification(self, identity_verification): 1511 """Sets the identity_verification of this Witness. 1512 1513 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501 1514 1515 :param identity_verification: The identity_verification of this Witness. # noqa: E501 1516 :type: RecipientIdentityVerification 1517 """ 1518 1519 self._identity_verification = identity_verification 1520 1521 @property 1522 def inherit_email_notification_configuration(self): 1523 """Gets the inherit_email_notification_configuration of this Witness. # noqa: E501 1524 1525 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 1526 1527 :return: The inherit_email_notification_configuration of this Witness. # noqa: E501 1528 :rtype: str 1529 """ 1530 return self._inherit_email_notification_configuration 1531 1532 @inherit_email_notification_configuration.setter 1533 def inherit_email_notification_configuration(self, inherit_email_notification_configuration): 1534 """Sets the inherit_email_notification_configuration of this Witness. 1535 1536 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 1537 1538 :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this Witness. # noqa: E501 1539 :type: str 1540 """ 1541 1542 self._inherit_email_notification_configuration = inherit_email_notification_configuration 1543 1544 @property 1545 def is_bulk_recipient(self): 1546 """Gets the is_bulk_recipient of this Witness. # noqa: E501 1547 1548 # noqa: E501 1549 1550 :return: The is_bulk_recipient of this Witness. # noqa: E501 1551 :rtype: str 1552 """ 1553 return self._is_bulk_recipient 1554 1555 @is_bulk_recipient.setter 1556 def is_bulk_recipient(self, is_bulk_recipient): 1557 """Sets the is_bulk_recipient of this Witness. 1558 1559 # noqa: E501 1560 1561 :param is_bulk_recipient: The is_bulk_recipient of this Witness. # noqa: E501 1562 :type: str 1563 """ 1564 1565 self._is_bulk_recipient = is_bulk_recipient 1566 1567 @property 1568 def is_bulk_recipient_metadata(self): 1569 """Gets the is_bulk_recipient_metadata of this Witness. # noqa: E501 1570 1571 Reserved for DocuSign. # noqa: E501 1572 1573 :return: The is_bulk_recipient_metadata of this Witness. # noqa: E501 1574 :rtype: PropertyMetadata 1575 """ 1576 return self._is_bulk_recipient_metadata 1577 1578 @is_bulk_recipient_metadata.setter 1579 def is_bulk_recipient_metadata(self, is_bulk_recipient_metadata): 1580 """Sets the is_bulk_recipient_metadata of this Witness. 1581 1582 Reserved for DocuSign. # noqa: E501 1583 1584 :param is_bulk_recipient_metadata: The is_bulk_recipient_metadata of this Witness. # noqa: E501 1585 :type: PropertyMetadata 1586 """ 1587 1588 self._is_bulk_recipient_metadata = is_bulk_recipient_metadata 1589 1590 @property 1591 def last_name(self): 1592 """Gets the last_name of this Witness. # noqa: E501 1593 1594 # noqa: E501 1595 1596 :return: The last_name of this Witness. # noqa: E501 1597 :rtype: str 1598 """ 1599 return self._last_name 1600 1601 @last_name.setter 1602 def last_name(self, last_name): 1603 """Sets the last_name of this Witness. 1604 1605 # noqa: E501 1606 1607 :param last_name: The last_name of this Witness. # noqa: E501 1608 :type: str 1609 """ 1610 1611 self._last_name = last_name 1612 1613 @property 1614 def last_name_metadata(self): 1615 """Gets the last_name_metadata of this Witness. # noqa: E501 1616 1617 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1618 1619 :return: The last_name_metadata of this Witness. # noqa: E501 1620 :rtype: PropertyMetadata 1621 """ 1622 return self._last_name_metadata 1623 1624 @last_name_metadata.setter 1625 def last_name_metadata(self, last_name_metadata): 1626 """Sets the last_name_metadata of this Witness. 1627 1628 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1629 1630 :param last_name_metadata: The last_name_metadata of this Witness. # noqa: E501 1631 :type: PropertyMetadata 1632 """ 1633 1634 self._last_name_metadata = last_name_metadata 1635 1636 @property 1637 def locked_recipient_phone_auth_editable(self): 1638 """Gets the locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1639 1640 # noqa: E501 1641 1642 :return: The locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1643 :rtype: str 1644 """ 1645 return self._locked_recipient_phone_auth_editable 1646 1647 @locked_recipient_phone_auth_editable.setter 1648 def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): 1649 """Sets the locked_recipient_phone_auth_editable of this Witness. 1650 1651 # noqa: E501 1652 1653 :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1654 :type: str 1655 """ 1656 1657 self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable 1658 1659 @property 1660 def locked_recipient_sms_editable(self): 1661 """Gets the locked_recipient_sms_editable of this Witness. # noqa: E501 1662 1663 # noqa: E501 1664 1665 :return: The locked_recipient_sms_editable of this Witness. # noqa: E501 1666 :rtype: str 1667 """ 1668 return self._locked_recipient_sms_editable 1669 1670 @locked_recipient_sms_editable.setter 1671 def locked_recipient_sms_editable(self, locked_recipient_sms_editable): 1672 """Sets the locked_recipient_sms_editable of this Witness. 1673 1674 # noqa: E501 1675 1676 :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this Witness. # noqa: E501 1677 :type: str 1678 """ 1679 1680 self._locked_recipient_sms_editable = locked_recipient_sms_editable 1681 1682 @property 1683 def name(self): 1684 """Gets the name of this Witness. # noqa: E501 1685 1686 # noqa: E501 1687 1688 :return: The name of this Witness. # noqa: E501 1689 :rtype: str 1690 """ 1691 return self._name 1692 1693 @name.setter 1694 def name(self, name): 1695 """Sets the name of this Witness. 1696 1697 # noqa: E501 1698 1699 :param name: The name of this Witness. # noqa: E501 1700 :type: str 1701 """ 1702 1703 self._name = name 1704 1705 @property 1706 def name_metadata(self): 1707 """Gets the name_metadata of this Witness. # noqa: E501 1708 1709 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1710 1711 :return: The name_metadata of this Witness. # noqa: E501 1712 :rtype: PropertyMetadata 1713 """ 1714 return self._name_metadata 1715 1716 @name_metadata.setter 1717 def name_metadata(self, name_metadata): 1718 """Sets the name_metadata of this Witness. 1719 1720 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1721 1722 :param name_metadata: The name_metadata of this Witness. # noqa: E501 1723 :type: PropertyMetadata 1724 """ 1725 1726 self._name_metadata = name_metadata 1727 1728 @property 1729 def notary_id(self): 1730 """Gets the notary_id of this Witness. # noqa: E501 1731 1732 # noqa: E501 1733 1734 :return: The notary_id of this Witness. # noqa: E501 1735 :rtype: str 1736 """ 1737 return self._notary_id 1738 1739 @notary_id.setter 1740 def notary_id(self, notary_id): 1741 """Sets the notary_id of this Witness. 1742 1743 # noqa: E501 1744 1745 :param notary_id: The notary_id of this Witness. # noqa: E501 1746 :type: str 1747 """ 1748 1749 self._notary_id = notary_id 1750 1751 @property 1752 def notary_signer_email_sent(self): 1753 """Gets the notary_signer_email_sent of this Witness. # noqa: E501 1754 1755 # noqa: E501 1756 1757 :return: The notary_signer_email_sent of this Witness. # noqa: E501 1758 :rtype: str 1759 """ 1760 return self._notary_signer_email_sent 1761 1762 @notary_signer_email_sent.setter 1763 def notary_signer_email_sent(self, notary_signer_email_sent): 1764 """Sets the notary_signer_email_sent of this Witness. 1765 1766 # noqa: E501 1767 1768 :param notary_signer_email_sent: The notary_signer_email_sent of this Witness. # noqa: E501 1769 :type: str 1770 """ 1771 1772 self._notary_signer_email_sent = notary_signer_email_sent 1773 1774 @property 1775 def note(self): 1776 """Gets the note of this Witness. # noqa: E501 1777 1778 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 1779 1780 :return: The note of this Witness. # noqa: E501 1781 :rtype: str 1782 """ 1783 return self._note 1784 1785 @note.setter 1786 def note(self, note): 1787 """Sets the note of this Witness. 1788 1789 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 1790 1791 :param note: The note of this Witness. # noqa: E501 1792 :type: str 1793 """ 1794 1795 self._note = note 1796 1797 @property 1798 def note_metadata(self): 1799 """Gets the note_metadata of this Witness. # noqa: E501 1800 1801 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1802 1803 :return: The note_metadata of this Witness. # noqa: E501 1804 :rtype: PropertyMetadata 1805 """ 1806 return self._note_metadata 1807 1808 @note_metadata.setter 1809 def note_metadata(self, note_metadata): 1810 """Sets the note_metadata of this Witness. 1811 1812 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1813 1814 :param note_metadata: The note_metadata of this Witness. # noqa: E501 1815 :type: PropertyMetadata 1816 """ 1817 1818 self._note_metadata = note_metadata 1819 1820 @property 1821 def offline_attributes(self): 1822 """Gets the offline_attributes of this Witness. # noqa: E501 1823 1824 Reserved for DocuSign. # noqa: E501 1825 1826 :return: The offline_attributes of this Witness. # noqa: E501 1827 :rtype: OfflineAttributes 1828 """ 1829 return self._offline_attributes 1830 1831 @offline_attributes.setter 1832 def offline_attributes(self, offline_attributes): 1833 """Sets the offline_attributes of this Witness. 1834 1835 Reserved for DocuSign. # noqa: E501 1836 1837 :param offline_attributes: The offline_attributes of this Witness. # noqa: E501 1838 :type: OfflineAttributes 1839 """ 1840 1841 self._offline_attributes = offline_attributes 1842 1843 @property 1844 def phone_authentication(self): 1845 """Gets the phone_authentication of this Witness. # noqa: E501 1846 1847 When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. # noqa: E501 1848 1849 :return: The phone_authentication of this Witness. # noqa: E501 1850 :rtype: RecipientPhoneAuthentication 1851 """ 1852 return self._phone_authentication 1853 1854 @phone_authentication.setter 1855 def phone_authentication(self, phone_authentication): 1856 """Sets the phone_authentication of this Witness. 1857 1858 When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. # noqa: E501 1859 1860 :param phone_authentication: The phone_authentication of this Witness. # noqa: E501 1861 :type: RecipientPhoneAuthentication 1862 """ 1863 1864 self._phone_authentication = phone_authentication 1865 1866 @property 1867 def phone_number(self): 1868 """Gets the phone_number of this Witness. # noqa: E501 1869 1870 Describes the recipient phone number. # noqa: E501 1871 1872 :return: The phone_number of this Witness. # noqa: E501 1873 :rtype: RecipientPhoneNumber 1874 """ 1875 return self._phone_number 1876 1877 @phone_number.setter 1878 def phone_number(self, phone_number): 1879 """Sets the phone_number of this Witness. 1880 1881 Describes the recipient phone number. # noqa: E501 1882 1883 :param phone_number: The phone_number of this Witness. # noqa: E501 1884 :type: RecipientPhoneNumber 1885 """ 1886 1887 self._phone_number = phone_number 1888 1889 @property 1890 def proof_file(self): 1891 """Gets the proof_file of this Witness. # noqa: E501 1892 1893 The proof file of the recipient. # noqa: E501 1894 1895 :return: The proof_file of this Witness. # noqa: E501 1896 :rtype: RecipientProofFile 1897 """ 1898 return self._proof_file 1899 1900 @proof_file.setter 1901 def proof_file(self, proof_file): 1902 """Sets the proof_file of this Witness. 1903 1904 The proof file of the recipient. # noqa: E501 1905 1906 :param proof_file: The proof_file of this Witness. # noqa: E501 1907 :type: RecipientProofFile 1908 """ 1909 1910 self._proof_file = proof_file 1911 1912 @property 1913 def recipient_attachments(self): 1914 """Gets the recipient_attachments of this Witness. # noqa: E501 1915 1916 Reserved: # noqa: E501 1917 1918 :return: The recipient_attachments of this Witness. # noqa: E501 1919 :rtype: list[RecipientAttachment] 1920 """ 1921 return self._recipient_attachments 1922 1923 @recipient_attachments.setter 1924 def recipient_attachments(self, recipient_attachments): 1925 """Sets the recipient_attachments of this Witness. 1926 1927 Reserved: # noqa: E501 1928 1929 :param recipient_attachments: The recipient_attachments of this Witness. # noqa: E501 1930 :type: list[RecipientAttachment] 1931 """ 1932 1933 self._recipient_attachments = recipient_attachments 1934 1935 @property 1936 def recipient_authentication_status(self): 1937 """Gets the recipient_authentication_status of this Witness. # noqa: E501 1938 1939 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1940 1941 :return: The recipient_authentication_status of this Witness. # noqa: E501 1942 :rtype: AuthenticationStatus 1943 """ 1944 return self._recipient_authentication_status 1945 1946 @recipient_authentication_status.setter 1947 def recipient_authentication_status(self, recipient_authentication_status): 1948 """Sets the recipient_authentication_status of this Witness. 1949 1950 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1951 1952 :param recipient_authentication_status: The recipient_authentication_status of this Witness. # noqa: E501 1953 :type: AuthenticationStatus 1954 """ 1955 1956 self._recipient_authentication_status = recipient_authentication_status 1957 1958 @property 1959 def recipient_feature_metadata(self): 1960 """Gets the recipient_feature_metadata of this Witness. # noqa: E501 1961 1962 # noqa: E501 1963 1964 :return: The recipient_feature_metadata of this Witness. # noqa: E501 1965 :rtype: list[FeatureAvailableMetadata] 1966 """ 1967 return self._recipient_feature_metadata 1968 1969 @recipient_feature_metadata.setter 1970 def recipient_feature_metadata(self, recipient_feature_metadata): 1971 """Sets the recipient_feature_metadata of this Witness. 1972 1973 # noqa: E501 1974 1975 :param recipient_feature_metadata: The recipient_feature_metadata of this Witness. # noqa: E501 1976 :type: list[FeatureAvailableMetadata] 1977 """ 1978 1979 self._recipient_feature_metadata = recipient_feature_metadata 1980 1981 @property 1982 def recipient_id(self): 1983 """Gets the recipient_id of this Witness. # noqa: E501 1984 1985 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1986 1987 :return: The recipient_id of this Witness. # noqa: E501 1988 :rtype: str 1989 """ 1990 return self._recipient_id 1991 1992 @recipient_id.setter 1993 def recipient_id(self, recipient_id): 1994 """Sets the recipient_id of this Witness. 1995 1996 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1997 1998 :param recipient_id: The recipient_id of this Witness. # noqa: E501 1999 :type: str 2000 """ 2001 2002 self._recipient_id = recipient_id 2003 2004 @property 2005 def recipient_id_guid(self): 2006 """Gets the recipient_id_guid of this Witness. # noqa: E501 2007 2008 # noqa: E501 2009 2010 :return: The recipient_id_guid of this Witness. # noqa: E501 2011 :rtype: str 2012 """ 2013 return self._recipient_id_guid 2014 2015 @recipient_id_guid.setter 2016 def recipient_id_guid(self, recipient_id_guid): 2017 """Sets the recipient_id_guid of this Witness. 2018 2019 # noqa: E501 2020 2021 :param recipient_id_guid: The recipient_id_guid of this Witness. # noqa: E501 2022 :type: str 2023 """ 2024 2025 self._recipient_id_guid = recipient_id_guid 2026 2027 @property 2028 def recipient_signature_providers(self): 2029 """Gets the recipient_signature_providers of this Witness. # noqa: E501 2030 2031 # noqa: E501 2032 2033 :return: The recipient_signature_providers of this Witness. # noqa: E501 2034 :rtype: list[RecipientSignatureProvider] 2035 """ 2036 return self._recipient_signature_providers 2037 2038 @recipient_signature_providers.setter 2039 def recipient_signature_providers(self, recipient_signature_providers): 2040 """Sets the recipient_signature_providers of this Witness. 2041 2042 # noqa: E501 2043 2044 :param recipient_signature_providers: The recipient_signature_providers of this Witness. # noqa: E501 2045 :type: list[RecipientSignatureProvider] 2046 """ 2047 2048 self._recipient_signature_providers = recipient_signature_providers 2049 2050 @property 2051 def recipient_supplies_tabs(self): 2052 """Gets the recipient_supplies_tabs of this Witness. # noqa: E501 2053 2054 # noqa: E501 2055 2056 :return: The recipient_supplies_tabs of this Witness. # noqa: E501 2057 :rtype: str 2058 """ 2059 return self._recipient_supplies_tabs 2060 2061 @recipient_supplies_tabs.setter 2062 def recipient_supplies_tabs(self, recipient_supplies_tabs): 2063 """Sets the recipient_supplies_tabs of this Witness. 2064 2065 # noqa: E501 2066 2067 :param recipient_supplies_tabs: The recipient_supplies_tabs of this Witness. # noqa: E501 2068 :type: str 2069 """ 2070 2071 self._recipient_supplies_tabs = recipient_supplies_tabs 2072 2073 @property 2074 def recipient_type(self): 2075 """Gets the recipient_type of this Witness. # noqa: E501 2076 2077 # noqa: E501 2078 2079 :return: The recipient_type of this Witness. # noqa: E501 2080 :rtype: str 2081 """ 2082 return self._recipient_type 2083 2084 @recipient_type.setter 2085 def recipient_type(self, recipient_type): 2086 """Sets the recipient_type of this Witness. 2087 2088 # noqa: E501 2089 2090 :param recipient_type: The recipient_type of this Witness. # noqa: E501 2091 :type: str 2092 """ 2093 2094 self._recipient_type = recipient_type 2095 2096 @property 2097 def recipient_type_metadata(self): 2098 """Gets the recipient_type_metadata of this Witness. # noqa: E501 2099 2100 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 2101 2102 :return: The recipient_type_metadata of this Witness. # noqa: E501 2103 :rtype: PropertyMetadata 2104 """ 2105 return self._recipient_type_metadata 2106 2107 @recipient_type_metadata.setter 2108 def recipient_type_metadata(self, recipient_type_metadata): 2109 """Sets the recipient_type_metadata of this Witness. 2110 2111 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 2112 2113 :param recipient_type_metadata: The recipient_type_metadata of this Witness. # noqa: E501 2114 :type: PropertyMetadata 2115 """ 2116 2117 self._recipient_type_metadata = recipient_type_metadata 2118 2119 @property 2120 def require_id_lookup(self): 2121 """Gets the require_id_lookup of this Witness. # noqa: E501 2122 2123 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 2124 2125 :return: The require_id_lookup of this Witness. # noqa: E501 2126 :rtype: str 2127 """ 2128 return self._require_id_lookup 2129 2130 @require_id_lookup.setter 2131 def require_id_lookup(self, require_id_lookup): 2132 """Sets the require_id_lookup of this Witness. 2133 2134 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 2135 2136 :param require_id_lookup: The require_id_lookup of this Witness. # noqa: E501 2137 :type: str 2138 """ 2139 2140 self._require_id_lookup = require_id_lookup 2141 2142 @property 2143 def require_id_lookup_metadata(self): 2144 """Gets the require_id_lookup_metadata of this Witness. # noqa: E501 2145 2146 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 2147 2148 :return: The require_id_lookup_metadata of this Witness. # noqa: E501 2149 :rtype: PropertyMetadata 2150 """ 2151 return self._require_id_lookup_metadata 2152 2153 @require_id_lookup_metadata.setter 2154 def require_id_lookup_metadata(self, require_id_lookup_metadata): 2155 """Sets the require_id_lookup_metadata of this Witness. 2156 2157 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 2158 2159 :param require_id_lookup_metadata: The require_id_lookup_metadata of this Witness. # noqa: E501 2160 :type: PropertyMetadata 2161 """ 2162 2163 self._require_id_lookup_metadata = require_id_lookup_metadata 2164 2165 @property 2166 def require_signer_certificate(self): 2167 """Gets the require_signer_certificate of this Witness. # noqa: E501 2168 2169 # noqa: E501 2170 2171 :return: The require_signer_certificate of this Witness. # noqa: E501 2172 :rtype: str 2173 """ 2174 return self._require_signer_certificate 2175 2176 @require_signer_certificate.setter 2177 def require_signer_certificate(self, require_signer_certificate): 2178 """Sets the require_signer_certificate of this Witness. 2179 2180 # noqa: E501 2181 2182 :param require_signer_certificate: The require_signer_certificate of this Witness. # noqa: E501 2183 :type: str 2184 """ 2185 2186 self._require_signer_certificate = require_signer_certificate 2187 2188 @property 2189 def require_sign_on_paper(self): 2190 """Gets the require_sign_on_paper of this Witness. # noqa: E501 2191 2192 # noqa: E501 2193 2194 :return: The require_sign_on_paper of this Witness. # noqa: E501 2195 :rtype: str 2196 """ 2197 return self._require_sign_on_paper 2198 2199 @require_sign_on_paper.setter 2200 def require_sign_on_paper(self, require_sign_on_paper): 2201 """Sets the require_sign_on_paper of this Witness. 2202 2203 # noqa: E501 2204 2205 :param require_sign_on_paper: The require_sign_on_paper of this Witness. # noqa: E501 2206 :type: str 2207 """ 2208 2209 self._require_sign_on_paper = require_sign_on_paper 2210 2211 @property 2212 def require_upload_signature(self): 2213 """Gets the require_upload_signature of this Witness. # noqa: E501 2214 2215 # noqa: E501 2216 2217 :return: The require_upload_signature of this Witness. # noqa: E501 2218 :rtype: str 2219 """ 2220 return self._require_upload_signature 2221 2222 @require_upload_signature.setter 2223 def require_upload_signature(self, require_upload_signature): 2224 """Sets the require_upload_signature of this Witness. 2225 2226 # noqa: E501 2227 2228 :param require_upload_signature: The require_upload_signature of this Witness. # noqa: E501 2229 :type: str 2230 """ 2231 2232 self._require_upload_signature = require_upload_signature 2233 2234 @property 2235 def role_name(self): 2236 """Gets the role_name of this Witness. # noqa: E501 2237 2238 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 2239 2240 :return: The role_name of this Witness. # noqa: E501 2241 :rtype: str 2242 """ 2243 return self._role_name 2244 2245 @role_name.setter 2246 def role_name(self, role_name): 2247 """Sets the role_name of this Witness. 2248 2249 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 2250 2251 :param role_name: The role_name of this Witness. # noqa: E501 2252 :type: str 2253 """ 2254 2255 self._role_name = role_name 2256 2257 @property 2258 def routing_order(self): 2259 """Gets the routing_order of this Witness. # noqa: E501 2260 2261 Specifies the routing order of the recipient in the envelope. # noqa: E501 2262 2263 :return: The routing_order of this Witness. # noqa: E501 2264 :rtype: str 2265 """ 2266 return self._routing_order 2267 2268 @routing_order.setter 2269 def routing_order(self, routing_order): 2270 """Sets the routing_order of this Witness. 2271 2272 Specifies the routing order of the recipient in the envelope. # noqa: E501 2273 2274 :param routing_order: The routing_order of this Witness. # noqa: E501 2275 :type: str 2276 """ 2277 2278 self._routing_order = routing_order 2279 2280 @property 2281 def routing_order_metadata(self): 2282 """Gets the routing_order_metadata of this Witness. # noqa: E501 2283 2284 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 2285 2286 :return: The routing_order_metadata of this Witness. # noqa: E501 2287 :rtype: PropertyMetadata 2288 """ 2289 return self._routing_order_metadata 2290 2291 @routing_order_metadata.setter 2292 def routing_order_metadata(self, routing_order_metadata): 2293 """Sets the routing_order_metadata of this Witness. 2294 2295 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 2296 2297 :param routing_order_metadata: The routing_order_metadata of this Witness. # noqa: E501 2298 :type: PropertyMetadata 2299 """ 2300 2301 self._routing_order_metadata = routing_order_metadata 2302 2303 @property 2304 def sent_date_time(self): 2305 """Gets the sent_date_time of this Witness. # noqa: E501 2306 2307 The date and time the envelope was sent. # noqa: E501 2308 2309 :return: The sent_date_time of this Witness. # noqa: E501 2310 :rtype: str 2311 """ 2312 return self._sent_date_time 2313 2314 @sent_date_time.setter 2315 def sent_date_time(self, sent_date_time): 2316 """Sets the sent_date_time of this Witness. 2317 2318 The date and time the envelope was sent. # noqa: E501 2319 2320 :param sent_date_time: The sent_date_time of this Witness. # noqa: E501 2321 :type: str 2322 """ 2323 2324 self._sent_date_time = sent_date_time 2325 2326 @property 2327 def signature_info(self): 2328 """Gets the signature_info of this Witness. # noqa: E501 2329 2330 Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501 2331 2332 :return: The signature_info of this Witness. # noqa: E501 2333 :rtype: RecipientSignatureInformation 2334 """ 2335 return self._signature_info 2336 2337 @signature_info.setter 2338 def signature_info(self, signature_info): 2339 """Sets the signature_info of this Witness. 2340 2341 Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501 2342 2343 :param signature_info: The signature_info of this Witness. # noqa: E501 2344 :type: RecipientSignatureInformation 2345 """ 2346 2347 self._signature_info = signature_info 2348 2349 @property 2350 def signed_date_time(self): 2351 """Gets the signed_date_time of this Witness. # noqa: E501 2352 2353 Reserved: For DocuSign use only. # noqa: E501 2354 2355 :return: The signed_date_time of this Witness. # noqa: E501 2356 :rtype: str 2357 """ 2358 return self._signed_date_time 2359 2360 @signed_date_time.setter 2361 def signed_date_time(self, signed_date_time): 2362 """Sets the signed_date_time of this Witness. 2363 2364 Reserved: For DocuSign use only. # noqa: E501 2365 2366 :param signed_date_time: The signed_date_time of this Witness. # noqa: E501 2367 :type: str 2368 """ 2369 2370 self._signed_date_time = signed_date_time 2371 2372 @property 2373 def sign_in_each_location(self): 2374 """Gets the sign_in_each_location of this Witness. # noqa: E501 2375 2376 When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 2377 2378 :return: The sign_in_each_location of this Witness. # noqa: E501 2379 :rtype: str 2380 """ 2381 return self._sign_in_each_location 2382 2383 @sign_in_each_location.setter 2384 def sign_in_each_location(self, sign_in_each_location): 2385 """Sets the sign_in_each_location of this Witness. 2386 2387 When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 2388 2389 :param sign_in_each_location: The sign_in_each_location of this Witness. # noqa: E501 2390 :type: str 2391 """ 2392 2393 self._sign_in_each_location = sign_in_each_location 2394 2395 @property 2396 def sign_in_each_location_metadata(self): 2397 """Gets the sign_in_each_location_metadata of this Witness. # noqa: E501 2398 2399 Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. # noqa: E501 2400 2401 :return: The sign_in_each_location_metadata of this Witness. # noqa: E501 2402 :rtype: PropertyMetadata 2403 """ 2404 return self._sign_in_each_location_metadata 2405 2406 @sign_in_each_location_metadata.setter 2407 def sign_in_each_location_metadata(self, sign_in_each_location_metadata): 2408 """Sets the sign_in_each_location_metadata of this Witness. 2409 2410 Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. # noqa: E501 2411 2412 :param sign_in_each_location_metadata: The sign_in_each_location_metadata of this Witness. # noqa: E501 2413 :type: PropertyMetadata 2414 """ 2415 2416 self._sign_in_each_location_metadata = sign_in_each_location_metadata 2417 2418 @property 2419 def signing_group_id(self): 2420 """Gets the signing_group_id of this Witness. # noqa: E501 2421 2422 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 2423 2424 :return: The signing_group_id of this Witness. # noqa: E501 2425 :rtype: str 2426 """ 2427 return self._signing_group_id 2428 2429 @signing_group_id.setter 2430 def signing_group_id(self, signing_group_id): 2431 """Sets the signing_group_id of this Witness. 2432 2433 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 2434 2435 :param signing_group_id: The signing_group_id of this Witness. # noqa: E501 2436 :type: str 2437 """ 2438 2439 self._signing_group_id = signing_group_id 2440 2441 @property 2442 def signing_group_id_metadata(self): 2443 """Gets the signing_group_id_metadata of this Witness. # noqa: E501 2444 2445 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 2446 2447 :return: The signing_group_id_metadata of this Witness. # noqa: E501 2448 :rtype: PropertyMetadata 2449 """ 2450 return self._signing_group_id_metadata 2451 2452 @signing_group_id_metadata.setter 2453 def signing_group_id_metadata(self, signing_group_id_metadata): 2454 """Sets the signing_group_id_metadata of this Witness. 2455 2456 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 2457 2458 :param signing_group_id_metadata: The signing_group_id_metadata of this Witness. # noqa: E501 2459 :type: PropertyMetadata 2460 """ 2461 2462 self._signing_group_id_metadata = signing_group_id_metadata 2463 2464 @property 2465 def signing_group_name(self): 2466 """Gets the signing_group_name of this Witness. # noqa: E501 2467 2468 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 2469 2470 :return: The signing_group_name of this Witness. # noqa: E501 2471 :rtype: str 2472 """ 2473 return self._signing_group_name 2474 2475 @signing_group_name.setter 2476 def signing_group_name(self, signing_group_name): 2477 """Sets the signing_group_name of this Witness. 2478 2479 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 2480 2481 :param signing_group_name: The signing_group_name of this Witness. # noqa: E501 2482 :type: str 2483 """ 2484 2485 self._signing_group_name = signing_group_name 2486 2487 @property 2488 def signing_group_type(self): 2489 """Gets the signing_group_type of this Witness. # noqa: E501 2490 2491 # noqa: E501 2492 2493 :return: The signing_group_type of this Witness. # noqa: E501 2494 :rtype: str 2495 """ 2496 return self._signing_group_type 2497 2498 @signing_group_type.setter 2499 def signing_group_type(self, signing_group_type): 2500 """Sets the signing_group_type of this Witness. 2501 2502 # noqa: E501 2503 2504 :param signing_group_type: The signing_group_type of this Witness. # noqa: E501 2505 :type: str 2506 """ 2507 2508 self._signing_group_type = signing_group_type 2509 2510 @property 2511 def signing_group_users(self): 2512 """Gets the signing_group_users of this Witness. # noqa: E501 2513 2514 A complex type that contains information about users in the signing group. # noqa: E501 2515 2516 :return: The signing_group_users of this Witness. # noqa: E501 2517 :rtype: list[UserInfo] 2518 """ 2519 return self._signing_group_users 2520 2521 @signing_group_users.setter 2522 def signing_group_users(self, signing_group_users): 2523 """Sets the signing_group_users of this Witness. 2524 2525 A complex type that contains information about users in the signing group. # noqa: E501 2526 2527 :param signing_group_users: The signing_group_users of this Witness. # noqa: E501 2528 :type: list[UserInfo] 2529 """ 2530 2531 self._signing_group_users = signing_group_users 2532 2533 @property 2534 def sms_authentication(self): 2535 """Gets the sms_authentication of this Witness. # noqa: E501 2536 2537 When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501 2538 2539 :return: The sms_authentication of this Witness. # noqa: E501 2540 :rtype: RecipientSMSAuthentication 2541 """ 2542 return self._sms_authentication 2543 2544 @sms_authentication.setter 2545 def sms_authentication(self, sms_authentication): 2546 """Sets the sms_authentication of this Witness. 2547 2548 When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501 2549 2550 :param sms_authentication: The sms_authentication of this Witness. # noqa: E501 2551 :type: RecipientSMSAuthentication 2552 """ 2553 2554 self._sms_authentication = sms_authentication 2555 2556 @property 2557 def social_authentications(self): 2558 """Gets the social_authentications of this Witness. # noqa: E501 2559 2560 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2561 2562 :return: The social_authentications of this Witness. # noqa: E501 2563 :rtype: list[SocialAuthentication] 2564 """ 2565 return self._social_authentications 2566 2567 @social_authentications.setter 2568 def social_authentications(self, social_authentications): 2569 """Sets the social_authentications of this Witness. 2570 2571 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2572 2573 :param social_authentications: The social_authentications of this Witness. # noqa: E501 2574 :type: list[SocialAuthentication] 2575 """ 2576 2577 self._social_authentications = social_authentications 2578 2579 @property 2580 def status(self): 2581 """Gets the status of this Witness. # noqa: E501 2582 2583 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 2584 2585 :return: The status of this Witness. # noqa: E501 2586 :rtype: str 2587 """ 2588 return self._status 2589 2590 @status.setter 2591 def status(self, status): 2592 """Sets the status of this Witness. 2593 2594 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 2595 2596 :param status: The status of this Witness. # noqa: E501 2597 :type: str 2598 """ 2599 2600 self._status = status 2601 2602 @property 2603 def status_code(self): 2604 """Gets the status_code of this Witness. # noqa: E501 2605 2606 # noqa: E501 2607 2608 :return: The status_code of this Witness. # noqa: E501 2609 :rtype: str 2610 """ 2611 return self._status_code 2612 2613 @status_code.setter 2614 def status_code(self, status_code): 2615 """Sets the status_code of this Witness. 2616 2617 # noqa: E501 2618 2619 :param status_code: The status_code of this Witness. # noqa: E501 2620 :type: str 2621 """ 2622 2623 self._status_code = status_code 2624 2625 @property 2626 def suppress_emails(self): 2627 """Gets the suppress_emails of this Witness. # noqa: E501 2628 2629 # noqa: E501 2630 2631 :return: The suppress_emails of this Witness. # noqa: E501 2632 :rtype: str 2633 """ 2634 return self._suppress_emails 2635 2636 @suppress_emails.setter 2637 def suppress_emails(self, suppress_emails): 2638 """Sets the suppress_emails of this Witness. 2639 2640 # noqa: E501 2641 2642 :param suppress_emails: The suppress_emails of this Witness. # noqa: E501 2643 :type: str 2644 """ 2645 2646 self._suppress_emails = suppress_emails 2647 2648 @property 2649 def tabs(self): 2650 """Gets the tabs of this Witness. # noqa: E501 2651 2652 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 2653 2654 :return: The tabs of this Witness. # noqa: E501 2655 :rtype: Tabs 2656 """ 2657 return self._tabs 2658 2659 @tabs.setter 2660 def tabs(self, tabs): 2661 """Sets the tabs of this Witness. 2662 2663 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 2664 2665 :param tabs: The tabs of this Witness. # noqa: E501 2666 :type: Tabs 2667 """ 2668 2669 self._tabs = tabs 2670 2671 @property 2672 def template_locked(self): 2673 """Gets the template_locked of this Witness. # noqa: E501 2674 2675 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2676 2677 :return: The template_locked of this Witness. # noqa: E501 2678 :rtype: str 2679 """ 2680 return self._template_locked 2681 2682 @template_locked.setter 2683 def template_locked(self, template_locked): 2684 """Sets the template_locked of this Witness. 2685 2686 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2687 2688 :param template_locked: The template_locked of this Witness. # noqa: E501 2689 :type: str 2690 """ 2691 2692 self._template_locked = template_locked 2693 2694 @property 2695 def template_required(self): 2696 """Gets the template_required of this Witness. # noqa: E501 2697 2698 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2699 2700 :return: The template_required of this Witness. # noqa: E501 2701 :rtype: str 2702 """ 2703 return self._template_required 2704 2705 @template_required.setter 2706 def template_required(self, template_required): 2707 """Sets the template_required of this Witness. 2708 2709 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2710 2711 :param template_required: The template_required of this Witness. # noqa: E501 2712 :type: str 2713 """ 2714 2715 self._template_required = template_required 2716 2717 @property 2718 def total_tab_count(self): 2719 """Gets the total_tab_count of this Witness. # noqa: E501 2720 2721 # noqa: E501 2722 2723 :return: The total_tab_count of this Witness. # noqa: E501 2724 :rtype: str 2725 """ 2726 return self._total_tab_count 2727 2728 @total_tab_count.setter 2729 def total_tab_count(self, total_tab_count): 2730 """Sets the total_tab_count of this Witness. 2731 2732 # noqa: E501 2733 2734 :param total_tab_count: The total_tab_count of this Witness. # noqa: E501 2735 :type: str 2736 """ 2737 2738 self._total_tab_count = total_tab_count 2739 2740 @property 2741 def user_id(self): 2742 """Gets the user_id of this Witness. # noqa: E501 2743 2744 # noqa: E501 2745 2746 :return: The user_id of this Witness. # noqa: E501 2747 :rtype: str 2748 """ 2749 return self._user_id 2750 2751 @user_id.setter 2752 def user_id(self, user_id): 2753 """Sets the user_id of this Witness. 2754 2755 # noqa: E501 2756 2757 :param user_id: The user_id of this Witness. # noqa: E501 2758 :type: str 2759 """ 2760 2761 self._user_id = user_id 2762 2763 @property 2764 def web_form_recipient_view_id(self): 2765 """Gets the web_form_recipient_view_id of this Witness. # noqa: E501 2766 2767 # noqa: E501 2768 2769 :return: The web_form_recipient_view_id of this Witness. # noqa: E501 2770 :rtype: str 2771 """ 2772 return self._web_form_recipient_view_id 2773 2774 @web_form_recipient_view_id.setter 2775 def web_form_recipient_view_id(self, web_form_recipient_view_id): 2776 """Sets the web_form_recipient_view_id of this Witness. 2777 2778 # noqa: E501 2779 2780 :param web_form_recipient_view_id: The web_form_recipient_view_id of this Witness. # noqa: E501 2781 :type: str 2782 """ 2783 2784 self._web_form_recipient_view_id = web_form_recipient_view_id 2785 2786 @property 2787 def witness_for(self): 2788 """Gets the witness_for of this Witness. # noqa: E501 2789 2790 # noqa: E501 2791 2792 :return: The witness_for of this Witness. # noqa: E501 2793 :rtype: str 2794 """ 2795 return self._witness_for 2796 2797 @witness_for.setter 2798 def witness_for(self, witness_for): 2799 """Sets the witness_for of this Witness. 2800 2801 # noqa: E501 2802 2803 :param witness_for: The witness_for of this Witness. # noqa: E501 2804 :type: str 2805 """ 2806 2807 self._witness_for = witness_for 2808 2809 @property 2810 def witness_for_guid(self): 2811 """Gets the witness_for_guid of this Witness. # noqa: E501 2812 2813 # noqa: E501 2814 2815 :return: The witness_for_guid of this Witness. # noqa: E501 2816 :rtype: str 2817 """ 2818 return self._witness_for_guid 2819 2820 @witness_for_guid.setter 2821 def witness_for_guid(self, witness_for_guid): 2822 """Sets the witness_for_guid of this Witness. 2823 2824 # noqa: E501 2825 2826 :param witness_for_guid: The witness_for_guid of this Witness. # noqa: E501 2827 :type: str 2828 """ 2829 2830 self._witness_for_guid = witness_for_guid 2831 2832 def to_dict(self): 2833 """Returns the model properties as a dict""" 2834 result = {} 2835 2836 for attr, _ in six.iteritems(self.swagger_types): 2837 value = getattr(self, attr) 2838 if isinstance(value, list): 2839 result[attr] = list(map( 2840 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2841 value 2842 )) 2843 elif hasattr(value, "to_dict"): 2844 result[attr] = value.to_dict() 2845 elif isinstance(value, dict): 2846 result[attr] = dict(map( 2847 lambda item: (item[0], item[1].to_dict()) 2848 if hasattr(item[1], "to_dict") else item, 2849 value.items() 2850 )) 2851 else: 2852 result[attr] = value 2853 if issubclass(Witness, dict): 2854 for key, value in self.items(): 2855 result[key] = value 2856 2857 return result 2858 2859 def to_str(self): 2860 """Returns the string representation of the model""" 2861 return pprint.pformat(self.to_dict()) 2862 2863 def __repr__(self): 2864 """For `print` and `pprint`""" 2865 return self.to_str() 2866 2867 def __eq__(self, other): 2868 """Returns true if both objects are equal""" 2869 if not isinstance(other, Witness): 2870 return False 2871 2872 return self.to_dict() == other.to_dict() 2873 2874 def __ne__(self, other): 2875 """Returns true if both objects are not equal""" 2876 if not isinstance(other, Witness): 2877 return True 2878 2879 return self.to_dict() != other.to_dict()
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Witness(_configuration=None, **kwargs)
248 def __init__(self, _configuration=None, **kwargs): # noqa: E501 249 """Witness - a model defined in Swagger""" # noqa: E501 250 if _configuration is None: 251 _configuration = Configuration() 252 self._configuration = _configuration 253 254 self._access_code = None 255 self._access_code_metadata = None 256 self._add_access_code_to_email = None 257 self._additional_notifications = None 258 self._agent_can_edit_email = None 259 self._agent_can_edit_name = None 260 self._allow_system_override_for_locked_recipient = None 261 self._auto_navigation = None 262 self._auto_responded_reason = None 263 self._bulk_recipients_uri = None 264 self._bulk_send_v2_recipient = None 265 self._can_sign_offline = None 266 self._client_user_id = None 267 self._completed_count = None 268 self._consent_details_list = None 269 self._creation_reason = None 270 self._custom_fields = None 271 self._declined_date_time = None 272 self._declined_reason = None 273 self._default_recipient = None 274 self._delegated_by = None 275 self._delegated_to = None 276 self._delivered_date_time = None 277 self._delivery_method = None 278 self._delivery_method_metadata = None 279 self._designator_id = None 280 self._designator_id_guid = None 281 self._document_template_id = None 282 self._document_visibility = None 283 self._email = None 284 self._email_metadata = None 285 self._email_notification = None 286 self._email_recipient_post_signing_url = None 287 self._embedded_recipient_start_url = None 288 self._error_details = None 289 self._excluded_documents = None 290 self._fax_number = None 291 self._fax_number_metadata = None 292 self._first_name = None 293 self._first_name_metadata = None 294 self._full_name = None 295 self._full_name_metadata = None 296 self._id_check_configuration_name = None 297 self._id_check_configuration_name_metadata = None 298 self._id_check_information_input = None 299 self._identity_verification = None 300 self._inherit_email_notification_configuration = None 301 self._is_bulk_recipient = None 302 self._is_bulk_recipient_metadata = None 303 self._last_name = None 304 self._last_name_metadata = None 305 self._locked_recipient_phone_auth_editable = None 306 self._locked_recipient_sms_editable = None 307 self._name = None 308 self._name_metadata = None 309 self._notary_id = None 310 self._notary_signer_email_sent = None 311 self._note = None 312 self._note_metadata = None 313 self._offline_attributes = None 314 self._phone_authentication = None 315 self._phone_number = None 316 self._proof_file = None 317 self._recipient_attachments = None 318 self._recipient_authentication_status = None 319 self._recipient_feature_metadata = None 320 self._recipient_id = None 321 self._recipient_id_guid = None 322 self._recipient_signature_providers = None 323 self._recipient_supplies_tabs = None 324 self._recipient_type = None 325 self._recipient_type_metadata = None 326 self._require_id_lookup = None 327 self._require_id_lookup_metadata = None 328 self._require_signer_certificate = None 329 self._require_sign_on_paper = None 330 self._require_upload_signature = None 331 self._role_name = None 332 self._routing_order = None 333 self._routing_order_metadata = None 334 self._sent_date_time = None 335 self._signature_info = None 336 self._signed_date_time = None 337 self._sign_in_each_location = None 338 self._sign_in_each_location_metadata = None 339 self._signing_group_id = None 340 self._signing_group_id_metadata = None 341 self._signing_group_name = None 342 self._signing_group_type = None 343 self._signing_group_users = None 344 self._sms_authentication = None 345 self._social_authentications = None 346 self._status = None 347 self._status_code = None 348 self._suppress_emails = None 349 self._tabs = None 350 self._template_locked = None 351 self._template_required = None 352 self._total_tab_count = None 353 self._user_id = None 354 self._web_form_recipient_view_id = None 355 self._witness_for = None 356 self._witness_for_guid = None 357 self.discriminator = None 358 359 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 360 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 361 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 362 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 363 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 364 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 365 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 366 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 367 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 368 setattr(self, "_{}".format('bulk_recipients_uri'), kwargs.get('bulk_recipients_uri', None)) 369 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 370 setattr(self, "_{}".format('can_sign_offline'), kwargs.get('can_sign_offline', None)) 371 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 372 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 373 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 374 setattr(self, "_{}".format('creation_reason'), kwargs.get('creation_reason', None)) 375 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 376 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 377 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 378 setattr(self, "_{}".format('default_recipient'), kwargs.get('default_recipient', None)) 379 setattr(self, "_{}".format('delegated_by'), kwargs.get('delegated_by', None)) 380 setattr(self, "_{}".format('delegated_to'), kwargs.get('delegated_to', None)) 381 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 382 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 383 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 384 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 385 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 386 setattr(self, "_{}".format('document_template_id'), kwargs.get('document_template_id', None)) 387 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 388 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 389 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 390 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 391 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 392 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 393 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 394 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 395 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 396 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 397 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 398 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 399 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 400 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 401 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 402 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 403 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 404 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 405 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 406 setattr(self, "_{}".format('is_bulk_recipient'), kwargs.get('is_bulk_recipient', None)) 407 setattr(self, "_{}".format('is_bulk_recipient_metadata'), kwargs.get('is_bulk_recipient_metadata', None)) 408 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 409 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 410 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 411 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 412 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 413 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 414 setattr(self, "_{}".format('notary_id'), kwargs.get('notary_id', None)) 415 setattr(self, "_{}".format('notary_signer_email_sent'), kwargs.get('notary_signer_email_sent', None)) 416 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 417 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 418 setattr(self, "_{}".format('offline_attributes'), kwargs.get('offline_attributes', None)) 419 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 420 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 421 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 422 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 423 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 424 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 425 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 426 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 427 setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None)) 428 setattr(self, "_{}".format('recipient_supplies_tabs'), kwargs.get('recipient_supplies_tabs', None)) 429 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 430 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 431 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 432 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 433 setattr(self, "_{}".format('require_signer_certificate'), kwargs.get('require_signer_certificate', None)) 434 setattr(self, "_{}".format('require_sign_on_paper'), kwargs.get('require_sign_on_paper', None)) 435 setattr(self, "_{}".format('require_upload_signature'), kwargs.get('require_upload_signature', None)) 436 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 437 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 438 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 439 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 440 setattr(self, "_{}".format('signature_info'), kwargs.get('signature_info', None)) 441 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 442 setattr(self, "_{}".format('sign_in_each_location'), kwargs.get('sign_in_each_location', None)) 443 setattr(self, "_{}".format('sign_in_each_location_metadata'), kwargs.get('sign_in_each_location_metadata', None)) 444 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 445 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 446 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 447 setattr(self, "_{}".format('signing_group_type'), kwargs.get('signing_group_type', None)) 448 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 449 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 450 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 451 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 452 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 453 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 454 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 455 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 456 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 457 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 458 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 459 setattr(self, "_{}".format('web_form_recipient_view_id'), kwargs.get('web_form_recipient_view_id', None)) 460 setattr(self, "_{}".format('witness_for'), kwargs.get('witness_for', None)) 461 setattr(self, "_{}".format('witness_for_guid'), kwargs.get('witness_for_guid', None))
Witness - a model defined in Swagger
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', 'witness_for': 'str', 'witness_for_guid': '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', 'witness_for': 'witnessFor', 'witness_for_guid': 'witnessForGuid'}
access_code
Gets the access_code of this Witness. # 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
Returns
The access_code of this Witness. # noqa: E501
access_code_metadata
Gets the access_code_metadata of this Witness. # noqa: E501
Metadata that indicates whether the accessCode property is editable. This property is read-only. # noqa: E501
Returns
The access_code_metadata of this Witness. # noqa: E501
add_access_code_to_email
Gets the add_access_code_to_email of this Witness. # 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
Returns
The add_access_code_to_email of this Witness. # noqa: E501
additional_notifications
Gets the additional_notifications of this Witness. # noqa: E501
# noqa: E501
Returns
The additional_notifications of this Witness. # noqa: E501
agent_can_edit_email
Gets the agent_can_edit_email of this Witness. # noqa: E501
# noqa: E501
Returns
The agent_can_edit_email of this Witness. # noqa: E501
agent_can_edit_name
Gets the agent_can_edit_name of this Witness. # noqa: E501
# noqa: E501
Returns
The agent_can_edit_name of this Witness. # noqa: E501
allow_system_override_for_locked_recipient
Gets the allow_system_override_for_locked_recipient of this Witness. # noqa: E501
# noqa: E501
Returns
The allow_system_override_for_locked_recipient of this Witness. # noqa: E501
auto_responded_reason
Gets the auto_responded_reason of this Witness. # noqa: E501
# noqa: E501
Returns
The auto_responded_reason of this Witness. # noqa: E501
bulk_recipients_uri
Gets the bulk_recipients_uri of this Witness. # noqa: E501
Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501
Returns
The bulk_recipients_uri of this Witness. # noqa: E501
bulk_send_v2_recipient
Gets the bulk_send_v2_recipient of this Witness. # noqa: E501
# noqa: E501
Returns
The bulk_send_v2_recipient of this Witness. # noqa: E501
can_sign_offline
Gets the can_sign_offline of this Witness. # noqa: E501
When set to true, specifies that the signer can perform the signing ceremony offline. # noqa: E501
Returns
The can_sign_offline of this Witness. # noqa: E501
client_user_id
Gets the client_user_id of this Witness. # 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
Returns
The client_user_id of this Witness. # noqa: E501
completed_count
Gets the completed_count of this Witness. # noqa: E501
# noqa: E501
Returns
The completed_count of this Witness. # noqa: E501
consent_details_list
Gets the consent_details_list of this Witness. # noqa: E501
# noqa: E501
Returns
The consent_details_list of this Witness. # noqa: E501
creation_reason
Gets the creation_reason of this Witness. # noqa: E501
# noqa: E501
Returns
The creation_reason of this Witness. # noqa: E501
custom_fields
Gets the custom_fields of this Witness. # 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
Returns
The custom_fields of this Witness. # noqa: E501
declined_date_time
Gets the declined_date_time of this Witness. # noqa: E501
The date and time the recipient declined the document. # noqa: E501
Returns
The declined_date_time of this Witness. # noqa: E501
declined_reason
Gets the declined_reason of this Witness. # noqa: E501
The reason the recipient declined the document. # noqa: E501
Returns
The declined_reason of this Witness. # noqa: E501
default_recipient
Gets the default_recipient of this Witness. # noqa: E501
# noqa: E501
Returns
The default_recipient of this Witness. # noqa: E501
delegated_by
Gets the delegated_by of this Witness. # noqa: E501
# noqa: E501
Returns
The delegated_by of this Witness. # noqa: E501
delegated_to
Gets the delegated_to of this Witness. # noqa: E501
# noqa: E501
Returns
The delegated_to of this Witness. # noqa: E501
delivered_date_time
Gets the delivered_date_time of this Witness. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivered_date_time of this Witness. # noqa: E501
delivery_method
Gets the delivery_method of this Witness. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivery_method of this Witness. # noqa: E501
delivery_method_metadata
Gets the delivery_method_metadata of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The delivery_method_metadata of this Witness. # noqa: E501
designator_id
Gets the designator_id of this Witness. # noqa: E501
# noqa: E501
Returns
The designator_id of this Witness. # noqa: E501
designator_id_guid
Gets the designator_id_guid of this Witness. # noqa: E501
# noqa: E501
Returns
The designator_id_guid of this Witness. # noqa: E501
document_template_id
Gets the document_template_id of this Witness. # noqa: E501
# noqa: E501
Returns
The document_template_id of this Witness. # noqa: E501
document_visibility
Gets the document_visibility of this Witness. # noqa: E501
# noqa: E501
Returns
The document_visibility of this Witness. # noqa: E501
email
Gets the email of this Witness. # noqa: E501
# noqa: E501
Returns
The email of this Witness. # noqa: E501
email_metadata
Gets the email_metadata of this Witness. # noqa: E501
Metadata that indicates whether the email property is editable. This property is read-only. # noqa: E501
Returns
The email_metadata of this Witness. # noqa: E501
email_notification
Gets the email_notification of this Witness. # 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
Returns
The email_notification of this Witness. # noqa: E501
email_recipient_post_signing_url
Gets the email_recipient_post_signing_url of this Witness. # noqa: E501
# noqa: E501
Returns
The email_recipient_post_signing_url of this Witness. # noqa: E501
embedded_recipient_start_url
Gets the embedded_recipient_start_url of this Witness. # 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
Returns
The embedded_recipient_start_url of this Witness. # noqa: E501
error_details
Gets the error_details of this Witness. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this Witness. # noqa: E501
excluded_documents
Gets the excluded_documents of this Witness. # 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
Returns
The excluded_documents of this Witness. # noqa: E501
fax_number
Gets the fax_number of this Witness. # noqa: E501
Reserved: # noqa: E501
Returns
The fax_number of this Witness. # noqa: E501
fax_number_metadata
Gets the fax_number_metadata of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The fax_number_metadata of this Witness. # noqa: E501
first_name
Gets the first_name of this Witness. # noqa: E501
The user's first name. Maximum Length: 50 characters. # noqa: E501
Returns
The first_name of this Witness. # noqa: E501
first_name_metadata
Gets the first_name_metadata of this Witness. # noqa: E501
Metadata that indicates whether the firstName property is editable. This property is read-only. # noqa: E501
Returns
The first_name_metadata of this Witness. # noqa: E501
full_name
Gets the full_name of this Witness. # noqa: E501
# noqa: E501
Returns
The full_name of this Witness. # noqa: E501
full_name_metadata
Gets the full_name_metadata of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The full_name_metadata of this Witness. # noqa: E501
id_check_configuration_name
Gets the id_check_configuration_name of this Witness. # 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
Returns
The id_check_configuration_name of this Witness. # noqa: E501
id_check_configuration_name_metadata
Gets the id_check_configuration_name_metadata of this Witness. # noqa: E501
Metadata that indicates whether the idCheckConfigurationName property is editable. This property is read-only. # noqa: E501
Returns
The id_check_configuration_name_metadata of this Witness. # noqa: E501
id_check_information_input
Gets the id_check_information_input of this Witness. # noqa: E501
An object that contains input information related to a recipient ID check. # noqa: E501
Returns
The id_check_information_input of this Witness. # noqa: E501
identity_verification
Gets the identity_verification of this Witness. # noqa: E501
Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other recipient authentication methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501
Returns
The identity_verification of this Witness. # noqa: E501
inherit_email_notification_configuration
Gets the inherit_email_notification_configuration of this Witness. # 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
Returns
The inherit_email_notification_configuration of this Witness. # noqa: E501
is_bulk_recipient
Gets the is_bulk_recipient of this Witness. # noqa: E501
# noqa: E501
Returns
The is_bulk_recipient of this Witness. # noqa: E501
is_bulk_recipient_metadata
Gets the is_bulk_recipient_metadata of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The is_bulk_recipient_metadata of this Witness. # noqa: E501
last_name
Gets the last_name of this Witness. # noqa: E501
# noqa: E501
Returns
The last_name of this Witness. # noqa: E501
last_name_metadata
Gets the last_name_metadata of this Witness. # noqa: E501
Metadata that indicates whether the lastName property is editable. This property is read-only. # noqa: E501
Returns
The last_name_metadata of this Witness. # noqa: E501
locked_recipient_phone_auth_editable
Gets the locked_recipient_phone_auth_editable of this Witness. # noqa: E501
# noqa: E501
Returns
The locked_recipient_phone_auth_editable of this Witness. # noqa: E501
locked_recipient_sms_editable
Gets the locked_recipient_sms_editable of this Witness. # noqa: E501
# noqa: E501
Returns
The locked_recipient_sms_editable of this Witness. # noqa: E501
name
Gets the name of this Witness. # noqa: E501
# noqa: E501
Returns
The name of this Witness. # noqa: E501
name_metadata
Gets the name_metadata of this Witness. # noqa: E501
Metadata that indicates whether the name property is editable. This property is read-only. # noqa: E501
Returns
The name_metadata of this Witness. # noqa: E501
notary_id
Gets the notary_id of this Witness. # noqa: E501
# noqa: E501
Returns
The notary_id of this Witness. # noqa: E501
notary_signer_email_sent
Gets the notary_signer_email_sent of this Witness. # noqa: E501
# noqa: E501
Returns
The notary_signer_email_sent of this Witness. # noqa: E501
note
Gets the note of this Witness. # 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
Returns
The note of this Witness. # noqa: E501
note_metadata
Gets the note_metadata of this Witness. # noqa: E501
Metadata that indicates whether the note property is editable. This property is read-only. # noqa: E501
Returns
The note_metadata of this Witness. # noqa: E501
offline_attributes
Gets the offline_attributes of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The offline_attributes of this Witness. # noqa: E501
phone_authentication
Gets the phone_authentication of this Witness. # noqa: E501
When idCheckConfigurationName is set to Phone Auth $, you use this complex type to provide the recipient authentication method details. It contains the following elements: * recipMayProvideNumber: Boolean. When true, the recipient can use whatever phone number they choose. * senderProvidedNumbers: ArrayOfStrings. A list of phone numbers the recipient can use. * recordVoicePrint: Reserved for DocuSign. * validateRecipProvidedNumber: Reserved for DocuSign. # noqa: E501
Returns
The phone_authentication of this Witness. # noqa: E501
phone_number
Gets the phone_number of this Witness. # noqa: E501
Describes the recipient phone number. # noqa: E501
Returns
The phone_number of this Witness. # noqa: E501
proof_file
Gets the proof_file of this Witness. # noqa: E501
The proof file of the recipient. # noqa: E501
Returns
The proof_file of this Witness. # noqa: E501
recipient_attachments
Gets the recipient_attachments of this Witness. # noqa: E501
Reserved: # noqa: E501
Returns
The recipient_attachments of this Witness. # noqa: E501
recipient_authentication_status
Gets the recipient_authentication_status of this Witness. # noqa: E501
Information about the recipient's authentication status. This property is read-only. # noqa: E501
Returns
The recipient_authentication_status of this Witness. # noqa: E501
recipient_feature_metadata
Gets the recipient_feature_metadata of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_feature_metadata of this Witness. # noqa: E501
recipient_id
Gets the recipient_id of this Witness. # noqa: E501
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501
Returns
The recipient_id of this Witness. # noqa: E501
recipient_id_guid
Gets the recipient_id_guid of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this Witness. # noqa: E501
recipient_signature_providers
Gets the recipient_signature_providers of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_signature_providers of this Witness. # noqa: E501
recipient_supplies_tabs
Gets the recipient_supplies_tabs of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_supplies_tabs of this Witness. # noqa: E501
recipient_type
Gets the recipient_type of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_type of this Witness. # noqa: E501
recipient_type_metadata
Gets the recipient_type_metadata of this Witness. # noqa: E501
Metadata that indicates whether the recipientType property is editable. This property is read-only. # noqa: E501
Returns
The recipient_type_metadata of this Witness. # noqa: E501
require_id_lookup
Gets the require_id_lookup of this Witness. # 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
Returns
The require_id_lookup of this Witness. # noqa: E501
require_id_lookup_metadata
Gets the require_id_lookup_metadata of this Witness. # noqa: E501
Metadata that indicates whether the requireIdLookup property is editable. This property is read-only. # noqa: E501
Returns
The require_id_lookup_metadata of this Witness. # noqa: E501
require_signer_certificate
Gets the require_signer_certificate of this Witness. # noqa: E501
# noqa: E501
Returns
The require_signer_certificate of this Witness. # noqa: E501
require_sign_on_paper
Gets the require_sign_on_paper of this Witness. # noqa: E501
# noqa: E501
Returns
The require_sign_on_paper of this Witness. # noqa: E501
require_upload_signature
Gets the require_upload_signature of this Witness. # noqa: E501
# noqa: E501
Returns
The require_upload_signature of this Witness. # noqa: E501
role_name
Gets the role_name of this Witness. # noqa: E501
Optional element. Specifies the role name associated with the recipient.
This is required when working with template recipients. # noqa: E501
Returns
The role_name of this Witness. # noqa: E501
routing_order
Gets the routing_order of this Witness. # noqa: E501
Specifies the routing order of the recipient in the envelope. # noqa: E501
Returns
The routing_order of this Witness. # noqa: E501
routing_order_metadata
Gets the routing_order_metadata of this Witness. # noqa: E501
Metadata that indicates whether the routingOrder property is editable. This property is read-only. # noqa: E501
Returns
The routing_order_metadata of this Witness. # noqa: E501
sent_date_time
Gets the sent_date_time of this Witness. # noqa: E501
The date and time the envelope was sent. # noqa: E501
Returns
The sent_date_time of this Witness. # noqa: E501
signature_info
Gets the signature_info of this Witness. # noqa: E501
Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501
Returns
The signature_info of this Witness. # noqa: E501
signed_date_time
Gets the signed_date_time of this Witness. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The signed_date_time of this Witness. # noqa: E501
sign_in_each_location
Gets the sign_in_each_location of this Witness. # noqa: E501
When set to true, specifies that the signer must sign in all locations. # noqa: E501
Returns
The sign_in_each_location of this Witness. # noqa: E501
sign_in_each_location_metadata
Gets the sign_in_each_location_metadata of this Witness. # noqa: E501
Metadata that indicates whether the signInEachLocation property is editable. This property is read-only. # noqa: E501
Returns
The sign_in_each_location_metadata of this Witness. # noqa: E501
signing_group_id
Gets the signing_group_id of this Witness. # 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
Returns
The signing_group_id of this Witness. # noqa: E501
signing_group_id_metadata
Gets the signing_group_id_metadata of this Witness. # noqa: E501
Metadata that indicates whether the signingGroupId property is editable. This property is read-only. # noqa: E501
Returns
The signing_group_id_metadata of this Witness. # noqa: E501
signing_group_name
Gets the signing_group_name of this Witness. # noqa: E501
The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
Returns
The signing_group_name of this Witness. # noqa: E501
signing_group_type
Gets the signing_group_type of this Witness. # noqa: E501
# noqa: E501
Returns
The signing_group_type of this Witness. # noqa: E501
signing_group_users
Gets the signing_group_users of this Witness. # noqa: E501
A complex type that contains information about users in the signing group. # noqa: E501
Returns
The signing_group_users of this Witness. # noqa: E501
sms_authentication
Gets the sms_authentication of this Witness. # noqa: E501
When idCheckConfigurationName is set to SMS Auth $, you use this complex type to provide the recipient authentication method details. It contains the element senderProvidedNumbers, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501
Returns
The sms_authentication of this Witness. # noqa: E501
status
Gets the status of this Witness. # 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
Returns
The status of this Witness. # noqa: E501
status_code
Gets the status_code of this Witness. # noqa: E501
# noqa: E501
Returns
The status_code of this Witness. # noqa: E501
suppress_emails
Gets the suppress_emails of this Witness. # noqa: E501
# noqa: E501
Returns
The suppress_emails of this Witness. # noqa: E501
tabs
Gets the tabs of this Witness. # noqa: E501
A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501
Returns
The tabs of this Witness. # noqa: E501
template_locked
Gets the template_locked of this Witness. # noqa: E501
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_locked of this Witness. # noqa: E501
template_required
Gets the template_required of this Witness. # noqa: E501
When set to true, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_required of this Witness. # noqa: E501
total_tab_count
Gets the total_tab_count of this Witness. # noqa: E501
# noqa: E501
Returns
The total_tab_count of this Witness. # noqa: E501
user_id
Gets the user_id of this Witness. # noqa: E501
# noqa: E501
Returns
The user_id of this Witness. # noqa: E501
web_form_recipient_view_id
Gets the web_form_recipient_view_id of this Witness. # noqa: E501
# noqa: E501
Returns
The web_form_recipient_view_id of this Witness. # noqa: E501
witness_for
Gets the witness_for of this Witness. # noqa: E501
# noqa: E501
Returns
The witness_for of this Witness. # noqa: E501
witness_for_guid
Gets the witness_for_guid of this Witness. # noqa: E501
# noqa: E501
Returns
The witness_for_guid of this Witness. # noqa: E501
def
to_dict(self)
2832 def to_dict(self): 2833 """Returns the model properties as a dict""" 2834 result = {} 2835 2836 for attr, _ in six.iteritems(self.swagger_types): 2837 value = getattr(self, attr) 2838 if isinstance(value, list): 2839 result[attr] = list(map( 2840 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2841 value 2842 )) 2843 elif hasattr(value, "to_dict"): 2844 result[attr] = value.to_dict() 2845 elif isinstance(value, dict): 2846 result[attr] = dict(map( 2847 lambda item: (item[0], item[1].to_dict()) 2848 if hasattr(item[1], "to_dict") else item, 2849 value.items() 2850 )) 2851 else: 2852 result[attr] = value 2853 if issubclass(Witness, dict): 2854 for key, value in self.items(): 2855 result[key] = value 2856 2857 return result
Returns the model properties as a dict