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