docusign_esign.models.bulk_sending_copy_recipient

  1# coding: utf-8
  2
  3"""
  4    DocuSign REST API
  5
  6    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
  7
  8    OpenAPI spec version: v2.1
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14import pprint
 15import re  # noqa: F401
 16
 17import six
 18
 19from docusign_esign.client.configuration import Configuration
 20
 21
 22class BulkSendingCopyRecipient(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        'client_user_id': 'str',
 38        'custom_fields': 'list[str]',
 39        'delivery_method': 'str',
 40        'email': 'str',
 41        'email_notification': 'RecipientEmailNotification',
 42        'embedded_recipient_start_url': 'str',
 43        'fax_number': 'str',
 44        'host_email': 'str',
 45        'host_name': 'str',
 46        'id_check_configuration_name': 'str',
 47        'id_check_information_input': 'IdCheckInformationInput',
 48        'identification_method': 'str',
 49        'identity_verification': 'RecipientIdentityVerification',
 50        'name': 'str',
 51        'note': 'str',
 52        'phone_authentication': 'RecipientPhoneAuthentication',
 53        'recipient_id': 'str',
 54        'recipient_signature_providers': 'list[RecipientSignatureProvider]',
 55        'role_name': 'str',
 56        'signer_name': 'str',
 57        'signing_group_id': 'str',
 58        'sms_authentication': 'RecipientSMSAuthentication',
 59        'social_authentications': 'list[SocialAuthentication]',
 60        'tabs': 'list[BulkSendingCopyTab]'
 61    }
 62
 63    attribute_map = {
 64        'access_code': 'accessCode',
 65        'client_user_id': 'clientUserId',
 66        'custom_fields': 'customFields',
 67        'delivery_method': 'deliveryMethod',
 68        'email': 'email',
 69        'email_notification': 'emailNotification',
 70        'embedded_recipient_start_url': 'embeddedRecipientStartURL',
 71        'fax_number': 'faxNumber',
 72        'host_email': 'hostEmail',
 73        'host_name': 'hostName',
 74        'id_check_configuration_name': 'idCheckConfigurationName',
 75        'id_check_information_input': 'idCheckInformationInput',
 76        'identification_method': 'identificationMethod',
 77        'identity_verification': 'identityVerification',
 78        'name': 'name',
 79        'note': 'note',
 80        'phone_authentication': 'phoneAuthentication',
 81        'recipient_id': 'recipientId',
 82        'recipient_signature_providers': 'recipientSignatureProviders',
 83        'role_name': 'roleName',
 84        'signer_name': 'signerName',
 85        'signing_group_id': 'signingGroupId',
 86        'sms_authentication': 'smsAuthentication',
 87        'social_authentications': 'socialAuthentications',
 88        'tabs': 'tabs'
 89    }
 90
 91    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 92        """BulkSendingCopyRecipient - a model defined in Swagger"""  # noqa: E501
 93        if _configuration is None:
 94            _configuration = Configuration()
 95        self._configuration = _configuration
 96
 97        self._access_code = None
 98        self._client_user_id = None
 99        self._custom_fields = None
100        self._delivery_method = None
101        self._email = None
102        self._email_notification = None
103        self._embedded_recipient_start_url = None
104        self._fax_number = None
105        self._host_email = None
106        self._host_name = None
107        self._id_check_configuration_name = None
108        self._id_check_information_input = None
109        self._identification_method = None
110        self._identity_verification = None
111        self._name = None
112        self._note = None
113        self._phone_authentication = None
114        self._recipient_id = None
115        self._recipient_signature_providers = None
116        self._role_name = None
117        self._signer_name = None
118        self._signing_group_id = None
119        self._sms_authentication = None
120        self._social_authentications = None
121        self._tabs = None
122        self.discriminator = None
123
124        setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None))
125        setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None))
126        setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None))
127        setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None))
128        setattr(self, "_{}".format('email'), kwargs.get('email', None))
129        setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None))
130        setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None))
131        setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None))
132        setattr(self, "_{}".format('host_email'), kwargs.get('host_email', None))
133        setattr(self, "_{}".format('host_name'), kwargs.get('host_name', None))
134        setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None))
135        setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None))
136        setattr(self, "_{}".format('identification_method'), kwargs.get('identification_method', None))
137        setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None))
138        setattr(self, "_{}".format('name'), kwargs.get('name', None))
139        setattr(self, "_{}".format('note'), kwargs.get('note', None))
140        setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None))
141        setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None))
142        setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None))
143        setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None))
144        setattr(self, "_{}".format('signer_name'), kwargs.get('signer_name', None))
145        setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None))
146        setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None))
147        setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None))
148        setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None))
149
150    @property
151    def access_code(self):
152        """Gets the access_code of this BulkSendingCopyRecipient.  # noqa: E501
153
154        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
155
156        :return: The access_code of this BulkSendingCopyRecipient.  # noqa: E501
157        :rtype: str
158        """
159        return self._access_code
160
161    @access_code.setter
162    def access_code(self, access_code):
163        """Sets the access_code of this BulkSendingCopyRecipient.
164
165        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
166
167        :param access_code: The access_code of this BulkSendingCopyRecipient.  # noqa: E501
168        :type: str
169        """
170
171        self._access_code = access_code
172
173    @property
174    def client_user_id(self):
175        """Gets the client_user_id of this BulkSendingCopyRecipient.  # noqa: E501
176
177        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
178
179        :return: The client_user_id of this BulkSendingCopyRecipient.  # noqa: E501
180        :rtype: str
181        """
182        return self._client_user_id
183
184    @client_user_id.setter
185    def client_user_id(self, client_user_id):
186        """Sets the client_user_id of this BulkSendingCopyRecipient.
187
188        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
189
190        :param client_user_id: The client_user_id of this BulkSendingCopyRecipient.  # noqa: E501
191        :type: str
192        """
193
194        self._client_user_id = client_user_id
195
196    @property
197    def custom_fields(self):
198        """Gets the custom_fields of this BulkSendingCopyRecipient.  # noqa: E501
199
200        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
201
202        :return: The custom_fields of this BulkSendingCopyRecipient.  # noqa: E501
203        :rtype: list[str]
204        """
205        return self._custom_fields
206
207    @custom_fields.setter
208    def custom_fields(self, custom_fields):
209        """Sets the custom_fields of this BulkSendingCopyRecipient.
210
211        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
212
213        :param custom_fields: The custom_fields of this BulkSendingCopyRecipient.  # noqa: E501
214        :type: list[str]
215        """
216
217        self._custom_fields = custom_fields
218
219    @property
220    def delivery_method(self):
221        """Gets the delivery_method of this BulkSendingCopyRecipient.  # noqa: E501
222
223        Reserved: For DocuSign use only.  # noqa: E501
224
225        :return: The delivery_method of this BulkSendingCopyRecipient.  # noqa: E501
226        :rtype: str
227        """
228        return self._delivery_method
229
230    @delivery_method.setter
231    def delivery_method(self, delivery_method):
232        """Sets the delivery_method of this BulkSendingCopyRecipient.
233
234        Reserved: For DocuSign use only.  # noqa: E501
235
236        :param delivery_method: The delivery_method of this BulkSendingCopyRecipient.  # noqa: E501
237        :type: str
238        """
239
240        self._delivery_method = delivery_method
241
242    @property
243    def email(self):
244        """Gets the email of this BulkSendingCopyRecipient.  # noqa: E501
245
246          # noqa: E501
247
248        :return: The email of this BulkSendingCopyRecipient.  # noqa: E501
249        :rtype: str
250        """
251        return self._email
252
253    @email.setter
254    def email(self, email):
255        """Sets the email of this BulkSendingCopyRecipient.
256
257          # noqa: E501
258
259        :param email: The email of this BulkSendingCopyRecipient.  # noqa: E501
260        :type: str
261        """
262
263        self._email = email
264
265    @property
266    def email_notification(self):
267        """Gets the email_notification of this BulkSendingCopyRecipient.  # noqa: E501
268
269        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
270
271        :return: The email_notification of this BulkSendingCopyRecipient.  # noqa: E501
272        :rtype: RecipientEmailNotification
273        """
274        return self._email_notification
275
276    @email_notification.setter
277    def email_notification(self, email_notification):
278        """Sets the email_notification of this BulkSendingCopyRecipient.
279
280        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
281
282        :param email_notification: The email_notification of this BulkSendingCopyRecipient.  # noqa: E501
283        :type: RecipientEmailNotification
284        """
285
286        self._email_notification = email_notification
287
288    @property
289    def embedded_recipient_start_url(self):
290        """Gets the embedded_recipient_start_url of this BulkSendingCopyRecipient.  # noqa: E501
291
292        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
293
294        :return: The embedded_recipient_start_url of this BulkSendingCopyRecipient.  # noqa: E501
295        :rtype: str
296        """
297        return self._embedded_recipient_start_url
298
299    @embedded_recipient_start_url.setter
300    def embedded_recipient_start_url(self, embedded_recipient_start_url):
301        """Sets the embedded_recipient_start_url of this BulkSendingCopyRecipient.
302
303        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
304
305        :param embedded_recipient_start_url: The embedded_recipient_start_url of this BulkSendingCopyRecipient.  # noqa: E501
306        :type: str
307        """
308
309        self._embedded_recipient_start_url = embedded_recipient_start_url
310
311    @property
312    def fax_number(self):
313        """Gets the fax_number of this BulkSendingCopyRecipient.  # noqa: E501
314
315        Reserved:  # noqa: E501
316
317        :return: The fax_number of this BulkSendingCopyRecipient.  # noqa: E501
318        :rtype: str
319        """
320        return self._fax_number
321
322    @fax_number.setter
323    def fax_number(self, fax_number):
324        """Sets the fax_number of this BulkSendingCopyRecipient.
325
326        Reserved:  # noqa: E501
327
328        :param fax_number: The fax_number of this BulkSendingCopyRecipient.  # noqa: E501
329        :type: str
330        """
331
332        self._fax_number = fax_number
333
334    @property
335    def host_email(self):
336        """Gets the host_email of this BulkSendingCopyRecipient.  # noqa: E501
337
338          # noqa: E501
339
340        :return: The host_email of this BulkSendingCopyRecipient.  # noqa: E501
341        :rtype: str
342        """
343        return self._host_email
344
345    @host_email.setter
346    def host_email(self, host_email):
347        """Sets the host_email of this BulkSendingCopyRecipient.
348
349          # noqa: E501
350
351        :param host_email: The host_email of this BulkSendingCopyRecipient.  # noqa: E501
352        :type: str
353        """
354
355        self._host_email = host_email
356
357    @property
358    def host_name(self):
359        """Gets the host_name of this BulkSendingCopyRecipient.  # noqa: E501
360
361          # noqa: E501
362
363        :return: The host_name of this BulkSendingCopyRecipient.  # noqa: E501
364        :rtype: str
365        """
366        return self._host_name
367
368    @host_name.setter
369    def host_name(self, host_name):
370        """Sets the host_name of this BulkSendingCopyRecipient.
371
372          # noqa: E501
373
374        :param host_name: The host_name of this BulkSendingCopyRecipient.  # noqa: E501
375        :type: str
376        """
377
378        self._host_name = host_name
379
380    @property
381    def id_check_configuration_name(self):
382        """Gets the id_check_configuration_name of this BulkSendingCopyRecipient.  # noqa: E501
383
384        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
385
386        :return: The id_check_configuration_name of this BulkSendingCopyRecipient.  # noqa: E501
387        :rtype: str
388        """
389        return self._id_check_configuration_name
390
391    @id_check_configuration_name.setter
392    def id_check_configuration_name(self, id_check_configuration_name):
393        """Sets the id_check_configuration_name of this BulkSendingCopyRecipient.
394
395        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
396
397        :param id_check_configuration_name: The id_check_configuration_name of this BulkSendingCopyRecipient.  # noqa: E501
398        :type: str
399        """
400
401        self._id_check_configuration_name = id_check_configuration_name
402
403    @property
404    def id_check_information_input(self):
405        """Gets the id_check_information_input of this BulkSendingCopyRecipient.  # noqa: E501
406
407        An object that contains input information related to a recipient ID check.  # noqa: E501
408
409        :return: The id_check_information_input of this BulkSendingCopyRecipient.  # noqa: E501
410        :rtype: IdCheckInformationInput
411        """
412        return self._id_check_information_input
413
414    @id_check_information_input.setter
415    def id_check_information_input(self, id_check_information_input):
416        """Sets the id_check_information_input of this BulkSendingCopyRecipient.
417
418        An object that contains input information related to a recipient ID check.  # noqa: E501
419
420        :param id_check_information_input: The id_check_information_input of this BulkSendingCopyRecipient.  # noqa: E501
421        :type: IdCheckInformationInput
422        """
423
424        self._id_check_information_input = id_check_information_input
425
426    @property
427    def identification_method(self):
428        """Gets the identification_method of this BulkSendingCopyRecipient.  # noqa: E501
429
430          # noqa: E501
431
432        :return: The identification_method of this BulkSendingCopyRecipient.  # noqa: E501
433        :rtype: str
434        """
435        return self._identification_method
436
437    @identification_method.setter
438    def identification_method(self, identification_method):
439        """Sets the identification_method of this BulkSendingCopyRecipient.
440
441          # noqa: E501
442
443        :param identification_method: The identification_method of this BulkSendingCopyRecipient.  # noqa: E501
444        :type: str
445        """
446
447        self._identification_method = identification_method
448
449    @property
450    def identity_verification(self):
451        """Gets the identity_verification of this BulkSendingCopyRecipient.  # noqa: E501
452
453          # noqa: E501
454
455        :return: The identity_verification of this BulkSendingCopyRecipient.  # noqa: E501
456        :rtype: RecipientIdentityVerification
457        """
458        return self._identity_verification
459
460    @identity_verification.setter
461    def identity_verification(self, identity_verification):
462        """Sets the identity_verification of this BulkSendingCopyRecipient.
463
464          # noqa: E501
465
466        :param identity_verification: The identity_verification of this BulkSendingCopyRecipient.  # noqa: E501
467        :type: RecipientIdentityVerification
468        """
469
470        self._identity_verification = identity_verification
471
472    @property
473    def name(self):
474        """Gets the name of this BulkSendingCopyRecipient.  # noqa: E501
475
476          # noqa: E501
477
478        :return: The name of this BulkSendingCopyRecipient.  # noqa: E501
479        :rtype: str
480        """
481        return self._name
482
483    @name.setter
484    def name(self, name):
485        """Sets the name of this BulkSendingCopyRecipient.
486
487          # noqa: E501
488
489        :param name: The name of this BulkSendingCopyRecipient.  # noqa: E501
490        :type: str
491        """
492
493        self._name = name
494
495    @property
496    def note(self):
497        """Gets the note of this BulkSendingCopyRecipient.  # noqa: E501
498
499        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
500
501        :return: The note of this BulkSendingCopyRecipient.  # noqa: E501
502        :rtype: str
503        """
504        return self._note
505
506    @note.setter
507    def note(self, note):
508        """Sets the note of this BulkSendingCopyRecipient.
509
510        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
511
512        :param note: The note of this BulkSendingCopyRecipient.  # noqa: E501
513        :type: str
514        """
515
516        self._note = note
517
518    @property
519    def phone_authentication(self):
520        """Gets the phone_authentication of this BulkSendingCopyRecipient.  # noqa: E501
521
522        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
523
524        :return: The phone_authentication of this BulkSendingCopyRecipient.  # noqa: E501
525        :rtype: RecipientPhoneAuthentication
526        """
527        return self._phone_authentication
528
529    @phone_authentication.setter
530    def phone_authentication(self, phone_authentication):
531        """Sets the phone_authentication of this BulkSendingCopyRecipient.
532
533        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
534
535        :param phone_authentication: The phone_authentication of this BulkSendingCopyRecipient.  # noqa: E501
536        :type: RecipientPhoneAuthentication
537        """
538
539        self._phone_authentication = phone_authentication
540
541    @property
542    def recipient_id(self):
543        """Gets the recipient_id of this BulkSendingCopyRecipient.  # noqa: E501
544
545        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.  # noqa: E501
546
547        :return: The recipient_id of this BulkSendingCopyRecipient.  # noqa: E501
548        :rtype: str
549        """
550        return self._recipient_id
551
552    @recipient_id.setter
553    def recipient_id(self, recipient_id):
554        """Sets the recipient_id of this BulkSendingCopyRecipient.
555
556        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.  # noqa: E501
557
558        :param recipient_id: The recipient_id of this BulkSendingCopyRecipient.  # noqa: E501
559        :type: str
560        """
561
562        self._recipient_id = recipient_id
563
564    @property
565    def recipient_signature_providers(self):
566        """Gets the recipient_signature_providers of this BulkSendingCopyRecipient.  # noqa: E501
567
568          # noqa: E501
569
570        :return: The recipient_signature_providers of this BulkSendingCopyRecipient.  # noqa: E501
571        :rtype: list[RecipientSignatureProvider]
572        """
573        return self._recipient_signature_providers
574
575    @recipient_signature_providers.setter
576    def recipient_signature_providers(self, recipient_signature_providers):
577        """Sets the recipient_signature_providers of this BulkSendingCopyRecipient.
578
579          # noqa: E501
580
581        :param recipient_signature_providers: The recipient_signature_providers of this BulkSendingCopyRecipient.  # noqa: E501
582        :type: list[RecipientSignatureProvider]
583        """
584
585        self._recipient_signature_providers = recipient_signature_providers
586
587    @property
588    def role_name(self):
589        """Gets the role_name of this BulkSendingCopyRecipient.  # noqa: E501
590
591        Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.  # noqa: E501
592
593        :return: The role_name of this BulkSendingCopyRecipient.  # noqa: E501
594        :rtype: str
595        """
596        return self._role_name
597
598    @role_name.setter
599    def role_name(self, role_name):
600        """Sets the role_name of this BulkSendingCopyRecipient.
601
602        Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.  # noqa: E501
603
604        :param role_name: The role_name of this BulkSendingCopyRecipient.  # noqa: E501
605        :type: str
606        """
607
608        self._role_name = role_name
609
610    @property
611    def signer_name(self):
612        """Gets the signer_name of this BulkSendingCopyRecipient.  # noqa: E501
613
614          # noqa: E501
615
616        :return: The signer_name of this BulkSendingCopyRecipient.  # noqa: E501
617        :rtype: str
618        """
619        return self._signer_name
620
621    @signer_name.setter
622    def signer_name(self, signer_name):
623        """Sets the signer_name of this BulkSendingCopyRecipient.
624
625          # noqa: E501
626
627        :param signer_name: The signer_name of this BulkSendingCopyRecipient.  # noqa: E501
628        :type: str
629        """
630
631        self._signer_name = signer_name
632
633    @property
634    def signing_group_id(self):
635        """Gets the signing_group_id of this BulkSendingCopyRecipient.  # noqa: E501
636
637        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
638
639        :return: The signing_group_id of this BulkSendingCopyRecipient.  # noqa: E501
640        :rtype: str
641        """
642        return self._signing_group_id
643
644    @signing_group_id.setter
645    def signing_group_id(self, signing_group_id):
646        """Sets the signing_group_id of this BulkSendingCopyRecipient.
647
648        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
649
650        :param signing_group_id: The signing_group_id of this BulkSendingCopyRecipient.  # noqa: E501
651        :type: str
652        """
653
654        self._signing_group_id = signing_group_id
655
656    @property
657    def sms_authentication(self):
658        """Gets the sms_authentication of this BulkSendingCopyRecipient.  # noqa: E501
659
660        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
661
662        :return: The sms_authentication of this BulkSendingCopyRecipient.  # noqa: E501
663        :rtype: RecipientSMSAuthentication
664        """
665        return self._sms_authentication
666
667    @sms_authentication.setter
668    def sms_authentication(self, sms_authentication):
669        """Sets the sms_authentication of this BulkSendingCopyRecipient.
670
671        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
672
673        :param sms_authentication: The sms_authentication of this BulkSendingCopyRecipient.  # noqa: E501
674        :type: RecipientSMSAuthentication
675        """
676
677        self._sms_authentication = sms_authentication
678
679    @property
680    def social_authentications(self):
681        """Gets the social_authentications of this BulkSendingCopyRecipient.  # noqa: E501
682
683         Lists the social ID type that can be used for recipient authentication.  # noqa: E501
684
685        :return: The social_authentications of this BulkSendingCopyRecipient.  # noqa: E501
686        :rtype: list[SocialAuthentication]
687        """
688        return self._social_authentications
689
690    @social_authentications.setter
691    def social_authentications(self, social_authentications):
692        """Sets the social_authentications of this BulkSendingCopyRecipient.
693
694         Lists the social ID type that can be used for recipient authentication.  # noqa: E501
695
696        :param social_authentications: The social_authentications of this BulkSendingCopyRecipient.  # noqa: E501
697        :type: list[SocialAuthentication]
698        """
699
700        self._social_authentications = social_authentications
701
702    @property
703    def tabs(self):
704        """Gets the tabs of this BulkSendingCopyRecipient.  # noqa: E501
705
706          # noqa: E501
707
708        :return: The tabs of this BulkSendingCopyRecipient.  # noqa: E501
709        :rtype: list[BulkSendingCopyTab]
710        """
711        return self._tabs
712
713    @tabs.setter
714    def tabs(self, tabs):
715        """Sets the tabs of this BulkSendingCopyRecipient.
716
717          # noqa: E501
718
719        :param tabs: The tabs of this BulkSendingCopyRecipient.  # noqa: E501
720        :type: list[BulkSendingCopyTab]
721        """
722
723        self._tabs = tabs
724
725    def to_dict(self):
726        """Returns the model properties as a dict"""
727        result = {}
728
729        for attr, _ in six.iteritems(self.swagger_types):
730            value = getattr(self, attr)
731            if isinstance(value, list):
732                result[attr] = list(map(
733                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
734                    value
735                ))
736            elif hasattr(value, "to_dict"):
737                result[attr] = value.to_dict()
738            elif isinstance(value, dict):
739                result[attr] = dict(map(
740                    lambda item: (item[0], item[1].to_dict())
741                    if hasattr(item[1], "to_dict") else item,
742                    value.items()
743                ))
744            else:
745                result[attr] = value
746        if issubclass(BulkSendingCopyRecipient, dict):
747            for key, value in self.items():
748                result[key] = value
749
750        return result
751
752    def to_str(self):
753        """Returns the string representation of the model"""
754        return pprint.pformat(self.to_dict())
755
756    def __repr__(self):
757        """For `print` and `pprint`"""
758        return self.to_str()
759
760    def __eq__(self, other):
761        """Returns true if both objects are equal"""
762        if not isinstance(other, BulkSendingCopyRecipient):
763            return False
764
765        return self.to_dict() == other.to_dict()
766
767    def __ne__(self, other):
768        """Returns true if both objects are not equal"""
769        if not isinstance(other, BulkSendingCopyRecipient):
770            return True
771
772        return self.to_dict() != other.to_dict()