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