docusign_esign.models.certified_delivery
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 CertifiedDelivery(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_responded_reason': 'str', 44 'bulk_send_v2_recipient': 'str', 45 'client_user_id': 'str', 46 'completed_count': 'str', 47 'consent_details_list': 'list[ConsentDetails]', 48 'custom_fields': 'list[str]', 49 'declined_date_time': 'str', 50 'declined_reason': 'str', 51 'delivered_date_time': 'str', 52 'delivery_method': 'str', 53 'delivery_method_metadata': 'PropertyMetadata', 54 'designator_id': 'str', 55 'designator_id_guid': 'str', 56 'document_template_id': 'str', 57 'document_visibility': 'list[DocumentVisibility]', 58 'email': 'str', 59 'email_metadata': 'PropertyMetadata', 60 'email_notification': 'RecipientEmailNotification', 61 'email_recipient_post_signing_url': 'str', 62 'embedded_recipient_start_url': 'str', 63 'error_details': 'ErrorDetails', 64 'excluded_documents': 'list[str]', 65 'fax_number': 'str', 66 'fax_number_metadata': 'PropertyMetadata', 67 'first_name': 'str', 68 'first_name_metadata': 'PropertyMetadata', 69 'full_name': 'str', 70 'full_name_metadata': 'PropertyMetadata', 71 'id_check_configuration_name': 'str', 72 'id_check_configuration_name_metadata': 'PropertyMetadata', 73 'id_check_information_input': 'IdCheckInformationInput', 74 'identity_verification': 'RecipientIdentityVerification', 75 'inherit_email_notification_configuration': 'str', 76 'last_name': 'str', 77 'last_name_metadata': 'PropertyMetadata', 78 'locked_recipient_phone_auth_editable': 'str', 79 'locked_recipient_sms_editable': 'str', 80 'name': 'str', 81 'name_metadata': 'PropertyMetadata', 82 'note': 'str', 83 'note_metadata': 'PropertyMetadata', 84 'phone_authentication': 'RecipientPhoneAuthentication', 85 'phone_number': 'RecipientPhoneNumber', 86 'proof_file': 'RecipientProofFile', 87 'recipient_attachments': 'list[RecipientAttachment]', 88 'recipient_authentication_status': 'AuthenticationStatus', 89 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 90 'recipient_id': 'str', 91 'recipient_id_guid': 'str', 92 'recipient_type': 'str', 93 'recipient_type_metadata': 'PropertyMetadata', 94 'require_id_lookup': 'str', 95 'require_id_lookup_metadata': 'PropertyMetadata', 96 'role_name': 'str', 97 'routing_order': 'str', 98 'routing_order_metadata': 'PropertyMetadata', 99 'sent_date_time': 'str', 100 'signed_date_time': 'str', 101 'signing_group_id': 'str', 102 'signing_group_id_metadata': 'PropertyMetadata', 103 'signing_group_name': 'str', 104 'signing_group_type': 'str', 105 'signing_group_users': 'list[UserInfo]', 106 'sms_authentication': 'RecipientSMSAuthentication', 107 'social_authentications': 'list[SocialAuthentication]', 108 'status': 'str', 109 'status_code': 'str', 110 'suppress_emails': 'str', 111 'template_locked': 'str', 112 'template_required': 'str', 113 'total_tab_count': 'str', 114 'user_id': 'str', 115 'web_form_recipient_view_id': 'str' 116 } 117 118 attribute_map = { 119 'access_code': 'accessCode', 120 'access_code_metadata': 'accessCodeMetadata', 121 'add_access_code_to_email': 'addAccessCodeToEmail', 122 'additional_notifications': 'additionalNotifications', 123 'agent_can_edit_email': 'agentCanEditEmail', 124 'agent_can_edit_name': 'agentCanEditName', 125 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 126 'auto_responded_reason': 'autoRespondedReason', 127 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 128 'client_user_id': 'clientUserId', 129 'completed_count': 'completedCount', 130 'consent_details_list': 'consentDetailsList', 131 'custom_fields': 'customFields', 132 'declined_date_time': 'declinedDateTime', 133 'declined_reason': 'declinedReason', 134 'delivered_date_time': 'deliveredDateTime', 135 'delivery_method': 'deliveryMethod', 136 'delivery_method_metadata': 'deliveryMethodMetadata', 137 'designator_id': 'designatorId', 138 'designator_id_guid': 'designatorIdGuid', 139 'document_template_id': 'documentTemplateId', 140 'document_visibility': 'documentVisibility', 141 'email': 'email', 142 'email_metadata': 'emailMetadata', 143 'email_notification': 'emailNotification', 144 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 145 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 146 'error_details': 'errorDetails', 147 'excluded_documents': 'excludedDocuments', 148 'fax_number': 'faxNumber', 149 'fax_number_metadata': 'faxNumberMetadata', 150 'first_name': 'firstName', 151 'first_name_metadata': 'firstNameMetadata', 152 'full_name': 'fullName', 153 'full_name_metadata': 'fullNameMetadata', 154 'id_check_configuration_name': 'idCheckConfigurationName', 155 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 156 'id_check_information_input': 'idCheckInformationInput', 157 'identity_verification': 'identityVerification', 158 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 159 'last_name': 'lastName', 160 'last_name_metadata': 'lastNameMetadata', 161 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 162 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 163 'name': 'name', 164 'name_metadata': 'nameMetadata', 165 'note': 'note', 166 'note_metadata': 'noteMetadata', 167 'phone_authentication': 'phoneAuthentication', 168 'phone_number': 'phoneNumber', 169 'proof_file': 'proofFile', 170 'recipient_attachments': 'recipientAttachments', 171 'recipient_authentication_status': 'recipientAuthenticationStatus', 172 'recipient_feature_metadata': 'recipientFeatureMetadata', 173 'recipient_id': 'recipientId', 174 'recipient_id_guid': 'recipientIdGuid', 175 'recipient_type': 'recipientType', 176 'recipient_type_metadata': 'recipientTypeMetadata', 177 'require_id_lookup': 'requireIdLookup', 178 'require_id_lookup_metadata': 'requireIdLookupMetadata', 179 'role_name': 'roleName', 180 'routing_order': 'routingOrder', 181 'routing_order_metadata': 'routingOrderMetadata', 182 'sent_date_time': 'sentDateTime', 183 'signed_date_time': 'signedDateTime', 184 'signing_group_id': 'signingGroupId', 185 'signing_group_id_metadata': 'signingGroupIdMetadata', 186 'signing_group_name': 'signingGroupName', 187 'signing_group_type': 'signingGroupType', 188 'signing_group_users': 'signingGroupUsers', 189 'sms_authentication': 'smsAuthentication', 190 'social_authentications': 'socialAuthentications', 191 'status': 'status', 192 'status_code': 'statusCode', 193 'suppress_emails': 'suppressEmails', 194 'template_locked': 'templateLocked', 195 'template_required': 'templateRequired', 196 'total_tab_count': 'totalTabCount', 197 'user_id': 'userId', 198 'web_form_recipient_view_id': 'webFormRecipientViewId' 199 } 200 201 def __init__(self, _configuration=None, **kwargs): # noqa: E501 202 """CertifiedDelivery - a model defined in Swagger""" # noqa: E501 203 if _configuration is None: 204 _configuration = Configuration() 205 self._configuration = _configuration 206 207 self._access_code = None 208 self._access_code_metadata = None 209 self._add_access_code_to_email = None 210 self._additional_notifications = None 211 self._agent_can_edit_email = None 212 self._agent_can_edit_name = None 213 self._allow_system_override_for_locked_recipient = None 214 self._auto_responded_reason = None 215 self._bulk_send_v2_recipient = None 216 self._client_user_id = None 217 self._completed_count = None 218 self._consent_details_list = None 219 self._custom_fields = None 220 self._declined_date_time = None 221 self._declined_reason = None 222 self._delivered_date_time = None 223 self._delivery_method = None 224 self._delivery_method_metadata = None 225 self._designator_id = None 226 self._designator_id_guid = None 227 self._document_template_id = None 228 self._document_visibility = None 229 self._email = None 230 self._email_metadata = None 231 self._email_notification = None 232 self._email_recipient_post_signing_url = None 233 self._embedded_recipient_start_url = None 234 self._error_details = None 235 self._excluded_documents = None 236 self._fax_number = None 237 self._fax_number_metadata = None 238 self._first_name = None 239 self._first_name_metadata = None 240 self._full_name = None 241 self._full_name_metadata = None 242 self._id_check_configuration_name = None 243 self._id_check_configuration_name_metadata = None 244 self._id_check_information_input = None 245 self._identity_verification = None 246 self._inherit_email_notification_configuration = None 247 self._last_name = None 248 self._last_name_metadata = None 249 self._locked_recipient_phone_auth_editable = None 250 self._locked_recipient_sms_editable = None 251 self._name = None 252 self._name_metadata = None 253 self._note = None 254 self._note_metadata = None 255 self._phone_authentication = None 256 self._phone_number = None 257 self._proof_file = None 258 self._recipient_attachments = None 259 self._recipient_authentication_status = None 260 self._recipient_feature_metadata = None 261 self._recipient_id = None 262 self._recipient_id_guid = None 263 self._recipient_type = None 264 self._recipient_type_metadata = None 265 self._require_id_lookup = None 266 self._require_id_lookup_metadata = None 267 self._role_name = None 268 self._routing_order = None 269 self._routing_order_metadata = None 270 self._sent_date_time = None 271 self._signed_date_time = None 272 self._signing_group_id = None 273 self._signing_group_id_metadata = None 274 self._signing_group_name = None 275 self._signing_group_type = None 276 self._signing_group_users = None 277 self._sms_authentication = None 278 self._social_authentications = None 279 self._status = None 280 self._status_code = None 281 self._suppress_emails = None 282 self._template_locked = None 283 self._template_required = None 284 self._total_tab_count = None 285 self._user_id = None 286 self._web_form_recipient_view_id = None 287 self.discriminator = None 288 289 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 290 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 291 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 292 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 293 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 294 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 295 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 296 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 297 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 298 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 299 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 300 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 301 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 302 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 303 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 304 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 305 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 306 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 307 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 308 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 309 setattr(self, "_{}".format('document_template_id'), kwargs.get('document_template_id', None)) 310 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 311 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 312 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 313 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 314 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 315 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 316 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 317 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 318 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 319 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 320 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 321 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 322 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 323 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 324 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 325 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 326 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 327 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 328 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 329 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 330 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 331 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 332 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 333 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 334 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 335 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 336 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 337 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 338 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 339 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 340 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 341 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 342 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 343 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 344 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 345 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 346 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 347 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 348 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 349 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 350 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 351 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 352 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 353 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 354 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 355 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 356 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 357 setattr(self, "_{}".format('signing_group_type'), kwargs.get('signing_group_type', None)) 358 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 359 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 360 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 361 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 362 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 363 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 364 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 365 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 366 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 367 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 368 setattr(self, "_{}".format('web_form_recipient_view_id'), kwargs.get('web_form_recipient_view_id', None)) 369 370 @property 371 def access_code(self): 372 """Gets the access_code of this CertifiedDelivery. # noqa: E501 373 374 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 375 376 :return: The access_code of this CertifiedDelivery. # noqa: E501 377 :rtype: str 378 """ 379 return self._access_code 380 381 @access_code.setter 382 def access_code(self, access_code): 383 """Sets the access_code of this CertifiedDelivery. 384 385 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 386 387 :param access_code: The access_code of this CertifiedDelivery. # noqa: E501 388 :type: str 389 """ 390 391 self._access_code = access_code 392 393 @property 394 def access_code_metadata(self): 395 """Gets the access_code_metadata of this CertifiedDelivery. # noqa: E501 396 397 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 398 399 :return: The access_code_metadata of this CertifiedDelivery. # noqa: E501 400 :rtype: PropertyMetadata 401 """ 402 return self._access_code_metadata 403 404 @access_code_metadata.setter 405 def access_code_metadata(self, access_code_metadata): 406 """Sets the access_code_metadata of this CertifiedDelivery. 407 408 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 409 410 :param access_code_metadata: The access_code_metadata of this CertifiedDelivery. # noqa: E501 411 :type: PropertyMetadata 412 """ 413 414 self._access_code_metadata = access_code_metadata 415 416 @property 417 def add_access_code_to_email(self): 418 """Gets the add_access_code_to_email of this CertifiedDelivery. # noqa: E501 419 420 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 421 422 :return: The add_access_code_to_email of this CertifiedDelivery. # noqa: E501 423 :rtype: str 424 """ 425 return self._add_access_code_to_email 426 427 @add_access_code_to_email.setter 428 def add_access_code_to_email(self, add_access_code_to_email): 429 """Sets the add_access_code_to_email of this CertifiedDelivery. 430 431 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 432 433 :param add_access_code_to_email: The add_access_code_to_email of this CertifiedDelivery. # noqa: E501 434 :type: str 435 """ 436 437 self._add_access_code_to_email = add_access_code_to_email 438 439 @property 440 def additional_notifications(self): 441 """Gets the additional_notifications of this CertifiedDelivery. # noqa: E501 442 443 # noqa: E501 444 445 :return: The additional_notifications of this CertifiedDelivery. # noqa: E501 446 :rtype: list[RecipientAdditionalNotification] 447 """ 448 return self._additional_notifications 449 450 @additional_notifications.setter 451 def additional_notifications(self, additional_notifications): 452 """Sets the additional_notifications of this CertifiedDelivery. 453 454 # noqa: E501 455 456 :param additional_notifications: The additional_notifications of this CertifiedDelivery. # noqa: E501 457 :type: list[RecipientAdditionalNotification] 458 """ 459 460 self._additional_notifications = additional_notifications 461 462 @property 463 def agent_can_edit_email(self): 464 """Gets the agent_can_edit_email of this CertifiedDelivery. # noqa: E501 465 466 # noqa: E501 467 468 :return: The agent_can_edit_email of this CertifiedDelivery. # noqa: E501 469 :rtype: str 470 """ 471 return self._agent_can_edit_email 472 473 @agent_can_edit_email.setter 474 def agent_can_edit_email(self, agent_can_edit_email): 475 """Sets the agent_can_edit_email of this CertifiedDelivery. 476 477 # noqa: E501 478 479 :param agent_can_edit_email: The agent_can_edit_email of this CertifiedDelivery. # noqa: E501 480 :type: str 481 """ 482 483 self._agent_can_edit_email = agent_can_edit_email 484 485 @property 486 def agent_can_edit_name(self): 487 """Gets the agent_can_edit_name of this CertifiedDelivery. # noqa: E501 488 489 # noqa: E501 490 491 :return: The agent_can_edit_name of this CertifiedDelivery. # noqa: E501 492 :rtype: str 493 """ 494 return self._agent_can_edit_name 495 496 @agent_can_edit_name.setter 497 def agent_can_edit_name(self, agent_can_edit_name): 498 """Sets the agent_can_edit_name of this CertifiedDelivery. 499 500 # noqa: E501 501 502 :param agent_can_edit_name: The agent_can_edit_name of this CertifiedDelivery. # noqa: E501 503 :type: str 504 """ 505 506 self._agent_can_edit_name = agent_can_edit_name 507 508 @property 509 def allow_system_override_for_locked_recipient(self): 510 """Gets the allow_system_override_for_locked_recipient of this CertifiedDelivery. # noqa: E501 511 512 # noqa: E501 513 514 :return: The allow_system_override_for_locked_recipient of this CertifiedDelivery. # noqa: E501 515 :rtype: str 516 """ 517 return self._allow_system_override_for_locked_recipient 518 519 @allow_system_override_for_locked_recipient.setter 520 def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): 521 """Sets the allow_system_override_for_locked_recipient of this CertifiedDelivery. 522 523 # noqa: E501 524 525 :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this CertifiedDelivery. # noqa: E501 526 :type: str 527 """ 528 529 self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient 530 531 @property 532 def auto_responded_reason(self): 533 """Gets the auto_responded_reason of this CertifiedDelivery. # noqa: E501 534 535 # noqa: E501 536 537 :return: The auto_responded_reason of this CertifiedDelivery. # noqa: E501 538 :rtype: str 539 """ 540 return self._auto_responded_reason 541 542 @auto_responded_reason.setter 543 def auto_responded_reason(self, auto_responded_reason): 544 """Sets the auto_responded_reason of this CertifiedDelivery. 545 546 # noqa: E501 547 548 :param auto_responded_reason: The auto_responded_reason of this CertifiedDelivery. # noqa: E501 549 :type: str 550 """ 551 552 self._auto_responded_reason = auto_responded_reason 553 554 @property 555 def bulk_send_v2_recipient(self): 556 """Gets the bulk_send_v2_recipient of this CertifiedDelivery. # noqa: E501 557 558 # noqa: E501 559 560 :return: The bulk_send_v2_recipient of this CertifiedDelivery. # noqa: E501 561 :rtype: str 562 """ 563 return self._bulk_send_v2_recipient 564 565 @bulk_send_v2_recipient.setter 566 def bulk_send_v2_recipient(self, bulk_send_v2_recipient): 567 """Sets the bulk_send_v2_recipient of this CertifiedDelivery. 568 569 # noqa: E501 570 571 :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this CertifiedDelivery. # noqa: E501 572 :type: str 573 """ 574 575 self._bulk_send_v2_recipient = bulk_send_v2_recipient 576 577 @property 578 def client_user_id(self): 579 """Gets the client_user_id of this CertifiedDelivery. # noqa: E501 580 581 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 582 583 :return: The client_user_id of this CertifiedDelivery. # noqa: E501 584 :rtype: str 585 """ 586 return self._client_user_id 587 588 @client_user_id.setter 589 def client_user_id(self, client_user_id): 590 """Sets the client_user_id of this CertifiedDelivery. 591 592 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 593 594 :param client_user_id: The client_user_id of this CertifiedDelivery. # noqa: E501 595 :type: str 596 """ 597 598 self._client_user_id = client_user_id 599 600 @property 601 def completed_count(self): 602 """Gets the completed_count of this CertifiedDelivery. # noqa: E501 603 604 # noqa: E501 605 606 :return: The completed_count of this CertifiedDelivery. # noqa: E501 607 :rtype: str 608 """ 609 return self._completed_count 610 611 @completed_count.setter 612 def completed_count(self, completed_count): 613 """Sets the completed_count of this CertifiedDelivery. 614 615 # noqa: E501 616 617 :param completed_count: The completed_count of this CertifiedDelivery. # noqa: E501 618 :type: str 619 """ 620 621 self._completed_count = completed_count 622 623 @property 624 def consent_details_list(self): 625 """Gets the consent_details_list of this CertifiedDelivery. # noqa: E501 626 627 # noqa: E501 628 629 :return: The consent_details_list of this CertifiedDelivery. # noqa: E501 630 :rtype: list[ConsentDetails] 631 """ 632 return self._consent_details_list 633 634 @consent_details_list.setter 635 def consent_details_list(self, consent_details_list): 636 """Sets the consent_details_list of this CertifiedDelivery. 637 638 # noqa: E501 639 640 :param consent_details_list: The consent_details_list of this CertifiedDelivery. # noqa: E501 641 :type: list[ConsentDetails] 642 """ 643 644 self._consent_details_list = consent_details_list 645 646 @property 647 def custom_fields(self): 648 """Gets the custom_fields of this CertifiedDelivery. # noqa: E501 649 650 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 651 652 :return: The custom_fields of this CertifiedDelivery. # noqa: E501 653 :rtype: list[str] 654 """ 655 return self._custom_fields 656 657 @custom_fields.setter 658 def custom_fields(self, custom_fields): 659 """Sets the custom_fields of this CertifiedDelivery. 660 661 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 662 663 :param custom_fields: The custom_fields of this CertifiedDelivery. # noqa: E501 664 :type: list[str] 665 """ 666 667 self._custom_fields = custom_fields 668 669 @property 670 def declined_date_time(self): 671 """Gets the declined_date_time of this CertifiedDelivery. # noqa: E501 672 673 The date and time the recipient declined the document. # noqa: E501 674 675 :return: The declined_date_time of this CertifiedDelivery. # noqa: E501 676 :rtype: str 677 """ 678 return self._declined_date_time 679 680 @declined_date_time.setter 681 def declined_date_time(self, declined_date_time): 682 """Sets the declined_date_time of this CertifiedDelivery. 683 684 The date and time the recipient declined the document. # noqa: E501 685 686 :param declined_date_time: The declined_date_time of this CertifiedDelivery. # noqa: E501 687 :type: str 688 """ 689 690 self._declined_date_time = declined_date_time 691 692 @property 693 def declined_reason(self): 694 """Gets the declined_reason of this CertifiedDelivery. # noqa: E501 695 696 The reason the recipient declined the document. # noqa: E501 697 698 :return: The declined_reason of this CertifiedDelivery. # noqa: E501 699 :rtype: str 700 """ 701 return self._declined_reason 702 703 @declined_reason.setter 704 def declined_reason(self, declined_reason): 705 """Sets the declined_reason of this CertifiedDelivery. 706 707 The reason the recipient declined the document. # noqa: E501 708 709 :param declined_reason: The declined_reason of this CertifiedDelivery. # noqa: E501 710 :type: str 711 """ 712 713 self._declined_reason = declined_reason 714 715 @property 716 def delivered_date_time(self): 717 """Gets the delivered_date_time of this CertifiedDelivery. # noqa: E501 718 719 Reserved: For DocuSign use only. # noqa: E501 720 721 :return: The delivered_date_time of this CertifiedDelivery. # noqa: E501 722 :rtype: str 723 """ 724 return self._delivered_date_time 725 726 @delivered_date_time.setter 727 def delivered_date_time(self, delivered_date_time): 728 """Sets the delivered_date_time of this CertifiedDelivery. 729 730 Reserved: For DocuSign use only. # noqa: E501 731 732 :param delivered_date_time: The delivered_date_time of this CertifiedDelivery. # noqa: E501 733 :type: str 734 """ 735 736 self._delivered_date_time = delivered_date_time 737 738 @property 739 def delivery_method(self): 740 """Gets the delivery_method of this CertifiedDelivery. # noqa: E501 741 742 Reserved: For DocuSign use only. # noqa: E501 743 744 :return: The delivery_method of this CertifiedDelivery. # noqa: E501 745 :rtype: str 746 """ 747 return self._delivery_method 748 749 @delivery_method.setter 750 def delivery_method(self, delivery_method): 751 """Sets the delivery_method of this CertifiedDelivery. 752 753 Reserved: For DocuSign use only. # noqa: E501 754 755 :param delivery_method: The delivery_method of this CertifiedDelivery. # noqa: E501 756 :type: str 757 """ 758 759 self._delivery_method = delivery_method 760 761 @property 762 def delivery_method_metadata(self): 763 """Gets the delivery_method_metadata of this CertifiedDelivery. # noqa: E501 764 765 Reserved for DocuSign. # noqa: E501 766 767 :return: The delivery_method_metadata of this CertifiedDelivery. # noqa: E501 768 :rtype: PropertyMetadata 769 """ 770 return self._delivery_method_metadata 771 772 @delivery_method_metadata.setter 773 def delivery_method_metadata(self, delivery_method_metadata): 774 """Sets the delivery_method_metadata of this CertifiedDelivery. 775 776 Reserved for DocuSign. # noqa: E501 777 778 :param delivery_method_metadata: The delivery_method_metadata of this CertifiedDelivery. # noqa: E501 779 :type: PropertyMetadata 780 """ 781 782 self._delivery_method_metadata = delivery_method_metadata 783 784 @property 785 def designator_id(self): 786 """Gets the designator_id of this CertifiedDelivery. # noqa: E501 787 788 # noqa: E501 789 790 :return: The designator_id of this CertifiedDelivery. # noqa: E501 791 :rtype: str 792 """ 793 return self._designator_id 794 795 @designator_id.setter 796 def designator_id(self, designator_id): 797 """Sets the designator_id of this CertifiedDelivery. 798 799 # noqa: E501 800 801 :param designator_id: The designator_id of this CertifiedDelivery. # noqa: E501 802 :type: str 803 """ 804 805 self._designator_id = designator_id 806 807 @property 808 def designator_id_guid(self): 809 """Gets the designator_id_guid of this CertifiedDelivery. # noqa: E501 810 811 # noqa: E501 812 813 :return: The designator_id_guid of this CertifiedDelivery. # noqa: E501 814 :rtype: str 815 """ 816 return self._designator_id_guid 817 818 @designator_id_guid.setter 819 def designator_id_guid(self, designator_id_guid): 820 """Sets the designator_id_guid of this CertifiedDelivery. 821 822 # noqa: E501 823 824 :param designator_id_guid: The designator_id_guid of this CertifiedDelivery. # noqa: E501 825 :type: str 826 """ 827 828 self._designator_id_guid = designator_id_guid 829 830 @property 831 def document_template_id(self): 832 """Gets the document_template_id of this CertifiedDelivery. # noqa: E501 833 834 # noqa: E501 835 836 :return: The document_template_id of this CertifiedDelivery. # noqa: E501 837 :rtype: str 838 """ 839 return self._document_template_id 840 841 @document_template_id.setter 842 def document_template_id(self, document_template_id): 843 """Sets the document_template_id of this CertifiedDelivery. 844 845 # noqa: E501 846 847 :param document_template_id: The document_template_id of this CertifiedDelivery. # noqa: E501 848 :type: str 849 """ 850 851 self._document_template_id = document_template_id 852 853 @property 854 def document_visibility(self): 855 """Gets the document_visibility of this CertifiedDelivery. # noqa: E501 856 857 # noqa: E501 858 859 :return: The document_visibility of this CertifiedDelivery. # noqa: E501 860 :rtype: list[DocumentVisibility] 861 """ 862 return self._document_visibility 863 864 @document_visibility.setter 865 def document_visibility(self, document_visibility): 866 """Sets the document_visibility of this CertifiedDelivery. 867 868 # noqa: E501 869 870 :param document_visibility: The document_visibility of this CertifiedDelivery. # noqa: E501 871 :type: list[DocumentVisibility] 872 """ 873 874 self._document_visibility = document_visibility 875 876 @property 877 def email(self): 878 """Gets the email of this CertifiedDelivery. # noqa: E501 879 880 # noqa: E501 881 882 :return: The email of this CertifiedDelivery. # noqa: E501 883 :rtype: str 884 """ 885 return self._email 886 887 @email.setter 888 def email(self, email): 889 """Sets the email of this CertifiedDelivery. 890 891 # noqa: E501 892 893 :param email: The email of this CertifiedDelivery. # noqa: E501 894 :type: str 895 """ 896 897 self._email = email 898 899 @property 900 def email_metadata(self): 901 """Gets the email_metadata of this CertifiedDelivery. # noqa: E501 902 903 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 904 905 :return: The email_metadata of this CertifiedDelivery. # noqa: E501 906 :rtype: PropertyMetadata 907 """ 908 return self._email_metadata 909 910 @email_metadata.setter 911 def email_metadata(self, email_metadata): 912 """Sets the email_metadata of this CertifiedDelivery. 913 914 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 915 916 :param email_metadata: The email_metadata of this CertifiedDelivery. # noqa: E501 917 :type: PropertyMetadata 918 """ 919 920 self._email_metadata = email_metadata 921 922 @property 923 def email_notification(self): 924 """Gets the email_notification of this CertifiedDelivery. # noqa: E501 925 926 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 927 928 :return: The email_notification of this CertifiedDelivery. # noqa: E501 929 :rtype: RecipientEmailNotification 930 """ 931 return self._email_notification 932 933 @email_notification.setter 934 def email_notification(self, email_notification): 935 """Sets the email_notification of this CertifiedDelivery. 936 937 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 938 939 :param email_notification: The email_notification of this CertifiedDelivery. # noqa: E501 940 :type: RecipientEmailNotification 941 """ 942 943 self._email_notification = email_notification 944 945 @property 946 def email_recipient_post_signing_url(self): 947 """Gets the email_recipient_post_signing_url of this CertifiedDelivery. # noqa: E501 948 949 # noqa: E501 950 951 :return: The email_recipient_post_signing_url of this CertifiedDelivery. # noqa: E501 952 :rtype: str 953 """ 954 return self._email_recipient_post_signing_url 955 956 @email_recipient_post_signing_url.setter 957 def email_recipient_post_signing_url(self, email_recipient_post_signing_url): 958 """Sets the email_recipient_post_signing_url of this CertifiedDelivery. 959 960 # noqa: E501 961 962 :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this CertifiedDelivery. # noqa: E501 963 :type: str 964 """ 965 966 self._email_recipient_post_signing_url = email_recipient_post_signing_url 967 968 @property 969 def embedded_recipient_start_url(self): 970 """Gets the embedded_recipient_start_url of this CertifiedDelivery. # noqa: E501 971 972 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 973 974 :return: The embedded_recipient_start_url of this CertifiedDelivery. # noqa: E501 975 :rtype: str 976 """ 977 return self._embedded_recipient_start_url 978 979 @embedded_recipient_start_url.setter 980 def embedded_recipient_start_url(self, embedded_recipient_start_url): 981 """Sets the embedded_recipient_start_url of this CertifiedDelivery. 982 983 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 984 985 :param embedded_recipient_start_url: The embedded_recipient_start_url of this CertifiedDelivery. # noqa: E501 986 :type: str 987 """ 988 989 self._embedded_recipient_start_url = embedded_recipient_start_url 990 991 @property 992 def error_details(self): 993 """Gets the error_details of this CertifiedDelivery. # noqa: E501 994 995 Array or errors. # noqa: E501 996 997 :return: The error_details of this CertifiedDelivery. # noqa: E501 998 :rtype: ErrorDetails 999 """ 1000 return self._error_details 1001 1002 @error_details.setter 1003 def error_details(self, error_details): 1004 """Sets the error_details of this CertifiedDelivery. 1005 1006 Array or errors. # noqa: E501 1007 1008 :param error_details: The error_details of this CertifiedDelivery. # noqa: E501 1009 :type: ErrorDetails 1010 """ 1011 1012 self._error_details = error_details 1013 1014 @property 1015 def excluded_documents(self): 1016 """Gets the excluded_documents of this CertifiedDelivery. # noqa: E501 1017 1018 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 1019 1020 :return: The excluded_documents of this CertifiedDelivery. # noqa: E501 1021 :rtype: list[str] 1022 """ 1023 return self._excluded_documents 1024 1025 @excluded_documents.setter 1026 def excluded_documents(self, excluded_documents): 1027 """Sets the excluded_documents of this CertifiedDelivery. 1028 1029 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 1030 1031 :param excluded_documents: The excluded_documents of this CertifiedDelivery. # noqa: E501 1032 :type: list[str] 1033 """ 1034 1035 self._excluded_documents = excluded_documents 1036 1037 @property 1038 def fax_number(self): 1039 """Gets the fax_number of this CertifiedDelivery. # noqa: E501 1040 1041 Reserved: # noqa: E501 1042 1043 :return: The fax_number of this CertifiedDelivery. # noqa: E501 1044 :rtype: str 1045 """ 1046 return self._fax_number 1047 1048 @fax_number.setter 1049 def fax_number(self, fax_number): 1050 """Sets the fax_number of this CertifiedDelivery. 1051 1052 Reserved: # noqa: E501 1053 1054 :param fax_number: The fax_number of this CertifiedDelivery. # noqa: E501 1055 :type: str 1056 """ 1057 1058 self._fax_number = fax_number 1059 1060 @property 1061 def fax_number_metadata(self): 1062 """Gets the fax_number_metadata of this CertifiedDelivery. # noqa: E501 1063 1064 Reserved for DocuSign. # noqa: E501 1065 1066 :return: The fax_number_metadata of this CertifiedDelivery. # noqa: E501 1067 :rtype: PropertyMetadata 1068 """ 1069 return self._fax_number_metadata 1070 1071 @fax_number_metadata.setter 1072 def fax_number_metadata(self, fax_number_metadata): 1073 """Sets the fax_number_metadata of this CertifiedDelivery. 1074 1075 Reserved for DocuSign. # noqa: E501 1076 1077 :param fax_number_metadata: The fax_number_metadata of this CertifiedDelivery. # noqa: E501 1078 :type: PropertyMetadata 1079 """ 1080 1081 self._fax_number_metadata = fax_number_metadata 1082 1083 @property 1084 def first_name(self): 1085 """Gets the first_name of this CertifiedDelivery. # noqa: E501 1086 1087 The user's first name. Maximum Length: 50 characters. # noqa: E501 1088 1089 :return: The first_name of this CertifiedDelivery. # noqa: E501 1090 :rtype: str 1091 """ 1092 return self._first_name 1093 1094 @first_name.setter 1095 def first_name(self, first_name): 1096 """Sets the first_name of this CertifiedDelivery. 1097 1098 The user's first name. Maximum Length: 50 characters. # noqa: E501 1099 1100 :param first_name: The first_name of this CertifiedDelivery. # noqa: E501 1101 :type: str 1102 """ 1103 1104 self._first_name = first_name 1105 1106 @property 1107 def first_name_metadata(self): 1108 """Gets the first_name_metadata of this CertifiedDelivery. # noqa: E501 1109 1110 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1111 1112 :return: The first_name_metadata of this CertifiedDelivery. # noqa: E501 1113 :rtype: PropertyMetadata 1114 """ 1115 return self._first_name_metadata 1116 1117 @first_name_metadata.setter 1118 def first_name_metadata(self, first_name_metadata): 1119 """Sets the first_name_metadata of this CertifiedDelivery. 1120 1121 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1122 1123 :param first_name_metadata: The first_name_metadata of this CertifiedDelivery. # noqa: E501 1124 :type: PropertyMetadata 1125 """ 1126 1127 self._first_name_metadata = first_name_metadata 1128 1129 @property 1130 def full_name(self): 1131 """Gets the full_name of this CertifiedDelivery. # noqa: E501 1132 1133 # noqa: E501 1134 1135 :return: The full_name of this CertifiedDelivery. # noqa: E501 1136 :rtype: str 1137 """ 1138 return self._full_name 1139 1140 @full_name.setter 1141 def full_name(self, full_name): 1142 """Sets the full_name of this CertifiedDelivery. 1143 1144 # noqa: E501 1145 1146 :param full_name: The full_name of this CertifiedDelivery. # noqa: E501 1147 :type: str 1148 """ 1149 1150 self._full_name = full_name 1151 1152 @property 1153 def full_name_metadata(self): 1154 """Gets the full_name_metadata of this CertifiedDelivery. # noqa: E501 1155 1156 Reserved for DocuSign. # noqa: E501 1157 1158 :return: The full_name_metadata of this CertifiedDelivery. # noqa: E501 1159 :rtype: PropertyMetadata 1160 """ 1161 return self._full_name_metadata 1162 1163 @full_name_metadata.setter 1164 def full_name_metadata(self, full_name_metadata): 1165 """Sets the full_name_metadata of this CertifiedDelivery. 1166 1167 Reserved for DocuSign. # noqa: E501 1168 1169 :param full_name_metadata: The full_name_metadata of this CertifiedDelivery. # noqa: E501 1170 :type: PropertyMetadata 1171 """ 1172 1173 self._full_name_metadata = full_name_metadata 1174 1175 @property 1176 def id_check_configuration_name(self): 1177 """Gets the id_check_configuration_name of this CertifiedDelivery. # noqa: E501 1178 1179 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 1180 1181 :return: The id_check_configuration_name of this CertifiedDelivery. # noqa: E501 1182 :rtype: str 1183 """ 1184 return self._id_check_configuration_name 1185 1186 @id_check_configuration_name.setter 1187 def id_check_configuration_name(self, id_check_configuration_name): 1188 """Sets the id_check_configuration_name of this CertifiedDelivery. 1189 1190 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 1191 1192 :param id_check_configuration_name: The id_check_configuration_name of this CertifiedDelivery. # noqa: E501 1193 :type: str 1194 """ 1195 1196 self._id_check_configuration_name = id_check_configuration_name 1197 1198 @property 1199 def id_check_configuration_name_metadata(self): 1200 """Gets the id_check_configuration_name_metadata of this CertifiedDelivery. # noqa: E501 1201 1202 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1203 1204 :return: The id_check_configuration_name_metadata of this CertifiedDelivery. # noqa: E501 1205 :rtype: PropertyMetadata 1206 """ 1207 return self._id_check_configuration_name_metadata 1208 1209 @id_check_configuration_name_metadata.setter 1210 def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): 1211 """Sets the id_check_configuration_name_metadata of this CertifiedDelivery. 1212 1213 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1214 1215 :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this CertifiedDelivery. # noqa: E501 1216 :type: PropertyMetadata 1217 """ 1218 1219 self._id_check_configuration_name_metadata = id_check_configuration_name_metadata 1220 1221 @property 1222 def id_check_information_input(self): 1223 """Gets the id_check_information_input of this CertifiedDelivery. # noqa: E501 1224 1225 An object that contains input information related to a recipient ID check. # noqa: E501 1226 1227 :return: The id_check_information_input of this CertifiedDelivery. # noqa: E501 1228 :rtype: IdCheckInformationInput 1229 """ 1230 return self._id_check_information_input 1231 1232 @id_check_information_input.setter 1233 def id_check_information_input(self, id_check_information_input): 1234 """Sets the id_check_information_input of this CertifiedDelivery. 1235 1236 An object that contains input information related to a recipient ID check. # noqa: E501 1237 1238 :param id_check_information_input: The id_check_information_input of this CertifiedDelivery. # noqa: E501 1239 :type: IdCheckInformationInput 1240 """ 1241 1242 self._id_check_information_input = id_check_information_input 1243 1244 @property 1245 def identity_verification(self): 1246 """Gets the identity_verification of this CertifiedDelivery. # noqa: E501 1247 1248 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 1249 1250 :return: The identity_verification of this CertifiedDelivery. # noqa: E501 1251 :rtype: RecipientIdentityVerification 1252 """ 1253 return self._identity_verification 1254 1255 @identity_verification.setter 1256 def identity_verification(self, identity_verification): 1257 """Sets the identity_verification of this CertifiedDelivery. 1258 1259 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 1260 1261 :param identity_verification: The identity_verification of this CertifiedDelivery. # noqa: E501 1262 :type: RecipientIdentityVerification 1263 """ 1264 1265 self._identity_verification = identity_verification 1266 1267 @property 1268 def inherit_email_notification_configuration(self): 1269 """Gets the inherit_email_notification_configuration of this CertifiedDelivery. # noqa: E501 1270 1271 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 1272 1273 :return: The inherit_email_notification_configuration of this CertifiedDelivery. # noqa: E501 1274 :rtype: str 1275 """ 1276 return self._inherit_email_notification_configuration 1277 1278 @inherit_email_notification_configuration.setter 1279 def inherit_email_notification_configuration(self, inherit_email_notification_configuration): 1280 """Sets the inherit_email_notification_configuration of this CertifiedDelivery. 1281 1282 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 1283 1284 :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this CertifiedDelivery. # noqa: E501 1285 :type: str 1286 """ 1287 1288 self._inherit_email_notification_configuration = inherit_email_notification_configuration 1289 1290 @property 1291 def last_name(self): 1292 """Gets the last_name of this CertifiedDelivery. # noqa: E501 1293 1294 # noqa: E501 1295 1296 :return: The last_name of this CertifiedDelivery. # noqa: E501 1297 :rtype: str 1298 """ 1299 return self._last_name 1300 1301 @last_name.setter 1302 def last_name(self, last_name): 1303 """Sets the last_name of this CertifiedDelivery. 1304 1305 # noqa: E501 1306 1307 :param last_name: The last_name of this CertifiedDelivery. # noqa: E501 1308 :type: str 1309 """ 1310 1311 self._last_name = last_name 1312 1313 @property 1314 def last_name_metadata(self): 1315 """Gets the last_name_metadata of this CertifiedDelivery. # noqa: E501 1316 1317 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1318 1319 :return: The last_name_metadata of this CertifiedDelivery. # noqa: E501 1320 :rtype: PropertyMetadata 1321 """ 1322 return self._last_name_metadata 1323 1324 @last_name_metadata.setter 1325 def last_name_metadata(self, last_name_metadata): 1326 """Sets the last_name_metadata of this CertifiedDelivery. 1327 1328 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1329 1330 :param last_name_metadata: The last_name_metadata of this CertifiedDelivery. # noqa: E501 1331 :type: PropertyMetadata 1332 """ 1333 1334 self._last_name_metadata = last_name_metadata 1335 1336 @property 1337 def locked_recipient_phone_auth_editable(self): 1338 """Gets the locked_recipient_phone_auth_editable of this CertifiedDelivery. # noqa: E501 1339 1340 # noqa: E501 1341 1342 :return: The locked_recipient_phone_auth_editable of this CertifiedDelivery. # noqa: E501 1343 :rtype: str 1344 """ 1345 return self._locked_recipient_phone_auth_editable 1346 1347 @locked_recipient_phone_auth_editable.setter 1348 def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): 1349 """Sets the locked_recipient_phone_auth_editable of this CertifiedDelivery. 1350 1351 # noqa: E501 1352 1353 :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this CertifiedDelivery. # noqa: E501 1354 :type: str 1355 """ 1356 1357 self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable 1358 1359 @property 1360 def locked_recipient_sms_editable(self): 1361 """Gets the locked_recipient_sms_editable of this CertifiedDelivery. # noqa: E501 1362 1363 # noqa: E501 1364 1365 :return: The locked_recipient_sms_editable of this CertifiedDelivery. # noqa: E501 1366 :rtype: str 1367 """ 1368 return self._locked_recipient_sms_editable 1369 1370 @locked_recipient_sms_editable.setter 1371 def locked_recipient_sms_editable(self, locked_recipient_sms_editable): 1372 """Sets the locked_recipient_sms_editable of this CertifiedDelivery. 1373 1374 # noqa: E501 1375 1376 :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this CertifiedDelivery. # noqa: E501 1377 :type: str 1378 """ 1379 1380 self._locked_recipient_sms_editable = locked_recipient_sms_editable 1381 1382 @property 1383 def name(self): 1384 """Gets the name of this CertifiedDelivery. # noqa: E501 1385 1386 # noqa: E501 1387 1388 :return: The name of this CertifiedDelivery. # noqa: E501 1389 :rtype: str 1390 """ 1391 return self._name 1392 1393 @name.setter 1394 def name(self, name): 1395 """Sets the name of this CertifiedDelivery. 1396 1397 # noqa: E501 1398 1399 :param name: The name of this CertifiedDelivery. # noqa: E501 1400 :type: str 1401 """ 1402 1403 self._name = name 1404 1405 @property 1406 def name_metadata(self): 1407 """Gets the name_metadata of this CertifiedDelivery. # noqa: E501 1408 1409 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1410 1411 :return: The name_metadata of this CertifiedDelivery. # noqa: E501 1412 :rtype: PropertyMetadata 1413 """ 1414 return self._name_metadata 1415 1416 @name_metadata.setter 1417 def name_metadata(self, name_metadata): 1418 """Sets the name_metadata of this CertifiedDelivery. 1419 1420 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1421 1422 :param name_metadata: The name_metadata of this CertifiedDelivery. # noqa: E501 1423 :type: PropertyMetadata 1424 """ 1425 1426 self._name_metadata = name_metadata 1427 1428 @property 1429 def note(self): 1430 """Gets the note of this CertifiedDelivery. # noqa: E501 1431 1432 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 1433 1434 :return: The note of this CertifiedDelivery. # noqa: E501 1435 :rtype: str 1436 """ 1437 return self._note 1438 1439 @note.setter 1440 def note(self, note): 1441 """Sets the note of this CertifiedDelivery. 1442 1443 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 1444 1445 :param note: The note of this CertifiedDelivery. # noqa: E501 1446 :type: str 1447 """ 1448 1449 self._note = note 1450 1451 @property 1452 def note_metadata(self): 1453 """Gets the note_metadata of this CertifiedDelivery. # noqa: E501 1454 1455 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1456 1457 :return: The note_metadata of this CertifiedDelivery. # noqa: E501 1458 :rtype: PropertyMetadata 1459 """ 1460 return self._note_metadata 1461 1462 @note_metadata.setter 1463 def note_metadata(self, note_metadata): 1464 """Sets the note_metadata of this CertifiedDelivery. 1465 1466 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1467 1468 :param note_metadata: The note_metadata of this CertifiedDelivery. # noqa: E501 1469 :type: PropertyMetadata 1470 """ 1471 1472 self._note_metadata = note_metadata 1473 1474 @property 1475 def phone_authentication(self): 1476 """Gets the phone_authentication of this CertifiedDelivery. # noqa: E501 1477 1478 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 1479 1480 :return: The phone_authentication of this CertifiedDelivery. # noqa: E501 1481 :rtype: RecipientPhoneAuthentication 1482 """ 1483 return self._phone_authentication 1484 1485 @phone_authentication.setter 1486 def phone_authentication(self, phone_authentication): 1487 """Sets the phone_authentication of this CertifiedDelivery. 1488 1489 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 1490 1491 :param phone_authentication: The phone_authentication of this CertifiedDelivery. # noqa: E501 1492 :type: RecipientPhoneAuthentication 1493 """ 1494 1495 self._phone_authentication = phone_authentication 1496 1497 @property 1498 def phone_number(self): 1499 """Gets the phone_number of this CertifiedDelivery. # noqa: E501 1500 1501 Describes the recipient phone number. # noqa: E501 1502 1503 :return: The phone_number of this CertifiedDelivery. # noqa: E501 1504 :rtype: RecipientPhoneNumber 1505 """ 1506 return self._phone_number 1507 1508 @phone_number.setter 1509 def phone_number(self, phone_number): 1510 """Sets the phone_number of this CertifiedDelivery. 1511 1512 Describes the recipient phone number. # noqa: E501 1513 1514 :param phone_number: The phone_number of this CertifiedDelivery. # noqa: E501 1515 :type: RecipientPhoneNumber 1516 """ 1517 1518 self._phone_number = phone_number 1519 1520 @property 1521 def proof_file(self): 1522 """Gets the proof_file of this CertifiedDelivery. # noqa: E501 1523 1524 The proof file of the recipient. # noqa: E501 1525 1526 :return: The proof_file of this CertifiedDelivery. # noqa: E501 1527 :rtype: RecipientProofFile 1528 """ 1529 return self._proof_file 1530 1531 @proof_file.setter 1532 def proof_file(self, proof_file): 1533 """Sets the proof_file of this CertifiedDelivery. 1534 1535 The proof file of the recipient. # noqa: E501 1536 1537 :param proof_file: The proof_file of this CertifiedDelivery. # noqa: E501 1538 :type: RecipientProofFile 1539 """ 1540 1541 self._proof_file = proof_file 1542 1543 @property 1544 def recipient_attachments(self): 1545 """Gets the recipient_attachments of this CertifiedDelivery. # noqa: E501 1546 1547 Reserved: # noqa: E501 1548 1549 :return: The recipient_attachments of this CertifiedDelivery. # noqa: E501 1550 :rtype: list[RecipientAttachment] 1551 """ 1552 return self._recipient_attachments 1553 1554 @recipient_attachments.setter 1555 def recipient_attachments(self, recipient_attachments): 1556 """Sets the recipient_attachments of this CertifiedDelivery. 1557 1558 Reserved: # noqa: E501 1559 1560 :param recipient_attachments: The recipient_attachments of this CertifiedDelivery. # noqa: E501 1561 :type: list[RecipientAttachment] 1562 """ 1563 1564 self._recipient_attachments = recipient_attachments 1565 1566 @property 1567 def recipient_authentication_status(self): 1568 """Gets the recipient_authentication_status of this CertifiedDelivery. # noqa: E501 1569 1570 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1571 1572 :return: The recipient_authentication_status of this CertifiedDelivery. # noqa: E501 1573 :rtype: AuthenticationStatus 1574 """ 1575 return self._recipient_authentication_status 1576 1577 @recipient_authentication_status.setter 1578 def recipient_authentication_status(self, recipient_authentication_status): 1579 """Sets the recipient_authentication_status of this CertifiedDelivery. 1580 1581 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1582 1583 :param recipient_authentication_status: The recipient_authentication_status of this CertifiedDelivery. # noqa: E501 1584 :type: AuthenticationStatus 1585 """ 1586 1587 self._recipient_authentication_status = recipient_authentication_status 1588 1589 @property 1590 def recipient_feature_metadata(self): 1591 """Gets the recipient_feature_metadata of this CertifiedDelivery. # noqa: E501 1592 1593 # noqa: E501 1594 1595 :return: The recipient_feature_metadata of this CertifiedDelivery. # noqa: E501 1596 :rtype: list[FeatureAvailableMetadata] 1597 """ 1598 return self._recipient_feature_metadata 1599 1600 @recipient_feature_metadata.setter 1601 def recipient_feature_metadata(self, recipient_feature_metadata): 1602 """Sets the recipient_feature_metadata of this CertifiedDelivery. 1603 1604 # noqa: E501 1605 1606 :param recipient_feature_metadata: The recipient_feature_metadata of this CertifiedDelivery. # noqa: E501 1607 :type: list[FeatureAvailableMetadata] 1608 """ 1609 1610 self._recipient_feature_metadata = recipient_feature_metadata 1611 1612 @property 1613 def recipient_id(self): 1614 """Gets the recipient_id of this CertifiedDelivery. # noqa: E501 1615 1616 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1617 1618 :return: The recipient_id of this CertifiedDelivery. # noqa: E501 1619 :rtype: str 1620 """ 1621 return self._recipient_id 1622 1623 @recipient_id.setter 1624 def recipient_id(self, recipient_id): 1625 """Sets the recipient_id of this CertifiedDelivery. 1626 1627 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1628 1629 :param recipient_id: The recipient_id of this CertifiedDelivery. # noqa: E501 1630 :type: str 1631 """ 1632 1633 self._recipient_id = recipient_id 1634 1635 @property 1636 def recipient_id_guid(self): 1637 """Gets the recipient_id_guid of this CertifiedDelivery. # noqa: E501 1638 1639 # noqa: E501 1640 1641 :return: The recipient_id_guid of this CertifiedDelivery. # noqa: E501 1642 :rtype: str 1643 """ 1644 return self._recipient_id_guid 1645 1646 @recipient_id_guid.setter 1647 def recipient_id_guid(self, recipient_id_guid): 1648 """Sets the recipient_id_guid of this CertifiedDelivery. 1649 1650 # noqa: E501 1651 1652 :param recipient_id_guid: The recipient_id_guid of this CertifiedDelivery. # noqa: E501 1653 :type: str 1654 """ 1655 1656 self._recipient_id_guid = recipient_id_guid 1657 1658 @property 1659 def recipient_type(self): 1660 """Gets the recipient_type of this CertifiedDelivery. # noqa: E501 1661 1662 # noqa: E501 1663 1664 :return: The recipient_type of this CertifiedDelivery. # noqa: E501 1665 :rtype: str 1666 """ 1667 return self._recipient_type 1668 1669 @recipient_type.setter 1670 def recipient_type(self, recipient_type): 1671 """Sets the recipient_type of this CertifiedDelivery. 1672 1673 # noqa: E501 1674 1675 :param recipient_type: The recipient_type of this CertifiedDelivery. # noqa: E501 1676 :type: str 1677 """ 1678 1679 self._recipient_type = recipient_type 1680 1681 @property 1682 def recipient_type_metadata(self): 1683 """Gets the recipient_type_metadata of this CertifiedDelivery. # noqa: E501 1684 1685 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 1686 1687 :return: The recipient_type_metadata of this CertifiedDelivery. # noqa: E501 1688 :rtype: PropertyMetadata 1689 """ 1690 return self._recipient_type_metadata 1691 1692 @recipient_type_metadata.setter 1693 def recipient_type_metadata(self, recipient_type_metadata): 1694 """Sets the recipient_type_metadata of this CertifiedDelivery. 1695 1696 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 1697 1698 :param recipient_type_metadata: The recipient_type_metadata of this CertifiedDelivery. # noqa: E501 1699 :type: PropertyMetadata 1700 """ 1701 1702 self._recipient_type_metadata = recipient_type_metadata 1703 1704 @property 1705 def require_id_lookup(self): 1706 """Gets the require_id_lookup of this CertifiedDelivery. # noqa: E501 1707 1708 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 1709 1710 :return: The require_id_lookup of this CertifiedDelivery. # noqa: E501 1711 :rtype: str 1712 """ 1713 return self._require_id_lookup 1714 1715 @require_id_lookup.setter 1716 def require_id_lookup(self, require_id_lookup): 1717 """Sets the require_id_lookup of this CertifiedDelivery. 1718 1719 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 1720 1721 :param require_id_lookup: The require_id_lookup of this CertifiedDelivery. # noqa: E501 1722 :type: str 1723 """ 1724 1725 self._require_id_lookup = require_id_lookup 1726 1727 @property 1728 def require_id_lookup_metadata(self): 1729 """Gets the require_id_lookup_metadata of this CertifiedDelivery. # noqa: E501 1730 1731 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 1732 1733 :return: The require_id_lookup_metadata of this CertifiedDelivery. # noqa: E501 1734 :rtype: PropertyMetadata 1735 """ 1736 return self._require_id_lookup_metadata 1737 1738 @require_id_lookup_metadata.setter 1739 def require_id_lookup_metadata(self, require_id_lookup_metadata): 1740 """Sets the require_id_lookup_metadata of this CertifiedDelivery. 1741 1742 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 1743 1744 :param require_id_lookup_metadata: The require_id_lookup_metadata of this CertifiedDelivery. # noqa: E501 1745 :type: PropertyMetadata 1746 """ 1747 1748 self._require_id_lookup_metadata = require_id_lookup_metadata 1749 1750 @property 1751 def role_name(self): 1752 """Gets the role_name of this CertifiedDelivery. # noqa: E501 1753 1754 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 1755 1756 :return: The role_name of this CertifiedDelivery. # noqa: E501 1757 :rtype: str 1758 """ 1759 return self._role_name 1760 1761 @role_name.setter 1762 def role_name(self, role_name): 1763 """Sets the role_name of this CertifiedDelivery. 1764 1765 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 1766 1767 :param role_name: The role_name of this CertifiedDelivery. # noqa: E501 1768 :type: str 1769 """ 1770 1771 self._role_name = role_name 1772 1773 @property 1774 def routing_order(self): 1775 """Gets the routing_order of this CertifiedDelivery. # noqa: E501 1776 1777 Specifies the routing order of the recipient in the envelope. # noqa: E501 1778 1779 :return: The routing_order of this CertifiedDelivery. # noqa: E501 1780 :rtype: str 1781 """ 1782 return self._routing_order 1783 1784 @routing_order.setter 1785 def routing_order(self, routing_order): 1786 """Sets the routing_order of this CertifiedDelivery. 1787 1788 Specifies the routing order of the recipient in the envelope. # noqa: E501 1789 1790 :param routing_order: The routing_order of this CertifiedDelivery. # noqa: E501 1791 :type: str 1792 """ 1793 1794 self._routing_order = routing_order 1795 1796 @property 1797 def routing_order_metadata(self): 1798 """Gets the routing_order_metadata of this CertifiedDelivery. # noqa: E501 1799 1800 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 1801 1802 :return: The routing_order_metadata of this CertifiedDelivery. # noqa: E501 1803 :rtype: PropertyMetadata 1804 """ 1805 return self._routing_order_metadata 1806 1807 @routing_order_metadata.setter 1808 def routing_order_metadata(self, routing_order_metadata): 1809 """Sets the routing_order_metadata of this CertifiedDelivery. 1810 1811 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 1812 1813 :param routing_order_metadata: The routing_order_metadata of this CertifiedDelivery. # noqa: E501 1814 :type: PropertyMetadata 1815 """ 1816 1817 self._routing_order_metadata = routing_order_metadata 1818 1819 @property 1820 def sent_date_time(self): 1821 """Gets the sent_date_time of this CertifiedDelivery. # noqa: E501 1822 1823 The date and time the envelope was sent. # noqa: E501 1824 1825 :return: The sent_date_time of this CertifiedDelivery. # noqa: E501 1826 :rtype: str 1827 """ 1828 return self._sent_date_time 1829 1830 @sent_date_time.setter 1831 def sent_date_time(self, sent_date_time): 1832 """Sets the sent_date_time of this CertifiedDelivery. 1833 1834 The date and time the envelope was sent. # noqa: E501 1835 1836 :param sent_date_time: The sent_date_time of this CertifiedDelivery. # noqa: E501 1837 :type: str 1838 """ 1839 1840 self._sent_date_time = sent_date_time 1841 1842 @property 1843 def signed_date_time(self): 1844 """Gets the signed_date_time of this CertifiedDelivery. # noqa: E501 1845 1846 Reserved: For DocuSign use only. # noqa: E501 1847 1848 :return: The signed_date_time of this CertifiedDelivery. # noqa: E501 1849 :rtype: str 1850 """ 1851 return self._signed_date_time 1852 1853 @signed_date_time.setter 1854 def signed_date_time(self, signed_date_time): 1855 """Sets the signed_date_time of this CertifiedDelivery. 1856 1857 Reserved: For DocuSign use only. # noqa: E501 1858 1859 :param signed_date_time: The signed_date_time of this CertifiedDelivery. # noqa: E501 1860 :type: str 1861 """ 1862 1863 self._signed_date_time = signed_date_time 1864 1865 @property 1866 def signing_group_id(self): 1867 """Gets the signing_group_id of this CertifiedDelivery. # noqa: E501 1868 1869 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 1870 1871 :return: The signing_group_id of this CertifiedDelivery. # noqa: E501 1872 :rtype: str 1873 """ 1874 return self._signing_group_id 1875 1876 @signing_group_id.setter 1877 def signing_group_id(self, signing_group_id): 1878 """Sets the signing_group_id of this CertifiedDelivery. 1879 1880 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 1881 1882 :param signing_group_id: The signing_group_id of this CertifiedDelivery. # noqa: E501 1883 :type: str 1884 """ 1885 1886 self._signing_group_id = signing_group_id 1887 1888 @property 1889 def signing_group_id_metadata(self): 1890 """Gets the signing_group_id_metadata of this CertifiedDelivery. # noqa: E501 1891 1892 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 1893 1894 :return: The signing_group_id_metadata of this CertifiedDelivery. # noqa: E501 1895 :rtype: PropertyMetadata 1896 """ 1897 return self._signing_group_id_metadata 1898 1899 @signing_group_id_metadata.setter 1900 def signing_group_id_metadata(self, signing_group_id_metadata): 1901 """Sets the signing_group_id_metadata of this CertifiedDelivery. 1902 1903 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 1904 1905 :param signing_group_id_metadata: The signing_group_id_metadata of this CertifiedDelivery. # noqa: E501 1906 :type: PropertyMetadata 1907 """ 1908 1909 self._signing_group_id_metadata = signing_group_id_metadata 1910 1911 @property 1912 def signing_group_name(self): 1913 """Gets the signing_group_name of this CertifiedDelivery. # noqa: E501 1914 1915 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 1916 1917 :return: The signing_group_name of this CertifiedDelivery. # noqa: E501 1918 :rtype: str 1919 """ 1920 return self._signing_group_name 1921 1922 @signing_group_name.setter 1923 def signing_group_name(self, signing_group_name): 1924 """Sets the signing_group_name of this CertifiedDelivery. 1925 1926 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 1927 1928 :param signing_group_name: The signing_group_name of this CertifiedDelivery. # noqa: E501 1929 :type: str 1930 """ 1931 1932 self._signing_group_name = signing_group_name 1933 1934 @property 1935 def signing_group_type(self): 1936 """Gets the signing_group_type of this CertifiedDelivery. # noqa: E501 1937 1938 # noqa: E501 1939 1940 :return: The signing_group_type of this CertifiedDelivery. # noqa: E501 1941 :rtype: str 1942 """ 1943 return self._signing_group_type 1944 1945 @signing_group_type.setter 1946 def signing_group_type(self, signing_group_type): 1947 """Sets the signing_group_type of this CertifiedDelivery. 1948 1949 # noqa: E501 1950 1951 :param signing_group_type: The signing_group_type of this CertifiedDelivery. # noqa: E501 1952 :type: str 1953 """ 1954 1955 self._signing_group_type = signing_group_type 1956 1957 @property 1958 def signing_group_users(self): 1959 """Gets the signing_group_users of this CertifiedDelivery. # noqa: E501 1960 1961 A complex type that contains information about users in the signing group. # noqa: E501 1962 1963 :return: The signing_group_users of this CertifiedDelivery. # noqa: E501 1964 :rtype: list[UserInfo] 1965 """ 1966 return self._signing_group_users 1967 1968 @signing_group_users.setter 1969 def signing_group_users(self, signing_group_users): 1970 """Sets the signing_group_users of this CertifiedDelivery. 1971 1972 A complex type that contains information about users in the signing group. # noqa: E501 1973 1974 :param signing_group_users: The signing_group_users of this CertifiedDelivery. # noqa: E501 1975 :type: list[UserInfo] 1976 """ 1977 1978 self._signing_group_users = signing_group_users 1979 1980 @property 1981 def sms_authentication(self): 1982 """Gets the sms_authentication of this CertifiedDelivery. # noqa: E501 1983 1984 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 1985 1986 :return: The sms_authentication of this CertifiedDelivery. # noqa: E501 1987 :rtype: RecipientSMSAuthentication 1988 """ 1989 return self._sms_authentication 1990 1991 @sms_authentication.setter 1992 def sms_authentication(self, sms_authentication): 1993 """Sets the sms_authentication of this CertifiedDelivery. 1994 1995 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 1996 1997 :param sms_authentication: The sms_authentication of this CertifiedDelivery. # noqa: E501 1998 :type: RecipientSMSAuthentication 1999 """ 2000 2001 self._sms_authentication = sms_authentication 2002 2003 @property 2004 def social_authentications(self): 2005 """Gets the social_authentications of this CertifiedDelivery. # noqa: E501 2006 2007 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2008 2009 :return: The social_authentications of this CertifiedDelivery. # noqa: E501 2010 :rtype: list[SocialAuthentication] 2011 """ 2012 return self._social_authentications 2013 2014 @social_authentications.setter 2015 def social_authentications(self, social_authentications): 2016 """Sets the social_authentications of this CertifiedDelivery. 2017 2018 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2019 2020 :param social_authentications: The social_authentications of this CertifiedDelivery. # noqa: E501 2021 :type: list[SocialAuthentication] 2022 """ 2023 2024 self._social_authentications = social_authentications 2025 2026 @property 2027 def status(self): 2028 """Gets the status of this CertifiedDelivery. # noqa: E501 2029 2030 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 2031 2032 :return: The status of this CertifiedDelivery. # noqa: E501 2033 :rtype: str 2034 """ 2035 return self._status 2036 2037 @status.setter 2038 def status(self, status): 2039 """Sets the status of this CertifiedDelivery. 2040 2041 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 2042 2043 :param status: The status of this CertifiedDelivery. # noqa: E501 2044 :type: str 2045 """ 2046 2047 self._status = status 2048 2049 @property 2050 def status_code(self): 2051 """Gets the status_code of this CertifiedDelivery. # noqa: E501 2052 2053 # noqa: E501 2054 2055 :return: The status_code of this CertifiedDelivery. # noqa: E501 2056 :rtype: str 2057 """ 2058 return self._status_code 2059 2060 @status_code.setter 2061 def status_code(self, status_code): 2062 """Sets the status_code of this CertifiedDelivery. 2063 2064 # noqa: E501 2065 2066 :param status_code: The status_code of this CertifiedDelivery. # noqa: E501 2067 :type: str 2068 """ 2069 2070 self._status_code = status_code 2071 2072 @property 2073 def suppress_emails(self): 2074 """Gets the suppress_emails of this CertifiedDelivery. # noqa: E501 2075 2076 # noqa: E501 2077 2078 :return: The suppress_emails of this CertifiedDelivery. # noqa: E501 2079 :rtype: str 2080 """ 2081 return self._suppress_emails 2082 2083 @suppress_emails.setter 2084 def suppress_emails(self, suppress_emails): 2085 """Sets the suppress_emails of this CertifiedDelivery. 2086 2087 # noqa: E501 2088 2089 :param suppress_emails: The suppress_emails of this CertifiedDelivery. # noqa: E501 2090 :type: str 2091 """ 2092 2093 self._suppress_emails = suppress_emails 2094 2095 @property 2096 def template_locked(self): 2097 """Gets the template_locked of this CertifiedDelivery. # noqa: E501 2098 2099 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2100 2101 :return: The template_locked of this CertifiedDelivery. # noqa: E501 2102 :rtype: str 2103 """ 2104 return self._template_locked 2105 2106 @template_locked.setter 2107 def template_locked(self, template_locked): 2108 """Sets the template_locked of this CertifiedDelivery. 2109 2110 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2111 2112 :param template_locked: The template_locked of this CertifiedDelivery. # noqa: E501 2113 :type: str 2114 """ 2115 2116 self._template_locked = template_locked 2117 2118 @property 2119 def template_required(self): 2120 """Gets the template_required of this CertifiedDelivery. # noqa: E501 2121 2122 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2123 2124 :return: The template_required of this CertifiedDelivery. # noqa: E501 2125 :rtype: str 2126 """ 2127 return self._template_required 2128 2129 @template_required.setter 2130 def template_required(self, template_required): 2131 """Sets the template_required of this CertifiedDelivery. 2132 2133 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2134 2135 :param template_required: The template_required of this CertifiedDelivery. # noqa: E501 2136 :type: str 2137 """ 2138 2139 self._template_required = template_required 2140 2141 @property 2142 def total_tab_count(self): 2143 """Gets the total_tab_count of this CertifiedDelivery. # noqa: E501 2144 2145 # noqa: E501 2146 2147 :return: The total_tab_count of this CertifiedDelivery. # noqa: E501 2148 :rtype: str 2149 """ 2150 return self._total_tab_count 2151 2152 @total_tab_count.setter 2153 def total_tab_count(self, total_tab_count): 2154 """Sets the total_tab_count of this CertifiedDelivery. 2155 2156 # noqa: E501 2157 2158 :param total_tab_count: The total_tab_count of this CertifiedDelivery. # noqa: E501 2159 :type: str 2160 """ 2161 2162 self._total_tab_count = total_tab_count 2163 2164 @property 2165 def user_id(self): 2166 """Gets the user_id of this CertifiedDelivery. # noqa: E501 2167 2168 # noqa: E501 2169 2170 :return: The user_id of this CertifiedDelivery. # noqa: E501 2171 :rtype: str 2172 """ 2173 return self._user_id 2174 2175 @user_id.setter 2176 def user_id(self, user_id): 2177 """Sets the user_id of this CertifiedDelivery. 2178 2179 # noqa: E501 2180 2181 :param user_id: The user_id of this CertifiedDelivery. # noqa: E501 2182 :type: str 2183 """ 2184 2185 self._user_id = user_id 2186 2187 @property 2188 def web_form_recipient_view_id(self): 2189 """Gets the web_form_recipient_view_id of this CertifiedDelivery. # noqa: E501 2190 2191 # noqa: E501 2192 2193 :return: The web_form_recipient_view_id of this CertifiedDelivery. # noqa: E501 2194 :rtype: str 2195 """ 2196 return self._web_form_recipient_view_id 2197 2198 @web_form_recipient_view_id.setter 2199 def web_form_recipient_view_id(self, web_form_recipient_view_id): 2200 """Sets the web_form_recipient_view_id of this CertifiedDelivery. 2201 2202 # noqa: E501 2203 2204 :param web_form_recipient_view_id: The web_form_recipient_view_id of this CertifiedDelivery. # noqa: E501 2205 :type: str 2206 """ 2207 2208 self._web_form_recipient_view_id = web_form_recipient_view_id 2209 2210 def to_dict(self): 2211 """Returns the model properties as a dict""" 2212 result = {} 2213 2214 for attr, _ in six.iteritems(self.swagger_types): 2215 value = getattr(self, attr) 2216 if isinstance(value, list): 2217 result[attr] = list(map( 2218 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2219 value 2220 )) 2221 elif hasattr(value, "to_dict"): 2222 result[attr] = value.to_dict() 2223 elif isinstance(value, dict): 2224 result[attr] = dict(map( 2225 lambda item: (item[0], item[1].to_dict()) 2226 if hasattr(item[1], "to_dict") else item, 2227 value.items() 2228 )) 2229 else: 2230 result[attr] = value 2231 if issubclass(CertifiedDelivery, dict): 2232 for key, value in self.items(): 2233 result[key] = value 2234 2235 return result 2236 2237 def to_str(self): 2238 """Returns the string representation of the model""" 2239 return pprint.pformat(self.to_dict()) 2240 2241 def __repr__(self): 2242 """For `print` and `pprint`""" 2243 return self.to_str() 2244 2245 def __eq__(self, other): 2246 """Returns true if both objects are equal""" 2247 if not isinstance(other, CertifiedDelivery): 2248 return False 2249 2250 return self.to_dict() == other.to_dict() 2251 2252 def __ne__(self, other): 2253 """Returns true if both objects are not equal""" 2254 if not isinstance(other, CertifiedDelivery): 2255 return True 2256 2257 return self.to_dict() != other.to_dict()
class
CertifiedDelivery:
23class CertifiedDelivery(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_responded_reason': 'str', 45 'bulk_send_v2_recipient': 'str', 46 'client_user_id': 'str', 47 'completed_count': 'str', 48 'consent_details_list': 'list[ConsentDetails]', 49 'custom_fields': 'list[str]', 50 'declined_date_time': 'str', 51 'declined_reason': 'str', 52 'delivered_date_time': 'str', 53 'delivery_method': 'str', 54 'delivery_method_metadata': 'PropertyMetadata', 55 'designator_id': 'str', 56 'designator_id_guid': 'str', 57 'document_template_id': 'str', 58 'document_visibility': 'list[DocumentVisibility]', 59 'email': 'str', 60 'email_metadata': 'PropertyMetadata', 61 'email_notification': 'RecipientEmailNotification', 62 'email_recipient_post_signing_url': 'str', 63 'embedded_recipient_start_url': 'str', 64 'error_details': 'ErrorDetails', 65 'excluded_documents': 'list[str]', 66 'fax_number': 'str', 67 'fax_number_metadata': 'PropertyMetadata', 68 'first_name': 'str', 69 'first_name_metadata': 'PropertyMetadata', 70 'full_name': 'str', 71 'full_name_metadata': 'PropertyMetadata', 72 'id_check_configuration_name': 'str', 73 'id_check_configuration_name_metadata': 'PropertyMetadata', 74 'id_check_information_input': 'IdCheckInformationInput', 75 'identity_verification': 'RecipientIdentityVerification', 76 'inherit_email_notification_configuration': 'str', 77 'last_name': 'str', 78 'last_name_metadata': 'PropertyMetadata', 79 'locked_recipient_phone_auth_editable': 'str', 80 'locked_recipient_sms_editable': 'str', 81 'name': 'str', 82 'name_metadata': 'PropertyMetadata', 83 'note': 'str', 84 'note_metadata': 'PropertyMetadata', 85 'phone_authentication': 'RecipientPhoneAuthentication', 86 'phone_number': 'RecipientPhoneNumber', 87 'proof_file': 'RecipientProofFile', 88 'recipient_attachments': 'list[RecipientAttachment]', 89 'recipient_authentication_status': 'AuthenticationStatus', 90 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 91 'recipient_id': 'str', 92 'recipient_id_guid': 'str', 93 'recipient_type': 'str', 94 'recipient_type_metadata': 'PropertyMetadata', 95 'require_id_lookup': 'str', 96 'require_id_lookup_metadata': 'PropertyMetadata', 97 'role_name': 'str', 98 'routing_order': 'str', 99 'routing_order_metadata': 'PropertyMetadata', 100 'sent_date_time': 'str', 101 'signed_date_time': 'str', 102 'signing_group_id': 'str', 103 'signing_group_id_metadata': 'PropertyMetadata', 104 'signing_group_name': 'str', 105 'signing_group_type': 'str', 106 'signing_group_users': 'list[UserInfo]', 107 'sms_authentication': 'RecipientSMSAuthentication', 108 'social_authentications': 'list[SocialAuthentication]', 109 'status': 'str', 110 'status_code': 'str', 111 'suppress_emails': 'str', 112 'template_locked': 'str', 113 'template_required': 'str', 114 'total_tab_count': 'str', 115 'user_id': 'str', 116 'web_form_recipient_view_id': 'str' 117 } 118 119 attribute_map = { 120 'access_code': 'accessCode', 121 'access_code_metadata': 'accessCodeMetadata', 122 'add_access_code_to_email': 'addAccessCodeToEmail', 123 'additional_notifications': 'additionalNotifications', 124 'agent_can_edit_email': 'agentCanEditEmail', 125 'agent_can_edit_name': 'agentCanEditName', 126 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 127 'auto_responded_reason': 'autoRespondedReason', 128 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 129 'client_user_id': 'clientUserId', 130 'completed_count': 'completedCount', 131 'consent_details_list': 'consentDetailsList', 132 'custom_fields': 'customFields', 133 'declined_date_time': 'declinedDateTime', 134 'declined_reason': 'declinedReason', 135 'delivered_date_time': 'deliveredDateTime', 136 'delivery_method': 'deliveryMethod', 137 'delivery_method_metadata': 'deliveryMethodMetadata', 138 'designator_id': 'designatorId', 139 'designator_id_guid': 'designatorIdGuid', 140 'document_template_id': 'documentTemplateId', 141 'document_visibility': 'documentVisibility', 142 'email': 'email', 143 'email_metadata': 'emailMetadata', 144 'email_notification': 'emailNotification', 145 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 146 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 147 'error_details': 'errorDetails', 148 'excluded_documents': 'excludedDocuments', 149 'fax_number': 'faxNumber', 150 'fax_number_metadata': 'faxNumberMetadata', 151 'first_name': 'firstName', 152 'first_name_metadata': 'firstNameMetadata', 153 'full_name': 'fullName', 154 'full_name_metadata': 'fullNameMetadata', 155 'id_check_configuration_name': 'idCheckConfigurationName', 156 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 157 'id_check_information_input': 'idCheckInformationInput', 158 'identity_verification': 'identityVerification', 159 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 160 'last_name': 'lastName', 161 'last_name_metadata': 'lastNameMetadata', 162 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 163 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 164 'name': 'name', 165 'name_metadata': 'nameMetadata', 166 'note': 'note', 167 'note_metadata': 'noteMetadata', 168 'phone_authentication': 'phoneAuthentication', 169 'phone_number': 'phoneNumber', 170 'proof_file': 'proofFile', 171 'recipient_attachments': 'recipientAttachments', 172 'recipient_authentication_status': 'recipientAuthenticationStatus', 173 'recipient_feature_metadata': 'recipientFeatureMetadata', 174 'recipient_id': 'recipientId', 175 'recipient_id_guid': 'recipientIdGuid', 176 'recipient_type': 'recipientType', 177 'recipient_type_metadata': 'recipientTypeMetadata', 178 'require_id_lookup': 'requireIdLookup', 179 'require_id_lookup_metadata': 'requireIdLookupMetadata', 180 'role_name': 'roleName', 181 'routing_order': 'routingOrder', 182 'routing_order_metadata': 'routingOrderMetadata', 183 'sent_date_time': 'sentDateTime', 184 'signed_date_time': 'signedDateTime', 185 'signing_group_id': 'signingGroupId', 186 'signing_group_id_metadata': 'signingGroupIdMetadata', 187 'signing_group_name': 'signingGroupName', 188 'signing_group_type': 'signingGroupType', 189 'signing_group_users': 'signingGroupUsers', 190 'sms_authentication': 'smsAuthentication', 191 'social_authentications': 'socialAuthentications', 192 'status': 'status', 193 'status_code': 'statusCode', 194 'suppress_emails': 'suppressEmails', 195 'template_locked': 'templateLocked', 196 'template_required': 'templateRequired', 197 'total_tab_count': 'totalTabCount', 198 'user_id': 'userId', 199 'web_form_recipient_view_id': 'webFormRecipientViewId' 200 } 201 202 def __init__(self, _configuration=None, **kwargs): # noqa: E501 203 """CertifiedDelivery - a model defined in Swagger""" # noqa: E501 204 if _configuration is None: 205 _configuration = Configuration() 206 self._configuration = _configuration 207 208 self._access_code = None 209 self._access_code_metadata = None 210 self._add_access_code_to_email = None 211 self._additional_notifications = None 212 self._agent_can_edit_email = None 213 self._agent_can_edit_name = None 214 self._allow_system_override_for_locked_recipient = None 215 self._auto_responded_reason = None 216 self._bulk_send_v2_recipient = None 217 self._client_user_id = None 218 self._completed_count = None 219 self._consent_details_list = None 220 self._custom_fields = None 221 self._declined_date_time = None 222 self._declined_reason = None 223 self._delivered_date_time = None 224 self._delivery_method = None 225 self._delivery_method_metadata = None 226 self._designator_id = None 227 self._designator_id_guid = None 228 self._document_template_id = None 229 self._document_visibility = None 230 self._email = None 231 self._email_metadata = None 232 self._email_notification = None 233 self._email_recipient_post_signing_url = None 234 self._embedded_recipient_start_url = None 235 self._error_details = None 236 self._excluded_documents = None 237 self._fax_number = None 238 self._fax_number_metadata = None 239 self._first_name = None 240 self._first_name_metadata = None 241 self._full_name = None 242 self._full_name_metadata = None 243 self._id_check_configuration_name = None 244 self._id_check_configuration_name_metadata = None 245 self._id_check_information_input = None 246 self._identity_verification = None 247 self._inherit_email_notification_configuration = None 248 self._last_name = None 249 self._last_name_metadata = None 250 self._locked_recipient_phone_auth_editable = None 251 self._locked_recipient_sms_editable = None 252 self._name = None 253 self._name_metadata = None 254 self._note = None 255 self._note_metadata = None 256 self._phone_authentication = None 257 self._phone_number = None 258 self._proof_file = None 259 self._recipient_attachments = None 260 self._recipient_authentication_status = None 261 self._recipient_feature_metadata = None 262 self._recipient_id = None 263 self._recipient_id_guid = None 264 self._recipient_type = None 265 self._recipient_type_metadata = None 266 self._require_id_lookup = None 267 self._require_id_lookup_metadata = None 268 self._role_name = None 269 self._routing_order = None 270 self._routing_order_metadata = None 271 self._sent_date_time = None 272 self._signed_date_time = None 273 self._signing_group_id = None 274 self._signing_group_id_metadata = None 275 self._signing_group_name = None 276 self._signing_group_type = None 277 self._signing_group_users = None 278 self._sms_authentication = None 279 self._social_authentications = None 280 self._status = None 281 self._status_code = None 282 self._suppress_emails = None 283 self._template_locked = None 284 self._template_required = None 285 self._total_tab_count = None 286 self._user_id = None 287 self._web_form_recipient_view_id = None 288 self.discriminator = None 289 290 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 291 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 292 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 293 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 294 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 295 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 296 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 297 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 298 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 299 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 300 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 301 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 302 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 303 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 304 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 305 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 306 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 307 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 308 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 309 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 310 setattr(self, "_{}".format('document_template_id'), kwargs.get('document_template_id', None)) 311 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 312 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 313 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 314 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 315 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 316 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 317 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 318 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 319 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 320 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 321 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 322 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 323 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 324 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 325 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 326 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 327 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 328 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 329 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 330 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 331 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 332 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 333 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 334 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 335 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 336 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 337 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 338 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 339 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 340 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 341 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 342 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 343 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 344 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 345 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 346 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 347 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 348 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 349 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 350 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 351 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 352 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 353 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 354 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 355 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 356 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 357 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 358 setattr(self, "_{}".format('signing_group_type'), kwargs.get('signing_group_type', None)) 359 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 360 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 361 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 362 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 363 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 364 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 365 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 366 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 367 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 368 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 369 setattr(self, "_{}".format('web_form_recipient_view_id'), kwargs.get('web_form_recipient_view_id', None)) 370 371 @property 372 def access_code(self): 373 """Gets the access_code of this CertifiedDelivery. # noqa: E501 374 375 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 376 377 :return: The access_code of this CertifiedDelivery. # noqa: E501 378 :rtype: str 379 """ 380 return self._access_code 381 382 @access_code.setter 383 def access_code(self, access_code): 384 """Sets the access_code of this CertifiedDelivery. 385 386 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 387 388 :param access_code: The access_code of this CertifiedDelivery. # noqa: E501 389 :type: str 390 """ 391 392 self._access_code = access_code 393 394 @property 395 def access_code_metadata(self): 396 """Gets the access_code_metadata of this CertifiedDelivery. # noqa: E501 397 398 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 399 400 :return: The access_code_metadata of this CertifiedDelivery. # noqa: E501 401 :rtype: PropertyMetadata 402 """ 403 return self._access_code_metadata 404 405 @access_code_metadata.setter 406 def access_code_metadata(self, access_code_metadata): 407 """Sets the access_code_metadata of this CertifiedDelivery. 408 409 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 410 411 :param access_code_metadata: The access_code_metadata of this CertifiedDelivery. # noqa: E501 412 :type: PropertyMetadata 413 """ 414 415 self._access_code_metadata = access_code_metadata 416 417 @property 418 def add_access_code_to_email(self): 419 """Gets the add_access_code_to_email of this CertifiedDelivery. # noqa: E501 420 421 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 422 423 :return: The add_access_code_to_email of this CertifiedDelivery. # noqa: E501 424 :rtype: str 425 """ 426 return self._add_access_code_to_email 427 428 @add_access_code_to_email.setter 429 def add_access_code_to_email(self, add_access_code_to_email): 430 """Sets the add_access_code_to_email of this CertifiedDelivery. 431 432 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 433 434 :param add_access_code_to_email: The add_access_code_to_email of this CertifiedDelivery. # noqa: E501 435 :type: str 436 """ 437 438 self._add_access_code_to_email = add_access_code_to_email 439 440 @property 441 def additional_notifications(self): 442 """Gets the additional_notifications of this CertifiedDelivery. # noqa: E501 443 444 # noqa: E501 445 446 :return: The additional_notifications of this CertifiedDelivery. # noqa: E501 447 :rtype: list[RecipientAdditionalNotification] 448 """ 449 return self._additional_notifications 450 451 @additional_notifications.setter 452 def additional_notifications(self, additional_notifications): 453 """Sets the additional_notifications of this CertifiedDelivery. 454 455 # noqa: E501 456 457 :param additional_notifications: The additional_notifications of this CertifiedDelivery. # noqa: E501 458 :type: list[RecipientAdditionalNotification] 459 """ 460 461 self._additional_notifications = additional_notifications 462 463 @property 464 def agent_can_edit_email(self): 465 """Gets the agent_can_edit_email of this CertifiedDelivery. # noqa: E501 466 467 # noqa: E501 468 469 :return: The agent_can_edit_email of this CertifiedDelivery. # noqa: E501 470 :rtype: str 471 """ 472 return self._agent_can_edit_email 473 474 @agent_can_edit_email.setter 475 def agent_can_edit_email(self, agent_can_edit_email): 476 """Sets the agent_can_edit_email of this CertifiedDelivery. 477 478 # noqa: E501 479 480 :param agent_can_edit_email: The agent_can_edit_email of this CertifiedDelivery. # noqa: E501 481 :type: str 482 """ 483 484 self._agent_can_edit_email = agent_can_edit_email 485 486 @property 487 def agent_can_edit_name(self): 488 """Gets the agent_can_edit_name of this CertifiedDelivery. # noqa: E501 489 490 # noqa: E501 491 492 :return: The agent_can_edit_name of this CertifiedDelivery. # noqa: E501 493 :rtype: str 494 """ 495 return self._agent_can_edit_name 496 497 @agent_can_edit_name.setter 498 def agent_can_edit_name(self, agent_can_edit_name): 499 """Sets the agent_can_edit_name of this CertifiedDelivery. 500 501 # noqa: E501 502 503 :param agent_can_edit_name: The agent_can_edit_name of this CertifiedDelivery. # noqa: E501 504 :type: str 505 """ 506 507 self._agent_can_edit_name = agent_can_edit_name 508 509 @property 510 def allow_system_override_for_locked_recipient(self): 511 """Gets the allow_system_override_for_locked_recipient of this CertifiedDelivery. # noqa: E501 512 513 # noqa: E501 514 515 :return: The allow_system_override_for_locked_recipient of this CertifiedDelivery. # noqa: E501 516 :rtype: str 517 """ 518 return self._allow_system_override_for_locked_recipient 519 520 @allow_system_override_for_locked_recipient.setter 521 def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): 522 """Sets the allow_system_override_for_locked_recipient of this CertifiedDelivery. 523 524 # noqa: E501 525 526 :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this CertifiedDelivery. # noqa: E501 527 :type: str 528 """ 529 530 self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient 531 532 @property 533 def auto_responded_reason(self): 534 """Gets the auto_responded_reason of this CertifiedDelivery. # noqa: E501 535 536 # noqa: E501 537 538 :return: The auto_responded_reason of this CertifiedDelivery. # noqa: E501 539 :rtype: str 540 """ 541 return self._auto_responded_reason 542 543 @auto_responded_reason.setter 544 def auto_responded_reason(self, auto_responded_reason): 545 """Sets the auto_responded_reason of this CertifiedDelivery. 546 547 # noqa: E501 548 549 :param auto_responded_reason: The auto_responded_reason of this CertifiedDelivery. # noqa: E501 550 :type: str 551 """ 552 553 self._auto_responded_reason = auto_responded_reason 554 555 @property 556 def bulk_send_v2_recipient(self): 557 """Gets the bulk_send_v2_recipient of this CertifiedDelivery. # noqa: E501 558 559 # noqa: E501 560 561 :return: The bulk_send_v2_recipient of this CertifiedDelivery. # noqa: E501 562 :rtype: str 563 """ 564 return self._bulk_send_v2_recipient 565 566 @bulk_send_v2_recipient.setter 567 def bulk_send_v2_recipient(self, bulk_send_v2_recipient): 568 """Sets the bulk_send_v2_recipient of this CertifiedDelivery. 569 570 # noqa: E501 571 572 :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this CertifiedDelivery. # noqa: E501 573 :type: str 574 """ 575 576 self._bulk_send_v2_recipient = bulk_send_v2_recipient 577 578 @property 579 def client_user_id(self): 580 """Gets the client_user_id of this CertifiedDelivery. # noqa: E501 581 582 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 583 584 :return: The client_user_id of this CertifiedDelivery. # noqa: E501 585 :rtype: str 586 """ 587 return self._client_user_id 588 589 @client_user_id.setter 590 def client_user_id(self, client_user_id): 591 """Sets the client_user_id of this CertifiedDelivery. 592 593 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 594 595 :param client_user_id: The client_user_id of this CertifiedDelivery. # noqa: E501 596 :type: str 597 """ 598 599 self._client_user_id = client_user_id 600 601 @property 602 def completed_count(self): 603 """Gets the completed_count of this CertifiedDelivery. # noqa: E501 604 605 # noqa: E501 606 607 :return: The completed_count of this CertifiedDelivery. # noqa: E501 608 :rtype: str 609 """ 610 return self._completed_count 611 612 @completed_count.setter 613 def completed_count(self, completed_count): 614 """Sets the completed_count of this CertifiedDelivery. 615 616 # noqa: E501 617 618 :param completed_count: The completed_count of this CertifiedDelivery. # noqa: E501 619 :type: str 620 """ 621 622 self._completed_count = completed_count 623 624 @property 625 def consent_details_list(self): 626 """Gets the consent_details_list of this CertifiedDelivery. # noqa: E501 627 628 # noqa: E501 629 630 :return: The consent_details_list of this CertifiedDelivery. # noqa: E501 631 :rtype: list[ConsentDetails] 632 """ 633 return self._consent_details_list 634 635 @consent_details_list.setter 636 def consent_details_list(self, consent_details_list): 637 """Sets the consent_details_list of this CertifiedDelivery. 638 639 # noqa: E501 640 641 :param consent_details_list: The consent_details_list of this CertifiedDelivery. # noqa: E501 642 :type: list[ConsentDetails] 643 """ 644 645 self._consent_details_list = consent_details_list 646 647 @property 648 def custom_fields(self): 649 """Gets the custom_fields of this CertifiedDelivery. # noqa: E501 650 651 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 652 653 :return: The custom_fields of this CertifiedDelivery. # noqa: E501 654 :rtype: list[str] 655 """ 656 return self._custom_fields 657 658 @custom_fields.setter 659 def custom_fields(self, custom_fields): 660 """Sets the custom_fields of this CertifiedDelivery. 661 662 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 663 664 :param custom_fields: The custom_fields of this CertifiedDelivery. # noqa: E501 665 :type: list[str] 666 """ 667 668 self._custom_fields = custom_fields 669 670 @property 671 def declined_date_time(self): 672 """Gets the declined_date_time of this CertifiedDelivery. # noqa: E501 673 674 The date and time the recipient declined the document. # noqa: E501 675 676 :return: The declined_date_time of this CertifiedDelivery. # noqa: E501 677 :rtype: str 678 """ 679 return self._declined_date_time 680 681 @declined_date_time.setter 682 def declined_date_time(self, declined_date_time): 683 """Sets the declined_date_time of this CertifiedDelivery. 684 685 The date and time the recipient declined the document. # noqa: E501 686 687 :param declined_date_time: The declined_date_time of this CertifiedDelivery. # noqa: E501 688 :type: str 689 """ 690 691 self._declined_date_time = declined_date_time 692 693 @property 694 def declined_reason(self): 695 """Gets the declined_reason of this CertifiedDelivery. # noqa: E501 696 697 The reason the recipient declined the document. # noqa: E501 698 699 :return: The declined_reason of this CertifiedDelivery. # noqa: E501 700 :rtype: str 701 """ 702 return self._declined_reason 703 704 @declined_reason.setter 705 def declined_reason(self, declined_reason): 706 """Sets the declined_reason of this CertifiedDelivery. 707 708 The reason the recipient declined the document. # noqa: E501 709 710 :param declined_reason: The declined_reason of this CertifiedDelivery. # noqa: E501 711 :type: str 712 """ 713 714 self._declined_reason = declined_reason 715 716 @property 717 def delivered_date_time(self): 718 """Gets the delivered_date_time of this CertifiedDelivery. # noqa: E501 719 720 Reserved: For DocuSign use only. # noqa: E501 721 722 :return: The delivered_date_time of this CertifiedDelivery. # noqa: E501 723 :rtype: str 724 """ 725 return self._delivered_date_time 726 727 @delivered_date_time.setter 728 def delivered_date_time(self, delivered_date_time): 729 """Sets the delivered_date_time of this CertifiedDelivery. 730 731 Reserved: For DocuSign use only. # noqa: E501 732 733 :param delivered_date_time: The delivered_date_time of this CertifiedDelivery. # noqa: E501 734 :type: str 735 """ 736 737 self._delivered_date_time = delivered_date_time 738 739 @property 740 def delivery_method(self): 741 """Gets the delivery_method of this CertifiedDelivery. # noqa: E501 742 743 Reserved: For DocuSign use only. # noqa: E501 744 745 :return: The delivery_method of this CertifiedDelivery. # noqa: E501 746 :rtype: str 747 """ 748 return self._delivery_method 749 750 @delivery_method.setter 751 def delivery_method(self, delivery_method): 752 """Sets the delivery_method of this CertifiedDelivery. 753 754 Reserved: For DocuSign use only. # noqa: E501 755 756 :param delivery_method: The delivery_method of this CertifiedDelivery. # noqa: E501 757 :type: str 758 """ 759 760 self._delivery_method = delivery_method 761 762 @property 763 def delivery_method_metadata(self): 764 """Gets the delivery_method_metadata of this CertifiedDelivery. # noqa: E501 765 766 Reserved for DocuSign. # noqa: E501 767 768 :return: The delivery_method_metadata of this CertifiedDelivery. # noqa: E501 769 :rtype: PropertyMetadata 770 """ 771 return self._delivery_method_metadata 772 773 @delivery_method_metadata.setter 774 def delivery_method_metadata(self, delivery_method_metadata): 775 """Sets the delivery_method_metadata of this CertifiedDelivery. 776 777 Reserved for DocuSign. # noqa: E501 778 779 :param delivery_method_metadata: The delivery_method_metadata of this CertifiedDelivery. # noqa: E501 780 :type: PropertyMetadata 781 """ 782 783 self._delivery_method_metadata = delivery_method_metadata 784 785 @property 786 def designator_id(self): 787 """Gets the designator_id of this CertifiedDelivery. # noqa: E501 788 789 # noqa: E501 790 791 :return: The designator_id of this CertifiedDelivery. # noqa: E501 792 :rtype: str 793 """ 794 return self._designator_id 795 796 @designator_id.setter 797 def designator_id(self, designator_id): 798 """Sets the designator_id of this CertifiedDelivery. 799 800 # noqa: E501 801 802 :param designator_id: The designator_id of this CertifiedDelivery. # noqa: E501 803 :type: str 804 """ 805 806 self._designator_id = designator_id 807 808 @property 809 def designator_id_guid(self): 810 """Gets the designator_id_guid of this CertifiedDelivery. # noqa: E501 811 812 # noqa: E501 813 814 :return: The designator_id_guid of this CertifiedDelivery. # noqa: E501 815 :rtype: str 816 """ 817 return self._designator_id_guid 818 819 @designator_id_guid.setter 820 def designator_id_guid(self, designator_id_guid): 821 """Sets the designator_id_guid of this CertifiedDelivery. 822 823 # noqa: E501 824 825 :param designator_id_guid: The designator_id_guid of this CertifiedDelivery. # noqa: E501 826 :type: str 827 """ 828 829 self._designator_id_guid = designator_id_guid 830 831 @property 832 def document_template_id(self): 833 """Gets the document_template_id of this CertifiedDelivery. # noqa: E501 834 835 # noqa: E501 836 837 :return: The document_template_id of this CertifiedDelivery. # noqa: E501 838 :rtype: str 839 """ 840 return self._document_template_id 841 842 @document_template_id.setter 843 def document_template_id(self, document_template_id): 844 """Sets the document_template_id of this CertifiedDelivery. 845 846 # noqa: E501 847 848 :param document_template_id: The document_template_id of this CertifiedDelivery. # noqa: E501 849 :type: str 850 """ 851 852 self._document_template_id = document_template_id 853 854 @property 855 def document_visibility(self): 856 """Gets the document_visibility of this CertifiedDelivery. # noqa: E501 857 858 # noqa: E501 859 860 :return: The document_visibility of this CertifiedDelivery. # noqa: E501 861 :rtype: list[DocumentVisibility] 862 """ 863 return self._document_visibility 864 865 @document_visibility.setter 866 def document_visibility(self, document_visibility): 867 """Sets the document_visibility of this CertifiedDelivery. 868 869 # noqa: E501 870 871 :param document_visibility: The document_visibility of this CertifiedDelivery. # noqa: E501 872 :type: list[DocumentVisibility] 873 """ 874 875 self._document_visibility = document_visibility 876 877 @property 878 def email(self): 879 """Gets the email of this CertifiedDelivery. # noqa: E501 880 881 # noqa: E501 882 883 :return: The email of this CertifiedDelivery. # noqa: E501 884 :rtype: str 885 """ 886 return self._email 887 888 @email.setter 889 def email(self, email): 890 """Sets the email of this CertifiedDelivery. 891 892 # noqa: E501 893 894 :param email: The email of this CertifiedDelivery. # noqa: E501 895 :type: str 896 """ 897 898 self._email = email 899 900 @property 901 def email_metadata(self): 902 """Gets the email_metadata of this CertifiedDelivery. # noqa: E501 903 904 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 905 906 :return: The email_metadata of this CertifiedDelivery. # noqa: E501 907 :rtype: PropertyMetadata 908 """ 909 return self._email_metadata 910 911 @email_metadata.setter 912 def email_metadata(self, email_metadata): 913 """Sets the email_metadata of this CertifiedDelivery. 914 915 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 916 917 :param email_metadata: The email_metadata of this CertifiedDelivery. # noqa: E501 918 :type: PropertyMetadata 919 """ 920 921 self._email_metadata = email_metadata 922 923 @property 924 def email_notification(self): 925 """Gets the email_notification of this CertifiedDelivery. # noqa: E501 926 927 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 928 929 :return: The email_notification of this CertifiedDelivery. # noqa: E501 930 :rtype: RecipientEmailNotification 931 """ 932 return self._email_notification 933 934 @email_notification.setter 935 def email_notification(self, email_notification): 936 """Sets the email_notification of this CertifiedDelivery. 937 938 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 939 940 :param email_notification: The email_notification of this CertifiedDelivery. # noqa: E501 941 :type: RecipientEmailNotification 942 """ 943 944 self._email_notification = email_notification 945 946 @property 947 def email_recipient_post_signing_url(self): 948 """Gets the email_recipient_post_signing_url of this CertifiedDelivery. # noqa: E501 949 950 # noqa: E501 951 952 :return: The email_recipient_post_signing_url of this CertifiedDelivery. # noqa: E501 953 :rtype: str 954 """ 955 return self._email_recipient_post_signing_url 956 957 @email_recipient_post_signing_url.setter 958 def email_recipient_post_signing_url(self, email_recipient_post_signing_url): 959 """Sets the email_recipient_post_signing_url of this CertifiedDelivery. 960 961 # noqa: E501 962 963 :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this CertifiedDelivery. # noqa: E501 964 :type: str 965 """ 966 967 self._email_recipient_post_signing_url = email_recipient_post_signing_url 968 969 @property 970 def embedded_recipient_start_url(self): 971 """Gets the embedded_recipient_start_url of this CertifiedDelivery. # noqa: E501 972 973 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 974 975 :return: The embedded_recipient_start_url of this CertifiedDelivery. # noqa: E501 976 :rtype: str 977 """ 978 return self._embedded_recipient_start_url 979 980 @embedded_recipient_start_url.setter 981 def embedded_recipient_start_url(self, embedded_recipient_start_url): 982 """Sets the embedded_recipient_start_url of this CertifiedDelivery. 983 984 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 985 986 :param embedded_recipient_start_url: The embedded_recipient_start_url of this CertifiedDelivery. # noqa: E501 987 :type: str 988 """ 989 990 self._embedded_recipient_start_url = embedded_recipient_start_url 991 992 @property 993 def error_details(self): 994 """Gets the error_details of this CertifiedDelivery. # noqa: E501 995 996 Array or errors. # noqa: E501 997 998 :return: The error_details of this CertifiedDelivery. # noqa: E501 999 :rtype: ErrorDetails 1000 """ 1001 return self._error_details 1002 1003 @error_details.setter 1004 def error_details(self, error_details): 1005 """Sets the error_details of this CertifiedDelivery. 1006 1007 Array or errors. # noqa: E501 1008 1009 :param error_details: The error_details of this CertifiedDelivery. # noqa: E501 1010 :type: ErrorDetails 1011 """ 1012 1013 self._error_details = error_details 1014 1015 @property 1016 def excluded_documents(self): 1017 """Gets the excluded_documents of this CertifiedDelivery. # noqa: E501 1018 1019 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 1020 1021 :return: The excluded_documents of this CertifiedDelivery. # noqa: E501 1022 :rtype: list[str] 1023 """ 1024 return self._excluded_documents 1025 1026 @excluded_documents.setter 1027 def excluded_documents(self, excluded_documents): 1028 """Sets the excluded_documents of this CertifiedDelivery. 1029 1030 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 1031 1032 :param excluded_documents: The excluded_documents of this CertifiedDelivery. # noqa: E501 1033 :type: list[str] 1034 """ 1035 1036 self._excluded_documents = excluded_documents 1037 1038 @property 1039 def fax_number(self): 1040 """Gets the fax_number of this CertifiedDelivery. # noqa: E501 1041 1042 Reserved: # noqa: E501 1043 1044 :return: The fax_number of this CertifiedDelivery. # noqa: E501 1045 :rtype: str 1046 """ 1047 return self._fax_number 1048 1049 @fax_number.setter 1050 def fax_number(self, fax_number): 1051 """Sets the fax_number of this CertifiedDelivery. 1052 1053 Reserved: # noqa: E501 1054 1055 :param fax_number: The fax_number of this CertifiedDelivery. # noqa: E501 1056 :type: str 1057 """ 1058 1059 self._fax_number = fax_number 1060 1061 @property 1062 def fax_number_metadata(self): 1063 """Gets the fax_number_metadata of this CertifiedDelivery. # noqa: E501 1064 1065 Reserved for DocuSign. # noqa: E501 1066 1067 :return: The fax_number_metadata of this CertifiedDelivery. # noqa: E501 1068 :rtype: PropertyMetadata 1069 """ 1070 return self._fax_number_metadata 1071 1072 @fax_number_metadata.setter 1073 def fax_number_metadata(self, fax_number_metadata): 1074 """Sets the fax_number_metadata of this CertifiedDelivery. 1075 1076 Reserved for DocuSign. # noqa: E501 1077 1078 :param fax_number_metadata: The fax_number_metadata of this CertifiedDelivery. # noqa: E501 1079 :type: PropertyMetadata 1080 """ 1081 1082 self._fax_number_metadata = fax_number_metadata 1083 1084 @property 1085 def first_name(self): 1086 """Gets the first_name of this CertifiedDelivery. # noqa: E501 1087 1088 The user's first name. Maximum Length: 50 characters. # noqa: E501 1089 1090 :return: The first_name of this CertifiedDelivery. # noqa: E501 1091 :rtype: str 1092 """ 1093 return self._first_name 1094 1095 @first_name.setter 1096 def first_name(self, first_name): 1097 """Sets the first_name of this CertifiedDelivery. 1098 1099 The user's first name. Maximum Length: 50 characters. # noqa: E501 1100 1101 :param first_name: The first_name of this CertifiedDelivery. # noqa: E501 1102 :type: str 1103 """ 1104 1105 self._first_name = first_name 1106 1107 @property 1108 def first_name_metadata(self): 1109 """Gets the first_name_metadata of this CertifiedDelivery. # noqa: E501 1110 1111 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1112 1113 :return: The first_name_metadata of this CertifiedDelivery. # noqa: E501 1114 :rtype: PropertyMetadata 1115 """ 1116 return self._first_name_metadata 1117 1118 @first_name_metadata.setter 1119 def first_name_metadata(self, first_name_metadata): 1120 """Sets the first_name_metadata of this CertifiedDelivery. 1121 1122 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1123 1124 :param first_name_metadata: The first_name_metadata of this CertifiedDelivery. # noqa: E501 1125 :type: PropertyMetadata 1126 """ 1127 1128 self._first_name_metadata = first_name_metadata 1129 1130 @property 1131 def full_name(self): 1132 """Gets the full_name of this CertifiedDelivery. # noqa: E501 1133 1134 # noqa: E501 1135 1136 :return: The full_name of this CertifiedDelivery. # noqa: E501 1137 :rtype: str 1138 """ 1139 return self._full_name 1140 1141 @full_name.setter 1142 def full_name(self, full_name): 1143 """Sets the full_name of this CertifiedDelivery. 1144 1145 # noqa: E501 1146 1147 :param full_name: The full_name of this CertifiedDelivery. # noqa: E501 1148 :type: str 1149 """ 1150 1151 self._full_name = full_name 1152 1153 @property 1154 def full_name_metadata(self): 1155 """Gets the full_name_metadata of this CertifiedDelivery. # noqa: E501 1156 1157 Reserved for DocuSign. # noqa: E501 1158 1159 :return: The full_name_metadata of this CertifiedDelivery. # noqa: E501 1160 :rtype: PropertyMetadata 1161 """ 1162 return self._full_name_metadata 1163 1164 @full_name_metadata.setter 1165 def full_name_metadata(self, full_name_metadata): 1166 """Sets the full_name_metadata of this CertifiedDelivery. 1167 1168 Reserved for DocuSign. # noqa: E501 1169 1170 :param full_name_metadata: The full_name_metadata of this CertifiedDelivery. # noqa: E501 1171 :type: PropertyMetadata 1172 """ 1173 1174 self._full_name_metadata = full_name_metadata 1175 1176 @property 1177 def id_check_configuration_name(self): 1178 """Gets the id_check_configuration_name of this CertifiedDelivery. # noqa: E501 1179 1180 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 1181 1182 :return: The id_check_configuration_name of this CertifiedDelivery. # noqa: E501 1183 :rtype: str 1184 """ 1185 return self._id_check_configuration_name 1186 1187 @id_check_configuration_name.setter 1188 def id_check_configuration_name(self, id_check_configuration_name): 1189 """Sets the id_check_configuration_name of this CertifiedDelivery. 1190 1191 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 1192 1193 :param id_check_configuration_name: The id_check_configuration_name of this CertifiedDelivery. # noqa: E501 1194 :type: str 1195 """ 1196 1197 self._id_check_configuration_name = id_check_configuration_name 1198 1199 @property 1200 def id_check_configuration_name_metadata(self): 1201 """Gets the id_check_configuration_name_metadata of this CertifiedDelivery. # noqa: E501 1202 1203 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1204 1205 :return: The id_check_configuration_name_metadata of this CertifiedDelivery. # noqa: E501 1206 :rtype: PropertyMetadata 1207 """ 1208 return self._id_check_configuration_name_metadata 1209 1210 @id_check_configuration_name_metadata.setter 1211 def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): 1212 """Sets the id_check_configuration_name_metadata of this CertifiedDelivery. 1213 1214 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1215 1216 :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this CertifiedDelivery. # noqa: E501 1217 :type: PropertyMetadata 1218 """ 1219 1220 self._id_check_configuration_name_metadata = id_check_configuration_name_metadata 1221 1222 @property 1223 def id_check_information_input(self): 1224 """Gets the id_check_information_input of this CertifiedDelivery. # noqa: E501 1225 1226 An object that contains input information related to a recipient ID check. # noqa: E501 1227 1228 :return: The id_check_information_input of this CertifiedDelivery. # noqa: E501 1229 :rtype: IdCheckInformationInput 1230 """ 1231 return self._id_check_information_input 1232 1233 @id_check_information_input.setter 1234 def id_check_information_input(self, id_check_information_input): 1235 """Sets the id_check_information_input of this CertifiedDelivery. 1236 1237 An object that contains input information related to a recipient ID check. # noqa: E501 1238 1239 :param id_check_information_input: The id_check_information_input of this CertifiedDelivery. # noqa: E501 1240 :type: IdCheckInformationInput 1241 """ 1242 1243 self._id_check_information_input = id_check_information_input 1244 1245 @property 1246 def identity_verification(self): 1247 """Gets the identity_verification of this CertifiedDelivery. # noqa: E501 1248 1249 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 1250 1251 :return: The identity_verification of this CertifiedDelivery. # noqa: E501 1252 :rtype: RecipientIdentityVerification 1253 """ 1254 return self._identity_verification 1255 1256 @identity_verification.setter 1257 def identity_verification(self, identity_verification): 1258 """Sets the identity_verification of this CertifiedDelivery. 1259 1260 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 1261 1262 :param identity_verification: The identity_verification of this CertifiedDelivery. # noqa: E501 1263 :type: RecipientIdentityVerification 1264 """ 1265 1266 self._identity_verification = identity_verification 1267 1268 @property 1269 def inherit_email_notification_configuration(self): 1270 """Gets the inherit_email_notification_configuration of this CertifiedDelivery. # noqa: E501 1271 1272 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 1273 1274 :return: The inherit_email_notification_configuration of this CertifiedDelivery. # noqa: E501 1275 :rtype: str 1276 """ 1277 return self._inherit_email_notification_configuration 1278 1279 @inherit_email_notification_configuration.setter 1280 def inherit_email_notification_configuration(self, inherit_email_notification_configuration): 1281 """Sets the inherit_email_notification_configuration of this CertifiedDelivery. 1282 1283 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 1284 1285 :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this CertifiedDelivery. # noqa: E501 1286 :type: str 1287 """ 1288 1289 self._inherit_email_notification_configuration = inherit_email_notification_configuration 1290 1291 @property 1292 def last_name(self): 1293 """Gets the last_name of this CertifiedDelivery. # noqa: E501 1294 1295 # noqa: E501 1296 1297 :return: The last_name of this CertifiedDelivery. # noqa: E501 1298 :rtype: str 1299 """ 1300 return self._last_name 1301 1302 @last_name.setter 1303 def last_name(self, last_name): 1304 """Sets the last_name of this CertifiedDelivery. 1305 1306 # noqa: E501 1307 1308 :param last_name: The last_name of this CertifiedDelivery. # noqa: E501 1309 :type: str 1310 """ 1311 1312 self._last_name = last_name 1313 1314 @property 1315 def last_name_metadata(self): 1316 """Gets the last_name_metadata of this CertifiedDelivery. # noqa: E501 1317 1318 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1319 1320 :return: The last_name_metadata of this CertifiedDelivery. # noqa: E501 1321 :rtype: PropertyMetadata 1322 """ 1323 return self._last_name_metadata 1324 1325 @last_name_metadata.setter 1326 def last_name_metadata(self, last_name_metadata): 1327 """Sets the last_name_metadata of this CertifiedDelivery. 1328 1329 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1330 1331 :param last_name_metadata: The last_name_metadata of this CertifiedDelivery. # noqa: E501 1332 :type: PropertyMetadata 1333 """ 1334 1335 self._last_name_metadata = last_name_metadata 1336 1337 @property 1338 def locked_recipient_phone_auth_editable(self): 1339 """Gets the locked_recipient_phone_auth_editable of this CertifiedDelivery. # noqa: E501 1340 1341 # noqa: E501 1342 1343 :return: The locked_recipient_phone_auth_editable of this CertifiedDelivery. # noqa: E501 1344 :rtype: str 1345 """ 1346 return self._locked_recipient_phone_auth_editable 1347 1348 @locked_recipient_phone_auth_editable.setter 1349 def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): 1350 """Sets the locked_recipient_phone_auth_editable of this CertifiedDelivery. 1351 1352 # noqa: E501 1353 1354 :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this CertifiedDelivery. # noqa: E501 1355 :type: str 1356 """ 1357 1358 self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable 1359 1360 @property 1361 def locked_recipient_sms_editable(self): 1362 """Gets the locked_recipient_sms_editable of this CertifiedDelivery. # noqa: E501 1363 1364 # noqa: E501 1365 1366 :return: The locked_recipient_sms_editable of this CertifiedDelivery. # noqa: E501 1367 :rtype: str 1368 """ 1369 return self._locked_recipient_sms_editable 1370 1371 @locked_recipient_sms_editable.setter 1372 def locked_recipient_sms_editable(self, locked_recipient_sms_editable): 1373 """Sets the locked_recipient_sms_editable of this CertifiedDelivery. 1374 1375 # noqa: E501 1376 1377 :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this CertifiedDelivery. # noqa: E501 1378 :type: str 1379 """ 1380 1381 self._locked_recipient_sms_editable = locked_recipient_sms_editable 1382 1383 @property 1384 def name(self): 1385 """Gets the name of this CertifiedDelivery. # noqa: E501 1386 1387 # noqa: E501 1388 1389 :return: The name of this CertifiedDelivery. # noqa: E501 1390 :rtype: str 1391 """ 1392 return self._name 1393 1394 @name.setter 1395 def name(self, name): 1396 """Sets the name of this CertifiedDelivery. 1397 1398 # noqa: E501 1399 1400 :param name: The name of this CertifiedDelivery. # noqa: E501 1401 :type: str 1402 """ 1403 1404 self._name = name 1405 1406 @property 1407 def name_metadata(self): 1408 """Gets the name_metadata of this CertifiedDelivery. # noqa: E501 1409 1410 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1411 1412 :return: The name_metadata of this CertifiedDelivery. # noqa: E501 1413 :rtype: PropertyMetadata 1414 """ 1415 return self._name_metadata 1416 1417 @name_metadata.setter 1418 def name_metadata(self, name_metadata): 1419 """Sets the name_metadata of this CertifiedDelivery. 1420 1421 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1422 1423 :param name_metadata: The name_metadata of this CertifiedDelivery. # noqa: E501 1424 :type: PropertyMetadata 1425 """ 1426 1427 self._name_metadata = name_metadata 1428 1429 @property 1430 def note(self): 1431 """Gets the note of this CertifiedDelivery. # noqa: E501 1432 1433 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 1434 1435 :return: The note of this CertifiedDelivery. # noqa: E501 1436 :rtype: str 1437 """ 1438 return self._note 1439 1440 @note.setter 1441 def note(self, note): 1442 """Sets the note of this CertifiedDelivery. 1443 1444 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 1445 1446 :param note: The note of this CertifiedDelivery. # noqa: E501 1447 :type: str 1448 """ 1449 1450 self._note = note 1451 1452 @property 1453 def note_metadata(self): 1454 """Gets the note_metadata of this CertifiedDelivery. # noqa: E501 1455 1456 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1457 1458 :return: The note_metadata of this CertifiedDelivery. # noqa: E501 1459 :rtype: PropertyMetadata 1460 """ 1461 return self._note_metadata 1462 1463 @note_metadata.setter 1464 def note_metadata(self, note_metadata): 1465 """Sets the note_metadata of this CertifiedDelivery. 1466 1467 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1468 1469 :param note_metadata: The note_metadata of this CertifiedDelivery. # noqa: E501 1470 :type: PropertyMetadata 1471 """ 1472 1473 self._note_metadata = note_metadata 1474 1475 @property 1476 def phone_authentication(self): 1477 """Gets the phone_authentication of this CertifiedDelivery. # noqa: E501 1478 1479 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 1480 1481 :return: The phone_authentication of this CertifiedDelivery. # noqa: E501 1482 :rtype: RecipientPhoneAuthentication 1483 """ 1484 return self._phone_authentication 1485 1486 @phone_authentication.setter 1487 def phone_authentication(self, phone_authentication): 1488 """Sets the phone_authentication of this CertifiedDelivery. 1489 1490 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 1491 1492 :param phone_authentication: The phone_authentication of this CertifiedDelivery. # noqa: E501 1493 :type: RecipientPhoneAuthentication 1494 """ 1495 1496 self._phone_authentication = phone_authentication 1497 1498 @property 1499 def phone_number(self): 1500 """Gets the phone_number of this CertifiedDelivery. # noqa: E501 1501 1502 Describes the recipient phone number. # noqa: E501 1503 1504 :return: The phone_number of this CertifiedDelivery. # noqa: E501 1505 :rtype: RecipientPhoneNumber 1506 """ 1507 return self._phone_number 1508 1509 @phone_number.setter 1510 def phone_number(self, phone_number): 1511 """Sets the phone_number of this CertifiedDelivery. 1512 1513 Describes the recipient phone number. # noqa: E501 1514 1515 :param phone_number: The phone_number of this CertifiedDelivery. # noqa: E501 1516 :type: RecipientPhoneNumber 1517 """ 1518 1519 self._phone_number = phone_number 1520 1521 @property 1522 def proof_file(self): 1523 """Gets the proof_file of this CertifiedDelivery. # noqa: E501 1524 1525 The proof file of the recipient. # noqa: E501 1526 1527 :return: The proof_file of this CertifiedDelivery. # noqa: E501 1528 :rtype: RecipientProofFile 1529 """ 1530 return self._proof_file 1531 1532 @proof_file.setter 1533 def proof_file(self, proof_file): 1534 """Sets the proof_file of this CertifiedDelivery. 1535 1536 The proof file of the recipient. # noqa: E501 1537 1538 :param proof_file: The proof_file of this CertifiedDelivery. # noqa: E501 1539 :type: RecipientProofFile 1540 """ 1541 1542 self._proof_file = proof_file 1543 1544 @property 1545 def recipient_attachments(self): 1546 """Gets the recipient_attachments of this CertifiedDelivery. # noqa: E501 1547 1548 Reserved: # noqa: E501 1549 1550 :return: The recipient_attachments of this CertifiedDelivery. # noqa: E501 1551 :rtype: list[RecipientAttachment] 1552 """ 1553 return self._recipient_attachments 1554 1555 @recipient_attachments.setter 1556 def recipient_attachments(self, recipient_attachments): 1557 """Sets the recipient_attachments of this CertifiedDelivery. 1558 1559 Reserved: # noqa: E501 1560 1561 :param recipient_attachments: The recipient_attachments of this CertifiedDelivery. # noqa: E501 1562 :type: list[RecipientAttachment] 1563 """ 1564 1565 self._recipient_attachments = recipient_attachments 1566 1567 @property 1568 def recipient_authentication_status(self): 1569 """Gets the recipient_authentication_status of this CertifiedDelivery. # noqa: E501 1570 1571 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1572 1573 :return: The recipient_authentication_status of this CertifiedDelivery. # noqa: E501 1574 :rtype: AuthenticationStatus 1575 """ 1576 return self._recipient_authentication_status 1577 1578 @recipient_authentication_status.setter 1579 def recipient_authentication_status(self, recipient_authentication_status): 1580 """Sets the recipient_authentication_status of this CertifiedDelivery. 1581 1582 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1583 1584 :param recipient_authentication_status: The recipient_authentication_status of this CertifiedDelivery. # noqa: E501 1585 :type: AuthenticationStatus 1586 """ 1587 1588 self._recipient_authentication_status = recipient_authentication_status 1589 1590 @property 1591 def recipient_feature_metadata(self): 1592 """Gets the recipient_feature_metadata of this CertifiedDelivery. # noqa: E501 1593 1594 # noqa: E501 1595 1596 :return: The recipient_feature_metadata of this CertifiedDelivery. # noqa: E501 1597 :rtype: list[FeatureAvailableMetadata] 1598 """ 1599 return self._recipient_feature_metadata 1600 1601 @recipient_feature_metadata.setter 1602 def recipient_feature_metadata(self, recipient_feature_metadata): 1603 """Sets the recipient_feature_metadata of this CertifiedDelivery. 1604 1605 # noqa: E501 1606 1607 :param recipient_feature_metadata: The recipient_feature_metadata of this CertifiedDelivery. # noqa: E501 1608 :type: list[FeatureAvailableMetadata] 1609 """ 1610 1611 self._recipient_feature_metadata = recipient_feature_metadata 1612 1613 @property 1614 def recipient_id(self): 1615 """Gets the recipient_id of this CertifiedDelivery. # noqa: E501 1616 1617 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1618 1619 :return: The recipient_id of this CertifiedDelivery. # noqa: E501 1620 :rtype: str 1621 """ 1622 return self._recipient_id 1623 1624 @recipient_id.setter 1625 def recipient_id(self, recipient_id): 1626 """Sets the recipient_id of this CertifiedDelivery. 1627 1628 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1629 1630 :param recipient_id: The recipient_id of this CertifiedDelivery. # noqa: E501 1631 :type: str 1632 """ 1633 1634 self._recipient_id = recipient_id 1635 1636 @property 1637 def recipient_id_guid(self): 1638 """Gets the recipient_id_guid of this CertifiedDelivery. # noqa: E501 1639 1640 # noqa: E501 1641 1642 :return: The recipient_id_guid of this CertifiedDelivery. # noqa: E501 1643 :rtype: str 1644 """ 1645 return self._recipient_id_guid 1646 1647 @recipient_id_guid.setter 1648 def recipient_id_guid(self, recipient_id_guid): 1649 """Sets the recipient_id_guid of this CertifiedDelivery. 1650 1651 # noqa: E501 1652 1653 :param recipient_id_guid: The recipient_id_guid of this CertifiedDelivery. # noqa: E501 1654 :type: str 1655 """ 1656 1657 self._recipient_id_guid = recipient_id_guid 1658 1659 @property 1660 def recipient_type(self): 1661 """Gets the recipient_type of this CertifiedDelivery. # noqa: E501 1662 1663 # noqa: E501 1664 1665 :return: The recipient_type of this CertifiedDelivery. # noqa: E501 1666 :rtype: str 1667 """ 1668 return self._recipient_type 1669 1670 @recipient_type.setter 1671 def recipient_type(self, recipient_type): 1672 """Sets the recipient_type of this CertifiedDelivery. 1673 1674 # noqa: E501 1675 1676 :param recipient_type: The recipient_type of this CertifiedDelivery. # noqa: E501 1677 :type: str 1678 """ 1679 1680 self._recipient_type = recipient_type 1681 1682 @property 1683 def recipient_type_metadata(self): 1684 """Gets the recipient_type_metadata of this CertifiedDelivery. # noqa: E501 1685 1686 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 1687 1688 :return: The recipient_type_metadata of this CertifiedDelivery. # noqa: E501 1689 :rtype: PropertyMetadata 1690 """ 1691 return self._recipient_type_metadata 1692 1693 @recipient_type_metadata.setter 1694 def recipient_type_metadata(self, recipient_type_metadata): 1695 """Sets the recipient_type_metadata of this CertifiedDelivery. 1696 1697 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 1698 1699 :param recipient_type_metadata: The recipient_type_metadata of this CertifiedDelivery. # noqa: E501 1700 :type: PropertyMetadata 1701 """ 1702 1703 self._recipient_type_metadata = recipient_type_metadata 1704 1705 @property 1706 def require_id_lookup(self): 1707 """Gets the require_id_lookup of this CertifiedDelivery. # noqa: E501 1708 1709 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 1710 1711 :return: The require_id_lookup of this CertifiedDelivery. # noqa: E501 1712 :rtype: str 1713 """ 1714 return self._require_id_lookup 1715 1716 @require_id_lookup.setter 1717 def require_id_lookup(self, require_id_lookup): 1718 """Sets the require_id_lookup of this CertifiedDelivery. 1719 1720 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 1721 1722 :param require_id_lookup: The require_id_lookup of this CertifiedDelivery. # noqa: E501 1723 :type: str 1724 """ 1725 1726 self._require_id_lookup = require_id_lookup 1727 1728 @property 1729 def require_id_lookup_metadata(self): 1730 """Gets the require_id_lookup_metadata of this CertifiedDelivery. # noqa: E501 1731 1732 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 1733 1734 :return: The require_id_lookup_metadata of this CertifiedDelivery. # noqa: E501 1735 :rtype: PropertyMetadata 1736 """ 1737 return self._require_id_lookup_metadata 1738 1739 @require_id_lookup_metadata.setter 1740 def require_id_lookup_metadata(self, require_id_lookup_metadata): 1741 """Sets the require_id_lookup_metadata of this CertifiedDelivery. 1742 1743 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 1744 1745 :param require_id_lookup_metadata: The require_id_lookup_metadata of this CertifiedDelivery. # noqa: E501 1746 :type: PropertyMetadata 1747 """ 1748 1749 self._require_id_lookup_metadata = require_id_lookup_metadata 1750 1751 @property 1752 def role_name(self): 1753 """Gets the role_name of this CertifiedDelivery. # noqa: E501 1754 1755 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 1756 1757 :return: The role_name of this CertifiedDelivery. # noqa: E501 1758 :rtype: str 1759 """ 1760 return self._role_name 1761 1762 @role_name.setter 1763 def role_name(self, role_name): 1764 """Sets the role_name of this CertifiedDelivery. 1765 1766 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 1767 1768 :param role_name: The role_name of this CertifiedDelivery. # noqa: E501 1769 :type: str 1770 """ 1771 1772 self._role_name = role_name 1773 1774 @property 1775 def routing_order(self): 1776 """Gets the routing_order of this CertifiedDelivery. # noqa: E501 1777 1778 Specifies the routing order of the recipient in the envelope. # noqa: E501 1779 1780 :return: The routing_order of this CertifiedDelivery. # noqa: E501 1781 :rtype: str 1782 """ 1783 return self._routing_order 1784 1785 @routing_order.setter 1786 def routing_order(self, routing_order): 1787 """Sets the routing_order of this CertifiedDelivery. 1788 1789 Specifies the routing order of the recipient in the envelope. # noqa: E501 1790 1791 :param routing_order: The routing_order of this CertifiedDelivery. # noqa: E501 1792 :type: str 1793 """ 1794 1795 self._routing_order = routing_order 1796 1797 @property 1798 def routing_order_metadata(self): 1799 """Gets the routing_order_metadata of this CertifiedDelivery. # noqa: E501 1800 1801 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 1802 1803 :return: The routing_order_metadata of this CertifiedDelivery. # noqa: E501 1804 :rtype: PropertyMetadata 1805 """ 1806 return self._routing_order_metadata 1807 1808 @routing_order_metadata.setter 1809 def routing_order_metadata(self, routing_order_metadata): 1810 """Sets the routing_order_metadata of this CertifiedDelivery. 1811 1812 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 1813 1814 :param routing_order_metadata: The routing_order_metadata of this CertifiedDelivery. # noqa: E501 1815 :type: PropertyMetadata 1816 """ 1817 1818 self._routing_order_metadata = routing_order_metadata 1819 1820 @property 1821 def sent_date_time(self): 1822 """Gets the sent_date_time of this CertifiedDelivery. # noqa: E501 1823 1824 The date and time the envelope was sent. # noqa: E501 1825 1826 :return: The sent_date_time of this CertifiedDelivery. # noqa: E501 1827 :rtype: str 1828 """ 1829 return self._sent_date_time 1830 1831 @sent_date_time.setter 1832 def sent_date_time(self, sent_date_time): 1833 """Sets the sent_date_time of this CertifiedDelivery. 1834 1835 The date and time the envelope was sent. # noqa: E501 1836 1837 :param sent_date_time: The sent_date_time of this CertifiedDelivery. # noqa: E501 1838 :type: str 1839 """ 1840 1841 self._sent_date_time = sent_date_time 1842 1843 @property 1844 def signed_date_time(self): 1845 """Gets the signed_date_time of this CertifiedDelivery. # noqa: E501 1846 1847 Reserved: For DocuSign use only. # noqa: E501 1848 1849 :return: The signed_date_time of this CertifiedDelivery. # noqa: E501 1850 :rtype: str 1851 """ 1852 return self._signed_date_time 1853 1854 @signed_date_time.setter 1855 def signed_date_time(self, signed_date_time): 1856 """Sets the signed_date_time of this CertifiedDelivery. 1857 1858 Reserved: For DocuSign use only. # noqa: E501 1859 1860 :param signed_date_time: The signed_date_time of this CertifiedDelivery. # noqa: E501 1861 :type: str 1862 """ 1863 1864 self._signed_date_time = signed_date_time 1865 1866 @property 1867 def signing_group_id(self): 1868 """Gets the signing_group_id of this CertifiedDelivery. # noqa: E501 1869 1870 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 1871 1872 :return: The signing_group_id of this CertifiedDelivery. # noqa: E501 1873 :rtype: str 1874 """ 1875 return self._signing_group_id 1876 1877 @signing_group_id.setter 1878 def signing_group_id(self, signing_group_id): 1879 """Sets the signing_group_id of this CertifiedDelivery. 1880 1881 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 1882 1883 :param signing_group_id: The signing_group_id of this CertifiedDelivery. # noqa: E501 1884 :type: str 1885 """ 1886 1887 self._signing_group_id = signing_group_id 1888 1889 @property 1890 def signing_group_id_metadata(self): 1891 """Gets the signing_group_id_metadata of this CertifiedDelivery. # noqa: E501 1892 1893 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 1894 1895 :return: The signing_group_id_metadata of this CertifiedDelivery. # noqa: E501 1896 :rtype: PropertyMetadata 1897 """ 1898 return self._signing_group_id_metadata 1899 1900 @signing_group_id_metadata.setter 1901 def signing_group_id_metadata(self, signing_group_id_metadata): 1902 """Sets the signing_group_id_metadata of this CertifiedDelivery. 1903 1904 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 1905 1906 :param signing_group_id_metadata: The signing_group_id_metadata of this CertifiedDelivery. # noqa: E501 1907 :type: PropertyMetadata 1908 """ 1909 1910 self._signing_group_id_metadata = signing_group_id_metadata 1911 1912 @property 1913 def signing_group_name(self): 1914 """Gets the signing_group_name of this CertifiedDelivery. # noqa: E501 1915 1916 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 1917 1918 :return: The signing_group_name of this CertifiedDelivery. # noqa: E501 1919 :rtype: str 1920 """ 1921 return self._signing_group_name 1922 1923 @signing_group_name.setter 1924 def signing_group_name(self, signing_group_name): 1925 """Sets the signing_group_name of this CertifiedDelivery. 1926 1927 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 1928 1929 :param signing_group_name: The signing_group_name of this CertifiedDelivery. # noqa: E501 1930 :type: str 1931 """ 1932 1933 self._signing_group_name = signing_group_name 1934 1935 @property 1936 def signing_group_type(self): 1937 """Gets the signing_group_type of this CertifiedDelivery. # noqa: E501 1938 1939 # noqa: E501 1940 1941 :return: The signing_group_type of this CertifiedDelivery. # noqa: E501 1942 :rtype: str 1943 """ 1944 return self._signing_group_type 1945 1946 @signing_group_type.setter 1947 def signing_group_type(self, signing_group_type): 1948 """Sets the signing_group_type of this CertifiedDelivery. 1949 1950 # noqa: E501 1951 1952 :param signing_group_type: The signing_group_type of this CertifiedDelivery. # noqa: E501 1953 :type: str 1954 """ 1955 1956 self._signing_group_type = signing_group_type 1957 1958 @property 1959 def signing_group_users(self): 1960 """Gets the signing_group_users of this CertifiedDelivery. # noqa: E501 1961 1962 A complex type that contains information about users in the signing group. # noqa: E501 1963 1964 :return: The signing_group_users of this CertifiedDelivery. # noqa: E501 1965 :rtype: list[UserInfo] 1966 """ 1967 return self._signing_group_users 1968 1969 @signing_group_users.setter 1970 def signing_group_users(self, signing_group_users): 1971 """Sets the signing_group_users of this CertifiedDelivery. 1972 1973 A complex type that contains information about users in the signing group. # noqa: E501 1974 1975 :param signing_group_users: The signing_group_users of this CertifiedDelivery. # noqa: E501 1976 :type: list[UserInfo] 1977 """ 1978 1979 self._signing_group_users = signing_group_users 1980 1981 @property 1982 def sms_authentication(self): 1983 """Gets the sms_authentication of this CertifiedDelivery. # noqa: E501 1984 1985 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 1986 1987 :return: The sms_authentication of this CertifiedDelivery. # noqa: E501 1988 :rtype: RecipientSMSAuthentication 1989 """ 1990 return self._sms_authentication 1991 1992 @sms_authentication.setter 1993 def sms_authentication(self, sms_authentication): 1994 """Sets the sms_authentication of this CertifiedDelivery. 1995 1996 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 1997 1998 :param sms_authentication: The sms_authentication of this CertifiedDelivery. # noqa: E501 1999 :type: RecipientSMSAuthentication 2000 """ 2001 2002 self._sms_authentication = sms_authentication 2003 2004 @property 2005 def social_authentications(self): 2006 """Gets the social_authentications of this CertifiedDelivery. # noqa: E501 2007 2008 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2009 2010 :return: The social_authentications of this CertifiedDelivery. # noqa: E501 2011 :rtype: list[SocialAuthentication] 2012 """ 2013 return self._social_authentications 2014 2015 @social_authentications.setter 2016 def social_authentications(self, social_authentications): 2017 """Sets the social_authentications of this CertifiedDelivery. 2018 2019 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2020 2021 :param social_authentications: The social_authentications of this CertifiedDelivery. # noqa: E501 2022 :type: list[SocialAuthentication] 2023 """ 2024 2025 self._social_authentications = social_authentications 2026 2027 @property 2028 def status(self): 2029 """Gets the status of this CertifiedDelivery. # noqa: E501 2030 2031 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 2032 2033 :return: The status of this CertifiedDelivery. # noqa: E501 2034 :rtype: str 2035 """ 2036 return self._status 2037 2038 @status.setter 2039 def status(self, status): 2040 """Sets the status of this CertifiedDelivery. 2041 2042 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 2043 2044 :param status: The status of this CertifiedDelivery. # noqa: E501 2045 :type: str 2046 """ 2047 2048 self._status = status 2049 2050 @property 2051 def status_code(self): 2052 """Gets the status_code of this CertifiedDelivery. # noqa: E501 2053 2054 # noqa: E501 2055 2056 :return: The status_code of this CertifiedDelivery. # noqa: E501 2057 :rtype: str 2058 """ 2059 return self._status_code 2060 2061 @status_code.setter 2062 def status_code(self, status_code): 2063 """Sets the status_code of this CertifiedDelivery. 2064 2065 # noqa: E501 2066 2067 :param status_code: The status_code of this CertifiedDelivery. # noqa: E501 2068 :type: str 2069 """ 2070 2071 self._status_code = status_code 2072 2073 @property 2074 def suppress_emails(self): 2075 """Gets the suppress_emails of this CertifiedDelivery. # noqa: E501 2076 2077 # noqa: E501 2078 2079 :return: The suppress_emails of this CertifiedDelivery. # noqa: E501 2080 :rtype: str 2081 """ 2082 return self._suppress_emails 2083 2084 @suppress_emails.setter 2085 def suppress_emails(self, suppress_emails): 2086 """Sets the suppress_emails of this CertifiedDelivery. 2087 2088 # noqa: E501 2089 2090 :param suppress_emails: The suppress_emails of this CertifiedDelivery. # noqa: E501 2091 :type: str 2092 """ 2093 2094 self._suppress_emails = suppress_emails 2095 2096 @property 2097 def template_locked(self): 2098 """Gets the template_locked of this CertifiedDelivery. # noqa: E501 2099 2100 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2101 2102 :return: The template_locked of this CertifiedDelivery. # noqa: E501 2103 :rtype: str 2104 """ 2105 return self._template_locked 2106 2107 @template_locked.setter 2108 def template_locked(self, template_locked): 2109 """Sets the template_locked of this CertifiedDelivery. 2110 2111 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2112 2113 :param template_locked: The template_locked of this CertifiedDelivery. # noqa: E501 2114 :type: str 2115 """ 2116 2117 self._template_locked = template_locked 2118 2119 @property 2120 def template_required(self): 2121 """Gets the template_required of this CertifiedDelivery. # noqa: E501 2122 2123 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2124 2125 :return: The template_required of this CertifiedDelivery. # noqa: E501 2126 :rtype: str 2127 """ 2128 return self._template_required 2129 2130 @template_required.setter 2131 def template_required(self, template_required): 2132 """Sets the template_required of this CertifiedDelivery. 2133 2134 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2135 2136 :param template_required: The template_required of this CertifiedDelivery. # noqa: E501 2137 :type: str 2138 """ 2139 2140 self._template_required = template_required 2141 2142 @property 2143 def total_tab_count(self): 2144 """Gets the total_tab_count of this CertifiedDelivery. # noqa: E501 2145 2146 # noqa: E501 2147 2148 :return: The total_tab_count of this CertifiedDelivery. # noqa: E501 2149 :rtype: str 2150 """ 2151 return self._total_tab_count 2152 2153 @total_tab_count.setter 2154 def total_tab_count(self, total_tab_count): 2155 """Sets the total_tab_count of this CertifiedDelivery. 2156 2157 # noqa: E501 2158 2159 :param total_tab_count: The total_tab_count of this CertifiedDelivery. # noqa: E501 2160 :type: str 2161 """ 2162 2163 self._total_tab_count = total_tab_count 2164 2165 @property 2166 def user_id(self): 2167 """Gets the user_id of this CertifiedDelivery. # noqa: E501 2168 2169 # noqa: E501 2170 2171 :return: The user_id of this CertifiedDelivery. # noqa: E501 2172 :rtype: str 2173 """ 2174 return self._user_id 2175 2176 @user_id.setter 2177 def user_id(self, user_id): 2178 """Sets the user_id of this CertifiedDelivery. 2179 2180 # noqa: E501 2181 2182 :param user_id: The user_id of this CertifiedDelivery. # noqa: E501 2183 :type: str 2184 """ 2185 2186 self._user_id = user_id 2187 2188 @property 2189 def web_form_recipient_view_id(self): 2190 """Gets the web_form_recipient_view_id of this CertifiedDelivery. # noqa: E501 2191 2192 # noqa: E501 2193 2194 :return: The web_form_recipient_view_id of this CertifiedDelivery. # noqa: E501 2195 :rtype: str 2196 """ 2197 return self._web_form_recipient_view_id 2198 2199 @web_form_recipient_view_id.setter 2200 def web_form_recipient_view_id(self, web_form_recipient_view_id): 2201 """Sets the web_form_recipient_view_id of this CertifiedDelivery. 2202 2203 # noqa: E501 2204 2205 :param web_form_recipient_view_id: The web_form_recipient_view_id of this CertifiedDelivery. # noqa: E501 2206 :type: str 2207 """ 2208 2209 self._web_form_recipient_view_id = web_form_recipient_view_id 2210 2211 def to_dict(self): 2212 """Returns the model properties as a dict""" 2213 result = {} 2214 2215 for attr, _ in six.iteritems(self.swagger_types): 2216 value = getattr(self, attr) 2217 if isinstance(value, list): 2218 result[attr] = list(map( 2219 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2220 value 2221 )) 2222 elif hasattr(value, "to_dict"): 2223 result[attr] = value.to_dict() 2224 elif isinstance(value, dict): 2225 result[attr] = dict(map( 2226 lambda item: (item[0], item[1].to_dict()) 2227 if hasattr(item[1], "to_dict") else item, 2228 value.items() 2229 )) 2230 else: 2231 result[attr] = value 2232 if issubclass(CertifiedDelivery, dict): 2233 for key, value in self.items(): 2234 result[key] = value 2235 2236 return result 2237 2238 def to_str(self): 2239 """Returns the string representation of the model""" 2240 return pprint.pformat(self.to_dict()) 2241 2242 def __repr__(self): 2243 """For `print` and `pprint`""" 2244 return self.to_str() 2245 2246 def __eq__(self, other): 2247 """Returns true if both objects are equal""" 2248 if not isinstance(other, CertifiedDelivery): 2249 return False 2250 2251 return self.to_dict() == other.to_dict() 2252 2253 def __ne__(self, other): 2254 """Returns true if both objects are not equal""" 2255 if not isinstance(other, CertifiedDelivery): 2256 return True 2257 2258 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.
CertifiedDelivery(_configuration=None, **kwargs)
202 def __init__(self, _configuration=None, **kwargs): # noqa: E501 203 """CertifiedDelivery - a model defined in Swagger""" # noqa: E501 204 if _configuration is None: 205 _configuration = Configuration() 206 self._configuration = _configuration 207 208 self._access_code = None 209 self._access_code_metadata = None 210 self._add_access_code_to_email = None 211 self._additional_notifications = None 212 self._agent_can_edit_email = None 213 self._agent_can_edit_name = None 214 self._allow_system_override_for_locked_recipient = None 215 self._auto_responded_reason = None 216 self._bulk_send_v2_recipient = None 217 self._client_user_id = None 218 self._completed_count = None 219 self._consent_details_list = None 220 self._custom_fields = None 221 self._declined_date_time = None 222 self._declined_reason = None 223 self._delivered_date_time = None 224 self._delivery_method = None 225 self._delivery_method_metadata = None 226 self._designator_id = None 227 self._designator_id_guid = None 228 self._document_template_id = None 229 self._document_visibility = None 230 self._email = None 231 self._email_metadata = None 232 self._email_notification = None 233 self._email_recipient_post_signing_url = None 234 self._embedded_recipient_start_url = None 235 self._error_details = None 236 self._excluded_documents = None 237 self._fax_number = None 238 self._fax_number_metadata = None 239 self._first_name = None 240 self._first_name_metadata = None 241 self._full_name = None 242 self._full_name_metadata = None 243 self._id_check_configuration_name = None 244 self._id_check_configuration_name_metadata = None 245 self._id_check_information_input = None 246 self._identity_verification = None 247 self._inherit_email_notification_configuration = None 248 self._last_name = None 249 self._last_name_metadata = None 250 self._locked_recipient_phone_auth_editable = None 251 self._locked_recipient_sms_editable = None 252 self._name = None 253 self._name_metadata = None 254 self._note = None 255 self._note_metadata = None 256 self._phone_authentication = None 257 self._phone_number = None 258 self._proof_file = None 259 self._recipient_attachments = None 260 self._recipient_authentication_status = None 261 self._recipient_feature_metadata = None 262 self._recipient_id = None 263 self._recipient_id_guid = None 264 self._recipient_type = None 265 self._recipient_type_metadata = None 266 self._require_id_lookup = None 267 self._require_id_lookup_metadata = None 268 self._role_name = None 269 self._routing_order = None 270 self._routing_order_metadata = None 271 self._sent_date_time = None 272 self._signed_date_time = None 273 self._signing_group_id = None 274 self._signing_group_id_metadata = None 275 self._signing_group_name = None 276 self._signing_group_type = None 277 self._signing_group_users = None 278 self._sms_authentication = None 279 self._social_authentications = None 280 self._status = None 281 self._status_code = None 282 self._suppress_emails = None 283 self._template_locked = None 284 self._template_required = None 285 self._total_tab_count = None 286 self._user_id = None 287 self._web_form_recipient_view_id = None 288 self.discriminator = None 289 290 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 291 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 292 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 293 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 294 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 295 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 296 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 297 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 298 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 299 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 300 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 301 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 302 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 303 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 304 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 305 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 306 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 307 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 308 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 309 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 310 setattr(self, "_{}".format('document_template_id'), kwargs.get('document_template_id', None)) 311 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 312 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 313 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 314 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 315 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 316 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 317 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 318 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 319 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 320 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 321 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 322 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 323 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 324 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 325 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 326 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 327 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 328 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 329 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 330 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 331 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 332 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 333 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 334 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 335 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 336 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 337 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 338 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 339 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 340 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 341 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 342 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 343 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 344 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 345 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 346 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 347 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 348 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 349 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 350 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 351 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 352 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 353 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 354 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 355 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 356 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 357 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 358 setattr(self, "_{}".format('signing_group_type'), kwargs.get('signing_group_type', None)) 359 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 360 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 361 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 362 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 363 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 364 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 365 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 366 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 367 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 368 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 369 setattr(self, "_{}".format('web_form_recipient_view_id'), kwargs.get('web_form_recipient_view_id', None))
CertifiedDelivery - 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_responded_reason': 'str', 'bulk_send_v2_recipient': 'str', 'client_user_id': 'str', 'completed_count': 'str', 'consent_details_list': 'list[ConsentDetails]', 'custom_fields': 'list[str]', 'declined_date_time': 'str', 'declined_reason': 'str', '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', 'last_name': 'str', 'last_name_metadata': 'PropertyMetadata', 'locked_recipient_phone_auth_editable': 'str', 'locked_recipient_sms_editable': 'str', 'name': 'str', 'name_metadata': 'PropertyMetadata', 'note': 'str', 'note_metadata': 'PropertyMetadata', '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_type': 'str', 'recipient_type_metadata': 'PropertyMetadata', 'require_id_lookup': 'str', 'require_id_lookup_metadata': 'PropertyMetadata', 'role_name': 'str', 'routing_order': 'str', 'routing_order_metadata': 'PropertyMetadata', 'sent_date_time': 'str', 'signed_date_time': 'str', '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', 'template_locked': 'str', 'template_required': 'str', 'total_tab_count': 'str', 'user_id': 'str', 'web_form_recipient_view_id': 'str'}
attribute_map = {'access_code': 'accessCode', 'access_code_metadata': 'accessCodeMetadata', 'add_access_code_to_email': 'addAccessCodeToEmail', 'additional_notifications': 'additionalNotifications', 'agent_can_edit_email': 'agentCanEditEmail', 'agent_can_edit_name': 'agentCanEditName', 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 'auto_responded_reason': 'autoRespondedReason', 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 'client_user_id': 'clientUserId', 'completed_count': 'completedCount', 'consent_details_list': 'consentDetailsList', 'custom_fields': 'customFields', 'declined_date_time': 'declinedDateTime', 'declined_reason': 'declinedReason', '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', 'last_name': 'lastName', 'last_name_metadata': 'lastNameMetadata', 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 'name': 'name', 'name_metadata': 'nameMetadata', 'note': 'note', 'note_metadata': 'noteMetadata', '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_type': 'recipientType', 'recipient_type_metadata': 'recipientTypeMetadata', 'require_id_lookup': 'requireIdLookup', 'require_id_lookup_metadata': 'requireIdLookupMetadata', 'role_name': 'roleName', 'routing_order': 'routingOrder', 'routing_order_metadata': 'routingOrderMetadata', 'sent_date_time': 'sentDateTime', 'signed_date_time': 'signedDateTime', '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', 'template_locked': 'templateLocked', 'template_required': 'templateRequired', 'total_tab_count': 'totalTabCount', 'user_id': 'userId', 'web_form_recipient_view_id': 'webFormRecipientViewId'}
access_code
Gets the access_code of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
access_code_metadata
Gets the access_code_metadata of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
add_access_code_to_email
Gets the add_access_code_to_email of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
additional_notifications
Gets the additional_notifications of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The additional_notifications of this CertifiedDelivery. # noqa: E501
agent_can_edit_email
Gets the agent_can_edit_email of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The agent_can_edit_email of this CertifiedDelivery. # noqa: E501
agent_can_edit_name
Gets the agent_can_edit_name of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The agent_can_edit_name of this CertifiedDelivery. # noqa: E501
allow_system_override_for_locked_recipient
Gets the allow_system_override_for_locked_recipient of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The allow_system_override_for_locked_recipient of this CertifiedDelivery. # noqa: E501
auto_responded_reason
Gets the auto_responded_reason of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The auto_responded_reason of this CertifiedDelivery. # noqa: E501
bulk_send_v2_recipient
Gets the bulk_send_v2_recipient of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The bulk_send_v2_recipient of this CertifiedDelivery. # noqa: E501
client_user_id
Gets the client_user_id of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
completed_count
Gets the completed_count of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The completed_count of this CertifiedDelivery. # noqa: E501
consent_details_list
Gets the consent_details_list of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The consent_details_list of this CertifiedDelivery. # noqa: E501
custom_fields
Gets the custom_fields of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
declined_date_time
Gets the declined_date_time of this CertifiedDelivery. # noqa: E501
The date and time the recipient declined the document. # noqa: E501
Returns
The declined_date_time of this CertifiedDelivery. # noqa: E501
declined_reason
Gets the declined_reason of this CertifiedDelivery. # noqa: E501
The reason the recipient declined the document. # noqa: E501
Returns
The declined_reason of this CertifiedDelivery. # noqa: E501
delivered_date_time
Gets the delivered_date_time of this CertifiedDelivery. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivered_date_time of this CertifiedDelivery. # noqa: E501
delivery_method
Gets the delivery_method of this CertifiedDelivery. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivery_method of this CertifiedDelivery. # noqa: E501
delivery_method_metadata
Gets the delivery_method_metadata of this CertifiedDelivery. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The delivery_method_metadata of this CertifiedDelivery. # noqa: E501
designator_id
Gets the designator_id of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The designator_id of this CertifiedDelivery. # noqa: E501
designator_id_guid
Gets the designator_id_guid of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The designator_id_guid of this CertifiedDelivery. # noqa: E501
document_template_id
Gets the document_template_id of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The document_template_id of this CertifiedDelivery. # noqa: E501
document_visibility
Gets the document_visibility of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The document_visibility of this CertifiedDelivery. # noqa: E501
email
Gets the email of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The email of this CertifiedDelivery. # noqa: E501
email_metadata
Gets the email_metadata of this CertifiedDelivery. # noqa: E501
Metadata that indicates whether the email property is editable. This property is read-only. # noqa: E501
Returns
The email_metadata of this CertifiedDelivery. # noqa: E501
email_notification
Gets the email_notification of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
email_recipient_post_signing_url
Gets the email_recipient_post_signing_url of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The email_recipient_post_signing_url of this CertifiedDelivery. # noqa: E501
embedded_recipient_start_url
Gets the embedded_recipient_start_url of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
error_details
Gets the error_details of this CertifiedDelivery. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this CertifiedDelivery. # noqa: E501
excluded_documents
Gets the excluded_documents of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
fax_number
Gets the fax_number of this CertifiedDelivery. # noqa: E501
Reserved: # noqa: E501
Returns
The fax_number of this CertifiedDelivery. # noqa: E501
fax_number_metadata
Gets the fax_number_metadata of this CertifiedDelivery. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The fax_number_metadata of this CertifiedDelivery. # noqa: E501
first_name
Gets the first_name of this CertifiedDelivery. # noqa: E501
The user's first name. Maximum Length: 50 characters. # noqa: E501
Returns
The first_name of this CertifiedDelivery. # noqa: E501
first_name_metadata
Gets the first_name_metadata of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
full_name
Gets the full_name of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The full_name of this CertifiedDelivery. # noqa: E501
full_name_metadata
Gets the full_name_metadata of this CertifiedDelivery. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The full_name_metadata of this CertifiedDelivery. # noqa: E501
id_check_configuration_name
Gets the id_check_configuration_name of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
id_check_configuration_name_metadata
Gets the id_check_configuration_name_metadata of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
id_check_information_input
Gets the id_check_information_input of this CertifiedDelivery. # noqa: E501
An object that contains input information related to a recipient ID check. # noqa: E501
Returns
The id_check_information_input of this CertifiedDelivery. # noqa: E501
identity_verification
Gets the identity_verification of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
inherit_email_notification_configuration
Gets the inherit_email_notification_configuration of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
last_name
Gets the last_name of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The last_name of this CertifiedDelivery. # noqa: E501
last_name_metadata
Gets the last_name_metadata of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
locked_recipient_phone_auth_editable
Gets the locked_recipient_phone_auth_editable of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The locked_recipient_phone_auth_editable of this CertifiedDelivery. # noqa: E501
locked_recipient_sms_editable
Gets the locked_recipient_sms_editable of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The locked_recipient_sms_editable of this CertifiedDelivery. # noqa: E501
name
Gets the name of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The name of this CertifiedDelivery. # noqa: E501
name_metadata
Gets the name_metadata of this CertifiedDelivery. # noqa: E501
Metadata that indicates whether the name property is editable. This property is read-only. # noqa: E501
Returns
The name_metadata of this CertifiedDelivery. # noqa: E501
note
Gets the note of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
note_metadata
Gets the note_metadata of this CertifiedDelivery. # noqa: E501
Metadata that indicates whether the note property is editable. This property is read-only. # noqa: E501
Returns
The note_metadata of this CertifiedDelivery. # noqa: E501
phone_authentication
Gets the phone_authentication of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
phone_number
Gets the phone_number of this CertifiedDelivery. # noqa: E501
Describes the recipient phone number. # noqa: E501
Returns
The phone_number of this CertifiedDelivery. # noqa: E501
proof_file
Gets the proof_file of this CertifiedDelivery. # noqa: E501
The proof file of the recipient. # noqa: E501
Returns
The proof_file of this CertifiedDelivery. # noqa: E501
recipient_attachments
Gets the recipient_attachments of this CertifiedDelivery. # noqa: E501
Reserved: # noqa: E501
Returns
The recipient_attachments of this CertifiedDelivery. # noqa: E501
recipient_authentication_status
Gets the recipient_authentication_status of this CertifiedDelivery. # noqa: E501
Information about the recipient's authentication status. This property is read-only. # noqa: E501
Returns
The recipient_authentication_status of this CertifiedDelivery. # noqa: E501
recipient_feature_metadata
Gets the recipient_feature_metadata of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The recipient_feature_metadata of this CertifiedDelivery. # noqa: E501
recipient_id
Gets the recipient_id of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
recipient_id_guid
Gets the recipient_id_guid of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this CertifiedDelivery. # noqa: E501
recipient_type
Gets the recipient_type of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The recipient_type of this CertifiedDelivery. # noqa: E501
recipient_type_metadata
Gets the recipient_type_metadata of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
require_id_lookup
Gets the require_id_lookup of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
require_id_lookup_metadata
Gets the require_id_lookup_metadata of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
role_name
Gets the role_name of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
routing_order
Gets the routing_order of this CertifiedDelivery. # noqa: E501
Specifies the routing order of the recipient in the envelope. # noqa: E501
Returns
The routing_order of this CertifiedDelivery. # noqa: E501
routing_order_metadata
Gets the routing_order_metadata of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
sent_date_time
Gets the sent_date_time of this CertifiedDelivery. # noqa: E501
The date and time the envelope was sent. # noqa: E501
Returns
The sent_date_time of this CertifiedDelivery. # noqa: E501
signed_date_time
Gets the signed_date_time of this CertifiedDelivery. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The signed_date_time of this CertifiedDelivery. # noqa: E501
signing_group_id
Gets the signing_group_id of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
signing_group_id_metadata
Gets the signing_group_id_metadata of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
signing_group_name
Gets the signing_group_name of this CertifiedDelivery. # noqa: E501
The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
Returns
The signing_group_name of this CertifiedDelivery. # noqa: E501
signing_group_type
Gets the signing_group_type of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The signing_group_type of this CertifiedDelivery. # noqa: E501
signing_group_users
Gets the signing_group_users of this CertifiedDelivery. # noqa: E501
A complex type that contains information about users in the signing group. # noqa: E501
Returns
The signing_group_users of this CertifiedDelivery. # noqa: E501
sms_authentication
Gets the sms_authentication of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
status
Gets the status of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
status_code
Gets the status_code of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The status_code of this CertifiedDelivery. # noqa: E501
suppress_emails
Gets the suppress_emails of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The suppress_emails of this CertifiedDelivery. # noqa: E501
template_locked
Gets the template_locked of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
template_required
Gets the template_required of this CertifiedDelivery. # 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 CertifiedDelivery. # noqa: E501
total_tab_count
Gets the total_tab_count of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The total_tab_count of this CertifiedDelivery. # noqa: E501
user_id
Gets the user_id of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The user_id of this CertifiedDelivery. # noqa: E501
web_form_recipient_view_id
Gets the web_form_recipient_view_id of this CertifiedDelivery. # noqa: E501
# noqa: E501
Returns
The web_form_recipient_view_id of this CertifiedDelivery. # noqa: E501
def
to_dict(self)
2211 def to_dict(self): 2212 """Returns the model properties as a dict""" 2213 result = {} 2214 2215 for attr, _ in six.iteritems(self.swagger_types): 2216 value = getattr(self, attr) 2217 if isinstance(value, list): 2218 result[attr] = list(map( 2219 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2220 value 2221 )) 2222 elif hasattr(value, "to_dict"): 2223 result[attr] = value.to_dict() 2224 elif isinstance(value, dict): 2225 result[attr] = dict(map( 2226 lambda item: (item[0], item[1].to_dict()) 2227 if hasattr(item[1], "to_dict") else item, 2228 value.items() 2229 )) 2230 else: 2231 result[attr] = value 2232 if issubclass(CertifiedDelivery, dict): 2233 for key, value in self.items(): 2234 result[key] = value 2235 2236 return result
Returns the model properties as a dict