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